ArduinoBasicIO  1.0
Make basic operations with Arduino easier
All Classes Functions Variables Pages
DigitalActuator Class Reference

#include <BaseOutputs.h>

Inheritance diagram for DigitalActuator:
ActuatorBase DigitalOutputPin ArduinoPin KnockSwitch

Public Member Functions

 DigitalActuator ()
 DigitalActuator (uint8_t pin, uint8_t onLevel=true)
void initActuator (uint8_t pin, uint8_t onLevel=true)
virtual void on ()
virtual void off ()
virtual bool isOn ()
virtual bool isOff ()

Protected Attributes

uint8_t highOn

Additional Inherited Members

- Protected Member Functions inherited from ActuatorBase
 ActuatorBase ()
 ActuatorBase (uint8_t pin)
virtual void initActuator (uint8_t pin)

Detailed Description

An easier way of handling on/off actuators. Choose the type of basic actuator you're using by indicating the value that turns the actuator on.

Constructor & Destructor Documentation

DigitalActuator::DigitalActuator ( )
inline

Default constructor

DigitalActuator::DigitalActuator ( uint8_t  pin,
uint8_t  onLevel = true 
)
inline

Pin setting included constructor.

Member Function Documentation

void DigitalActuator::initActuator ( uint8_t  pin,
uint8_t  onLevel = true 
)
inline

Output pin initialization to off.

Parameters
onLevelDigital level for turning the actuator on,opened,whatever. HIGH,true or any number bigger than 0 means the opposite of LOW,false or 0.
virtual bool DigitalActuator::isOff ( )
inlinevirtual

Check if it's off

Reimplemented from ActuatorBase.

virtual bool DigitalActuator::isOn ( )
inlinevirtual

Check if it's on

Reimplemented from ActuatorBase.

virtual void DigitalActuator::off ( )
inlinevirtual

Turn it off

Implements ActuatorBase.

virtual void DigitalActuator::on ( )
inlinevirtual

Turn it on

Implements ActuatorBase.


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