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

docs: Re-organize Hall Filament Width Sensor Doc 

Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
This commit is contained in:
Yifei Ding 2021-10-23 12:03:45 -07:00 committed by KevinOConnor
parent 71ab552562
commit 0d0d8cbb7d
1 changed files with 78 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/HallFilamentWidthSensor.md
View File

@ -1,6 +1,6 @@
# Hall filament width sensor
This document describes Filament Width Sensor host module. Hardware used for developing this host module is based on Two Hall liniar sensors (ss49e for example). Sensors in the body are located opposite sides. Principle of operation : two hall sensors work in differential mode, temperature drift same for sensor. Special temperature compensation not needed. You can find designs at [thingiverse.com](https://www.thingiverse.com/thing:4138933)
This document describes Filament Width Sensor host module. Hardware used for developing this host module is based on Two Hall liniar sensors (ss49e for example). Sensors in the body are located opposite sides. Principle of operation : two hall sensors work in differential mode, temperature drift same for sensor. Special temperature compensation not needed. You can find designs at [Thingiverse](https://www.thingiverse.com/thing:4138933)
[Hall based filament width sensor assembly video](https://www.youtube.com/watch?v=TDO9tME8vp4)
@ -10,6 +10,7 @@ Sensor generates two analog output based on calculated filament width. Sum of ou
## Configuration
```
[hall_filament_width_sensor]
adc1: analog11
@ -69,15 +70,15 @@ Sensor generates two analog output based on calculated filament width. Sum of ou
#insert_gcode:
#event_delay: 3.0
#pause_delay: 0.5
```
## Commands
## G-Code Commands
**QUERY_FILAMENT_WIDTH** - Return the current measured filament width as result
**RESET_FILAMENT_WIDTH_SENSOR** – Clear all sensor readings. Can be used after filament change.
**RESET_FILAMENT_WIDTH_SENSOR** - Clear all sensor readings. Can be used after filament change.
**DISABLE_FILAMENT_WIDTH_SENSOR** – Turn off the filament width sensor and stop using it to do flow control
**DISABLE_FILAMENT_WIDTH_SENSOR** - Turn off the filament width sensor and stop using it to do flow control
**ENABLE_FILAMENT_WIDTH_SENSOR** - Turn on the filament width sensor and start using it to do flow control
@ -96,6 +97,8 @@ Sensor generates two analog output based on calculated filament width. Sum of ou
**hall_filament_width_sensor.is_active** Sensor on or off
## Template for menu variables
```
[menu __main __filament __width_current]
type: command
enable: {'hall_filament_width_sensor' in printer}
@ -107,23 +110,28 @@ Sensor generates two analog output based on calculated filament width. Sum of ou
enable: {'hall_filament_width_sensor' in printer}
name: Raw: {'%4.0F' % printer.hall_filament_width_sensor.Raw}
index: 1
```
## Calibration procedure
Insert first calibration rod (1.5 mm size) get first raw sensor value
To get raw sensor value you can use menu item or **QUERY_RAW_FILAMENT_WIDTH** command in terminal
Insert second calibration rod (2.0 mm size) get second raw sensor value
1. Insert first calibration rod (1.5 mm size) get first raw sensor value
Save raw values in config
2. Insert second calibration rod (2.0 mm size) get second raw sensor value
3. Save raw sensor values in config parameter `Raw_dia1` and `Raw_dia2`
## How to enable sensor
After power on by default sensor disabled.
Enable sensor in start g-code by command **ENABLE_FILAMENT_WIDTH_SENSOR** or change enable parameter in config
By default, the sensor is disabled at power-on.
To enable the sensor, issue **ENABLE_FILAMENT_WIDTH_SENSOR** command or set the `enable` parameter to `true.`
## Logging
After power on by default diameter Logging disabled.
Data to log added on every measurement interval (10 mm by default)
By default, diameter logging is disabled at power-on.
Issue **ENABLE_FILAMENT_WIDTH_LOG** command to start logging and issue **DISABLE_FILAMENT_WIDTH_LOG** command to stop logging. To enable logging at power-on, set the `logging` parameter to `true`.
Filament diameter is logged on every measurement interval (10 mm by default).