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

Prettified readme.

Browse Source
This commit is contained in:
Bassam Husain
2023-06-18 13:41:21 -04:00
parent 82be01a0e0
commit 514531b3dc
1 changed files with 30 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
README.md
View File

@@ -1,4 +1,4 @@
# 🚨 *One-Stop-Shop* Klipper Configuration # 🚨 _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 printer** running Klipper.
@@ -6,7 +6,7 @@ If you were looking for the OSS Klipper configuration for the **Sovol SV06**, pl
# Highlights # 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! 💥 Voron users can rightly disagree and say that it lacks the quad gantry leveling macros. Please create a pull request if you can help in this regard! - 💥 This Klipper configuration is an _endpoint_, meaning that it contains **everything** that you could possibly need in order to have an excellent Klipper experience! 💥 Voron users can rightly disagree and say that it lacks the quad gantry leveling macros. Please create a pull request if you can help in this regard!
- `NEW` <img src="./images/party_blob.gif" width="20" alt=''/> Filament runout sensor usage implemented. <img src="./images/party_blob.gif" width="20" alt=''/> - `NEW` <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. - 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. - 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.
@@ -27,7 +27,7 @@ I work on this repository all the time and a lot of new features are coming. Wat
## Before You Begin ## Before You Begin
- Know what you're getting into by reading this documentation *fully!* - Know what you're getting into by reading this documentation _fully!_
- 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. - 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.
- It is 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`. - It is 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`.
- It is assumed that you already have a working `printer.cfg` and you already have your printer up and running Klipper. - It is assumed that you already have a working `printer.cfg` and you already have your printer up and running Klipper.
@@ -37,9 +37,10 @@ I work on this repository all the time and a lot of new features are coming. Wat
1. [Download](https://github.com/bassamanator/Sovol-SV06-firmware/archive/refs/heads/any-printer.zip) the `ZIP` file containing the Klipper configuration. 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. 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`. 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 the RPi Zero_, you need to simply paste the following into your _existing_ `moonraker.conf`:
💡 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 the RPi Zero*, you need to simply paste the following into your *existing* `moonraker.conf`:
``` ```
[file_manager] [file_manager]
enable_object_processing: True enable_object_processing: True
@@ -51,9 +52,10 @@ Simply add `[include ./osskc.cfg]` somewhere at the top of your `printer.cfg`.
## Directory Structure ## Directory Structure
This repository contains many files and folders. Some are *necessary* for this Klipper configuration to work, others are not. 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 ✅. - **Necessary** items are marked with a ✅.
- Items that can *optionally* be deleted are marked with a ❌. - Items that can _optionally_ be deleted are marked with a ❌.
``` ```
├── cfgs ✅ ├── cfgs ✅
@@ -95,6 +97,7 @@ Please see [this discussion](https://github.com/bassamanator/Sovol-SV06-firmware
##### When does beeping occur? ##### When does beeping occur?
If you have a beeper pin set in your `printer.cfg`, the printer will beep upon: If you have a beeper pin set in your `printer.cfg`, the printer will beep upon:
- Filament runout. - Filament runout.
- Filament change/`M600`. - Filament change/`M600`.
- Upon `PRINT_END`. - Upon `PRINT_END`.
@@ -102,25 +105,25 @@ If you have a beeper pin set in your `printer.cfg`, the printer will beep upon:
##### How do I disable beeping? ##### 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` | | File | `cfgs/misc-macros.cfg` |
| - | - | | --------------- | -------------------------- |
| Section | `[gcode_macro _globals]` | | Section | `[gcode_macro _globals]` |
| Variable | `variable_beeping_enabled` | | Variable | `variable_beeping_enabled` |
| Disable beeping | `0` | | Disable beeping | `0` |
| Enable beeping | `1` | | Enable beeping | `1` |
##### I have a simple filament sensor connected. How do I enable/disable it? ##### I have a simple filament sensor connected. How do I enable/disable it?
Make the following changes according to your needs. Also, search for the word `NOTE` in this repository to find other places where such a sensor might come into play. Make the following changes according to your needs. Also, search for the word `NOTE` in this repository to find other places where such a sensor might come into play.
| File | `cfgs/misc-macros.cfg` | | File | `cfgs/misc-macros.cfg` |
| - | - | | -------------- | ---------------------------------- |
| Section | `[gcode_macro _globals]` | | Section | `[gcode_macro _globals]` |
| Variable | `variable_filament_sensor_enabled` | | Variable | `variable_filament_sensor_enabled` |
| Disable sensor | `0` | | Disable sensor | `0` |
| Enable sensor | `1` | | Enable sensor | `1` |
##### My filament runout sensor works, but I just started a print without any filament loaded. What gives? ##### My filament runout sensor works, but I just started a print without any filament loaded. What gives?
@@ -135,23 +138,23 @@ A simple runout sensor can only detect a change in state. So, if you start a pri
##### What happens when I pause a print? ##### 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? ##### 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. _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? ##### How do I resume a print after a colour change or filament runout?
*Do no disable the stepper motors during this process!* _Do no disable the stepper motors during this process!_
The printhead is now parked front center waiting for you to insert filament. You will: The printhead is now parked front center waiting for you to insert filament. You will:
1. Heat up the hotend to the desired temperature. 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. 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). - 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*. - 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. 3. Hit resume in your Klipper dashboard.
## Useful Resources ## Useful Resources