aboutsummaryrefslogtreecommitdiffstats
path: root/docs/G-Codes.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2019-02-08 20:11:05 -0500
committerKevin O'Connor <kevin@koconnor.net>2019-02-12 13:38:13 -0500
commit2d7c3a84eefdb584e977747d0b8d84304571b50f (patch)
treeb2696ad66a5fed6160baa3ecff82797c2eeb181e /docs/G-Codes.md
parent57e6acbc5c0d479786e924d588b51b3bb34da92a (diff)
downloadkutter-2d7c3a84eefdb584e977747d0b8d84304571b50f.tar.gz
kutter-2d7c3a84eefdb584e977747d0b8d84304571b50f.tar.xz
kutter-2d7c3a84eefdb584e977747d0b8d84304571b50f.zip
manual_stepper: Add an "extras" module for manually controlling a stepper
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/G-Codes.md')
-rw-r--r--docs/G-Codes.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/G-Codes.md b/docs/G-Codes.md
index 38b90a13..77fd70e9 100644
--- a/docs/G-Codes.md
+++ b/docs/G-Codes.md
@@ -162,6 +162,21 @@ enabled:
- `SET_SERVO SERVO=config_name [WIDTH=<seconds>] [ENABLE=<0|1>]`
- `SET_SERVO SERVO=config_name [ANGLE=<degrees>] [ENABLE=<0|1>]`
+## Manual stepper Commands
+
+The following command is available when a "manual_stepper" config
+section is enabled:
+- `MANUAL_STEPPER STEPPER=config_name [ENABLE=[0|1]]
+ [SET_POSITION=<pos>]
+ [MOVE=<pos> SPEED=<speed> [STOP_ON_ENDSTOP=1]]`: This command will
+ alter the state of the stepper. Use the ENABLE parameter to
+ enable/disable the stepper. Use the SET_POSITION parameter to force
+ the stepper to think it is at the given position. Use the MOVE
+ parameter to request a movement to the given position at the given
+ SPEED. If STOP_ON_ENDSTOP is specified then the move will end early
+ should the endstop report as triggered (use STOP_ON_ENDSTOP=-1 to
+ stop early should the endstop report not triggered).
+
## Probe
The following commands are available when a "probe" config section is