h3n3/klipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Improve filament width sensor documentation (#5058)

Browse Source 
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>
This commit is contained in:
Yifei Ding
2021-12-27 09:41:31 -08:00
committed by GitHub
parent 634ae08df6
commit 98af5dffe6
4 changed files with 68 additions and 124 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docs/G-Codes.md
View File

@@ -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