aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Status_Reference.md
diff options
context:
space:
mode:
authorPedro Lamas <pedrolamas@gmail.com>2022-07-25 16:49:21 +0100
committerKevinOConnor <kevin@koconnor.net>2022-07-28 20:43:19 -0400
commitb725d971db3b4f722aa218b773005a0585910175 (patch)
tree03e97742ef1b2305cba5968877d34818d68aa069 /docs/Status_Reference.md
parentc29e190696053310b7513c305d63667e67a293d1 (diff)
downloadkutter-b725d971db3b4f722aa218b773005a0585910175.tar.gz
kutter-b725d971db3b4f722aa218b773005a0585910175.tar.xz
kutter-b725d971db3b4f722aa218b773005a0585910175.zip
bed_screws: report status
Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
Diffstat (limited to 'docs/Status_Reference.md')
-rw-r--r--docs/Status_Reference.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/Status_Reference.md b/docs/Status_Reference.md
index 4c7883c7..7b6f1a42 100644
--- a/docs/Status_Reference.md
+++ b/docs/Status_Reference.md
@@ -28,6 +28,17 @@ The following information is available in the
- `profiles`: The set of currently defined profiles as setup
using BED_MESH_PROFILE.
+## bed_screws
+
+The following information is available in the
+`Config_Reference.md#bed_screws` object:
+- `is_active`: Returns True if the bed screws adjustment tool is currently
+active.
+- `state`: The bed screws adjustment tool state. It is one of
+the following strings: "adjust", "fine".
+- `current_screw`: The index for the current screw being adjusted.
+- `accepted_screws`: The number of accepted screws.
+
## configfile
The following information is available in the `configfile` object