aboutsummaryrefslogtreecommitdiffstats
path: root/docs/G-Codes.md
diff options
context:
space:
mode:
authorYifei Ding <dingyifeiair@gmail.com>2021-12-27 09:41:31 -0800
committerGitHub <noreply@github.com>2021-12-27 12:41:31 -0500
commit98af5dffe61476200d1215afbd00b0d809ad0474 (patch)
tree0afb9a03195ea2e2d073cea1f0a2130933f1e832 /docs/G-Codes.md
parent634ae08df6fbd962bd034ac434539c5d02eb5dfa (diff)
downloadkutter-98af5dffe61476200d1215afbd00b0d809ad0474.tar.gz
kutter-98af5dffe61476200d1215afbd00b0d809ad0474.tar.xz
kutter-98af5dffe61476200d1215afbd00b0d809ad0474.zip
docs: Improve filament width sensor documentation (#5058)
Add Filament Width Sensor to G-Codes.md Remove Redundant Filament Width Sensor Entries Remove Duplicate Status Reference In Hall Filament Width Sensor Fix Indentation For Filament Width Sensors Signed-off-by: Yifei Ding<yifeiding@protonmail.com>
Diffstat (limited to 'docs/G-Codes.md')
-rw-r--r--docs/G-Codes.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/G-Codes.md b/docs/G-Codes.md
index 01e16570..12070f1d 100644
--- a/docs/G-Codes.md
+++ b/docs/G-Codes.md
@@ -841,3 +841,30 @@ Palette prints work by embedding special OCodes (Omega Codes)
in the GCode file:
- `O1`...`O32`: These codes are read from the GCode stream and processed
by this module and passed to the Palette 2 device.
+
+### Filament Width Sensor Commands
+
+The following command is available when the
+[tsl1401cl filament width sensor config section](Config_Reference.md#tsl1401cl_filament_width_sensor)
+or [hall filament width sensor config section](Config_Reference.md#hall_filament_width_sensor)
+is enabled (also see [TSLl401CL Filament Width Sensor](TSL1401CL_Filament_Width_Sensor.md)
+and [Hall Filament Width Sensor](Hall_Filament_Width_Sensor.md)):
+
+- `QUERY_FILAMENT_WIDTH` - Return the current measured filament width
+- `RESET_FILAMENT_WIDTH_SENSOR` - Clear all sensor readings. Helpful after
+ filament change
+- `DISABLE_FILAMENT_WIDTH_SENSOR` - Turn off the filament width sensor and
+ stop using it for flow control
+- `ENABLE_FILAMENT_WIDTH_SENSOR` - Turn on the filament width sensor and
+ start using it for flow control
+
+### Hall Filament Width Sensor Commands
+
+The following command is available when the
+[hall filament width sensor config section](Config_Reference.md#hall_filament_width_sensor)
+is enabled:
+
+- `QUERY_RAW_FILAMENT_WIDTH` - Return the current ADC channel readings and
+ RAW sensor value for calibration points
+- `ENABLE_FILAMENT_WIDTH_LOG` - Turn on diameter logging
+- `DISABLE_FILAMENT_WIDTH_LOG` - Turn off diameter logging