diff --git a/README.md b/README.md index 0ca213f..73b3828 100644 --- a/README.md +++ b/README.md @@ -74,10 +74,10 @@ In many ways, this entire repository can be considered _my opinion_ on the `3D p ## Before You Begin -- This entire page is a **12 minute read**. Save yourself _hours of troubleshooting_ and read this documentation fully. +- This entire page is a **9 minute read**. Save yourself _hours of troubleshooting_ and read this documentation fully. - On the SV06 Plus, your screen will not work if you install Klipper. You can get it _mostly_ working again via the instructions found [here](https://github.com/fryc88/klipper-sv06plus-screen). - ⚠️ 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. +- ⚠️ [Disable](https://github.com/bassamanator/everything-sovol-sv06/blob/main/howto.md#disable-usb-cable-5v-pin) the USB cable's 5V pin. - 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`. @@ -86,9 +86,10 @@ In many ways, this entire repository can be considered _my opinion_ on the `3D p - 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 that is not the case, then the steps in this guide will not work _perfectly_ for you. +- It is assumed that there is one instance of Klipper installed. If that is not the case, 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. + [🔼 Back to top](#outline) @@ -96,11 +97,11 @@ In many ways, this entire repository can be considered _my opinion_ on the `3D p ### Flash Firmware -💡 If you have already flashed klipper onto your motherboard in the past, you can skip this step. +💡 If you flashed Klipper onto your motherboard in the past, you can skip this step. Please note: -- 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`. +- For the sake of simplicity, I will refer to the 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. - You may find this [video](https://youtu.be/p6l253OJa34) useful. @@ -153,7 +154,7 @@ Please note: 💡 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: +1. Find what port the `mcu` (printer motherboard) is connected to via _one_ of the following commands: - `ls /dev/serial/by-id/*` - `ls /dev/serial/by-path/*` @@ -172,7 +173,7 @@ Please note: 3. Do a `FIRMWARE_RESTART`. -If the Klipper flash that you did earlier was successful, and you've done everything else correctly, you should see no errors or warnings in the `Mainsail`/`Fluidd` dashboard. **Klipper has successfully been installed on your printer!** +If the Klipper flash that you did earlier was successful, and you've done everything else correctly, you should see no errors or warnings in the `Mainsail`/`Fluidd` dashboard. 🎉 **Your printer has been Klipperized!** 🎉 [🔼 Back to top](#outline) @@ -211,15 +212,15 @@ If the Klipper flash that you did earlier was successful, and you've done everyt 1. `DO_CREATE_MESH` 2. `SAVE_CONFIG` (once completed) -🏁 If you've made it here, then your printer has been Klipperized, and is ready to print! 🏁 +🏁 If you've made it here, then your Klipperized printer is ready to print! 🏁 -But first, adjust your slicer. +_But first_, adjust your slicer. [🔼 Back to top](#outline) ## Adjust Your Slicer -📝 If you are using the config bundles found on this repo, you can skip this section. +📝 If you are using the slicer bundles found on this repo, you can skip this section. ### Start G-Code @@ -284,11 +285,23 @@ This repository contains many files and folders. Some are _necessary_ for this K ## FAQ +### What are some settings that I can change? + +| File | Section | +| ---------------------- | ------------------------ | +| `cfgs/misc-macros.cfg` | `[gcode_macro _globals]` | + +| Variable | Disable | Enable | Notes | +| ---------------------------------- | ------------- | ------------- | ------------------------------------------------------------------- | +| `variable_beeping_enabled` | `0` (default) | `1` | +| `variable_filament_sensor_enabled` | `0` | `1` (default) | +| `variable_kamp_enable` | `0` (default) | `1` | See [here](#how-do-i-enable-kamp-klipper-adaptive-meshing--purging) | + ### How do I import a configuration bundle into SuperSlicer/PrusaSlicer? Please see this [discussion](https://github.com/bassamanator/Sovol-SV06-firmware/discussions/13). -### How do I print using SuperSlicer? +### How do I print using SuperSlicer/PrusaSlicer? Please see this [discussion](https://github.com/bassamanator/Sovol-SV06-firmware/discussions/14). @@ -303,24 +316,10 @@ The printer will beep upon: - Upon `PRINT_END`. - `MECHANICAL_GANTRY_CALIBRATION`/`G34`. -| File | `cfgs/misc-macros.cfg` | -| -------- | -------------------------- | -| Section | `[gcode_macro _globals]` | -| Variable | `variable_beeping_enabled` | -| Disable | `0` (default) | -| Enable | `1` | - ### I want to use a filament sensor. How do I set it up? You can find information about the physical setup [here](https://github.com/bassamanator/everything-sovol-sv06#filament-sensor). -| File | `cfgs/misc-macros.cfg` | -| -------- | ---------------------------------- | -| Section | `[gcode_macro _globals]` | -| Variable | `variable_filament_sensor_enabled` | -| Disable | `0` | -| Enable | `1` (default) | - ### My filament runout sensor works, but I just started a print without any filament loaded. What gives? A simple runout sensor can only detect a change in state. So, if you start a print without filament loaded, the printer will not know that there is no filament loaded. You should test your sensor by having filament loaded, starting a print, then cutting the filament. The expected behaviour is that the print will pause, and as long as you have beeping enabled, you will hear 3 annoying beeps. @@ -365,13 +364,6 @@ The printhead is now parked front center waiting for you to insert filament. You 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`. -| File | `cfgs/misc-macros.cfg` | -| -------- | ------------------------ | -| Section | `[gcode_macro _globals]` | -| Variable | `variable_kamp_enable` | -| Disable | `0` (default) | -| Enable | `1` | - ### How do I use the `TEST_SPEED` macro? ⚠️ This is for advanced users only, with well oiled machines. You can cause serious damage to your printer if you're not careful. ☠️ **You have been warned** ☠️.