Skip to content

Commit 399745f

Browse files
kennethjiangkennethjiang
committed
moonraker-obico auto discovery guide'
1 parent 76d1def commit 399745f

File tree

3 files changed

+191
-2
lines changed

3 files changed

+191
-2
lines changed

‎website/docs/user-guides/klipper-plugin-setup-manual-link.md

+189
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,189 @@
1+
---
2+
title: Manually Link Klipper with a 6-digit code
3+
description: For Klipper/Moonraker/Mainsail/Fluidd users
4+
sidebar_label: Manually Link Klipper
5+
---
6+
7+
import Tabs from '@theme/Tabs';
8+
import TabItem from '@theme/TabItem';
9+
10+
:::caution
11+
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](octoprint-plugin-setup.md) instead.
12+
:::
13+
14+
:::info
15+
This guide assumes you are connecting to the [Obico Cloud](https://app.obico.io). If you are connecting to a [self-hosted Obico Server](/docs/server-guides/), you will need to use the address of your self-hosted server.
16+
:::
17+
18+
## Hardware requirements {#hardware-requirements}
19+
20+
Before you start, make sure:
21+
22+
- 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.
23+
- A webcam is set up for your printer and connected to Mainsail/Fluidd/Moonraker.
24+
- 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.
25+
26+
27+
## Step 1: Download Obico for Klipper and run `install.sh` {#step-1-download-obico-for-klipper-and-run-installsh}
28+
29+
1. SSH to the Raspberry Pi your Klipper runs on.
30+
2. Run:
31+
```bash
32+
cd ~
33+
git clone https://github.com/TheSpaghettiDetective/moonraker-obico.git
34+
cd moonraker-obico
35+
./install.sh
36+
```
37+
3. Follow the installation steps. You may be asked to enter the password in order to run `sudo` commands.
38+
5. You will also be asked to enter the configurations necessary for the installation to complete, such as the location of your `moonraker.conf`, Moonraker's port and address, and the log directory.
39+
6. `install.sh` will now start the process to link your printer to the Obico server. You will be asked to enter:
40+
- The Obico Server you want to link it to. The default is the [Obico Cloud](https://app.obico.io). You can also change it to using your own [self-hosted Obico Server](https://www.obico.io/docs/server-guides/) (ex: http://192.168.0.5:3334).
41+
- A **6-digit verification code**. You will obtain this 6-digit verification code in the following steps.
42+
7. Leave the terminal open. We will come back to enter the 6-digit code once we obtain it from the Obico app.
43+
44+
## Step 2: Sign up for an Obico account. {#step-2-sign-up-for-an-obico-account}
45+
46+
:::tip
47+
48+
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.
49+
50+
:::
51+
52+
:::info
53+
54+
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.
55+
56+
:::
57+
58+
:::info
59+
60+
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.
61+
62+
:::
63+
64+
<Tabs
65+
groupId="app"
66+
defaultValue="mobile"
67+
values={[
68+
{label: '📱 Mobile App', value: 'mobile'},
69+
{label: '🌐 Web App', value: 'web'},
70+
]}>
71+
<TabItem value="mobile">
72+
73+
1. Download the Obico app from the [Apple App Store](https://apps.apple.com/us/app/the-spaghetti-detective/id1540646623?ign-itsct=apps_box&ign-itscg=30200) or [Google Play Store](https://play.google.com/store/apps/details?id=com.thespaghettidetective.android).
74+
1. Open the mobile app. Click through the first time tour and then tap **“Let’s Go!”**.
75+
1. Simply tap "**YES!**" on the "Hardware Required" screen.
76+
1. Tap "**Sign Up/Sign In**" button to proceed to the sign up/sign in screen.
77+
1. 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.
78+
79+
:::info
80+
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.
81+
:::
82+
83+
<div style={{display: "flex", justifyContent: "center"}}><img src="/img/user-guides/setupguide/mobile-app-signup.gif" /></div>
84+
85+
</TabItem>
86+
<TabItem value="web">
87+
88+
1. Open the [Obico Server sign up page](https://app.obico.io/accounts/signup/) in a new browser tab.
89+
1. 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.
90+
91+
![Sign Up Account](/img/user-guides/setupguide/tsd-signup.png)
92+
93+
94+
</TabItem>
95+
</Tabs>
96+
97+
<br />
98+
99+
## Step 3: Launch the "Link Printer" wizard in the Obico app {#step-3-launch-the-link-printer-wizard-in-the-obico-app}
100+
101+
<Tabs
102+
groupId="app"
103+
defaultValue="mobile"
104+
values={[
105+
{label: '📱 Mobile App', value: 'mobile'},
106+
{label: '🌐 Web App', value: 'web'},
107+
]}>
108+
<TabItem value="mobile">
109+
110+
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**".
111+
112+
<div style={{display: "flex", justifyContent: "center"}}><img src="/img/user-guides/setupguide/launch-manual-link-mobile.jpg" /></div>
113+
114+
</TabItem>
115+
<TabItem value="web">
116+
117+
On the welcome page, click the "**Link Printer**" button.
118+
119+
![Welcome page](/img/user-guides/setupguide/welcome-web.jpg)
120+
121+
</TabItem>
122+
</Tabs>
123+
124+
## Step 4: Obtain the 6-digit verification code {#step-4-obtain-the-6-digit-verification-code}
125+
126+
<Tabs
127+
groupId="app"
128+
defaultValue="mobile"
129+
values={[
130+
{label: '📱 Mobile App', value: 'mobile'},
131+
{label: '🌐 Web App', value: 'web'},
132+
]}>
133+
<TabItem value="mobile">
134+
135+
1. Choose "**Klipper**" on the next screen.
136+
1. Assuming you have followed the previous steps and run the `install.sh` script, simply press "**Yes. Obico for Klipper is installed**".
137+
1. 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.
138+
139+
<div style={{display: "flex", justifyContent: "center"}}><img src="/img/user-guides/setupguide/klipper-verification-code-mobile.jpg" /></div>
140+
141+
<div />
142+
143+
</TabItem>
144+
145+
<TabItem value="web">
146+
147+
1. Click "Klipper" on the page that asks you to select a platform.
148+
149+
<div style={{display: "flex", justifyContent: "center"}}><img src="/img/user-guides/setupguide/select-platform-web.jpg" /></div>
150+
151+
2. Assuming you have followed Step 1 and run the `install.sh` script, you can simply click the "**Next>**" button.
152+
3. Now you will see a screen with a 6-digit verification code. You can press Ctrl-C (Windows) or Cmd-C (Mac) to copy the 6 digit code to the clipboard.
153+
154+
<div style={{display: "flex", justifyContent: "center"}}><img src="/img/user-guides/setupguide/klipper-verification-code-web.jpg" /></div>
155+
156+
</TabItem>
157+
</Tabs>
158+
159+
## Step 5: Enter the 6-digit code {#step-5-enter-the-6-digit-code}
160+
161+
1. Go back to terminal for your SSH session in Step 1.
162+
1. Enter the 6-digit code you obtained in the previous step.
163+
1. 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! :)
164+
165+
<div style={{display: "flex", justifyContent: "center"}}><img src="/img/user-guides/setupguide/link-success-klipper.png" /></div>
166+
<br />
167+
168+
Hooray! You are done! You can now close the terminal. Obico for Klipper is now running as a system service.
169+
170+
## Step 6 (optional): Give your printer a shiny name! {#step-6-optional-give-your-printer-a-shiny-name}
171+
172+
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*".
173+
174+
## What's next? {#whats-next}
175+
176+
### Check out your printer feed! {#check-out-your-printer-feed}
177+
178+
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!
179+
180+
### Test the magical failure detection! {#test-the-magical-failure-detection}
181+
182+
The Detective sounds too magical to be true? [See The Detective in action for yourself](/docs/user-guides/how-to-test-failure-detection).
183+
184+
### Change printer settings. {#change-printer-settings}
185+
186+
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:
187+
188+
- [Change notification settings](/docs/user-guides/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.
189+
- [Change printer settings](/docs/user-guides/detection-print-job-settings), such as if The Detective should pause your printer when a failure is detected.

‎website/docs/user-guides/klipper-setup.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ If you are phone or computer is one the **the same local network** as your Klipp
120120
4. The app will start scanning for the Klipper printer connected to the same local network.
121121
5. If printer is found, simply click the "**Link**" button and the app will do the rest for you.
122122
:::tip
123-
**If, however, the app can't find your printer after 1 minute of scanning, you need to follow the [Manual Setup Guide](/docs/user-guides/octoprint-plugin-setup-manual-link) to link your printer using a 6-digit code.**
123+
**If, however, the app can't find your printer after 1 minute of scanning, you need to follow the [Manual Setup Guide](/docs/user-guides/klipper-plugin-setup-manual-link) to link your printer using a 6-digit code.**
124124
:::
125125

126126
<div style={{display: "flex", justifyContent: "center"}}><img src="/img/user-guides/setupguide/auto-link-klipper-mobile.gif" /></div>

‎website/sidebars.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ module.exports = {
105105
type: 'category',
106106
label: 'Obico for Klipper',
107107
link: {type: 'doc', id: 'user-guides/moonraker-obico/overview'},
108-
items: ['user-guides/moonraker-obico/config', 'user-guides/webcam-streaming-resolution-framerate-klipper', 'user-guides/moonraker-obico/logging-file', 'user-guides/moonraker-obico/update-manager', 'user-guides/moonraker-obico/uninstall'],
108+
items: ['user-guides/klipper-plugin-setup-manual-link','user-guides/moonraker-obico/config', 'user-guides/webcam-streaming-resolution-framerate-klipper', 'user-guides/moonraker-obico/logging-file', 'user-guides/moonraker-obico/update-manager', 'user-guides/moonraker-obico/uninstall'],
109109
},
110110
'user-guides/contact-us-for-support',
111111
],

0 commit comments

Comments
 (0)