From bc28fbc448f4d7af414fc7853715704e33f641b5 Mon Sep 17 00:00:00 2001 From: Bassam Husain Date: Sun, 18 Jun 2023 23:45:57 -0400 Subject: [PATCH] Added outline and many other adjustments. --- README.md | 55 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 36 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 953906d..4727c79 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,21 @@ This branch contains the Klipper configuration and firmware for the **Sovol SV06 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. -πŸ™πŸ»πŸ™ŒπŸ» A big thanks to [transistor1](https://github.com/transistor1) for getting this `printer.cfg` up an running to begin with. +πŸ™πŸ»πŸ™ŒπŸ» Big thanks to [transistor1](https://github.com/transistor1) for getting the `printer.cfg` up an running to begin with. + +## Outline + +- [Installation Instructions](#installation-instructions) + - [Electronic Wiring](#electronic-wiring) + - [⚠️ Important Note About Stepper Motor Current](#important-note-about-stepper-motor-current) + - [Download Firmware](#download-firmware) + - [Flash Firmware](#flash-firmware) + - [Download Klipper Configuration](#download-klipper-configuration) +- [Initial Steps](#initial-steps) +- [Support Me](#support-me) +- [Useful Resources](#useful-resources) +- [Sovol Official Links](#sovol-official-links) +- [Sources](#sources) ## Installation Instructions @@ -20,28 +34,34 @@ I am creating these files for my personal use and cannot be held responsible for Wire cables according to the following diagram: skr-mini-e3-v3.0 installation instructions +### Important Note About Stepper Motor Current + +For the SKR-Mini-E3-V3.0, the `run_current` for x, y, z stepper motors has been reduced in the `printer.cfg`, because the standard current seems to make the steppers dangerously hot. You may have to increase the current, or if the motors are still too hot, you may have to decrease it. + +πŸ’‘ Although stepper motors can withstand upwards of 125C, they should at the most get hot to the touch (~55C), not _very hot_. + ### Download Firmware πŸ’‘ The firmware files are located in `misc/skr-mini`. -πŸ’‘ Be sure to download the `raw` files. Find out more about this [here](https://stackoverflow.com/questions/4604663/download-single-files-from-github). +πŸ’‘ Be sure to download the `raw` files. Find out more about this [here](https://stackoverflow.com/questions/4604663/download-single-files-from-github); check the answer with the highest score. Download [klipper-USB.bin](./misc/skr-mini/klipper-USB.bin) compiled by BTT. Or you can download [klipper-v0.11.0-198-g33b18fd6-latest-UNTESTED.bin](./misc/skr-mini/klipper-v0.11.0-198-g33b18fd6-latest-UNTESTED.bin) that I compiled, however, it is **untested**. -#### Alternatively, find instructions on how to build the firmware yourself [here](https://github.com/bigtreetech/BIGTREETECH-SKR-mini-E3/tree/master/firmware/V3.0/Klipper#build-firmware-image) +#### Alternatively, find instructions on how to build the firmware yourself [here](https://github.com/bigtreetech/BIGTREETECH-SKR-mini-E3/tree/master/firmware/V3.0/Klipper#build-firmware-image). ls output ### Flash Firmware -⚠️ Make sure the microSD card has been prepared using the instructions found [here](https://github.com/bassamanator/Sovol-SV06-firmware#prepare-the-microsd-card-for-flashing). +⚠️ Make sure the microSD card has been prepared using the instructions found [here](https://github.com/bassamanator/Sovol-SV06-firmware#1-prepare-the-microsd-card-for-flashing-with-these-parameters). 1. Rename whatever firmware file you're using to `firmware.bin`. ⚠️ If the file is not renamed, the bootloader will not be updated properly. 2. Copy `firmware.bin` to the root directory of the microSD card. -3. Power off the skr-mini-E3-V3.0. +3. Power off the printer. 4. Insert the microSD card. -5. Power on the skr-mini-E3-V3.0. +5. Power on the printer. 6. After a few seconds, the skr-mini-E3-V3.0 should be flashed, but wait a full minute just to be sure. 7. You can confirm that the flash was successful, by running `ls -l /dev/serial/by-id/` or `ls -l /dev/serial/by-path/`. If the flash was successful, you'll see something like the following: ls output @@ -50,32 +70,29 @@ Or you can download [klipper-v0.11.0-198-g33b18fd6-latest-UNTESTED.bin](./misc/s 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`. -3. `git clone -b skr-mini-e3-v3 --single-branch https://github.com/bassamanator/Sovol-SV06-firmware.git .` +2. Empty entire `~/printer_data/config` folder. + - In linux, you can delete files via `rm fileName` and directories via `rmdir directoryName`. +3. `git clone -b skr-mini-e3-v3 --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/skr-mini-e3-v3.zip) the `ZIP` file containing the Klipper configuration. 2. See Step 2 in Method 1. 3. The parent folder in the `ZIP` is `Sovol-SV06-firmware-skr-mini-e3-v3`. This is relevant in the next step. 4. Extract **only** the _contents_ of the parent folder into `~/printer_data/config`. -### ⚠️ Important Note About Stepper Motor Current +## Initial Steps -For the SKR-Mini-E3-V3.0, the `run_current` for x, y, z stepper motors has been reduced in the `printer.cfg`, because the standard current seems to make the steppers dangerously hot. You may have to increase the current, or if the motors are still too hot, you may have to decrease it. +Once you've cloned or downloaded the configuration, please follow instructions found in [Initial Steps](https://github.com/bassamanator/Sovol-SV06-firmware#initial-steps). -πŸ’‘ Although stepper motors can withstand upwards of 125C, they should at the most get hot to the touch (~55C), not _very hot_. +## Support Me -#### Once you've cloned or downloaded the configuration, please follow instructions found in [Initial Steps](https://github.com/bassamanator/Sovol-SV06-firmware#initial-steps). +Please ⭐ star ⭐ this repository! -## 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). +If you found my work useful, please consider buying me a [Ko-fi](https://ko-fi.com/bassamanator). ## Useful Resources