JMotorDriverDual Class Reference

control two JMotorDrivers (of any type) as if they are one driver More...

#include <JMotorDriverDual.h>

Inheritance diagram for JMotorDriverDual:

Collaboration diagram for JMotorDriverDual:

Public Member Functions
	JMotorDriverDual (JMotorDriver &_m1, JMotorDriver &_m2)
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
JMotorDriver &	m1
JMotorDriver &	m2

Detailed Description

control two JMotorDrivers (of any type) as if they are one driver

Note

one (or both) of the drivers may be another dual driver allowing for controlling more than two motors together

Constructor & Destructor Documentation

JMotorDriverDual()

JMotorDriverDual::JMotorDriverDual ( JMotorDriver &  _m1, JMotorDriver &  _m2  )

inline

Member Function Documentation

getEnable()

bool JMotorDriverDual::getEnable ( )

inlinevirtual

get the enable state of the driver

Return values

(bool)

true if enabled, false if disabled

Reimplemented from JMotorDriver.

getMaxRange()

float JMotorDriverDual::getMaxRange ( )

inlinevirtual

high end of the range

Note

usually 1.0

Return values

(float)

maxRange

Reimplemented from JMotorDriver.

getMinRange()

float JMotorDriverDual::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()

bool JMotorDriverDual::set ( float  val )

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()

bool JMotorDriverDual::setEnable ( bool  _enable )

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

m1

JMotorDriver& JMotorDriverDual::m1

m2

JMotorDriver& JMotorDriverDual::m2

---

The documentation for this class was generated from the following file:

• src/JMotorDriver/JMotorDriverDual.h