From 817a6771f6ebb3b81d8cd77ef979113c0cec42c2 Mon Sep 17 00:00:00 2001 From: Bassam Husain Date: Sun, 11 Jun 2023 01:15:21 -0400 Subject: [PATCH 1/8] Cleanup with linter. --- README.md | 43 +++++++++++++++++++++++-------------------- 1 file changed, 23 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 4bd03e6..02ad668 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ I am creating these files for my personal use and cannot be held responsible for # Highlights - πŸ’₯ This Klipper configuration is an _endpoint_, meaning that it contains **everything** that you could possibly need in order to have an excellent Klipper experience! πŸ’₯ -- `NEW` Filament runout sensor usage implemented. +- `NEW` Filament runout sensor usage implemented. - Minimum configuration settings for Mainsail/Fluiddpi to work. - SuperSlicer config bundle that contains the printer configuration, as well as what are considered by many to be the best print settings available for any FDM printer ([Ellis' SuperSlicer Profiles](https://github.com/AndrewEllis93/Ellis-SuperSlicer-Profiles)). Find the differences between the different print setting profiles [here](https://github.com/AndrewEllis93/Ellis-SuperSlicer-Profiles/tree/master/SuperSlicer). But basically, the 45 degree profile places the seam at the back. - Bed model and texture to use in SuperSlicer/PrusaSlicer. @@ -30,7 +30,7 @@ I work on this repository all the time and a lot of new features are coming. Wat # 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 documentation found 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. +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 documentation found 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. # Installation Steps @@ -43,7 +43,7 @@ Although I've made switching over to Klipper as easy as is possible, it can stil - 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. Note that 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. - 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 [~~FluiddPI~~](https://docs.fluidd.xyz/installation/fluiddpi#download) (⚠️ `FluiddPI` is not under active maintenance) or [MainsailOS](https://github.com/mainsail-crew/mainsail/releases/latest) image. Alternatively, you can install `Fluidd` or `Mainsail` via [KIAUH](https://github.com/th33xitus/kiauh). -- Robert Redford's performance in *Spy Game (2001)* was superb! +- Robert Redford's performance in _Spy Game (2001)_ was superb! - 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 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. @@ -63,7 +63,7 @@ Although I've made switching over to Klipper as easy as is possible, it can stil - Size: `8GB`. According to Sovol, the largest size that you can use is `16GB`. - File system: `FAT32`. - Allocation unit size: `4096 bytes`. -- Must not contain any files *except* the firmware file. +- Must not contain any files _except_ the firmware file. ### Flashing Procedure @@ -100,18 +100,18 @@ You can choose _either_ of the 2 following methods. ### Step 1 1. Find what port the `mcu` (printer motherboard) is connected to via `ls -l /dev/serial/by-id/` or `ls -l /dev/serial/by-path/`. - 1. The output will be something along the lines of -`lrwxrwxrwx 13 root root 22 Apr 11:10 usb-1a86_USB2.0-Serial-if00-port0 -> ../../ttyUSB0`. - 2. `usb-1a86_USB2.0-Serial-if00-port0` is the relevant part. - 3. Therefore, the full path to your `mcu` is either `/dev/serial/by-id/usb-1a86_USB2.0-Serial-if00-port0` or `/dev/serial/by-path/usb-1a86_USB2.0-Serial-if00-port0`, depending on the command you used to find the `mcu`. + 1. The output will be something along the lines of + `lrwxrwxrwx 13 root root 22 Apr 11:10 usb-1a86_USB2.0-Serial-if00-port0 -> ../../ttyUSB0`. + 2. `usb-1a86_USB2.0-Serial-if00-port0` is the relevant part. + 3. Therefore, the full path to your `mcu` is either `/dev/serial/by-id/usb-1a86_USB2.0-Serial-if00-port0` or `/dev/serial/by-path/usb-1a86_USB2.0-Serial-if00-port0`, depending on the command you used to find the `mcu`. 2. Adjust the `[mcu]` section in `printer.cfg` accordingly. - This is just an *example* `mcu` section: + This is just an _example_ `mcu` section: - ``` - [mcu] - serial: /dev/serial/by-id/usb-1a86_USB2.0-Serial-if00-port0 - restart_method: command - ``` + ``` + [mcu] + serial: /dev/serial/by-id/usb-1a86_USB2.0-Serial-if00-port0 + restart_method: command + ``` ### Step 2 @@ -175,6 +175,7 @@ PURGE_LINE ## Directory Structure This repository contains many files and folders. Some are _necessary_ for this Klipper configuration to work, others are not. + - **Necessary** items are marked with a βœ…. - Items that can _optionally_ be deleted are marked with a ❌. @@ -225,6 +226,7 @@ Please see [this discussion](https://github.com/bassamanator/Sovol-SV06-firmware ##### When does beeping occur? The printer will beep upon: + - Filament runout. - Filament change/`M600`. - Upon `PRINT_END`. @@ -232,7 +234,7 @@ The printer will beep upon: ##### How do I disable beeping? -Make the following changes according to your needs. All beeping will be disabled *except* during gantry calibration. +Make the following changes according to your needs. All beeping will be disabled _except_ during gantry calibration. | File | `cfgs/misc-macros.cfg` | | --------------- | -------------------------- | @@ -243,7 +245,8 @@ Make the following changes according to your needs. All beeping will be disabled ##### 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). +You can find information about the physical setup [here](https://github.com/bassamanator/everything-sovol-sv06#filament-sensor). + ##### I have a simple filament sensor connected. How do I enable/disable it? Make the following changes according to your needs. @@ -268,7 +271,7 @@ A simple runout sensor can only detect a change in state. So, if you start a pri ##### What happens when I pause a print? -Same behaviour as `M600`/colour change *except* there won't be any beeping. +Same behaviour as `M600`/colour change _except_ there won't be any beeping. ##### What happens when filament runs out? @@ -281,10 +284,10 @@ _If_ you have a working filament sensor, the same behaviour as `M600`/colour cha 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. + - 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_. + - 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. ## Useful Resources From f921823acf8cd9a49c17a59402d071aa0581c7b5 Mon Sep 17 00:00:00 2001 From: Bassam Husain Date: Sun, 11 Jun 2023 01:21:53 -0400 Subject: [PATCH 2/8] Adjusted settings.json. --- .vscode/settings.json | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 3e14150..1a48344 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -27,5 +27,8 @@ "Prusa", "runout", "Sovol" - ] + ], + "[markdown]": { + "editor.formatOnSave": true + } } From baf505113dff9a4eb27d9e6336dc880fe6f23a79 Mon Sep 17 00:00:00 2001 From: Bassam Husain Date: Sun, 18 Jun 2023 13:45:14 -0400 Subject: [PATCH 3/8] Update readme minor. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 02ad668..de64954 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This repository contains the Klipper configuration and firmware for the **Sovol For the **Sovol SV06 Plus**, please refer to the [sv06-plus](https://github.com/bassamanator/Sovol-SV06-firmware/tree/sv06-plus) branch. -If you wanted to use the One-Stop-Shop Klipper Configuration for a _different printer_, please switch to the [any-printer](https://github.com/bassamanator/Sovol-SV06-firmware/tree/any-printer) branch. +To use the One-Stop-Shop Klipper Configuration with a _different printer_, please switch to the [any-printer](https://github.com/bassamanator/Sovol-SV06-firmware/tree/any-printer) branch. 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. From cd59efe4c142e2d12f72cfc091799411b3fa80ee Mon Sep 17 00:00:00 2001 From: Bassam Husain Date: Sun, 18 Jun 2023 13:50:37 -0400 Subject: [PATCH 4/8] Update readme minor. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index de64954..b236660 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # 🚨 _One-Stop-Shop_ Sovol SV06 Klipper Configuration -This repository contains the Klipper configuration and firmware for the **Sovol SV06** 3D printer with completely _stock hardware_. +This branch contains the Klipper configuration and firmware for the **Sovol SV06** 3D printer. For the **Sovol SV06 Plus**, please refer to the [sv06-plus](https://github.com/bassamanator/Sovol-SV06-firmware/tree/sv06-plus) branch. -To use the One-Stop-Shop Klipper Configuration with a _different printer_, please switch to the [any-printer](https://github.com/bassamanator/Sovol-SV06-firmware/tree/any-printer) branch. +To use the One-Stop-Shop Klipper Configuration with a _different printer_, please refer to the [any-printer](https://github.com/bassamanator/Sovol-SV06-firmware/tree/any-printer) branch. 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. From 61eaab3221117f00302c747b449ef9b84827a2d8 Mon Sep 17 00:00:00 2001 From: Bassam Husain Date: Sun, 18 Jun 2023 14:38:18 -0400 Subject: [PATCH 5/8] Updated readme minor. --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b236660..72f722c 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,11 @@ This branch contains the Klipper configuration and firmware for the **Sovol SV06** 3D printer. +For the **Sovol SV06 SKR-Mini-E3-V3**, please refer to the [skr-mini-e3-v3](https://github.com/bassamanator/Sovol-SV06-firmware/tree/skr-mini-e3-v3) branch. + For the **Sovol SV06 Plus**, please refer to the [sv06-plus](https://github.com/bassamanator/Sovol-SV06-firmware/tree/sv06-plus) branch. -To use the One-Stop-Shop Klipper Configuration with a _different printer_, please refer to the [any-printer](https://github.com/bassamanator/Sovol-SV06-firmware/tree/any-printer) branch. +For all **other printers**, please refer to the [any-printer](https://github.com/bassamanator/Sovol-SV06-firmware/tree/any-printer) branch. 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. From ccdde22c5776b588102051b66845d7de389a6275 Mon Sep 17 00:00:00 2001 From: Bassam Husain Date: Sun, 18 Jun 2023 14:51:18 -0400 Subject: [PATCH 6/8] Added table for branches instead of text. --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 72f722c..7713dae 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,12 @@ This branch contains the Klipper configuration and firmware for the **Sovol SV06** 3D printer. -For the **Sovol SV06 SKR-Mini-E3-V3**, please refer to the [skr-mini-e3-v3](https://github.com/bassamanator/Sovol-SV06-firmware/tree/skr-mini-e3-v3) branch. - -For the **Sovol SV06 Plus**, please refer to the [sv06-plus](https://github.com/bassamanator/Sovol-SV06-firmware/tree/sv06-plus) branch. - -For all **other printers**, please refer to the [any-printer](https://github.com/bassamanator/Sovol-SV06-firmware/tree/any-printer) branch. +| Printer | Branch | +| --------------------------- | ----------------------------------------------------------------------------------------- | +| Sovol SV06 | **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) | 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. From 9c79ca81bb3cced3a941ae51f770690615f0f07e Mon Sep 17 00:00:00 2001 From: Bassam Husain Date: Sun, 18 Jun 2023 15:31:57 -0400 Subject: [PATCH 7/8] Adjusted links. --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7713dae..18c8e9c 100644 --- a/README.md +++ b/README.md @@ -300,11 +300,11 @@ The printhead is now parked front center waiting for you to insert filament. You - ⭐⭐⭐⭐⭐ [Ellis' Print Tuning Guide](https://ellis3dp.com/Print-Tuning-Guide) - [Simplify3D Print Quality Troubleshooting Guide](https://www.simplify3d.com/resources/print-quality-troubleshooting/) -## Links +## Sovol Official Links -- [SV06 Official Marlin Source Code](https://github.com/Sovol3d/Sv06-Source-Code) -- [SV06 Official Models](https://github.com/Sovol3d/SV06-Fully-Open-Source) -- [SV06 Plus Official Marlin Source Code and Models](https://github.com/Sovol3d/SV06-PLUS) +- [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) ## Sources From 7aecb64bca601e803b938183702ca43eed6a0b3d Mon Sep 17 00:00:00 2001 From: Bassam Husain Date: Sun, 18 Jun 2023 19:43:03 -0400 Subject: [PATCH 8/8] Updated readme minor. --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 18c8e9c..20968a0 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,14 @@ This branch contains the Klipper configuration and firmware for the **Sovol SV06 | Printer | Branch | | --------------------------- | ----------------------------------------------------------------------------------------- | -| Sovol SV06 | **You are here** | +| Sovol SV06 | ✨**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) | 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. -# Highlights +# 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! πŸ’₯ - `NEW` Filament runout sensor usage implemented. @@ -25,9 +25,9 @@ I am creating these files for my personal use and cannot be held responsible for - Load/unload filament macros. - Purge line macro. -## Stay Up-to-Date +# Stay Up-to-Date -I work on this repository all the time and a lot of new features are coming. Watch releases of this repository to be notified for future updates: +Watch for releases and updates: Raspberry Pi @@ -214,6 +214,8 @@ This repository contains many files and folders. Some are _necessary_ for this K ## Ko-fi Support Me Ko-fi +Please ⭐star⭐ this repository! + If you found my work useful, please consider buying me a [Ko-fi](https://ko-fi.com/bassamanator). ## FAQ