PublicArchives/Sovol-SV06-firmware
1
0
Fork 0
mirror of https://github.com/bassamanator/Sovol-SV06-firmware.git synced 2025-11-08 13:31:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' into any-printer. Many adjustments to readme.md.

Browse Source
This commit is contained in:
Bassam Husain
2023-11-27 04:10:04 -05:00
parent 501b195290 b2d13a4438
commit 360d861498
6 changed files with 371 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

243
README.md
View File

@@ -1,6 +1,6 @@
# 🚨 _One-Stop-Shop_ Klipper Configuration
This branch contains the OSS Klipper configuration that can be used with **any printer** running Klipper.
This branch contains the OSS Klipper configuration that can be used with **any single-extruder printer** running Klipper. You must, however, have a working `printer.cfg`.
| Printer | Branch |
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
@@ -17,9 +17,12 @@ I am creating these files for my personal use and cannot be held responsible for
- [Stay Up-to-Date](#stay-up-to-date)
- [Preface](#preface)
- [Before You Begin](#before-you-begin)
- [Installation Steps](#installation-steps)
- [Klipper Installation](#klipper-installation)
- [Download OSS Klipper Configuration](#download-oss-klipper-configuration)
- [Setup Instructions](#setup-instructions)
- [Initial Steps](#initial-steps)
1. [Adjust Configuration with MCU Path](#adjust-configuration-with-mcu-path)
2. [Configure Your Printer](#configure-your-printer)
- [Adjust Your Slicer](#adjust-your-slicer)
- [Support Me](#support-me)
- [Directory Structure](#directory-structure)
@@ -43,33 +46,48 @@ I am creating these files for my personal use and cannot be held responsible for
- 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](https://github.com/bassamanator/Sovol-SV06-firmware/tree/master#how-do-i-enable-kamp-klipper-adaptive-meshing--purging).
- Klipper Adaptive Meshing & Purging (KAMP) integrated. Read about it [here](#how-do-i-enable-kamp-klipper-adaptive-meshing--purging).
[🔼 Back to top](#outline)
## Stay Up-to-Date
⭐ ${\normalsize{\textcolor{goldenrod}{\texttt{Star this project}}}}$
${\normalsize{\textcolor{goldenrod}{\texttt{Star ⭐ this project}}}}$
Watch for releases and updates.
Watch for releases and updates. Please see this [discussion](https://github.com/bassamanator/Sovol-SV06-firmware/discussions/37).
<img src="./images/githubstar.gif" width="500" alt='github star'/>
[🔼 Back to top](#outline)
## Preface
Although I've made switching over to Klipper as easy as is possible, it can still be a challenge for some, especially considering that most of you have likely never used GNU+Linux. Save yourself the frustration, and _fully read all the documentation on this page_. Also note that Klipper is not a _must_, and is not for everyone. You can stick with Marlin, and have a fine 3D printing experience.
[🔼 Back to top](#outline)
## Before You Begin
- This entire page is a **6 minute read**. Save yourself _hours of troubleshooting_ and read this documentation fully.
- 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 step by step instructions on how to get Klipper going. If you are a beginner, you might find those instructions useful.
- 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`.
- 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 repository. There are roughly half a dozen short points amongst the various files that you should be aware of if you're using this configuration.
- You must have a `bed_mesh` for `PRINT_START` to work correctly. If you do not have probe to create a `bed_mesh`, simply comment out the line `BED_MESH_PROFILE LOAD=default` in the `PRINT_START` macro.
## Installation Steps
[🔼 Back to top](#outline)
## Klipper Installation
### Flash Firmware
You must flash your motherboard according to the manufacturer's instructions.
### Download OSS Klipper Configuration
@@ -77,7 +95,9 @@ Although I've made switching over to Klipper as easy as is possible, it can stil
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`.
💡 **If** you get a warning that you already have a `moonraker.conf` (which you probably do since you're already up and running Klipper), **and** you're not using a low powered device such as a Raspberry Pi Zero, you need to simply paste the following into your **existing** `moonraker.conf`:
See what files are necessary and which ones can be skipped [here](#directory-structure).
💡 **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:
```yaml
[file_manager]
@@ -88,25 +108,104 @@ enable_object_processing: True
Simply add `[include ./osskc.cfg]` somewhere at the top of your `printer.cfg`.
[🔼 Back to top](#outline)
## Initial Steps
### Adjust Configuration with MCU Path
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. **Klipper has successfully been installed on your printer!**
[🔼 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. I recommend leaving a 2mm gap for safety.
1. `G28`
2. `G90`
3. `G1 X{insert_X_position_max_here} F3000`
4. `G1 Y{insert_Y_position_max_here} F3000`
2. _This step is optional_. 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. _This step is optional_. Create a bed mesh.
1. `DO_CREATE_MESH`
2. `SAVE_CONFIG` (once completed)
🏁 If you've made it here, then your printer has been Klipperized, and is ready to print! 🏁
But first, adjust your slicer.
[🔼 Back to top](#outline)
## Adjust Your Slicer
💡 If you are using the config bundles found on this repo, you can skip this step.
You need to adjust the start and end gcode in your slicer. The relevant macros are `PRINT_START` and `PRINT_END`. Find instructions [here](https://ellis3dp.com/Print-Tuning-Guide/articles/passing_slicer_variables.html#slicer-start-g-code).
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 `PURGE_LINE`.
### Line Purge
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).
```yaml
# 🗒️ This is just an example
# 🗒️ This is just an example Start G-Code
PRINT_START ...
PURGE_LINE
```
[🔼 Back to top](#outline)
## Support Me
Please ⭐ star this repository!
If you found my work useful, consider buying me a [<img src="./images/logo_white_stroke.png" height="20" alt='Ko-fi'/>](https://ko-fi.com/bassamanator).
If you found my work useful, buy me a [<img src="./images/logo_white_stroke.png" height="20" alt='Ko-fi'/>](https://ko-fi.com/bassamanator).
[🔼 Back to top](#outline)
## Directory Structure
@@ -125,16 +224,126 @@ This repository contains many files and folders. Some are _necessary_ for this K
├── images/ ❌
├── LICENSE ❌
├── misc/ ❌
├── moonraker.conf ✅
├── moonraker.conf ✅ ❔
├── osskc.cfg ✅
├── README.md ❌
├── SECURITY.md ❌
└── .vscode/ ❌
```
[🔼 Back to top](#outline)
## FAQ
Please find answers to common questions [here](https://github.com/bassamanator/Sovol-SV06-firmware/blob/master/README.md#faq).
### How do I import a configuration bundle into SuperSlicer/PrusaSlicer?
Please see this [discussion](https://github.com/bassamanator/Sovol-SV06-firmware/discussions/13).
### How do I print using SuperSlicer?
Please see this [discussion](https://github.com/bassamanator/Sovol-SV06-firmware/discussions/14).
### When does beeping occur?
The printer will beep upon:
- Filament runout.
- Filament change/`M600`.
- Upon `PRINT_END`.
- `MECHANICAL_GANTRY_CALIBRATION`/`G34`.
Adjust behaviour according to your needs.
| File | `cfgs/misc-macros.cfg` |
| -------- | -------------------------- |
| Section | `[gcode_macro _globals]` |
| Variable | `variable_beeping_enabled` |
| Disable | `0` |
| Enable | `1` (default) |
### I want to use a filament sensor. How do I set it up?
You can find information about the physical setup [here](https://github.com/bassamanator/everything-sovol-sv06#filament-sensor).
Adjust behaviour according to your needs.
| File | `cfgs/misc-macros.cfg` |
| -------- | ---------------------------------- |
| Section | `[gcode_macro _globals]` |
| Variable | `variable_filament_sensor_enabled` |
| Disable | `0` (default) |
| Enable | `1` |
### 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.
### What happens when I put in `M600`/colour change at a certain layer?
1. The printer will beep 3 times (not annoyingly).
2. Printing will stop.
3. The printhead will park itself front center.
4. The hotend will turn off, but the bed will remain hot.
### What happens when I pause a print?
Same behaviour as `M600`/colour change _except_ there won't be any beeping.
### What happens when filament runs out?
_If_ you have a working filament sensor, the same behaviour as `M600`/colour change will occur _except_ the beeps will be fairly annoying.
### How do I resume a print after a colour change or filament runout?
⚠️ Do not disable the stepper motors during this process!
The printhead is now parked front center waiting for you to insert filament. You will:
1. Heat up the hotend to the desired temperature.
- Use your Klipper dashboard.
2. Purge (push) some filament through the nozzle.
- Use your Klipper dashboard, and extrude maybe 50mm (for a colour change you probably want to extrude more).
- 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)?
⚠️ 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.
🗒️ 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.
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`.
Adjust behaviour according to your needs.
| File | `cfgs/misc-macros.cfg` |
| -------- | ------------------------ |
| Section | `[gcode_macro _globals]` |
| Variable | `variable_kamp_enable` |
| Disable | `0` (default) |
| Enable | `1` |
### 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** ☠️.
Find full instructions [here](https://ellis3dp.com/Print-Tuning-Guide/articles/determining_max_speeds_accels.html).
Some tips:
- Before running with `ITERATIONS=40` with an untested speed/accel value, run with `ITERATIONS=1`.
- Pay close attention throughout the run, so that you can click ${\small{\textcolor{red}{\texttt{EMERGENCY STOP}}}}$ at a moment's notice.
- This macro will simply help you determine the maximum speed your printhead and bed can reliably move at, not necessarily print at. The bottleneck for my SV06, for example, is the 15mm/s^2 that the hotend maxes out at (well under 200mm/s actual print speed).
### How do I compile my own firmware?
Please see this [discussion](https://github.com/bassamanator/Sovol-SV06-firmware/discussions/111).
[🔼 Back to top](#outline)
## Useful Resources
@@ -143,12 +352,16 @@ Please find answers to common questions [here](https://github.com/bassamanator/S
- ⭐⭐⭐⭐⭐ [Ellis' Print Tuning Guide](https://ellis3dp.com/Print-Tuning-Guide)
- [Simplify3D Print Quality Troubleshooting Guide](https://www.simplify3d.com/resources/print-quality-troubleshooting/)
[🔼 Back to top](#outline)
## Sovol Official Links
- [SV06 Marlin Source Code](https://github.com/Sovol3d/Sv06-Source-Code)
- [SV06 Models](https://github.com/Sovol3d/SV06-Fully-Open-Source)
- [SV06 Plus Marlin Source Code and Models](https://github.com/Sovol3d/SV06-PLUS)
[🔼 Back to top](#outline)
## Sources
- [https://www.klipper3d.org](https://www.klipper3d.org)
@@ -161,3 +374,5 @@ Please find answers to common questions [here](https://github.com/bassamanator/S
- [PrusaSlicer Print Settings](https://github.com/mjonuschat/PrusaSlicer-Profiles)
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/H2H0HIHTH)
[🔼 Back to top](#outline)