diff options
| author | theophile <chmeredith@gmail.com> | 2022-12-17 10:39:25 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-12-17 11:39:25 -0500 |
| commit | 2a25733cd8d32bf7c02c896da0ce7964d7474ba6 (patch) | |
| tree | 358cb345787754b78ad8f054560dbbcf9ae46571 /docs | |
| parent | 3c1ed3bb2731b49249d6aaacf01248783e4c8bf6 (diff) | |
| download | kutter-2a25733cd8d32bf7c02c896da0ce7964d7474ba6.tar.gz kutter-2a25733cd8d32bf7c02c896da0ce7964d7474ba6.tar.xz kutter-2a25733cd8d32bf7c02c896da0ce7964d7474ba6.zip | |
screws_tilt_adjust: Add get_status() method (#5921)
Signed-off-by: Christopher Meredith <chmeredith@gmail.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Status_Reference.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/Status_Reference.md b/docs/Status_Reference.md index e6595ddb..ff6a30bc 100644 --- a/docs/Status_Reference.md +++ b/docs/Status_Reference.md @@ -369,6 +369,28 @@ The following information is available in the `query_endstops` object the QUERY_ENDSTOP command must be run prior to the macro containing this reference. +## screws_tilt_adjust + +The following information is available in the `screws_tilt_adjust` +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. + - `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. + - `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.) + ## servo The following information is available in |