diff --git a/site/docs/addons/_category_.json b/site/docs/addons/_category_.json index a52fb07..0a4fee9 100644 --- a/site/docs/addons/_category_.json +++ b/site/docs/addons/_category_.json @@ -1,5 +1,5 @@ { - "label": "Addons & Extras", + "label": "Addons", "position": 4, "collapsed": false, "link": { diff --git a/site/docs/addons/img/mainsail/enable-mainsail.png b/site/docs/addons/img/mainsail/enable-mainsail.png new file mode 100644 index 0000000..2ec5a0b Binary files /dev/null and b/site/docs/addons/img/mainsail/enable-mainsail.png differ diff --git a/site/docs/addons/img/mainsail/klipper-settings.png b/site/docs/addons/img/mainsail/klipper-settings.png new file mode 100644 index 0000000..0179ef5 Binary files /dev/null and b/site/docs/addons/img/mainsail/klipper-settings.png differ diff --git a/site/docs/addons/img/mainsail/open-mailsail-button.png b/site/docs/addons/img/mainsail/open-mailsail-button.png new file mode 100644 index 0000000..9ac7d2f Binary files /dev/null and b/site/docs/addons/img/mainsail/open-mailsail-button.png differ diff --git a/site/docs/addons/img/open-printnanny-os-settings.png b/site/docs/addons/img/open-printnanny-os-settings.png new file mode 100644 index 0000000..6144fd0 Binary files /dev/null and b/site/docs/addons/img/open-printnanny-os-settings.png differ diff --git a/site/docs/addons/img/sdwire/SDWire-3D-back-v1.4-r1.jpg b/site/docs/addons/img/sdwire/SDWire-3D-back-v1.4-r1.jpg new file mode 100644 index 0000000..e2dc97d Binary files /dev/null and b/site/docs/addons/img/sdwire/SDWire-3D-back-v1.4-r1.jpg differ diff --git a/site/docs/addons/img/sdwire/SDWire-3D-front-v1.4-r1.jpg b/site/docs/addons/img/sdwire/SDWire-3D-front-v1.4-r1.jpg new file mode 100644 index 0000000..cad1544 Binary files /dev/null and b/site/docs/addons/img/sdwire/SDWire-3D-front-v1.4-r1.jpg differ diff --git a/site/docs/addons/img/sdwire/sdwire-in-testserver-mode.jpg b/site/docs/addons/img/sdwire/sdwire-in-testserver-mode.jpg new file mode 100644 index 0000000..c19b76a Binary files /dev/null and b/site/docs/addons/img/sdwire/sdwire-in-testserver-mode.jpg differ diff --git a/site/docs/addons/mainsail-moonraker-klipper.md b/site/docs/addons/mainsail-moonraker-klipper.md new file mode 100644 index 0000000..33dd1a4 --- /dev/null +++ b/site/docs/addons/mainsail-moonraker-klipper.md @@ -0,0 +1,191 @@ +--- +sidebar_position: 4 +--- + +# Klipper, Mainsail, Moonraker + +This section will show you how to set up Mainsail (Web UI), Moonraker (API), and Klipper (firmware). + +:::info +If your 3D printer ships with Marlin firmware, achieving reliably great results with Klipper will require tinkering/tuning. + +::: + +## Prerequisites + +Make sure you've have the following before proceeding to the next section: + +* [SD card with latest version of PrintNanny OS.](/docs/quick-start/create-printnanny-os-image/) +* [Raspberry Pi connected to PrintNanny Cloud](https://printnanny.ai/docs/quick-start/connect-printnanny-cloud/) + +## Configure Klipper `printer.cfg` + +### 1. [Log into PrintNanny Cloud](https://printnanny.ai/devices/) + +- [ ] Open [https://printnanny.ai/devices/](https://printnanny.ai/devices/) in your browser and log into PrintNanny Cloud. + +### 2. Open Mission Control + +- [ ] Click the **PrintNanny OS** link in the Actions & Quick Links menu. This will open PrintNanny OS's **Mission Control** dashboard. + +![Click the "PrintNanny OS" link in the Actions & Quick Links menu](./img/open-printnanny-os-mission-control.png) + +### 3. Open PrintNanny OS settings. + +- [ ] Click the gear icon ⚙️ to open PrintNanny OS settings. + +![Click the gear icon to open PrintNanny OS settings](./img/open-printnanny-os-settings.png) + +- [ ] Click `Edit Settings Files` in the left-hand menu, and select `klipper/printer.cfg` from the file drop-down. + +![Open printer.cfg using the file drop-down menu](./img/mainsail/klipper-settings.png) + +### 4. Edit Klipper Configuration + +- [ ] Copy/paste the following into the code editor: + +``` +### +# This file contains Klipper configuration. +# See https://www.klipper3d.org/Example_Configs.html for reference. +### + +### +# Mainsail macros - DO NOT DELETE below this line! +### + +[pause_resume] + +[display_status] + +[virtual_sdcard] +path: ~/media/gcode +on_error_gcode: + CANCEL_PRINT + +[gcode_macro CANCEL_PRINT] +description: Cancel the actual running print +rename_existing: CANCEL_PRINT_BASE +variable_park: True +gcode: + ## Move head and retract only if not already in the pause state and park set to true + {% if printer.pause_resume.is_paused|lower == 'false' and park|lower == 'true'%} + _TOOLHEAD_PARK_PAUSE_CANCEL + {% endif %} + TURN_OFF_HEATERS + M106 S0 + CANCEL_PRINT_BASE + +[gcode_macro PAUSE] +description: Pause the actual running print +rename_existing: PAUSE_BASE +gcode: + PAUSE_BASE + _TOOLHEAD_PARK_PAUSE_CANCEL + +[gcode_macro RESUME] +description: Resume the actual running print +rename_existing: RESUME_BASE +gcode: + ##### read extrude from _TOOLHEAD_PARK_PAUSE_CANCEL macro ##### + {% set extrude = printer['gcode_macro _TOOLHEAD_PARK_PAUSE_CANCEL'].extrude %} + #### get VELOCITY parameter if specified #### + {% if 'VELOCITY' in params|upper %} + {% set get_params = ('VELOCITY=' + params.VELOCITY) %} + {%else %} + {% set get_params = "" %} + {% endif %} + ##### end of definitions ##### + {% if printer.extruder.can_extrude|lower == 'true' %} + M83 + G1 E{extrude} F2100 + {% if printer.gcode_move.absolute_extrude |lower == 'true' %} M82 {% endif %} + {% else %} + {action_respond_info("Extruder not hot enough")} + {% endif %} + RESUME_BASE {get_params} + +[gcode_macro _TOOLHEAD_PARK_PAUSE_CANCEL] +description: Helper: park toolhead used in PAUSE and CANCEL_PRINT +variable_extrude: 1.0 +gcode: + ##### set park positon for x and y ##### + # default is your max posion from your printer.cfg + {% set x_park = printer.toolhead.axis_maximum.x|float - 5.0 %} + {% set y_park = printer.toolhead.axis_maximum.y|float - 5.0 %} + {% set z_park_delta = 2.0 %} + ##### calculate save lift position ##### + {% set max_z = printer.toolhead.axis_maximum.z|float %} + {% set act_z = printer.toolhead.position.z|float %} + {% if act_z < (max_z - z_park_delta) %} + {% set z_safe = z_park_delta %} + {% else %} + {% set z_safe = max_z - act_z %} + {% endif %} + ##### end of definitions ##### + {% if printer.extruder.can_extrude|lower == 'true' %} + M83 + G1 E-{extrude} F2100 + {% if printer.gcode_move.absolute_extrude |lower == 'true' %} M82 {% endif %} + {% else %} + {action_respond_info("Extruder not hot enough")} + {% endif %} + {% if "xyz" in printer.toolhead.homed_axes %} + G91 + G1 Z{z_safe} F900 + G90 + G1 X{x_park} Y{y_park} F6000 + {% if printer.gcode_move.absolute_coordinates|lower == 'false' %} G91 {% endif %} + {% else %} + {action_respond_info("Printer not homed")} + {% endif %} +### +# Mainsail macros - DO NOT DELETE above this line! +### + +### +# Paste your printer configuration below this section +### + + +``` + +- [ ] In a new tab, [open Klipper's example configuration files](https://github.com/Klipper3d/klipper/tree/master/config) and **copy/paste** the `.cfg` for your 3D printer. + +:::info + +If you're not sure which Klipper configuration to use, refer to [Klipper's configuration docs](https://www.klipper3d.org/Example_Configs.html) for more information. + +::: + +- [ ] Click the **Save** button to save your changes. + + +## Enable Mainsail + +- [ ] Click `Home` to return to Mission Control +- [ ] Use the toggle-switch to enable the Mainsail add-on. + +:::info + +The first time you enable Mainsail, you'll need to wait a few extra minutes. + +When you see the notification `Mainsail is now available` you can proceed to the next step. + +::: + +![Use the toggle-switch to enable the Mainsail add-on.](./img/mainsail/enable-mainsail.png) + + +- [ ] Click the `Open Mainsail` button to open the Mainsail dashboard in a new tab. + +- [ ] Refer to [Mainsail settings](https://docs.mainsail.xyz/overview/settings) to continue customizing your Mainsail dashboard. + +![Use the toggle-switch to enable the Mainsail add-on.](./img/mainsail/open-mailsail-button.png) + +## Additional Resources + +* [Example Klipper configurations](https://www.klipper3d.org/Example_Configs.html) +* [Welcome to Mainsail](https://docs.mainsail.xyz/) +* [Reddit /r/klippers](https://www.reddit.com/r/klippers/) + \ No newline at end of file diff --git a/site/docs/addons/sdwire.md b/site/docs/addons/sdwire.md index c8b963e..6e9f8c0 100644 --- a/site/docs/addons/sdwire.md +++ b/site/docs/addons/sdwire.md @@ -1,8 +1,8 @@ --- -sidebar_position: 4 +sidebar_position: 1 --- -# PrintNanny SDWire +# File Sync (SDWire) ## What does an SDWire board do? @@ -116,6 +116,7 @@ If you see an error `libusb_open() failed`, re-run the command using `sudo`. When the SDWire is in **Test Server** mode, a solid blue LED labeled `TS` will remain lit. +![When the SDWire is in Test Server mode, a solid blue LED labeled `TS` will remain lit.](./img/sdwire/sdwire-in-testserver-mode.jpg) ### Mode Device-Under-Test