diff options
| author | Pedro Lamas <pedrolamas@gmail.com> | 2023-01-18 00:06:45 +0000 |
|---|---|---|
| committer | KevinOConnor <kevin@koconnor.net> | 2023-02-03 18:16:19 -0500 |
| commit | fa78e6b8fb392baf0a8fdcdda9fad7c0383bd1ff (patch) | |
| tree | efae63e2306581bd622df71bcfa26eaad8992475 /docs | |
| parent | d479366242cadc43775f74e0772c9c961c597ec4 (diff) | |
| download | kutter-fa78e6b8fb392baf0a8fdcdda9fad7c0383bd1ff.tar.gz kutter-fa78e6b8fb392baf0a8fdcdda9fad7c0383bd1ff.tar.xz kutter-fa78e6b8fb392baf0a8fdcdda9fad7c0383bd1ff.zip | |
screws_tilt_adjust: status result as dictionary
Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Config_Changes.md | 5 | ||||
| -rw-r--r-- | docs/Status_Reference.md | 9 |
2 files changed, 8 insertions, 6 deletions
diff --git a/docs/Config_Changes.md b/docs/Config_Changes.md index f77a9bd9..3a38fd40 100644 --- a/docs/Config_Changes.md +++ b/docs/Config_Changes.md @@ -8,6 +8,11 @@ All dates in this document are approximate. ## Changes +20230202: The format of the `printer.screws_tilt_adjust` status +information has changed. The information is now stored as a dictionary of +screws with the resulting measurements. See the +[status reference](Status_Reference.md#screws_tilt_adjust) for details. + 20230201: The `[bed_mesh]` module no longer loads the `default` profile on startup. It is recommended that users who use the `default` profile add `BED_MESH_PROFILE LOAD=default` to their `START_PRINT` macro (or diff --git a/docs/Status_Reference.md b/docs/Status_Reference.md index ff6a30bc..ef947f5b 100644 --- a/docs/Status_Reference.md +++ b/docs/Status_Reference.md @@ -376,20 +376,17 @@ 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`. -- `results`: A list of the probed screw locations. Each entry in - the list will be a dictionary containing the following keys: - - `name`: The name of the screw as specified in the config file. - - `x`: The X coordinate of the screw as specified in the config file. - - `y`: The Y coordinate of the screw as specified in the config file. +- `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 necessary adjustment. Either "CW" for clockwise or "CCW" for - counterclockwise. The base screw will not have a `sign` key. + counterclockwise. - `adjust`: The number of screw turns to adjust the screw, given in the format "HH:MM," where "HH" is the number of full screw turns and "MM" is the number of "minutes of a clock face" representing a partial screw turn. (E.g. "01:15" would mean to turn the screw one and a quarter revolutions.) + - `is_base`: Returns True if this is the base screw. ## servo |