Skip to content

Commit 0de53b2

Browse files
committed
docs: add info about Gstat message 'graphics-gcode-properties'
1 parent bc074fd commit 0de53b2

7 files changed

Lines changed: 22 additions & 3 deletions

docs/src/gui/gstat.adoc

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -406,9 +406,28 @@ This depends on the widget/libraries used.
406406
intended to be sent when a G-code error is found when loading. +
407407
This depends on the widget/libraries used.
408408

409-
*graphics-gcode-properties* :: '(returns string)' -
410-
intended to be sent when G-code is loaded. +
411-
This depends on the widget/libraries used.
409+
*graphics-gcode-properties* :: '(returns Python dict)' -
410+
Sent when G-code is loaded. +
411+
The dict contains the following keys:
412+
- `name` (_string_): Name of the loaded file
413+
- `size` (_string_): Size in bytes and lines
414+
- `g0` (_string_): Total rapid distance
415+
- `g1` (_string_): Total feed distance
416+
- `run` (_string_): Estimated program run time
417+
- `toollist` (_list_): List of used tools
418+
- `x` (_string_): X extents (bounds) ^1^
419+
- `x_zero_rxy` (_string_): X extents without rotation around z (bounds) ^1^
420+
- `y` (_string_): Y extents (bounds) ^1^
421+
- `y_zero_rxy` (_string_): Y extents without rotation around z (bounds) ^1^
422+
- `z` (_string_): Z extents (bounds) ^1^
423+
- `z_zero_rxy` (_string_): Z extents without rotation around z (bounds) ^1^
424+
- `machine_unit_sys` (_string_): Machine units ('Metric' or 'Imperial')
425+
- `gcode_units` (_string_): Units in G-code file ('mm' or 'in')
426+
+
427+
[NOTE]
428+
====
429+
1. See the images image:images/gremlin_extents_non-rotated_link.png[align="left",link="images/gremlin_extents_non-rotated.png",alt="extends non-rotated"] and image:images/gremlin_extents_rotated_30_link.png[align="left",link="images/gremlin_extents_rotated_30.png",alt="extends rotated 30"] for a better understanding.
430+
====
412431

413432
*graphics-view-changed* :: '(returns string, Python dict or None)' -
414433
intended to be sent when graphics view is changed. +
14.5 KB
Loading
2.04 KB
Loading
3.8 KB
Loading
19.1 KB
Loading
2.81 KB
Loading
6.19 KB
Loading

0 commit comments

Comments
 (0)