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

#include <KnockSwitch.h>

Inheritance diagram for KnockSwitch:
DinamicPulseTrainDetector DigitalActuator

Public Member Functions

void init (uint8_t switchPin, bool switchOnLevel, uint8_t relayPin, bool relayOnLevel)
bool update ()
void setOnKnocks (uint8_t knocks)
void setOffKnocks (uint8_t knocks)
void setKnocks (uint8_t knocks)
void setKnocks (uint8_t onKnocks, uint8_t offKnocks)
bool isOn ()

Additional Inherited Members

- Private Member Functions inherited from DinamicPulseTrainDetector
void setExpectedPulses (uint8_t pulses)
void setDelays (unsigned int minDelay, unsigned int maxDelay)
void initDetector (uint8_t pulsePin, uint8_t pulseOnLevel)
boolean pulseTrainDetected ()
- Private Member Functions inherited from DigitalActuator
 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 ()

Detailed Description

Pulse train based switch.

Member Function Documentation

void KnockSwitch::init ( uint8_t  switchPin,
bool  switchOnLevel,
uint8_t  relayPin,
bool  relayOnLevel 
)
inline

Inits switch. Say pins and ON levels.

bool KnockSwitch::isOn ( )
inline

Check if it's on

void KnockSwitch::setKnocks ( uint8_t  knocks)
inline

Sets the the same number of knock to turn on/off.

void KnockSwitch::setKnocks ( uint8_t  onKnocks,
uint8_t  offKnocks 
)
inline

Sets the the number of knock to turn on/off.

void KnockSwitch::setOffKnocks ( uint8_t  knocks)
inline

Sets the number of pulses to turn off the switch

void KnockSwitch::setOnKnocks ( uint8_t  knocks)
inline

Sets the number of pulses to turn on the switch

bool KnockSwitch::update ( )
inline

Upadates state.


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