Skip to main content

Set up Obico for Klipper

caution

This guide is for the users who use Moonraker with Klipper. If you are using OctoPrint with Klipper, please follow the Obico for OctoPrint guide instead.

info

This guide assumes you are connecting to the Obico Cloud. If you are connecting to a self-hosted Obico Server, you will need to use the address of your self-hosted server.

Hardware requirements​

Before you start, make sure:

  • You have the Klipper and Moonraker set up correctly and connected to your printer. Also a user interface such as Mainsail/Fluidd is highly recommended.
  • A webcam is set up for your printer and connected to Mainsail/Fluidd/Moonraker.
  • There is sufficient lighting to illuminate the printing area of your printer. If your printer is in a lighted room, you are probably fine. If you'll print with light off, you will need to make sure the printing area is illuminated when your printer is printing. A LED strip or small LED lamp will do the trick.

Step 1: Download Obico for Klipper and run install.sh​

  1. SSH to the Raspberry Pi your Klipper runs on.
  2. Run:
    cd ~
git clone https://github.com/TheSpaghettiDetective/moonraker-obico.git
cd moonraker-obico
./install.sh
  1. Follow the installation steps. You may be asked to enter the password in order to run sudo commands.
  2. If you set up your Klipper platform in one of the common ways, such as MainsailOS or FluiddPi, good for you. install.sh will automatically detect your configurations and ask you for confirmation.
  3. If you have a custom setup for your Klipper platform, we may have to ask you to enter the configurations necessary for the installation to complete, such as the location of your moonraker.conf, Moonraker's port, and the log directory.
  4. install.sh will now start the process to link your printer to the Obico server. You will be asked to enter:
    • The Obico Server you want to link it to. The default is the Obico Cloud. You can also change it to using your own self-hosted Obico Server.
    • A 6-digit verification code. You will obtain this 6-digit verification code in the following steps.
  5. Leave the terminal open. We will come back to enter the 6-digit code once we obtain it from the Obico app.

Step 2: Sign up for an Obico account.​

tip

Follow instructions in the "πŸ“± Mobile App" tab if you are using the Obico mobile app, or the "🌐 Web App" tab if you are using the web app.

info

Your Obico account is the same for the mobile app and the web app. If you sign up for an account using the mobile app, you can sign in to the web app later with the same email and password. And vice versa.

info

All functions are available equally in the mobile and the web app. However, with the mobile app, you can receive push notifications on your phone to easily track the print progress, and get alerted in case a failure is detected.

  1. Download the Obico app from the Apple App Store or Google Play Store.
  2. Open the mobile app. Click through the first time tour and then tap β€œLet’s Go!”.
  3. Simply tap "YES!" on the "Hardware Required" screen.
  4. Tap "Sign Up/Sign In" button to proceed to the sign up/sign in screen.
  5. Sign up with your email, Google or Facebook account. If you have already registered, click the "Sign In" button and sign in to your account.
info

If you are connecting to a self-hosted Obico Server, press the wrench icon (πŸ”§) on the top-left corner of the sign-up screen to change the server address.


Press "Link Printer" button on the welcome screen. If you don't see that screen, tap the menu icon (☰) on the top-left corner, and select "Link New Printer".

Step 4: Obtain the 6-digit verification code​

  1. Choose "Klipper" on the next screen.
  2. Assuming you have followed the previous steps and run the install.sh script, simply press "Yes. Obico for Klipper is installed".
  3. Now you will see a screen with a 6-digit verification code. This is the code you will use to link your printer. You can long-press the number to copy it to the clipboard.

Step 5: Enter the 6-digit code​

  1. Go back to terminal for your SSH session in Step 1.
  2. Enter the 6-digit code you obtained in the previous step.
  3. As the final step, you will be asked if you want to opt in bug reporting. We strongly recommend you answer "Y" here. Bug reporting will help us catch and fix bugs earlier and more easily, and hence a better Obico app for you! :)

Hooray! You are done! You can now close the terminal. Obico for Klipper is now running as a system service.

Step 6 (optional): Give your printer a shinny name!​

Optionally, you can now give your printer a name. If you skip this step, your printer will have the default name "My Awesome Cloud Printer".

What's next?​

Check out your printer feed!​

Press "Go Check Out Printer Feed!" to see everything you care about your printer: the webcam feed, heater temperature, time remaining on the print job, and more! Remember, you can see your printer feed anywhere you go, as long as you have an internet connection on your phone!

Test the magical failure detection!​

The Detective sounds too magical to be true? See The Detective in action for yourself.

Change printer settings.​

The default settings for your printer in The Spaghetti Detective are the ones that most users find the most reasonable. But feel free to tweak them to your liking:

  • Change notification settings (mobile app only). By default you receive push notifications when The Detective finds something fishy, and for the status of whatever your printer is printing. But you can choose to receive a lot more.
  • Change printer settings, such as if The Detective should pause your printer when a failure is detected.