diff options
| author | Kevin O'Connor <kevin@koconnor.net> | 2021-08-27 19:24:14 -0400 |
|---|---|---|
| committer | Kevin O'Connor <kevin@koconnor.net> | 2021-08-30 12:00:46 -0400 |
| commit | 5fd1c9853d243cccdb53c75cae0a1a48b882368d (patch) | |
| tree | 7d1fd1d5119cd5b056d9fb37507e7239d926e3e8 /docs/Status_Reference.md | |
| parent | 950477849d0871766ce9d4240ddd5976a9086e33 (diff) | |
| download | kutter-5fd1c9853d243cccdb53c75cae0a1a48b882368d.tar.gz kutter-5fd1c9853d243cccdb53c75cae0a1a48b882368d.tar.xz kutter-5fd1c9853d243cccdb53c75cae0a1a48b882368d.zip | |
tmc: Add support for a get_status() method
Export mcu_phase_offset and drv_status information.
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/Status_Reference.md')
| -rw-r--r-- | docs/Status_Reference.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/Status_Reference.md b/docs/Status_Reference.md index 969f8704..68abf2f6 100644 --- a/docs/Status_Reference.md +++ b/docs/Status_Reference.md @@ -311,6 +311,21 @@ objects: temperature seen by the sensor since the Klipper host software was last restarted. +## tmc drivers + +The following information is available in +[TMC stepper driver](Config_Reference.md#tmc-stepper-driver-configuration) +objects (eg, `[tmc2208 stepper_x]`): +- `mcu_phase_offset`: The micro-controller stepper position + corresponding with the driver's "zero" phase. This field may be null + if the phase offset is not known. +- `phase_offset_position`: The "commanded position" corresponding to + the driver's "zero" phase. This field may be null if the phase + offset is not known. +- `drv_status`: The results of the last driver status query. (Only + non-zero fields are reported.) This field will be null if the driver + is not enabled (and thus is not periodically queried). + ## toolhead The following information is available in the `toolhead` object |