aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Status_Reference.md
diff options
context:
space:
mode:
authorViesturs Zariņš <viesturz@gmail.com>2024-04-04 22:46:30 +0200
committerGitHub <noreply@github.com>2024-04-04 16:46:30 -0400
commitb029d0466841b90b54279500f70a92deacfd6c5a (patch)
treec189dad07adb69f999314b45b6577c0fc10f904f /docs/Status_Reference.md
parent6f16e111977d0aa68fb4c6362509cec07a94115c (diff)
downloadkutter-b029d0466841b90b54279500f70a92deacfd6c5a.tar.gz
kutter-b029d0466841b90b54279500f70a92deacfd6c5a.tar.xz
kutter-b029d0466841b90b54279500f70a92deacfd6c5a.zip
manual_stepper: Add basic status. (#6527)
Adding position and enabled in manual_stepper status. Enabled is already available through stepper_enable object. But this makes it more straightforward to access it. Signed-off-by: Viesturs Zarins <viesturz@gmail.com>
Diffstat (limited to 'docs/Status_Reference.md')
-rw-r--r--docs/Status_Reference.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/Status_Reference.md b/docs/Status_Reference.md
index 0e72a12b..80f53d9f 100644
--- a/docs/Status_Reference.md
+++ b/docs/Status_Reference.md
@@ -293,6 +293,13 @@ understands it).
- `z_position_lower`: Last probe attempt just lower than the current height.
- `z_position_upper`: Last probe attempt just greater than the current height.
+## manual_stepper
+
+The following information is available in the
+`manual_stepper` object:
+- `enabled`: Returns True if the stepper is currently enabled.
+- `position`: The requested position.
+
## mcu
The following information is available in