aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Status_Reference.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2023-03-28 16:34:58 -0400
committerKevin O'Connor <kevin@koconnor.net>2023-04-07 15:20:40 -0400
commit83308a10510ca4efa022c463b5e6455192f8a0a7 (patch)
tree5a4d23439846c7bbd75af4831a3c70efc34ed20b /docs/Status_Reference.md
parent22ee889f41249a00664d3ccd7e12696975bd4fde (diff)
downloadkutter-83308a10510ca4efa022c463b5e6455192f8a0a7.tar.gz
kutter-83308a10510ca4efa022c463b5e6455192f8a0a7.tar.xz
kutter-83308a10510ca4efa022c463b5e6455192f8a0a7.zip
tmc: Support reporting tmc2240 temperature in driver get_status()
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/Status_Reference.md')
-rw-r--r--docs/Status_Reference.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/Status_Reference.md b/docs/Status_Reference.md
index 423e3fd5..84b4de73 100644
--- a/docs/Status_Reference.md
+++ b/docs/Status_Reference.md
@@ -458,6 +458,9 @@ objects (eg, `[tmc2208 stepper_x]`):
- `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).
+- `temperature`: The internal temperature reported by the driver. This
+ field will be null if the driver is not enabled or if the driver
+ does not support temperature reporting.
- `run_current`: The currently set run current.
- `hold_current`: The currently set hold current.