diff options
author | Kevin O'Connor <kevin@koconnor.net> | 2021-10-30 01:32:10 -0400 |
---|---|---|
committer | Kevin O'Connor <kevin@koconnor.net> | 2021-11-04 12:06:27 -0400 |
commit | 14cbc6f7548cdfe0d1d2b727a5cae63b2a242310 (patch) | |
tree | f41d9ff35c84b48987256724ec3fb1a433823b6e | |
parent | 689231df3a6c1ed606d227cce7115703b153193b (diff) | |
download | kutter-14cbc6f7548cdfe0d1d2b727a5cae63b2a242310.tar.gz kutter-14cbc6f7548cdfe0d1d2b727a5cae63b2a242310.tar.xz kutter-14cbc6f7548cdfe0d1d2b727a5cae63b2a242310.zip |
docs: Update MCU_Commands.md with new config_stepper command
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
-rw-r--r-- | docs/MCU_Commands.md | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/docs/MCU_Commands.md b/docs/MCU_Commands.md index 12e3f65c..9b8a4eb6 100644 --- a/docs/MCU_Commands.md +++ b/docs/MCU_Commands.md @@ -137,12 +137,17 @@ This section lists some commonly used config commands. sampled at regular interval using the query_analog_in command (see below). -* `config_stepper oid=%c step_pin=%c dir_pin=%c invert_step=%c` : This - command creates an internal stepper object. The 'step_pin' and - 'dir_pin' parameters specify the step and direction pins - respectively; this command will configure them in digital output - mode. The 'invert_step' parameter specifies whether a step occurs on - a rising edge (invert_step=0) or falling edge (invert_step=1). +* `config_stepper oid=%c step_pin=%c dir_pin=%c invert_step=%c + step_pulse_ticks=%u` : This command creates an internal stepper + object. The 'step_pin' and 'dir_pin' parameters specify the step and + direction pins respectively; this command will configure them in + digital output mode. The 'invert_step' parameter specifies whether a + step occurs on a rising edge (invert_step=0) or falling edge + (invert_step=1). The 'step_pulse_ticks' parameter specifies the + minimum duration of the step pulse. If the mcu exports the constant + 'STEPPER_BOTH_EDGE=1' then setting step_pulse_ticks=0 and + invert_step=-1 will setup for stepping on both the rising and + falling edges of the step pin. * `config_endstop oid=%c pin=%c pull_up=%c stepper_count=%c` : This command creates an internal "endstop" object. It is used to specify |