aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Status_Reference.md
diff options
context:
space:
mode:
authorFrank Tackitt <im@frank.af>2022-03-01 13:12:35 -0700
committerKevinOConnor <kevin@koconnor.net>2022-06-03 14:12:04 -0400
commit638cd4d7810d017996438c2c993948af31b0a579 (patch)
treed01dd01b3d712a7d24b640c5c36c385a755cc05b /docs/Status_Reference.md
parent89c59b035e93e87d2fc22010d7030dc86434ce03 (diff)
downloadkutter-638cd4d7810d017996438c2c993948af31b0a579.tar.gz
kutter-638cd4d7810d017996438c2c993948af31b0a579.tar.xz
kutter-638cd4d7810d017996438c2c993948af31b0a579.zip
docs: add exclude_object documentation
Also include sample macros to add M486 compatibility. Signed-off-by: Franklyn Tackitt <git@frank.af> Co-authored-by: Troy Jacobson <troy.d.jacobson@gmail.com>
Diffstat (limited to 'docs/Status_Reference.md')
-rw-r--r--docs/Status_Reference.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/Status_Reference.md b/docs/Status_Reference.md
index aac6fec0..a515901b 100644
--- a/docs/Status_Reference.md
+++ b/docs/Status_Reference.md
@@ -69,6 +69,44 @@ The following information is available in the
forward direction minus the total number of steps taken in the
reverse direction since the micro-controller was last restarted.
+## exclude_object
+
+The following information is available in the
+[exclude_object](Exclude_Object.md) object:
+
+- `objects`: An array of the known objects as provided by the
+ `EXCLUDE_OBJECT_DEFINE` command. This is the same information provided by
+ the `EXCLUDE_OBJECT VERBOSE=1` command. The `center` and `polygon` fields will
+ only be present if provided in the original `EXCLUDE_OBJECT_DEFINE`
+
+ Here is a JSON sample:
+```
+[
+ {
+ "polygon": [
+ [ 156.25, 146.2511675 ],
+ [ 156.25, 153.7488325 ],
+ [ 163.75, 153.7488325 ],
+ [ 163.75, 146.2511675 ]
+ ],
+ "name": "CYLINDER_2_STL_ID_2_COPY_0",
+ "center": [ 160, 150 ]
+ },
+ {
+ "polygon": [
+ [ 146.25, 146.2511675 ],
+ [ 146.25, 153.7488325 ],
+ [ 153.75, 153.7488325 ],
+ [ 153.75, 146.2511675 ]
+ ],
+ "name": "CYLINDER_2_STL_ID_1_COPY_0",
+ "center": [ 150, 150 ]
+ }
+]
+```
+- `excluded_objects`: An array of strings listing the names of excluded objects.
+- `current_object`: The name of the object currently being printed.
+
## fan
The following information is available in