aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--config/example-extras.cfg21
-rw-r--r--docs/G-Codes.md8
2 files changed, 29 insertions, 0 deletions
diff --git a/config/example-extras.cfg b/config/example-extras.cfg
index 2645c6cb..134ac66b 100644
--- a/config/example-extras.cfg
+++ b/config/example-extras.cfg
@@ -1368,3 +1368,24 @@
#recover_velocity: 50.
# When capture/restore is enabled, the speed at which to return to
# the captured position (in mm/s). Default is 50.0 mm/s.
+
+# Filament Switch Sensor. Support for filament insert and runout detection
+# using a switch sensor, such as an endstop switch.
+#[filament_switch_sensor my_sensor]
+#pause_on_runout: True
+# When set to True, a PAUSE will execute immediately after a runout is
+# detected. Note that if pause_on_runout is False and the runout_gcode is
+# omitted then runout detection is disabled. Default is True.
+#runout_gcode:
+# The gcode to run after a filament runout is detected. If pause_on_runout
+# is set to True this gcode will run after the PAUSE is complete. The default
+# is not to run any gcode commands.
+#insert_gcode:
+# The gcode to run after a filament insert is detected. The default is not to
+# run any gcode commands, which disables insert detection.
+#event_delay: 3.0
+# The minimum amount of time in seconds to delay between events. Events
+# triggered during this time period will be silently ignored. The default
+# is 3 seconds.
+#switch_pin:
+# The pin on which the switch is connected. This parameter must be provided.
diff --git a/docs/G-Codes.md b/docs/G-Codes.md
index b9db71c7..197ec3e2 100644
--- a/docs/G-Codes.md
+++ b/docs/G-Codes.md
@@ -357,3 +357,11 @@ is enabled:
- `RESUME [VELOCITY=<value>]`: Resumes the print from a pause, first restoring
the previously captured position. The VELOCITY parameter determines the speed
at which the tool should return to the original captured position.
+
+## Filament Sensor
+
+The following command is available when the "filament_switch_sensor" config
+section is enabled.
+ - `QUERY_FILAMENT_SENSOR SENSOR=<sensor_name>`: Queries the current status of
+ the filament sensor. The data displayed on the terminal will depend on the
+ sensor type defined in the confguration.