From b7ba3f11ce76a4bf7ef4f77b24e90eee420a9cce Mon Sep 17 00:00:00 2001 From: camrbuss Date: Mon, 4 May 2020 19:32:38 -0600 Subject: [PATCH] svd for FreeRTOS, state doc updates --- Firmware/.vscode/launch.json | 1 + docs/commands.md | 2 ++ docs/endstops.md | 2 +- 3 files changed, 4 insertions(+), 1 deletion(-) diff --git a/Firmware/.vscode/launch.json b/Firmware/.vscode/launch.json index 48fecec2..f512f3e8 100644 --- a/Firmware/.vscode/launch.json +++ b/Firmware/.vscode/launch.json @@ -30,6 +30,7 @@ "interface/stlink-v2.cfg", "target/stm32f4x_stlink.cfg", ], + "svdFile": "${workspaceRoot}/Board/v3/STM32F40x.svd", "cwd": "${workspaceRoot}" }, ] diff --git a/docs/commands.md b/docs/commands.md index 17c595b1..69a54982 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -40,6 +40,8 @@ The current state of an axis is indicated by `.current_state`. The user ca * Can only be entered if the motor is calibrated (`.motor.is_calibrated`) or the motor direction is unspecified (`.motor.config.direction == 1`) 10. `AXIS_STATE_ENCODER_DIR_FIND` Run encoder direction search. * Can only be entered if the motor is calibrated (`.motor.is_calibrated`). + 11. `AXIS_STATE_HOMING` Run axis homing function. + * Endstops must be enabled to use this feature. ### Startup Procedure diff --git a/docs/endstops.md b/docs/endstops.md index 87455825..46b08d9c 100644 --- a/docs/endstops.md +++ b/docs/endstops.md @@ -51,7 +51,7 @@ The debouncing time for this endstop. Most switches exhibit some sort of bounce ### is_active_high This is how you configure the endstop to be either "NPN" or "PNP". An "NPN" configuration would be `is_active_high = False` whereas a PNP configuration is `is_active_high = True`. Refer to the following table for more information: -3D printer endstops (like those that come with a RAMPS 1.4) are typically configuration **4**. +3D printer endstops (like those that come with a RAMPS 1.4) are typically configuration **4**. Typically configuration **1** or **3** is preferred when using mechanical switches as the most common failure mode leaves the switch open. ![Endstop configuration](Endstop_configuration.png)