aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2017-03-05 15:00:15 -0500
committerKevin O'Connor <kevin@koconnor.net>2017-03-09 14:54:52 -0500
commita38437f378ece33cb762b482120be629c78d3540 (patch)
treea4a4ec60221aecbb3e41a5854f75bbaf629065d4 /docs
parent8d6ecd9af87d3e0da312588bacb1c43332412107 (diff)
downloadkutter-a38437f378ece33cb762b482120be629c78d3540.tar.gz
kutter-a38437f378ece33cb762b482120be629c78d3540.tar.xz
kutter-a38437f378ece33cb762b482120be629c78d3540.zip
stepper: Introduce stepper_get_position command and remove from endstop.c
Move the logic to calculate and report the stepper's current position from endstop.c to stepper.c. This localizes the stepper code into stepper.c. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs')
-rw-r--r--docs/Firmware_Commands.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/Firmware_Commands.md b/docs/Firmware_Commands.md
index a0f9a65c..63647c39 100644
--- a/docs/Firmware_Commands.md
+++ b/docs/Firmware_Commands.md
@@ -251,6 +251,12 @@ Stepper commands
so that the next step is relative to the supplied 'clock' time. The
host usually only sends this command at the start of a print.
+* stepper_get_position oid=%c : This command causes the firmware to
+ generate a "stepper_position" response message with the stepper's
+ current position. The position is the total number of steps
+ generated with dir=1 minus the total number of steps generated with
+ dir=0.
+
* end_stop_home oid=%c clock=%u rest_ticks=%u pin_value=%c : This
command is used during stepper "homing" operations. To use this
command a 'config_end_stop' command with the same 'oid' parameter