diff options
| author | Russell Cloran <rcloran@gmail.com> | 2025-03-17 20:50:10 -0700 |
|---|---|---|
| committer | KevinOConnor <kevin@koconnor.net> | 2025-04-17 11:44:26 -0400 |
| commit | 516ef1d3616acd7ddfd61b80b562f58a7800ceed (patch) | |
| tree | 86d1c438a95dc8cf5e42c9c2b5f6130384f7092d /docs | |
| parent | b9757c9b69f4c4ec6da7eeb8318235fb1a01f40b (diff) | |
| download | kutter-516ef1d3616acd7ddfd61b80b562f58a7800ceed.tar.gz kutter-516ef1d3616acd7ddfd61b80b562f58a7800ceed.tar.xz kutter-516ef1d3616acd7ddfd61b80b562f58a7800ceed.zip | |
hall_filament_width_sensor: Add filament switch values to status
`hall_filament_width_sensor` contains a runout sensor object internally.
This exposes those values in the API status result.
```
SEND: {"id":123,"method":"objects/query","params":{"objects":{"hall_filament_width_sensor":["enabled","filament_detected","is_active","Diameter","Raw"]}}}
GOT: b'{"id":123,"result":{"eventtime":199567.823596603,"status":{"hall_filament_width_sensor":{"enabled":true,"filament_detected":true,"is_active":true,"Diameter":1.9499999999999986,"Raw":6113}}}}'
```
The duplication of `is_active` and `enabled` seems confusing, but both
of these can be independently manipulated by GCode:
```
SEND: {"id":123,"method":"gcode/script","params":{"script":"DISABLE_FILAMENT_WIDTH_SENSOR"}}
GOT: b'{"id":123,"result":{}}'
SEND: {"id":123,"method":"objects/query","params":{"objects":{"hall_filament_width_sensor":["enabled","is_active"]}}}
GOT: b'{"id":123,"result":{"eventtime":199770.446013297,"status":{"hall_filament_width_sensor":{"enabled":true,"is_active":false}}}}'
SEND: {"id":123,"method":"gcode/script","params":{"script":"SET_FILAMENT_SENSOR SENSOR=hall_filament_width_sensor ENABLE=0"}}
GOT: b'{"id":123,"result":{}}'
SEND: {"id":123,"method":"objects/query","params":{"objects":{"hall_filament_width_sensor":["enabled","is_active"]}}}
GOT: b'{"id":123,"result":{"eventtime":199847.927726196,"status":{"hall_filament_width_sensor":{"enabled":false,"is_active":false}}}}'
```
Signed-off-by: Russell Cloran <rcloran@gmail.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Status_Reference.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/Status_Reference.md b/docs/Status_Reference.md index 0303ae41..e8f7f2c0 100644 --- a/docs/Status_Reference.md +++ b/docs/Status_Reference.md @@ -242,6 +242,8 @@ The following information is available in the `gcode_move` object The following information is available in the [hall_filament_width_sensor](Config_Reference.md#hall_filament_width_sensor) object: +- all items from + [filament_switch_sensor](Status_Reference.md#filament_switch_sensor) - `is_active`: Returns True if the sensor is currently active. - `Diameter`: The last reading from the sensor in mm. - `Raw`: The last raw ADC reading from the sensor. |