From 28aa2f507a6d78d8bbba59f26e3011c028127d6e Mon Sep 17 00:00:00 2001 From: Kevin O'Connor Date: Fri, 12 Jul 2019 08:09:30 -0400 Subject: endstop: Rename mcu end_stop commands to endstop Rename the commands. The main reason for this change is to force a micro-controller code updated (due to important bugfix in 7fefe52d). Signed-off-by: Kevin O'Connor --- docs/MCU_Commands.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'docs/MCU_Commands.md') diff --git a/docs/MCU_Commands.md b/docs/MCU_Commands.md index f103af5f..32fb2618 100644 --- a/docs/MCU_Commands.md +++ b/docs/MCU_Commands.md @@ -161,15 +161,15 @@ This section lists some commonly used config commands. clock ticks since the last step. It is used as a check on the maximum stepper velocity that a stepper may have before stopping. -* `config_end_stop oid=%c pin=%c pull_up=%c stepper_count=%c` : This +* `config_endstop oid=%c pin=%c pull_up=%c stepper_count=%c` : This command creates an internal "endstop" object. It is used to specify the endstop pins and to enable "homing" operations (see the - end_stop_home command below). The command will configure the + endstop_home command below). The command will configure the specified pin in digital input mode. The 'pull_up' parameter determines whether hardware provided pullup resistors for the pin (if available) will be enabled. The 'stepper_count' parameter specifies the maximum number of steppers that this endstop may need - to halt during a homing operation (see end_stop_home below). + to halt during a homing operation (see endstop_home below). * `config_spi oid=%c bus=%u pin=%u mode=%u rate=%u shutdown_msg=%*s` : This command creates an internal SPI object. It is used with @@ -260,9 +260,9 @@ Stepper commands number of steps generated with dir=1 minus the total number of steps generated with dir=0. -* `end_stop_home oid=%c clock=%u sample_ticks=%u sample_count=%c +* `endstop_home oid=%c clock=%u sample_ticks=%u sample_count=%c rest_ticks=%u pin_value=%c` : This command is used during stepper - "homing" operations. To use this command a 'config_end_stop' command + "homing" operations. To use this command a 'config_endstop' command with the same 'oid' parameter must have been issued during micro-controller configuration. When this command is invoked, the micro-controller will sample the endstop pin every 'rest_ticks' -- cgit v1.2.3-70-g09d2