aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Status_Reference.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2021-07-19 22:28:40 -0400
committerKevin O'Connor <kevin@koconnor.net>2021-07-29 16:53:32 -0400
commit60aa05829fb3de744d8ef406b62bbdd26fb8c44b (patch)
tree43b764bde8e64bf5aa2980aff3d560c41fefcb18 /docs/Status_Reference.md
parent38766c367f09c17eb3b6cebb1952b342c26a7f95 (diff)
downloadkutter-60aa05829fb3de744d8ef406b62bbdd26fb8c44b.tar.gz
kutter-60aa05829fb3de744d8ef406b62bbdd26fb8c44b.tar.xz
kutter-60aa05829fb3de744d8ef406b62bbdd26fb8c44b.zip
motion_report: Add get_status() method with current requested toolhead position
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/Status_Reference.md')
-rw-r--r--docs/Status_Reference.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/Status_Reference.md b/docs/Status_Reference.md
index a15720fa..b9011428 100644
--- a/docs/Status_Reference.md
+++ b/docs/Status_Reference.md
@@ -189,6 +189,18 @@ The following information is available in
- `last_stats.<statistics_name>`: Statistics information on the
micro-controller connection.
+## motion_report
+
+The following information is available in the `motion_report` object
+(this object is automatically available if any stepper config section
+is defined):
+- `live_position`: The requested toolhead position interpolated to the
+ current time.
+- `live_velocity`: The requested toolhead velocity (in mm/s) at the
+ current time.
+- `live_extruder_velocity`: The requested extruder velocity (in mm/s)
+ at the current time.
+
## output_pin
The following information is available in