From 62e2e96e0c4f2eccc2020b9ce0ff014807f64a0f Mon Sep 17 00:00:00 2001 From: Bassam Husain Date: Mon, 20 Nov 2023 03:14:27 -0500 Subject: [PATCH 1/3] Adjust readme: FAQs. --- README.md | 36 ++++++++++++++++-------------------- 1 file changed, 16 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 3c1e0ef..1dbf3cb 100644 --- a/README.md +++ b/README.md @@ -241,26 +241,24 @@ This repository contains many files and folders. Some are _necessary_ for this K ## FAQ -##### How do I import a configuration bundle into SuperSlicer/PrusaSlicer? +### 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? Please see [this discussion](https://github.com/bassamanator/Sovol-SV06-firmware/discussions/14). -##### When does beeping occur? +### When does beeping occur? The printer will beep upon: - Filament runout. - Filament change/`M600`. - Upon `PRINT_END`. -- `MECHANICAL_GANTRY_CALIBRATION`/`G34`. +- `MECHANICAL_GANTRY_CALIBRATION`/`G34` (beeping will occur even if beeping is disabled, as long as you have a speaker on your board). -##### How do I disable beeping? - -Make the following changes according to your needs. All beeping will be disabled _except_ during gantry calibration. +Adjust behaviour according to your needs. | File | `cfgs/misc-macros.cfg` | | -------- | -------------------------- | @@ -269,13 +267,11 @@ Make the following changes according to your needs. All beeping will be disabled | Disable | `0` | | Enable | `1` (default) | -##### I want to use a filament sensor. How do I set it up? +### 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). -##### I have a simple filament sensor connected. How do I enable/disable it? - -Make the following changes according to your needs. +Adjust behaviour according to your needs. | File | `cfgs/misc-macros.cfg` | | -------- | ---------------------------------- | @@ -284,28 +280,28 @@ Make the following changes according to your needs. | Disable | `0` (default) | | Enable | `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? 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. -##### What happens when I put in `M600`/colour change at a certain layer? +### What happens when I put in `M600`/colour change at a certain layer? 1. The printer will beep 3 times (not annoyingly). 2. Printing will stop. 3. The printhead will park itself front center. 4. The hotend will turn off, but the bed will remain hot. -##### 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. -##### 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. -##### 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 not disable the stepper motors during this process!_ +⚠️ Do not disable the stepper motors during this process! The printhead is now parked front center waiting for you to insert filament. You will: @@ -316,7 +312,7 @@ The printhead is now parked front center waiting for you to insert filament. You - 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. -##### How do I enable KAMP (Klipper Adaptive Meshing & Purging)? +### How do I enable KAMP (Klipper Adaptive Meshing & Purging)? Although this repo contains all the code from the KAMP repository, only the `mesh` functionality of KAMP has been configured and tested. To enable other functionality, adjust `/cfgs/kamp/KAMP_Settings.cfg`. @@ -326,7 +322,7 @@ The [Label objects setting](https://docs.mainsail.xyz/overview/features/exclude- ⚠️ KAMP cannot be used with low-powered devices such as the Raspberry Pi Zero. -Adjust according to your needs. +Adjust behaviour according to your needs. | File | `cfgs/misc-macros.cfg` | | -------- | ------------------------ | @@ -335,7 +331,7 @@ Adjust according to your needs. | Disable | `0` (default) | | Enable | `1` | -##### How do I use the `TEST_SPEED` macro? +### 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** ☠️. From 4b42fcccd6f77f69282aa4c82bcd6d0b9081fba9 Mon Sep 17 00:00:00 2001 From: Bassam <61985779+bassamanator@users.noreply.github.com> Date: Tue, 21 Nov 2023 01:24:26 -0500 Subject: [PATCH 2/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 30a0878..fe035e1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,14 @@ # Contribution Guidelines -When contributing, please ... +When contributing, please: - provide a clear and concise explanation of your pull request. -- try to make small changes, ie, make many small pull requests as opposed to a single large pull request. This allows me to check your work more quickly, thus merge more quickly. +- try to make small changes, ie, make many small pull requests as opposed to a single large pull request. - try to follow the patterns I've already established. +Contributions to `README.md` should do some or all of the following: +- add clarity +- reduce complexity for the user +- reduce verbosity +- fix errors + Thank you. From 89183cad941ab0f64201ce7014326a104f6d3623 Mon Sep 17 00:00:00 2001 From: Bassam Husain Date: Wed, 22 Nov 2023 19:05:26 -0500 Subject: [PATCH 3/3] Adjust MECHANICAL_GANTRY_CALIBRATION.cfg: change to CONDITIONAL_BEEP. --- README.md | 2 +- cfgs/MECHANICAL_GANTRY_CALIBRATION.cfg | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1dbf3cb..9690417 100644 --- a/README.md +++ b/README.md @@ -256,7 +256,7 @@ The printer will beep upon: - Filament runout. - Filament change/`M600`. - Upon `PRINT_END`. -- `MECHANICAL_GANTRY_CALIBRATION`/`G34` (beeping will occur even if beeping is disabled, as long as you have a speaker on your board). +- `MECHANICAL_GANTRY_CALIBRATION`/`G34`. Adjust behaviour according to your needs. diff --git a/cfgs/MECHANICAL_GANTRY_CALIBRATION.cfg b/cfgs/MECHANICAL_GANTRY_CALIBRATION.cfg index f99852c..3a9f928 100644 --- a/cfgs/MECHANICAL_GANTRY_CALIBRATION.cfg +++ b/cfgs/MECHANICAL_GANTRY_CALIBRATION.cfg @@ -72,16 +72,16 @@ gcode: SET_TMC_CURRENT STEPPER=stepper_z1 CURRENT={my_current} ; drop current {% endif %} - BEEP I=1 + CONDITIONAL_BEEP I=1 G4 P200 ; Probably not necessary, it is here just for sure SET_KINEMATIC_POSITION Z={z_max - 25} ; Trick printer into beleiving the gantry is 25mm lower than it is ; CHANGED G1 Z{z_max} F{6 * 60} ; based on above figures, there will be 20mm worth of grinding ; CHANGED - BEEP I=2 + CONDITIONAL_BEEP I=2 G4 P10000 ; wait 10 seconds G1 Z{z_max -6} F{6 * 60} ; move 4mm down - BEEP I=3 + CONDITIONAL_BEEP I=3 G4 P200 ; same as the first one SET_TMC_CURRENT STEPPER=stepper_z CURRENT={oldcurrent} HOLDCURRENT={oldhold}