Merge branch 'master' into sv06-plus

.vscode/settings.json

@@ -7,6 +7,7 @@
 	"spellright.documentTypes": ["markdown", "plaintext"],
 	"cSpell.words": [
 		"ADXL",
+		"blanchas",
 		"cfgs",
 		"Fluidd",
 		"Fluiddpi",
@@ -29,6 +30,6 @@
 		"Sovol"
 	],
 	"[markdown]": {
-		"editor.formatOnSave": true
+		"editor.formatOnSave": false
 	}
 }

README.md

@@ -13,10 +13,30 @@ I am creating these files for my personal use and cannot be held responsible for
 
 🙏🏻 🙌🏻 Big thanks to [blanchas3d](https://github.com/blanchas3d) in testing out this branch and reporting issues.
 
+## Outline
+
+- [Features](#features)
+- [Stay Up-to-Date](#stay-up-to-date)
+- [Preface](#preface)
+- [Installation Steps](#installation-steps)
+  - [Before You Begin](#before-you-begin)
+  - [Flash Firmware](#flash-firmware)
+  - [Download Klipper Configuration](#download-klipper-configuration)
+- [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)
+- [Directory Structure](#directory-structure)
+- [Support Me](#support-me)
+- [FAQ](#faq)
+- [Useful Resources](#useful-resources)
+- [Sovol Official Links](#sovol-official-links)
+- [Sources](#sources)
+
 # 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` <img src="./images/party_blob.gif" width="20" alt=''/> Filament runout sensor usage implemented. <img src="./images/party_blob.gif" width="20" alt=''/>
+- <img src="./images/party_blob.gif" width="20" alt=''/> Filament runout sensor usage implemented. <img src="./images/party_blob.gif" width="20" alt=''/>
 - 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.
@@ -27,19 +47,19 @@ 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.
 
 <img src="./images/githubstar.gif" width="500" alt='Raspberry Pi'/>
 
-# Preface
+## 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.
 
-# Installation Steps
+## Installation Steps
 
-## Before You Begin
+### Before You Begin
 
 - On the SV06 Plus, your screen will not work if you install Klipper. You can get it working again via the instructions found [here](https://github.com/fryc88/klipper-sv06plus-screen).
 - Read this documentation _fully!_
@@ -54,24 +74,25 @@ Although I've made switching over to Klipper as easy as is possible, it can stil
 - 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.
 
-## Flash Firmware
+### Flash Firmware
 
 💡 _If you have already flashed klipper onto your motherboard in the past, you can skip this step._
 
-💡 For the sake of simplicity, I will refer to the klipper firmware file as `klipper.bin` even though the actual filename is something along the lines of `klipper-v0.11.0-148-g52f4e20c.bin`.
+Please note:
 
-💡 The firmware file is located in the `misc` folder.
+- For the sake of simplicity, I will refer to the klipper 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.
+- Many users have reported having issues flashing Klipper using the Sovol microSD card.
 
-### Prepare the microSD Card for Flashing
+#### 1. Prepare the microSD Card for Flashing with These Parameters
 
-⚠️ Many users have reported having issues flashing Klipper using the Sovol microSD card.
+- Size: `16GB` maximum.
-
-- 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.
 
-### Flashing Procedure
+#### 2. Flashing Procedure
 
 1. Disconnect any USB cables that might be connected to the motherboard.
 2. Copy `klipper.bin` to the microSD card.
@@ -82,19 +103,18 @@ Although I've made switching over to Klipper as easy as is possible, it can stil
 
 You may find this [video](https://youtu.be/p6l253OJa34) useful.
 
-⚠️ **Caveat**: Flashing will only work if current firmware filename is _different from previous flashing procedure_. The `.bin` is also important.
+### Download Klipper Configuration
-
-## Download Klipper Configuration
 
 You can choose _either_ of the 2 following methods.
 
-### Method 1: Clone the Repository
+#### Method 1: Clone the Repository
 
 1. `cd ~/printer_data/config`
-2. Empty entire `~/printer_data/config` folder. Unfortunately, for safety reasons I will not post this command here. However, in linux, you can delete files via `rm filename`.
+2. Empty entire `~/printer_data/config` folder.
-3. `git clone -b sv06-plus --single-branch https://github.com/bassamanator/Sovol-SV06-firmware.git .` 💡 Don't miss the period!
+   - In linux, you can delete files via `rm fileName` and directories via `rmdir directoryName`.
+3. `git clone -b sv06-plus --single-branch https://github.com/bassamanator/Sovol-SV06-firmware.git .` ⚠️ Don't miss the period!
 
-### Method 2: Download the ZIP
+#### Method 2: Download the ZIP
 
 1. [Download](https://github.com/bassamanator/Sovol-SV06-firmware/archive/refs/heads/sv06-plus.zip) the `ZIP` file containing the Klipper configuration.
 2. See `Step 2` in `Method 1`.
@@ -103,7 +123,7 @@ You can choose _either_ of the 2 following methods.
 
 ## Initial Steps
 
-### Step 1
+### Adjust Configuration with MCU Path
 
 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
@@ -119,7 +139,11 @@ You can choose _either_ of the 2 following methods.
    restart_method: command
    ```
 
-### Step 2
+3. Do a `FIRMWARE_RESTART`.
+
+If you've done everything correctly, you should see no errors or warnings in your Mainsail/Fluidd dashboard.
+
+### Configure Your Printer
 
 ❗☠️ **Your finger should be on the power switch for most of these steps** ☠️❗
 
@@ -127,7 +151,7 @@ You can choose _either_ of the 2 following methods.
 
 💡 I recommend no filament be loaded for any of these steps.
 
-💡 Find explanations for gcode commands at [https://marlinfw.org/](https://marlinfw.org/) and [klipper.org](https://www.klipper3d.org/G-Codes.html).
+💡 Find explanations for gcode commands at [https://marlinfw.org/](https://marlinfw.org/) and [https://www.klipper3d.org/](https://www.klipper3d.org/G-Codes.html).
 
 You will be pasting/typing these commands into the Mainsail/Fluidd console.
 
@@ -141,7 +165,7 @@ You will be pasting/typing these commands into the Mainsail/Fluidd console.
    3. `G1 X150 Y150 Z40 F6000`
    4. `PID_CALIBRATE HEATER=heater_bed TARGET=70`
    5. `SAVE_CONFIG` (once completed)
-4. Pid tune the extruder while part cooling fan runs at 25%.
+4. PID tune the extruder while part cooling fan runs at 25%.
    1. `G28`
    2. `G90`
    3. `G1 X150 Y150 Z10 F6000`
@@ -187,40 +211,48 @@ This repository contains many files and folders. Some are _necessary_ for this K
 
 ```
 ├── cfgs ✅
-│   ├── adxl-direct.cfg
+│   ├── adxl-direct.cfg
-│   ├── adxl-rp2040.cfg
+│   ├── adxl-rp2040.cfg
-│   ├── adxl-rpi-pico-2x.cfg
+│   ├── adxl-rpi-pico-2x.cfg
-│   ├── MECHANICAL_GANTRY_CALIBRATION.cfg
+│   ├── MECHANICAL_GANTRY_CALIBRATION.cfg
-│   ├── misc-macros.cfg
+│   ├── misc-macros.cfg
-│   ├── PARKING.cfg
+│   ├── PARKING.cfg
-│   └── TEST_SPEED.cfg
+│   └── TEST_SPEED.cfg
 ├── CODE_OF_CONDUCT.md ❌
 ├── CONTRIBUTING.md ❌
+├── .github ❌
+│   ├── FUNDING.yml
+│   └── ISSUE_TEMPLATE
+│       ├── bug_report.md
+│       └── feature_request.md
+├── .gitignore ❌
 ├── images ❌
-│   ├── cup-border.png
+│   ├── cup-border.png
-│   ├── githubstar.gif
+│   ├── githubstar.gif
-│   ├── heart.gif
+│   ├── heart.gif
-│   ├── logo_white_stroke.png
+│   ├── logo_white_stroke.png
-│   └── party_blob.gif
+│   └── party_blob.gif
 ├── misc ❌
-│   ├── klipper-v0.11.0-148-g52f4e20c.bin
+│   ├── klipper-v0.11.0-148-g52f4e20c.bin
-│   ├── M503-output.yml
+│   ├── M503-output.yml
-│   ├── M503-plus-output.yml
+│   ├── M503-plus-output.yml
-│   ├── SuperSlicer_config_bundle.ini
+│   ├── SuperSlicer_config_bundle.ini
-│   ├── sv06-buildPlate.png
+│   ├── sv06-buildPlate.png
-│   ├── SV06Plus-buildPlate.stl
+│   ├── SV06Plus-buildPlate.stl
-│   ├── SV06-PLUSfirmware-2.23.rar
+│   ├── SV06-PLUSfirmware-2.23.rar
-│   └── SV06-texture.svg
+│   └── SV06-texture.svg
 ├── moonraker.conf ✅
 ├── printer.cfg ✅
-└── README.md ❌
+├── README.md ❌
+└── .vscode ❌
+    └── settings.json
 ```
 
-## <img src="./images/cup-border.png" width="30" alt='Ko-fi'/> Support Me <img src="./images/cup-border.png" width="30" alt='Ko-fi'/>
+## Support Me
 
-Please ⭐star⭐ this repository!
+Please ⭐ star ⭐ this repository!
 
-<img src="./images/heart.gif" width="17" alt=''/> If you found my work useful, please 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, please consider buying me a [<img src="./images/logo_white_stroke.png" height="20" alt='Ko-fi'/>](https://ko-fi.com/bassamanator).
 
 ## FAQ