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 skr-mini-e3-v3

Browse Source
This commit is contained in:
bassamanator
2024-01-15 23:51:56 -05:00
parent 1f21a299a5 e416117048
commit 00253641c6
2 changed files with 106 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
README.md
View File

@@ -58,9 +58,9 @@ I am creating these files for my personal use and cannot be held responsible for
## Stay Up-to-Date
${\normalsize{\textcolor{goldenrod}{\texttt{Star ⭐ this project}}}}$
${\normalsize{\textcolor{goldenrod}{\texttt{Star ⭐ this project.}}}}$
Watch for releases and updates. Please see this [discussion](https://github.com/bassamanator/Sovol-SV06-firmware/discussions/37).
Watch for [updates](https://github.com/bassamanator/Sovol-SV06-firmware/discussions/37).
<img src="./images/githubstar.gif" width="500" alt='github star'/>
@@ -76,19 +76,18 @@ In many ways, this entire repository can be considered _my opinion_ on the `3D p
## Before You Begin
- This entire page is a **13 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_ 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.
- This entire page is a **12 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.
- 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).
- 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.
- 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 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.
- It is assumed that there is one instance of Klipper installed. If that is not the case, then the steps in this guide will not work _perfectly_ 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.
@@ -142,10 +141,10 @@ Please note:
### Download OSS Klipper Configuration
You can choose _either_ of the 2 following methods.
#### Method 1: Clone the Repository
💡 Make sure `git` is installed (`sudo apt update && sudo apt install git`).
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`.
@@ -165,6 +164,8 @@ You can choose _either_ of the 2 following methods.
### 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/*`
@@ -176,7 +177,7 @@ You can choose _either_ of the 2 following methods.
2. Adjust the `[mcu]` section in `printer.cfg` accordingly.
```yaml
# 🗒️ This is just an example
# 📝 This is just an example
[mcu]
serial: /dev/serial/by-id/usb-1a86_USB2.0-Serial-if00-port0
restart_method: command
@@ -200,7 +201,7 @@ If the Klipper flash that you did earlier was successful, and you've done everyt
💡 I recommend no filament be loaded for any of these steps.
🗒️ You will be pasting/typing these commands into the `Mainsail`/`Fluidd` console.
📝 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`
@@ -231,7 +232,7 @@ But first, adjust your slicer.
## Adjust Your Slicer
🗒️ If you are using the config bundles found on this repo, you can skip this section.
📝 If you are using the config bundles found on this repo, you can skip this section.
### Start G-Code
@@ -251,7 +252,7 @@ If you would like to print a purge line before your print starts, at the end of
- `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 Start G-Code
# 📝 This is just an example Start G-Code
PRINT_START ...
PURGE_LINE
```
@@ -262,7 +263,7 @@ PURGE_LINE
Please ⭐ star this repository!
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).
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).
[🔼 Back to top](#outline)
@@ -271,24 +272,25 @@ If you found my work useful, buy me a [<img src="./images/logo_white_stroke.png"
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 ❌.
<!-- tree -a -C -I '.git|.directory' -L 1 -F -->
- Items that can _optionally_ be deleted are marked with a 💠.
<!-- tree -a -C -I '.directory' -L 1 -F -->
```sh
├── cfgs/ ✅
├── CODE_OF_CONDUCT.md ❌
├── CONTRIBUTING.md ❌
├── .github/ ❌
├── .gitignore ❌
├── images/ ❌
├── LICENSE ❌
├── misc/ ❌
├── CODE_OF_CONDUCT.md 💠
├── CONTRIBUTING.md 💠
├── .git/ ✅❔
├── .github/ 💠
├── .gitignore ✅❔
├── images/ 💠
├── LICENSE 💠
├── misc/ 💠
├── moonraker.conf ✅
├── osskc.cfg ✅
├── printer.cfg ✅
├── README.md ❌
├── SECURITY.md ❌
└── .vscode/ ❌
├── README.md 💠
├── SECURITY.md 💠
└── .vscode/ 💠
```
[🔼 Back to top](#outline)
@@ -312,8 +314,6 @@ The printer will beep upon:
- Upon `PRINT_END`.
- `MECHANICAL_GANTRY_CALIBRATION`/`G34`.
Adjust behaviour according to your needs.
| File | `cfgs/misc-macros.cfg` |
| -------- | -------------------------- |
| Section | `[gcode_macro _globals]` |
@@ -325,8 +325,6 @@ Adjust behaviour according to your needs.
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]` |
@@ -372,14 +370,12 @@ The printhead is now parked front center waiting for you to insert filament. You
⚠️ 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.
📝 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.
📝 `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]` |

73
misc/how-to-update.md Normal file
View File

@@ -0,0 +1,73 @@
\*\* _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.