aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorTheJoshW <46292721+TheJoshW@users.noreply.github.com>2021-03-15 12:36:19 +1100
committerGitHub <noreply@github.com>2021-03-14 21:36:19 -0400
commitbf8f7133b43cbb98b4a9515e43e1a1b7d71e04ea (patch)
treed1f778bb9736b70b18925a36b971c52e400898b9 /docs
parentd77928b17ba6b32189033b3d6decdb5bcc7c342c (diff)
downloadkutter-bf8f7133b43cbb98b4a9515e43e1a1b7d71e04ea.tar.gz
kutter-bf8f7133b43cbb98b4a9515e43e1a1b7d71e04ea.tar.xz
kutter-bf8f7133b43cbb98b4a9515e43e1a1b7d71e04ea.zip
filament_motion_sensor: Add filament_motion_sensor (#3857)
Add functionality to support a Filament Motion Sensor for detecting extruder jams as well as runouts. Works by an encoder toggling the switch_pin 0/1 as the filament is pulled through the sensor. Signed-off-by: Joshua Wherrett <thejoshw.code@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/Config_Reference.md28
-rw-r--r--docs/G-Codes.md2
2 files changed, 29 insertions, 1 deletions
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md
index c1c09cb7..b27da60b 100644
--- a/docs/Config_Reference.md
+++ b/docs/Config_Reference.md
@@ -3461,6 +3461,34 @@ information.
# provided.
```
+## [filament_motion_sensor]
+
+Filament Motion Sensor. Support for filament insert and runout
+detection using an encoder that toggles the output pin during filament
+movement through the sensor.
+
+See the [command reference](G-Codes.md#filament-sensor) for more
+information.
+
+```
+[filament_motion_sensor my_sensor]
+detection_length: 7.0
+# The minimum length of filament pulled through the sensor to trigger
+# a state change on the switch_pin
+# Default is 7 mm.
+extruder:
+# The name of the extruder section this sensor is associated with.
+# This parameter must be provided.
+switch_pin:
+#pause_on_runout:
+#runout_gcode:
+#insert_gcode:
+#event_delay:
+#pause_delay:
+# See the "filament_switch_sensor" section for a description of the
+# above parameters.
+```
+
## [tsl1401cl_filament_width_sensor]
TSLl401CL Based Filament Width Sensor. See the
diff --git a/docs/G-Codes.md b/docs/G-Codes.md
index 772815fc..00ecdad8 100644
--- a/docs/G-Codes.md
+++ b/docs/G-Codes.md
@@ -574,7 +574,7 @@ enabled:
## Filament Sensor
The following command is available when the
-[filament_switch_sensor config section](Config_Reference.md#filament_switch_sensor)
+[filament_switch_sensor or filament_motion_sensor config section](Config_Reference.md#filament_switch_sensor)
is enabled.
- `QUERY_FILAMENT_SENSOR SENSOR=<sensor_name>`: Queries the current
status of the filament sensor. The data displayed on the terminal