diff --git a/README.md b/README.md index 8ab65a3..9d437a6 100644 --- a/README.md +++ b/README.md @@ -20,36 +20,29 @@ I am creating these files for my personal use and cannot be held responsible for - Load/unload filament macros. - Purge line macro. -## To do: - -- [x] Replace M109/M190 with `TEMPERATURE_WAIT`. -- [ ] ~~Get the Ellis `TEST_SPEED` macro working.~~ Does not seem safely doable on this printer. -- [x] Add information about directory structure. -- [x] Create FAQ section. -- [x] Get filament sensor working with hotend PCB. -- [x] Finalize filament sensor config and merge into `master`. -- [ ] Create topic in Discussion section detailing how users should keep this repository in sync with their own Klipper config using `git`. -- [ ] Explain `PAUSE`/`RESUME` extruder behaviour. -- [ ] Integrate KAMP (Klipper Adaptive Meshing and Purging). -- [x] Add `BEEP` when filament needs changing/`M600`. - ## 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: Raspberry Pi +# 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 fustration, 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 ## Before You Begin -- 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 USB. +- Read this documentation *fully!* +- 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. 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) or [MainsailOS](https://github.com/mainsail-crew/mainsail/releases/latest) image. -- 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 not work for you. +- 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) or [MainsailOS](https://github.com/mainsail-crew/mainsail/releases/latest) image. [KIAUH](https://github.com/th33xitus/kiauh) is another excellent option, though it's not as simple as flashing MainsailOS on a microSD card, for example. +- 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. -- If you see any errors, or encounter any issues, please create an [Issue](https://github.com/bassamanator/Sovol-SV06-firmware/issues/new), or a [Pull request](https://github.com/bassamanator/Sovol-SV06-firmware/pulls). - 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 @@ -83,13 +76,13 @@ You may find this [video](https://youtu.be/p6l253OJa34) useful. You can choose *either* of the 2 following methods. -### 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`. 3. `git clone -b master --single-branch https://github.com/bassamanator/Sovol-SV06-firmware.git .` -### Download the ZIP +### Method 2: Download the ZIP 1. [Download](https://github.com/bassamanator/Sovol-SV06-firmware/archive/refs/heads/master.zip) the `ZIP` file containing the Klipper configuration. 2. The parent folder in the `ZIP` is `Sovol-SV06-firmware-master`. This is relevant in the next step. @@ -125,7 +118,7 @@ You can choose *either* of the 2 following methods. 3. `M106 S64` 4. `PID_CALIBRATE HEATER=extruder TARGET=245` 5. `SAVE_CONFIG` (once completed) -5. Adjust `z_offset`. Make sure your nozzle if very clean. Paper test [reference](https://www.klipper3d.org/Bed_Level.html?h=probe_calibrate#the-paper-test). +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. `SET_HEATER_TEMPERATURE HEATER=heater_bed TARGET=60` 2. `SET_HEATER_TEMPERATURE HEATER=extruder TARGET=180` 3. Proceed to next steps after both temperatures have been reached. @@ -140,6 +133,14 @@ You can choose *either* of the 2 following methods. 5. `BED_MESH_CALIBRATE` 6. `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. + +## Adjust Your Slicer + +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). + ## Directory Structure This repository contains many files and folders. Some are *necessary* for this Klipper configuration to work, others are not.