Merge branch 'master' into any-printer

Special considerations.

.github/FUNDING.yml

@@ -1 +0,0 @@
-ko_fi: bassamanator

.gitignore

@@ -1,3 +1,6 @@
 printer-*_*.cfg
 .moonraker.conf.bkp
 .directory
+.venv
+__pycache__
+crowsnest.conf.*

.vscode/settings.json

@@ -1,7 +1,5 @@
 {
 	"editor.tabSize": 4,
-	// "editor.formatOnSave": false,
-	// "editor.defaultFormatter": null,
 	"editor.insertSpaces": true,
 	"editor.detectIndentation": false,
 	"git.mergeEditor": false,
@@ -20,20 +18,25 @@
 		"Klipper",
 		"Klipperized",
 		"lrwxrwxrwx",
+		"microsteps",
 		"moonraker",
 		"normalsize",
 		"octahedroflake",
 		"osskc",
+		"Painis",
 		"PARKBED",
 		"PARKCENTER",
 		"PARKFRONT",
 		"PARKFRONTLOW",
 		"PARKREAR",
 		"pico",
+		"Printables",
 		"Prusa",
 		"runout",
+		"scriptsize",
 		"Sovol",
 		"textcolor",
+		"textit",
 		"texttt"
 	],
 	"[markdown]": {

README.md

@@ -1,15 +1,23 @@
-# 🚨 _One-Stop-Shop_ Klipper Configuration
+<p align="center">
+Please consider
+<a href="https://ko-fi.com/bassamanator" target="_blank">donating</a> to
+support my open source work ❤️
+</p>
 
-This branch contains the Klipper configuration and firmware for the **Sovol SV06** 3D printer.
+# One-Stop-Shop Klipper Configuration
 
-| Printer                                                         | Branch                                                                                    |
-| --------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
-| ${\normalsize{\textcolor{darkturquoise}{\texttt{Sovol SV06}}}}$ | ⚡ ${\small{\textcolor{darkturquoise}{\texttt{YOU ARE HERE}}}}$ ⚡                        |
-| Sovol SV06 Skr-Mini-E3-V3.0                                     | [skr-mini-e3-v3](https://github.com/bassamanator/Sovol-SV06-firmware/tree/skr-mini-e3-v3) |
-| Sovol SV06 Plus                                                 | [sv06-plus](https://github.com/bassamanator/Sovol-SV06-firmware/tree/sv06-plus)           |
-| All other printers                                              | [any-printer](https://github.com/bassamanator/Sovol-SV06-firmware/tree/any-printer)       |
+| Printer                                                       | Branch                                                                                    |
+| ------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
+| ${\normalsize{\textcolor{darkturquoise}{\text{Sovol SV06}}}}$ | [master](https://github.com/bassamanator/Sovol-SV06-firmware/tree/master)                     |
+| Sovol SV06 SKR-Mini-E3-V3.0                                   | [skr-mini-e3-v3](https://github.com/bassamanator/Sovol-SV06-firmware/tree/skr-mini-e3-v3) |
+| Sovol SV06 Fly-E3-Pro-V3                                      | [fly-e3-pro-v3](https://github.com/ElPainis/Fly-E3-Pro-v3) \*\*                           |
+| Sovol SV06 Plus                                               | [sv06-plus](https://github.com/bassamanator/Sovol-SV06-firmware/tree/sv06-plus)           |
+| All other printers                                            | ⚡ ${\scriptsize{\textcolor{darkturquoise}{\text{YOU ARE HERE}}}}$ ⚡       |
 
-I am creating these files for my personal use and cannot be held responsible for what it might do to your printer. Use at your own risk.
+${\small{\textit{** Maintained by ElPainis}}}$
+
+> [!WARNING]
+> I am creating these files for my personal use and cannot be held responsible for what it might do to your printer. Use at your own risk.
 
 ## Outline
 
@@ -20,12 +28,11 @@ I am creating these files for my personal use and cannot be held responsible for
 - [Klipper Installation](#klipper-installation)
   - [Flash Firmware](#flash-firmware)
   - [Download OSS Klipper Configuration](#download-oss-klipper-configuration)
-- [Initial Steps](#initial-steps)
-  1. [Adjust Configuration with MCU Path](#adjust-configuration-with-mcu-path)
-  2. [Configure Your Printer](#configure-your-printer)
+  - [Setup Instructions](#setup-instructions)
 - [Adjust Your Slicer](#adjust-your-slicer)
 - [Support Me](#support-me)
 - [Directory Structure](#directory-structure)
+- [Special Considerations](#special-considerations)
 - [FAQ](#faq)
 - [Useful Resources](#useful-resources)
 - [Sovol Official Links](#sovol-official-links)
@@ -33,22 +40,20 @@ I am creating these files for my personal use and cannot be held responsible for
 
 ## Features
 
-- 💥 This Klipper configuration is an _endpoint_, meaning that it contains **everything** that you could possibly need in order to have an excellent Klipper experience! 💥
+- 💥 This Klipper configuration is an _endpoint_, meaning that it contains **everything** that you could possibly need in order to have an excellent Klipper experience! 💥 CoreXY users can rightly disagree and say that it lacks the quad gantry levelling macros. Please create a pull request if you can help in this regard!
 - Filament runout sensor usage implemented.
 - Minimum configuration settings for `Mainsail` and `Fluidd`.
 - Pre-configured configuration bundles based on the [Ellis SuperSlicer Print Profiles](https://github.com/AndrewEllis93/Ellis-SuperSlicer-Profiles):
   - SuperSlicer
   - PrusaSlicer
-  - Printer profiles: SV06/Plus; SV07/Plus
-- Bed model and texture to use in SuperSlicer/PrusaSlicer.
-- Macros:
+- Macros
   - **Improved** mechanical gantry calibration/`G34` macro that provides the user audio feedback, and time to check the calibration.
   - Misc macros: `PRINT_START`, `CANCEL_PRINT`, `PRINT_END`, `PAUSE`, `RESUME`.
   - Parking macros (parks the printhead at various locations): `PARKFRONT`, `PARKFRONTLOW`, `PARKREAR`, `PARKCENTER`, `PARKBED`.
   - Load/unload filament macros.
   - `PURGE_LINE` macro.
   - `TEST_SPEED` macro. Find instructions [here](#how-do-i-use-the-test_speed-macro).
-- Klipper Adaptive Meshing & Purging (KAMP) integrated. Read about it [here](#how-do-i-enable-kamp-klipper-adaptive-meshing--purging).
+- Klipper Adaptive Meshing & Purging (KAMP) integrated. Read about it [here](#what-do-i-need-to-know-about-kamp).
 
 [🔼 Back to top](#outline)
 
@@ -58,7 +63,7 @@ ${\normalsize{\textcolor{goldenrod}{\texttt{Star ⭐ this project.}}}}$
 
 Watch for [updates](https://github.com/bassamanator/Sovol-SV06-firmware/discussions/37).
 
-<img src="./images/githubstar.gif" width="500" alt='github star'/>
+<img src="./misc/images/githubstar.gif" width="500" alt='github star'/>
 
 [🔼 Back to top](#outline)
 
@@ -72,21 +77,24 @@ In many ways, this entire repository can be considered _my opinion_ on the `3D p
 
 ## Before You Begin
 
-- This entire page is a **9 minute read**. Save yourself _hours of troubleshooting_ and read this documentation fully.
-- ⚠️ Make sure your printer is in good physical condition, because print and travel speeds will be _a lot faster_. Beginners would be wise to run through [these steps](https://github.com/bassamanator/everything-sovol-sv06/blob/main/initialsteps.md).
-- ⚠️ [Disable](https://github.com/bassamanator/everything-sovol-sv06/blob/main/howto.md#disable-usb-cable-5v-pin) the USB cable's 5V pin.
-- Follow the steps in order. If an error was reported at a step, do no proceed to the next step.
-- It is assumed that you are connected to your host Raspberry Pi (or other host device) via SSH, and that your printer motherboard is connected to the host via a data USB cable. 💡 Most of the micro USB cables that you find at home are _unlikely_ to be data cables, and it is not possible to tell just by looking.
-- It is also assumed that the username on the host device is `pi`. If that is not the case, edit `moonraker.conf` and `cfgs/misc-macros.cfg` to change any mentions of `/home/pi` to `/home/yourUserName`.
-- Klipper _must_ be installed on the host beforehand. Easiest is to use [MainsailOS](https://github.com/mainsail-crew/mainsail/releases/latest). [KIAUH](https://github.com/th33xitus/kiauh) is another option.
+- This entire page is a **12 minute read**. Save yourself _hours of troubleshooting_ and read this documentation fully.
+- It is assumed that you already have a working `printer.cfg` and you already have your printer up and running Klipper.
+- The [master](https://github.com/bassamanator/Sovol-SV06-firmware/tree/master) branch of this repo contains baby step by step instructions on how to get Klipper going for a particular bed printer (Sovol SV06). If you are a beginner, you might find those instructions useful.
+- Make sure your printer is in good physical condition, because print and travel speeds will be _a lot faster_ than they were before. Beginner's would be wise to go through the steps mentioned [here](https://github.com/bassamanator/everything-sovol-sv06/blob/main/initialsteps.md). Consider yourself warned.
+- Follow the steps in order.
+- If an error was reported at a step, do no proceed to the next step.
+- It is assumed that you are connected to your host Raspberry Pi (or other host device) via SSH, and that your printer motherboard is connected to the host via a data USB cable. 💡 Most of the micro USB cables that you find at home are _unlikely_ to be data cables, and it's not possible to tell just by looking.
+- [Disable](https://github.com/bassamanator/everything-sovol-sv06/blob/main/howto.md#disable-usb-cable-5v-pin) the USB cable's 5V pin.
+- It is also assumed that the username on the host device is `pi`. If that is not the case, you will have to manually edit `moonraker.conf` and `cfgs/misc-macros.cfg` and change any mentions of `/home/pi` to `/home/yourUserName`.
+- Klipper _must_ be installed on the host Raspberry Pi for everything to work. Easiest is to use a [MainsailOS](https://github.com/mainsail-crew/mainsail/releases/latest) image. Alternatively, you can install `Fluidd` or `Mainsail` via [KIAUH](https://github.com/th33xitus/kiauh).
 - Klipper _must_ be up to date.
   - In `Fluidd`, you can do this from `Settings` > `Software Updates`.
   - In `Mainsail`, you can do this from `Machine` > `Update Manager`.
 - Robert Redford's performance in _Spy Game (2001)_ was superb!
-- It is assumed that there is one instance of Klipper installed. If that is not the case, the steps in this guide will not work _perfectly_ for you.
+- ~~It is assumed that there is one instance of Klipper installed. If you have multiple instances of Klipper installed, via `KIAUH` for example, then this guide is not for you. You can still use all the configs of course, but the steps in this guide will likely not work for you.~~
 - Your question has probably been answered already, but if it hasn't, please post in the [Discussion](https://github.com/bassamanator/Sovol-SV06-firmware/discussions) section.
 - I would recommend searching for the word `NOTE` in this configuration. There are roughly half a dozen short points amongst the various files that you should be aware of.
-<!-- - Link to recommended parts. -->
+- You must have a `bed_mesh` for `PRINT_START` to work correctly. If you do not have a probe to create a `bed_mesh`, simply comment out the line `BED_MESH_PROFILE LOAD=default` in the `PRINT_START` macro.
 
 [🔼 Back to top](#outline)
 
@@ -94,130 +102,35 @@ In many ways, this entire repository can be considered _my opinion_ on the `3D p
 
 ### Flash Firmware
 
-💡 If you flashed Klipper onto your motherboard in the past, you can skip this step.
-
-Please note:
-
-- For the sake of simplicity, I will refer to the firmware file as `klipper.bin` even though the actual filename is something along the lines of `klipper-v0.11.0-148-g52f4e20c.bin`.
-- The firmware file is located in the `misc` folder.
-- Flashing will only work if current firmware filename is _different from previous flashing procedure_. The `.bin` is also important.
-- You may find this [video](https://youtu.be/p6l253OJa34) useful.
-- ⚠️ Many users have reported having issues flashing Klipper using the Sovol microSD card.
-
-#### 1. Prepare the microSD Card for Flashing with These Parameters
-
-- Size: `16GB` maximum.
-- File system: `FAT32`.
-- Allocation unit size: `4096 bytes`.
-- Must not contain any files _except_ the firmware file.
-
-#### 2. Flashing Procedure
-
-1. Disconnect any USB cables that might be connected to the motherboard.
-2. Copy `klipper.bin` to the microSD card.
-3. Make sure the printer is off.
-4. Insert the microSD card into printer.
-5. Turn on the printer and wait a minute (usually takes 10 seconds).
-6. Turn off the printer and remove the microSD.
-
-⏲️ At this point, it's not possible to tell with certainty whether your flash was successful, continue on with the guide.
-
-[🔼 Back to top](#outline)
+You must flash your motherboard according to the manufacturer's instructions.
 
 ### Download OSS Klipper Configuration
 
-#### Method 1: Clone the Repository
+1. [Download](https://github.com/bassamanator/Sovol-SV06-firmware/archive/refs/heads/any-printer.zip) the `ZIP` file containing the Klipper configuration.
+2. The parent folder in the `ZIP` is `Sovol-SV06-firmware-any-printer`. This is relevant in the next step.
+3. Extract **only** the _contents_ of the parent folder into `~/printer_data/config`.
 
-💡 Make sure `git` is installed (`sudo apt update && sudo apt install git`).
+See what files are necessary and which ones can be skipped [here](#directory-structure).
 
-1. `cd ~/printer_data/config`
-2. Empty entire `~/printer_data/config` folder.
-   - In linux, you can delete files via `rm fileName` and directories via `rmdir directoryName`.
-   - In linux, you can list files and folders via `ls -lah`.
-3. `git clone -b master --single-branch https://github.com/bassamanator/Sovol-SV06-firmware.git .` ⚠️ Don't miss the period!
+💡 **If** you get a warning that you already have a `moonraker.conf` **and if** you're _not_ using a low powered device such as a Raspberry Pi Zero, do not overwrite the _existing_ `moonraker.conf` and simply paste the following into it:
 
-#### Method 2: Download the ZIP
+```yaml
+[file_manager]
+enable_object_processing: True
+```
 
-1. [Download](https://github.com/bassamanator/Sovol-SV06-firmware/archive/refs/heads/master.zip) the `ZIP` file containing the Klipper configuration.
-2. See `Step 2` in `Method 1`.
-3. The parent folder in the `ZIP` is `Sovol-SV06-firmware-master`. This is relevant in the next step.
-4. Extract **only** the _contents_ of the parent folder into `~/printer_data/config`.
+### Setup Instructions
 
-[🔼 Back to top](#outline)
+Simply add `[include ./osskc.cfg]` somewhere at the top of your `printer.cfg`.
 
-## Initial Steps
-
-### Adjust Configuration with MCU Path
-
-💡 Make sure the host and printer are connected via USB.
-
-1. Find what port the `mcu` (printer motherboard) is connected to via _one_ of the following commands:
-
-   - `ls /dev/serial/by-id/*`
-   - `ls /dev/serial/by-path/*`
-
-   1. The output will be something along the lines of
-      - `/dev/serial/by-id/usb-1a86_USB2.0-Serial-if00-port0`
-
-2. Adjust the `[mcu]` section in `printer.cfg` accordingly.
-
-   ```yaml
-   # 📝 This is just an example
-   [mcu]
-   serial: /dev/serial/by-id/usb-1a86_USB2.0-Serial-if00-port0
-   restart_method: command
-   ```
-
-3. Do a `FIRMWARE_RESTART`.
-
-If the Klipper flash that you did earlier was successful, and you've done everything else correctly, you should see no errors or warnings in the `Mainsail`/`Fluidd` dashboard. 🎉 **Your printer has been Klipperized!** 🎉
-
-[🔼 Back to top](#outline)
-
-### Configure Your Printer
-
-❗☠️ **Your finger should be on the power switch for most of these steps** ☠️❗
-
-❗☠️ **Power off if there is a collision/problem** ☠️❗
-
-💡 The ${\small{\textcolor{red}{\texttt{EMERGENCY STOP}}}}$ button in your dashboard works faster than hitting the power switch.
-
-💡 Do a practice emergency stop.
-
-💡 I recommend no filament be loaded for any of these steps.
-
-📝 You will be pasting/typing these commands into the `Mainsail`/`Fluidd` console.
-
-1. Check to see if `X` and `Y` max positions can be reached, and adjust `position_max`, if necessary. You might be able to go further, which is great, but I recommend leaving a 2mm gap for safety.
-   1. `G28`
-   2. `G90`
-   3. `G1 X223 F3000`
-   4. `G1 Y223 F3000`
-2. Do a mechanical gantry calibration; `G34`. After the controlled collision against the beam at the top, there will be a 10 second pause for you to verify that both sides of the gantry are pressed up against the `stoppers` at the top. You will hear a succession of beeps.
-   1. Figure out your `Z` `position_max` by baby stepping your way up to the beam, and adjust `position_max`, if necessary.
-3. PID tune the bed. Ideally, all PID tuning should occur at the temperatures that you print most at.
-   1. `PID_TEST_BED TEMP=70`
-   2. `SAVE_CONFIG` (once completed)
-4. PID tune the extruder while part cooling fan runs at 25%.
-   1. `PID_TEST_HOTEND TEMP=245`
-   2. `SAVE_CONFIG` (once completed)
-5. Adjust `z_offset`. Make sure your nozzle if very clean. Do the [Paper test](https://www.klipper3d.org/Bed_Level.html?h=probe_calibrate#the-paper-test).
-   1. `DO_PROBE_CALIBRATE`
-   2. Follow `z_offset` setup in `Mainsail`/`Fluidd`.
-   3. `SAVE_CONFIG` (once completed)
-6. Create a bed mesh.
-   1. `DO_CREATE_MESH`
-   2. `SAVE_CONFIG` (once completed)
-
-🏁 If you've made it here, then your Klipperized printer is ready to print! 🏁
-
-_But first_, adjust your slicer.
+And remember to _adjust your slicer_.
 
 [🔼 Back to top](#outline)
 
 ## Adjust Your Slicer
 
-📝 If you are using the slicer bundles found on this repo, you can skip this section.
+> [!NOTE]
+> If you are using the slicer bundles found on this repo, you can skip this section.
 
 ### Start G-Code
 
@@ -234,7 +147,10 @@ PRINT_END
 If you would like to print a purge line before your print starts, at the end of your start gcode, on a new line, add one of the following:
 
 - `PURGE_LINE`; prints a standard purge line.
-- `LINE_PURGE`; prints KAMP's purge line. ⚠️ Do not attempt to use without reading [this section](#how-do-i-enable-kamp-klipper-adaptive-meshing--purging).
+- `LINE_PURGE`; prints KAMP's purge line.
+
+> [!WARNING]
+> Do not attempt to use `LINE_PURGE` without reading [this section](#what-do-i-need-to-know-about-kamp).
 
 ```yaml
 # 📝 This is just an example Start G-Code
@@ -248,7 +164,7 @@ PURGE_LINE
 
 Please ⭐ star this repository!
 
-Support [open source](https://en.wikipedia.org/wiki/Open_source), and buy me a [<img src="./images/logo_white_stroke.png" height="20" alt='Ko-fi'/>](https://ko-fi.com/bassamanator).
+Support [open source](https://en.wikipedia.org/wiki/Open_source), and buy me a [<img src="./misc/images/logo_white_stroke.png" height="20" alt='Ko-fi'/>](https://ko-fi.com/bassamanator).
 
 [🔼 Back to top](#outline)
 
@@ -265,15 +181,13 @@ This repository contains many files and folders. Some are _necessary_ for this K
 ├── cfgs/ ✅
 ├── CODE_OF_CONDUCT.md 💠
 ├── CONTRIBUTING.md 💠
-├── .git/ ✅❔
 ├── .github/ 💠
-├── .gitignore ✅❔
+├── .gitignore 💠
 ├── images/ 💠
 ├── LICENSE 💠
 ├── misc/ 💠
-├── moonraker.conf ✅
+├── moonraker.conf ✅ ❔
 ├── osskc.cfg ✅
-├── printer.cfg ✅
 ├── README.md 💠
 ├── SECURITY.md 💠
 └── .vscode/ 💠
@@ -281,6 +195,28 @@ This repository contains many files and folders. Some are _necessary_ for this K
 
 [🔼 Back to top](#outline)
 
+## Special Considerations
+
+### Sequential printing
+
+If enabled, cancelling, or resuming a print from pause, could lead to collisions with previously printed objects. In order to prevent collisions, in your slicer, ensure that objects are printed from the back of the build plate to the front.
+
+In PrusaSlicer, please see Printer Settings > Notes, for extruder clearances.
+
+### Renamed GCODE Commands
+
+#### BED_MESH_CALIBRATE
+
+Renamed to `_BED_MESH_CALIBRATE`.
+
+### Errors
+
+#### MCU 'mcu' shutdown: Timer too close
+
+This error often occurs when the `mcu` is unable to generate the required `microsteps`. Lower power Klipper hosts might be especially susceptible. Reducing `microsteps` to `64`, or even `32` can resolve the issue.
+
+[🔼 Back to top](#outline)
+
 ## FAQ
 
 ### What are some settings that I can change?
@@ -291,11 +227,11 @@ Edit the relevant file according to your needs.
 | ---------------------- | ------------------------ |
 | `cfgs/misc-macros.cfg` | `[gcode_macro _globals]` |
 
-| Variable                           | Disable       | Enable        | Notes                                                               |
-| ---------------------------------- | ------------- | ------------- | ------------------------------------------------------------------- |
-| `variable_beeping_enabled`         | `0`           | `1` (default) |
+| Variable                           | Disable       | Enable        | Notes                                          |
+| ---------------------------------- | ------------- | ------------- | ---------------------------------------------- |
+| `variable_beeping_enabled`         | `0` (default) | `1`           |
 | `variable_filament_sensor_enabled` | `0` (default) | `1`           |
-| `variable_kamp_enable`             | `0` (default) | `1`           | See [here](#how-do-i-enable-kamp-klipper-adaptive-meshing--purging) |
+| `variable_kamp_enable`             | `0` (default) | `1`           | See [here](#what-do-i-need-to-know-about-kamp) |
 
 ### How do I import a configuration bundle into SuperSlicer/PrusaSlicer?
 
@@ -318,6 +254,8 @@ The printer will beep upon:
 
 You can find information about the physical setup [here](https://github.com/bassamanator/everything-sovol-sv06#filament-sensor).
 
+You can test the sensor via `QUERY_FILAMENT_SENSOR SENSOR=filament_sensor`.
+
 ### My filament runout sensor works, but I just started a print without any filament loaded. What gives?
 
 A simple runout sensor can only detect a change in state. So, if you start a print without filament loaded, the printer will not know that there is no filament loaded. You should test your sensor by having filament loaded, starting a print, then cutting the filament. The expected behaviour is that the print will pause, and as long as you have beeping enabled, you will hear 3 annoying beeps.
@@ -339,7 +277,8 @@ _If_ you have a working filament sensor, the same behaviour as `M600`/colour cha
 
 ### How do I resume a print after a colour change or filament runout?
 
-⚠️ Do not disable the stepper motors during this process!
+> [!WARNING]
+> Do not disable the stepper motors during this process!
 
 The printhead is now parked front center waiting for you to insert filament. You will:
 
@@ -350,21 +289,28 @@ The printhead is now parked front center waiting for you to insert filament. You
    - OR, you can push some filament by hand _making sure to first disengage the extruder's spring loaded arm_.
 3. Hit resume in your Klipper dashboard.
 
-### How do I enable KAMP (Klipper Adaptive Meshing & Purging)?
+### What do I need to know about KAMP?
 
-⚠️ No KAMP functionality can be used on low-powered devices such as the Raspberry Pi Zero.
+> [!WARNING]
+> No KAMP functionality can be used on low-powered devices such as the Raspberry Pi Zero.
 
-⚠️ If KAMP is disabled, and there is no `default` mesh, `PRINT_START` will crash.
+> [!WARNING]
+> If KAMP is disabled, and there is no `default` mesh, `PRINT_START` will crash.
 
-📝 The [Label objects setting](https://docs.mainsail.xyz/overview/features/exclude-objects#enable-the-label-objects-setting-in-your-slicer) in your slicer must be enabled for KAMP to work.
+> [!IMPORTANT]
+> The [Label objects setting](https://docs.mainsail.xyz/overview/features/exclude-objects#enable-the-label-objects-setting-in-your-slicer) in your slicer must be enabled for KAMP to work.
 
-📝 `LINE_PURGE` is useable (on appropriate devices) even if KAMP is disabled.
+> [!NOTE]
+> `LINE_PURGE` is useable _on appropriate devices_ even if KAMP is disabled.
 
 This repo contains all the code from the KAMP repository, however, only the `adaptive meshing` and `LINE_PURGE` functionality of KAMP has been configured and tested for use. To enable other functionality, adjust `/cfgs/kamp/KAMP_Settings.cfg`.
 
+Read [KAMP official docs](https://github.com/kyleisah/Klipper-Adaptive-Meshing-Purging) to learn more.
+
 ### How do I use the `TEST_SPEED` macro?
 
-⚠️ This is for advanced users only, with well oiled machines. You can cause serious damage to your printer if you're not careful. ☠️ **You have been warned** ☠️.
+> [!WARNING]
+> This is for advanced users only, with well oiled machines. You can cause serious damage to your printer if you're not careful.
 
 Find full instructions [here](https://ellis3dp.com/Print-Tuning-Guide/articles/determining_max_speeds_accels.html).
 

cfgs/TEST_SPEED.cfg

@@ -1,10 +1,12 @@
 # NOTE Find how to use instructions here: https://ellis3dp.com/Print-Tuning-Guide/articles/determining_max_speeds_accels.html
+[gcode_macro TEST_SPEED]
 # Home, get position, throw around toolhead, home again.
 # If MCU stepper positions (first line in GET_POSITION) are greater than a full step different (your number of microsteps), then skipping occured.
 # We only measure to a full step to accomodate for endstop variance.
 # Example: TEST_SPEED SPEED=300 ACCEL=5000 ITERATIONS=10
 
-[gcode_macro TEST_SPEED]
+description: Test for max speed and acceleration parameters for the printer. Procedure: Home -> ReadPositionFromMCU -> MovesToolhead@Vel&Accel -> Home -> ReadPositionfromMCU
+
 gcode:
     # Speed
     {% set speed  = params.SPEED|default(printer.configfile.settings.printer.max_velocity)|int %}
@@ -12,6 +14,8 @@ gcode:
     {% set iterations = params.ITERATIONS|default(5)|int %}
     # Acceleration
     {% set accel  = params.ACCEL|default(printer.configfile.settings.printer.max_accel)|int %}
+    # Minimum Cruise Ratio
+    {% set min_cruise_ratio = params.MIN_CRUISE_RATIO|default(0.5)|float %}
     # Bounding inset for large pattern (helps prevent slamming the toolhead into the sides after small skips, and helps to account for machines with imperfectly set dimensions)
     {% set bound = params.BOUND|default(20)|int %}
     # Size for small pattern box
@@ -64,7 +68,11 @@ gcode:
     G0 X{x_min} Y{y_min} Z{bound + 10} F{speed*60}
 
     # Set new limits
-    SET_VELOCITY_LIMIT VELOCITY={speed} ACCEL={accel} ACCEL_TO_DECEL={accel / 2}
+    {% if printer.configfile.settings.printer.minimum_cruise_ratio is defined %}
+        SET_VELOCITY_LIMIT VELOCITY={speed} ACCEL={accel} MINIMUM_CRUISE_RATIO={min_cruise_ratio}
+    {% else %}
+        SET_VELOCITY_LIMIT VELOCITY={speed} ACCEL={accel} ACCEL_TO_DECEL={accel / 2}
+    {% endif %}
 
     {% for i in range(iterations) %}
         # Large pattern diagonals
@@ -80,7 +88,7 @@ gcode:
         G0 X{x_min} Y{y_max} F{speed*60}
         G0 X{x_max} Y{y_max} F{speed*60}
         G0 X{x_max} Y{y_min} F{speed*60}
-        
+    
         # Small pattern diagonals
         G0 X{x_center_min} Y{y_center_min} F{speed*60}
         G0 X{x_center_max} Y{y_center_max} F{speed*60}
@@ -89,7 +97,7 @@ gcode:
         G0 X{x_center_min} Y{y_center_max} F{speed*60}
         G0 X{x_center_max} Y{y_center_min} F{speed*60}
         
-        # Small patternbox
+        # Small pattern box
         G0 X{x_center_min} Y{y_center_min} F{speed*60}
         G0 X{x_center_min} Y{y_center_max} F{speed*60}
         G0 X{x_center_max} Y{y_center_max} F{speed*60}
@@ -97,7 +105,11 @@ gcode:
     {% endfor %}
 
     # Restore max speed/accel/accel_to_decel to their configured values
-    SET_VELOCITY_LIMIT VELOCITY={printer.configfile.settings.printer.max_velocity} ACCEL={printer.configfile.settings.printer.max_accel} ACCEL_TO_DECEL={printer.configfile.settings.printer.max_accel_to_decel} 
+    {% if printer.configfile.settings.printer.minimum_cruise_ratio is defined %}
+        SET_VELOCITY_LIMIT VELOCITY={printer.configfile.settings.printer.max_velocity} ACCEL={printer.configfile.settings.printer.max_accel} MINIMUM_CRUISE_RATIO={printer.configfile.settings.printer.minimum_cruise_ratio} 
+    {% else %}
+        SET_VELOCITY_LIMIT VELOCITY={printer.configfile.settings.printer.max_velocity} ACCEL={printer.configfile.settings.printer.max_accel} ACCEL_TO_DECEL={printer.configfile.settings.printer.max_accel_to_decel}
+    {% endif %}
 
     # Re-home and get position again for comparison:
         M400 # Finish moves - https://github.com/AndrewEllis93/Print-Tuning-Guide/issues/66
@@ -109,4 +121,5 @@ gcode:
         GET_POSITION
 
     # Restore previous gcode state (absolute/relative, etc)
-    RESTORE_GCODE_STATE NAME=TEST_SPEED
+    RESTORE_GCODE_STATE NAME=TEST_SPEED
+    

cfgs/misc-macros.cfg

@@ -23,14 +23,15 @@ path: /home/pi/printer_data/gcodes
 [pause_resume]
 [display_status]
 
-[delayed_gcode DISABLEFILAMENTSENSOR]
-initial_duration: 1
-gcode:
-    SET_FILAMENT_SENSOR SENSOR=filament_sensor ENABLE=0
+# NOTE If you have a filament sensor, uncomment the following 4 lines
+# [delayed_gcode DISABLEFILAMENTSENSOR]
+# initial_duration: 1
+# gcode:
+#     SET_FILAMENT_SENSOR SENSOR=filament_sensor ENABLE=0
 
 [gcode_macro _globals]
 variable_filament_sensor_enabled: 0 # NOTE Enable(1) or disable(0) the filament sensor, if one is connected
-variable_beeping_enabled: 1 # NOTE Enable(1) or disable(0) beeping everywhere except during gantry calibration
+variable_beeping_enabled: 0 # NOTE Enable(1) or disable(0) beeping everywhere except during gantry calibration
 variable_bed_temp_over: 10 # NOTE Start print if bed temperature is over by this amount, otherwise wait for temperature drop
 variable_kamp_enable: 0 # NOTE Enable(1) or disable(0) KAMP (adaptive mesh)
 variable_pre_purge_prime_length: 1.40

misc/M503-output.yml

@@ -1,48 +0,0 @@
-echo:; Linear Units:
-echo:  G21 ; (mm)
-echo:; Temperature Units:
-echo:  M149 C ; Units in Celsius
-echo:; Filament settings (Disabled):
-echo:  M200 S0 D1.75
-echo:; Steps per unit:
-echo:  M92 X80.00 Y80.00 Z800.00 E691.50
-echo:; Max feedrates (units/s):
-echo:  M203 X500.00 Y500.00 Z10.00 E30.00
-echo:; Max Acceleration (units/s2):
-echo:  M201 X500.00 Y500.00 Z100.00 E5000.00
-echo:; Acceleration (units/s2) (P<print-accel> R<retract-accel> T<travel-accel>):
-echo:  M204 P500.00 R500.00 T1000.00
-echo:; Advanced (B<min_segment_time_us> S<min_feedrate> T<min_travel_feedrate> X<max_x_jerk> Y<max_y_jerk> Z<max_z_jerk> E<max_e_jerk>):
-echo:  M205 B20000.00 S0.00 T0.00 X8.00 Y8.00 Z0.40 E5.00
-echo:; Home offset:
-echo:  M206 X0.00 Y0.00 Z0.00
-echo:; Auto Bed Leveling:
-echo:  M420 S0 Z10.00 ; Leveling OFF
-echo:; Material heatup parameters:
-echo:  M145 S0 H185.00 B60.00 F255
-echo:  M145 S1 H240.00 B80.00 F255
-echo:; Hotend PID:
-echo:  M301 P15.95 I1.30 D48.96
-echo:; Bed PID:
-echo:echo:  M304 P110.38 I6.12 D497.30
-echo:; User thermistors:
-echo:  M305 P0 R4700.0 T94162.0 B4160.0 C0.000000000 ; HOTEND 0
-echo:; Power-loss recovery:
-echo:  M413 S1 ; ON
-echo:; Z-Probe Offset:
-echo:  M851 X25.00 Y-25.00 Z0.00 ; (mm)
-echo:; Stepper driver current:
-echo:  M906 X860 Y900 Z800
-echo:  M906 T0 E550
-echo:; Hybrid Threshold:
-echo:  M913 X183 Y183 Z41
-echo:  M913 T0 E60
-echo:; StallGuard threshold:
-echo:  M914 X68 Y70
-echo:; Driver stepping mode:
-echo:  M569 S1 X Y Z
-echo:  M569 S1 T0 E
-echo:; Linear Advance:
-echo:  M900 K0.04
-echo:; Filament load/unload:
-echo:  M603 L0.00 U50.00 ; (mm)

misc/how-to-update.md

@@ -1,73 +0,0 @@
-\*\* _Flashing the firmware is not required for any method_
-
-## Should You Update?
-
-I treat this config like software, and like any piece of modern software, it will require periodic updates to fix issues, add features, improve functionality, etc. So, if you want to have the latest and greatest, I recommend you periodically pull the changes from this repo.
-
-### What Changes Should You Be Concerned With
-
-The only changes you need to be concerned with relate to the `.cfg` and `.conf` files; all changes to `.md` files (these are markdown files, the text that you see when you visit this repo) can be ignored.
-
-### Git Users
-
-If you do a `git diff origin/master --name-only` and it shows you that a `.cfg` file has changed, you might want to pull in those changes (but you don't have to).
-
-### Non-Git Users
-
-Unfortunately, there's no simple way for you to ascertain whether there have been changes. I simply recommend that you update your config via the instructions below from time to time.
-
-## How to Update
-
-There are three methods to accomplish this:
-
-1. The correct method, using `git`.
-2. The mostly acceptable method, without using `git`.
-3. The start-from-scratch method. _Recommended for non-git users and those who haven't made many changes to their configuration._
-
-### The `git` method.
-
-⚠️ This method is only intended for those who already know how to use `git`.
-
-📝 In this example, I'm using the `master` branch which applies to SV06 users only. Be sure to use the appropriate branch for your printer.
-
-📝 The assumption is that you didn't change branches after the initial setup, so you are in `master`, and there are many untracked changes.
-
-1. `ssh` into your Klipper host.
-2. `cd ~/printer_data/config`
-3. `git checkout -b my-settings`
-4. `git add .`
-5. `git commit -m "Saving my settings."`
-6. `git checkout master`
-7. `git pull`
-8. `git checkout my-settings`
-9. `git merge master --no-ff --no-commit`
-10. Deal with comparing and pulling in incoming changes from `master` using your favourite code editor. You can also do this from the command line via `git commit --interactive`, however, only advanced `git` users should attempt this, though it is easy enough.
-11. Add all welcomed changes to the staging area, and discard all other changes.
-12. `git commit -m "Update with upstream."`
-
-You should push your branch to your own fork of this repo.
-
-For any future updates, you can run through the same process again, however, you cannot re-create the `my-settings` branch as you did in `step 3`, because it already exists. Simply omit the `-b` flag in `step 3` next time you update.
-
-### The mostly acceptable method.
-
-This method has shortcomings, because it relies on the user's memory, and requires more manual edits. Perfectly functional method, however.
-
-1. Read all the documentation.
-2. Backup your current configuration, essentially everything inside `~/printer_data/config`.
-3. Repeat steps in [Download OSS Klipper Configuration](https://github.com/bassamanator/Sovol-SV06-firmware#download-oss-klipper-configuration), and [Adjust Configuration with MCU Path](https://github.com/bassamanator/Sovol-SV06-firmware#adjust-configuration-with-mcu-path).
-4. Copy everything from `#*# <---------------------- SAVE_CONFIG ---------------------->` onward and paste into new `printer.cfg`, inclusive.
-5. Copy any other changes you might have made into the new configuration. Maybe you had adjusted the size of your printer (`position_max`), or other such changes.
-
-### The start-from-scratch method.
-
-1. Delete the folder `~/printer_data/config`.
-2. Recreate the folder `~/printer_data/config` via `mkdir ~/printer_data/config`.
-3. Start the Klipper installation process starting from `Download OSS Klipper Configuration` in the appropriate branch.
-
-## Linux Tips
-
-- In linux, you can delete files via `rm fileName` and directories via `rmdir directoryName`.
-- In linux, you can list files and folders via `ls -lah`.
-
-You are now up-to-date with this repo, and have added your personal settings on top.

printer.cfg

@@ -1,231 +0,0 @@
-# This file contains pin mappings for the stock Sovol SV06.
-# 
-# Find installation instructions at https://github.com/bassamanator/Sovol-SV06-firmware
-# 
-# See https://www.klipper3d.org/Config_Reference.html for configuration reference.
-
-[include ./osskc.cfg]
-
-[mcu]
-# NOTE Obtain definition by "ls -l /dev/serial/by-path/" or "ls -l /dev/serial/by-id/"
-serial: /dev/serial/by-path/platform-fd500000.pcie-pci-0000:01:00.0-usb-0:1.2:1.0-port0
-restart_method: command
-
-[printer]
-kinematics: cartesian
-max_velocity: 200
-max_accel: 3000
-max_z_velocity: 15
-max_z_accel: 45
-square_corner_velocity: 8.0
-
-#####################################################################
-#      X/Y/Z Stepper Settings
-#####################################################################
-
-[stepper_x]
-step_pin: PC2
-dir_pin: !PB9
-enable_pin: !PC3
-microsteps: 128
-rotation_distance: 40
-endstop_pin: tmc2209_stepper_x:virtual_endstop
-position_endstop: 0
-position_max: 223 # NOTE You can adjust this if you have more room
-homing_speed: 40
-homing_retract_dist: 0
-
-[tmc2209 stepper_x]
-uart_pin: PC1
-run_current: 0.860
-stealthchop_threshold: 0
-interpolate: False
-sense_resistor: 0.150
-uart_address: 3
-driver_SGTHRS: 81
-diag_pin: PA5
-
-[stepper_y]
-step_pin: PB8
-dir_pin: PB7
-enable_pin: !PC3
-microsteps: 128
-rotation_distance: 40
-endstop_pin: tmc2209_stepper_y:virtual_endstop
-position_endstop: 0
-position_max: 223 # NOTE You can adjust this if you have more room
-homing_speed: 40
-homing_retract_dist: 0
-
-[tmc2209 stepper_y]
-uart_pin: PC0
-run_current: 0.900
-stealthchop_threshold: 0
-interpolate: False
-sense_resistor: 0.150
-uart_address: 3
-driver_SGTHRS: 81
-diag_pin: PA6
-
-[stepper_z]
-step_pin: PB6
-dir_pin: !PB5
-enable_pin: !PC3
-microsteps: 128
-rotation_distance: 4
-endstop_pin: probe:z_virtual_endstop
-position_min: -4
-position_max: 258 # NOTE You can adjust this if you have more room
-homing_speed: 5
-
-[tmc2209 stepper_z]
-uart_pin: PA15
-run_current: 1.000
-stealthchop_threshold: 0
-interpolate: False
-sense_resistor: 0.150
-uart_address: 3
-diag_pin: PA7
-
-#####################################################################
-#   Extruder
-#####################################################################
-
-[extruder]
-step_pin: PB4
-dir_pin: !PB3
-enable_pin: !PC3
-microsteps: 128
-rotation_distance: 4.65 # NOTE Calibrate e-steps https://www.klipper3d.org/Rotation_Distance.html#calibrating-rotation_distance-on-extruders, https://github.com/bassamanator/everything-sovol-sv06/blob/main/howto.md#calibrate-esteps
-nozzle_diameter: 0.400
-filament_diameter: 1.750
-heater_pin: PA1
-sensor_type: EPCOS 100K B57560G104F
-sensor_pin: PC5
-control: pid
-pid_kd: 86.991
-pid_kp: 21.479
-pid_ki: 1.326
-min_temp: 0
-max_temp: 300
-max_extrude_only_distance: 150.0
-max_extrude_cross_section: 5 # NOTE Needed for KAMP purge
-
-[tmc2209 extruder]
-uart_pin: PC14
-run_current: 0.550
-stealthchop_threshold: 0
-interpolate: False
-sense_resistor: 0.150
-uart_address: 3
-
-#####################################################################
-#   Bed Heater
-#####################################################################
-
-[heater_bed]
-heater_pin: PA2
-sensor_type: EPCOS 100K B57560G104F
-sensor_pin: PC4
-control: pid
-pid_kp: 64.440
-pid_ki: 0.773
-pid_kd: 1343.571
-min_temp: 0
-max_temp: 110
-
-#####################################################################
-#   Probe Related
-#####################################################################
-
-[probe]
-pin: PB1
-x_offset: 27
-y_offset: -20
-z_offset: 0
-samples: 3
-samples_result: median
-samples_tolerance: 0.01
-samples_tolerance_retries: 5
-
-[safe_z_home]
-home_xy_position: 84.50, 135 # NOTE The probe is at the center of the bed.
-speed: 100.0
-z_hop: 10
-z_hop_speed: 15
-
-[bed_mesh]
-speed: 175
-mesh_min: 27, 6 # probe as close to origin as possible while remaining fully on the bed
-mesh_max: 222, 203 # (x.position_max - 1), (y.position_max - abs(y_offset)) ; probe as far as possible from the origin while remaining fully on the bed
-probe_count: 5,5
-algorithm: bicubic
-fade_start: 1
-fade_end: 10
-fade_target: 0
-
-[axis_twist_compensation]
-calibrate_start_x: 27 # probe x coor at furthest left ; abs(x_offset)
-calibrate_end_x: 195 # probe x coor at furthest right ; (x.position_max - abs(x_offset) - 1)
-calibrate_y: 115
-
-#####################################################################
-#   Fans
-#####################################################################
-
-[fan]
-pin: PA0
-
-#####################################################################
-#   Misc
-#####################################################################
-
-[display]
-lcd_type: st7920
-cs_pin: PB12
-sclk_pin: PB13
-sid_pin: PB15
-encoder_pins: ^PB14, ^PB10
-click_pin: ^!PB2
-
-[bed_screws]
-screw1_name: front left
-screw1: 26.5, 31
-screw2_name: front right
-screw2: 196.75, 31
-screw3_name: back right
-screw3: 196.75, 201
-screw4_name: back left
-screw4: 26.5, 201
-
-[screws_tilt_adjust]
-screw1_name: center
-screw1: 84.50, 135
-screw2_name: front left
-screw2: 0, 51
-screw3_name: front right
-screw3: 169.75, 51
-screw4_name: back right
-screw4: 169.75, 221
-screw5_name: back left
-screw5: 0, 221
-horizontal_move_z: 10
-screw_thread: CCW-M4
-
-[output_pin beeper]
-pin: PC6
-value: 0
-shutdown_value: 0
-pwm: True
-cycle_time: 0.0005 ; Default beeper tone in kHz. 1 / 0.0005 = 2000Hz (2kHz)
-
-[filament_switch_sensor filament_sensor]
-switch_pin: !PA4 # "Pulled-high"
-pause_on_runout: True
-insert_gcode:
-    M117 Insert Detected
-    { action_respond_info("Insert Detected") }
-runout_gcode:
-    M117 Runout Detected
-    { action_respond_info("Runout Detected") }
-    CONDITIONAL_BEEP i=3 dur=300 freq=400