for motor controllers with one direction input and one speed input pin More...
#include <JMotorDriverAvrPWMDir.h>
Inheritance diagram for JMotorDriverAvrPWMDir:
Collaboration diagram for JMotorDriverAvrPWMDir:
Public Member Functions | |
| JMotorDriverAvrPWMDir (byte _speedPin, byte _dirPin, bool _rev=false) | |
| constructor, sets pins | |
| bool | set (float val) |
| set motor power | |
| bool | setEnable (bool _enable) |
| use to enable or disable a motor, and sets up pin states | |
| bool | getEnable () |
| get the enable state of the driver | |
| float | getMaxRange () |
| high end of the range | |
| float | getMinRange () |
| low end of the range | |
 Public Member Functions inherited from JMotorDriver | |
| bool | enable () |
| enable motor | |
| bool | disable () |
| disable motor | |
Public Attributes | |
| bool | reverse = false |
| JMotorDriverAvrPWM | pwmDriver |
Detailed Description
for motor controllers with one direction input and one speed input pin
- Note
- compatible with all boards that support analogWrite()
Constructor & Destructor Documentation
◆ JMotorDriverAvrPWMDir()
|
inline |
constructor, sets pins
- Note
- speed pin must be PWM capable
- Parameters
-
_speedPin speed input to motor controller (PWM) _dirPin direction input to motor controller (digital) _rev = false: if false(default), direction pin set HIGH for positive speed, LOW for negative speed
Member Function Documentation
◆ getEnable()
|
inlinevirtual |
get the enable state of the driver
- Return values
-
(bool) true if enabled, false if disabled
Reimplemented from JMotorDriver.
◆ getMaxRange()
|
inlinevirtual |
high end of the range
- Note
- usually 1.0
- Return values
-
(float) maxRange
Reimplemented from JMotorDriver.
◆ getMinRange()
|
inlinevirtual |
low end of the range
- Note
- usually -1.0, if 0, that indicates a motor controller with no reverse function
- Return values
-
(float) minRange
Reimplemented from JMotorDriver.
◆ set()
|
inlinevirtual |
set motor power
- Note
- val should be between getMinRange and getMaxRange, but constrained internally
- Parameters
-
val (float) val
- Return values
-
(bool) false if at end of power range, true otherwise
Reimplemented from JMotorDriver.
◆ setEnable()
|
inlinevirtual |
use to enable or disable a motor, and sets up pin states
- Note
- setEnable(true) must be called before a motor driver will activate
- Parameters
-
_enable (bool) true=enable, false=disable
- Return values
-
(bool) true if state changed, false if state already set
Reimplemented from JMotorDriver.
Member Data Documentation
◆ pwmDriver
| JMotorDriverAvrPWM JMotorDriverAvrPWMDir::pwmDriver |
◆ reverse
| bool JMotorDriverAvrPWMDir::reverse = false |
The documentation for this class was generated from the following file:
- src/JMotorDriver/JMotorDriverAvrPWMDir.h
