Filament runout sensor code merged.

README.md

@@ -9,6 +9,7 @@ I am creating these files for my personal use and cannot be held responsible for
 # Highlights
 
 - 💥 This Klipper configuration is an *endpoint*, meaning that it contains **everything** that you could possibly need in order to have an excellent Klipper experience! 💥
+- `NEW` Filament runout sensor usage implemented.
 - Minimum configuration settings for Mainsail/Fluiddpi to work.
 - SuperSlicer config bundle that contains the printer configuration, as well as what are considered by many to be the best print settings available for any FDM printer ([Ellis' SuperSlicer Profiles](https://github.com/AndrewEllis93/Ellis-SuperSlicer-Profiles)). Find the differences between the different print setting profiles [here](https://github.com/AndrewEllis93/Ellis-SuperSlicer-Profiles/tree/master/SuperSlicer). But basically, the 45 degree profile places the seam at the back.
 - Bed model and texture to use in SuperSlicer/PrusaSlicer.
@@ -24,10 +25,11 @@ I am creating these files for my personal use and cannot be held responsible for
 - [x] Replace M109/M190 with `TEMPERATURE_WAIT`.
 - [ ] Get the Ellis `TEST_SPEED` macro working.
 - [x] Add information about directory structure.
-- [ ] Create FAQ section.
+- [x] Create FAQ section.
 - [x] Get filament sensor working with hotend PCB.
-- [ ] Finalize filament sensor config and merge into `master`.
+- [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.
 
 ## Stay Up-to-Date
 
@@ -160,7 +162,28 @@ If you found my work useful, please consider buying me a [<img src="./misc/logo_
 
 ##### How do I disable the beeping at the end of a print?
 
-Edit the file `cfgs/misc-macros.cfg`: change the line that reads `variable_beeping_enabled: 1` to `variable_beeping_enabled: 0`. All beeping will be disabled except during gantry calibration.
+Make the following changes according to your needs. All beeping will be disabled except during gantry calibration.
+
+| File | `cfgs/misc-macros.cfg` |
+| - | - |
+| Section | `[gcode_macro _globals]` |
+| Variable | `variable_beeping_enabled` |
+| Disable beeping | `0` |
+| Enable beeping | `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).
+##### I have a simple filament sensor connected. How do I enable/disable it?
+
+Make the following changes according to your needs.
+
+| File | `cfgs/misc-macros.cfg` |
+| - | - |
+| Section | `[gcode_macro _globals]` |
+| Variable | `variable_filament_sensor_enabled` |
+| Disable sensor | `0` |
+| Enable sensor | `1` |
 
 ## Useful Resources
 

cfgs/misc-macros.cfg

@@ -79,7 +79,7 @@ gcode:
 # https://github.com/VoronDesign/Voron-Switchwire/blob/200cdae033c59ef81f67c4235469da7ca66d53a1/Firmware/skr_mini_e3_v2_config.cfg
 gcode:
     {% set PRE_PURGE_PRIME_LENGTH=printer["gcode_macro _globals"].pre_purge_prime_length|default(1.40)|float %}
-    # ADJUST_FILAMENT_SENSOR_STATUS ENABLE=1
+    ADJUST_FILAMENT_SENSOR_STATUS ENABLE=1
     G0 Y0 X0 F4000                         ; go to tongue of print bed
     G1 Z0.4 F500.0                          ; move bed to nozzle
     G92 E0.0                                ; reset extruder
@@ -104,7 +104,7 @@ gcode:
     {% set hotendtemp = params.HOTEND|int %}
     {% set chambertemp = params.CHAMBER|default(0)|int %}
     
-    # ADJUST_FILAMENT_SENSOR_STATUS ENABLE=1
+    ADJUST_FILAMENT_SENSOR_STATUS ENABLE=1
 
     G28 X Y
     # <insert your routines here>
@@ -122,7 +122,7 @@ gcode:
 
 [gcode_macro PRINT_END]
 gcode:
-    # ADJUST_FILAMENT_SENSOR_STATUS ENABLE=0
+    ADJUST_FILAMENT_SENSOR_STATUS ENABLE=0
     CONDITIONAL_BEEP I=2 DUR=30 FREQ=8500                               ; NOTE Comment out this line to stop the beeps at the end of a print
     {% set PRE_PURGE_PRIME_LENGTH=printer["gcode_macro _globals"].pre_purge_prime_length|default(1.40)|float %}
     M400                                    ; wait for buffer to clear
@@ -190,7 +190,7 @@ gcode:
         SET_GCODE_VARIABLE MACRO=RESUME VARIABLE=zhop VALUE={z}                              ; set z hop variable for reference in resume macro
         SET_GCODE_VARIABLE MACRO=RESUME VARIABLE=etemp VALUE={printer['extruder'].target}    ; set hotend temp variable for reference in resume macro
 
-        # ADJUST_FILAMENT_SENSOR_STATUS ENABLE=0
+        ADJUST_FILAMENT_SENSOR_STATUS ENABLE=0
 
         SAVE_GCODE_STATE NAME=PAUSE                                                          ; save current print position for resume
         BASE_PAUSE                                                                           ; pause print
@@ -217,7 +217,7 @@ gcode:
     {% set e = params.E|default(2.5)|int %}                                          ; hotend prime amount (in mm)
 
     {% if printer['pause_resume'].is_paused|int == 1 %}
-        # ADJUST_FILAMENT_SENSOR_STATUS ENABLE=1
+        ADJUST_FILAMENT_SENSOR_STATUS ENABLE=1
 
         SET_IDLE_TIMEOUT TIMEOUT={printer.configfile.settings.idle_timeout.timeout}  ; set timeout back to configured value
         {% if etemp > 0 %}