From d78f6a2ce3d8232c2babab5009a9ac7a12c5342a Mon Sep 17 00:00:00 2001 From: HomeSpan Date: Sat, 8 Jul 2023 18:00:47 -0500 Subject: [PATCH] Update Stepper.md --- docs/Stepper.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/Stepper.md b/docs/Stepper.md index 41bd94f..06146d3 100644 --- a/docs/Stepper.md +++ b/docs/Stepper.md @@ -31,13 +31,19 @@ The **StepperControl** class provides the following methods to operate and contr * `void enable()` * enables current flow to the stepper motor coils, actively holding the motor in its position - + * returns pointer to itself so methods can be daisy-chained + * example: `myMotor=(new Stepper_TB6612(23,32,22,14,33,27))->enable();` + * `void disable()` * disables current flow to the stepper motor coils and leaves them in a state of high impedence, allowing the motor to turn freely + * returns pointer to itself so methods can be daisy-chained + * example: `myMotor=(new Stepper_TB6612(23,32,22,14,33,27))->disable();` * `void brake()` * disables current flow to the stepper motor coils but leaves them in a state of low impedence, preventing the motor from freely turning * applicable only for driver chips that support a "short brake" mode, otherwise has no effect + * returns pointer to itself so methods can be daisy-chained + * example: `myMotor=(new Stepper_TB6612(23,32,22,14,33,27))->brake();` * `void move(int nSteps, uint32_t msDelay, endAction_t endAction=NONE)` * enables the stepper motor and turns it *nSteps* steps. Note this is a **non-blocking** function and returns immediately after being called while the motor turns for *nSteps* steps in the background