Seich
/
HomeSpan
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update Stepper.md

This commit is contained in:
HomeSpan 2023-07-08 18:00:47 -05:00 committed by GitHub
parent 6aedec5a2d
commit d78f6a2ce3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/Stepper.md
View File

@ -31,13 +31,19 @@ The **StepperControl** class provides the following methods to operate and contr
* `void enable()` * `void enable()`
* enables current flow to the stepper motor coils, actively holding the motor in its position * 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()` * `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 * 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()` * `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 * 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 * 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)` * `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 * 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