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:30:29 -05:00 committed by GitHub
parent d78f6a2ce3
commit e958e07d0b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/Stepper.md
View File

@ -29,17 +29,17 @@ Click on either of the driver-specific classes above for complete details on how
The **StepperControl** class provides the following methods to operate and control a stepper motor object instantiated with one of the driver-specific classes described above:
* `void enable()`
* `StepperControl *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()`
* `StepperControl *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()`
* `StepperControl *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