aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2021-04-28 20:49:37 -0400
committerKevin O'Connor <kevin@koconnor.net>2021-06-03 22:27:30 -0400
commit93b9a85d19147ee57f6e79b1661e33df21aa1f20 (patch)
tree3442525f191c74ad13bf671199e2293d755058fb /docs
parent703418de01a550fe59c7cbe7ae73815947c35021 (diff)
downloadkutter-93b9a85d19147ee57f6e79b1661e33df21aa1f20.tar.gz
kutter-93b9a85d19147ee57f6e79b1661e33df21aa1f20.tar.xz
kutter-93b9a85d19147ee57f6e79b1661e33df21aa1f20.zip
endstop_phase: Add support for reporting phase information via get_status()
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs')
-rw-r--r--docs/Status_Reference.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/Status_Reference.md b/docs/Status_Reference.md
index ab14b7f7..17a759f5 100644
--- a/docs/Status_Reference.md
+++ b/docs/Status_Reference.md
@@ -36,6 +36,20 @@ The following information is available in the `display_status` object
`virtual_sdcard.progress` if no recent `M73` received).
- `message`: The message contained in the last `M117` G-Code command.
+# endstop_phase
+
+The following information is available in the
+[endstop_phase](Config_Reference.md#endstop_phase) object:
+- `last_home.<stepper name>.phase`: The phase of the stepper motor at
+ the end of the last home attempt.
+- `last_home.<stepper name>.phases`: The total number of phases
+ available on the stepper motor.
+- `last_home.<stepper name>.mcu_position`: The position (as tracked by
+ the micro-controller) of the stepper motor at the end of the last
+ home attempt. The position is the total number of steps taken in a
+ forward direction minus the total number of steps taken in the
+ reverse direction since the micro-controller was last restarted.
+
# fan
The following information is available in