aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorStefan Dej <meteyou@gmail.com>2023-07-19 22:31:33 +0200
committerKevinOConnor <kevin@koconnor.net>2023-08-01 12:14:15 -0400
commitea330717cde4c05e8952ae3fbb4bec2f11e7672f (patch)
treefd0833650aa640d2f7a132145b38eb0d93c92cf9 /docs
parentfee385dad84acb1d6c763f620480cf67eab7cad7 (diff)
downloadkutter-ea330717cde4c05e8952ae3fbb4bec2f11e7672f.tar.gz
kutter-ea330717cde4c05e8952ae3fbb4bec2f11e7672f.tar.xz
kutter-ea330717cde4c05e8952ae3fbb4bec2f11e7672f.zip
screws_tilt_adjust: add max_deviation to report status
Signed-off-by: Stefan Dej <meteyou@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/Status_Reference.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/Status_Reference.md b/docs/Status_Reference.md
index bff64d18..48aeb0fd 100644
--- a/docs/Status_Reference.md
+++ b/docs/Status_Reference.md
@@ -386,6 +386,8 @@ object:
- `error`: Returns True if the most recent `SCREWS_TILT_CALCULATE`
command included the `MAX_DEVIATION` parameter and any of the probed
screw points exceeded the specified `MAX_DEVIATION`.
+- `max_deviation`: Return the last `MAX_DEVIATION` value of the most
+ recent `SCREWS_TILT_CALCULATE` command.
- `results["<screw>"]`: A dictionary containing the following keys:
- `z`: The measured Z height of the screw location.
- `sign`: A string specifying the direction to turn to screw for the