ButtonToSwitch-4.0.1/docs/_button_to_switch_8h_source.html

#ifndef _BUTTONTOSWITCH_H_

#define _BUTTONTOSWITCH_H_


#include <Arduino.h>

#include <stdint.h>


//===========================>> BEGIN General use constant definitions

#define _HwMinDbncTime 20   //Documented minimum wait time for a MPB signal to stabilize

#define _StdPollDelay 10

#define _MinSrvcTime 100

#define _InvalidPinNum 0xFF // Value to give as "yet to be defined", the "Valid pin number" range and characteristics are development platform and environment related


/*---------- DbncdMPBttn complete status related constants, argument structs, information packing and unpacking BEGIN -------*/

const uint8_t IsOnBitPos {0};

const uint8_t IsEnabledBitPos{1};

const uint8_t PilotOnBitPos{2};

const uint8_t WrnngOnBitPos{3};

const uint8_t IsVoidedBitPos{4};

const uint8_t IsOnScndryBitPos{5};

const uint8_t OtptCurValBitPos{16};

//===========================>> END General use constant definitions


#ifndef MPBOTPTS_T

    #define MPBOTPTS_T


    struct MpbOtpts_t{

        bool isOn;

        bool isEnabled;

        bool pilotOn;

        bool wrnngOn;

        bool isVoided;

        bool isOnScndry;

        uint16_t otptCurVal;

    };


#endif

/*---------------- DbncdMPBttn complete status related constants, argument structs, information packing and unpacking END -------*/


// Definition workaround to let a function/method return value to be a function pointer

typedef void (*fncPtrType)();

typedef  fncPtrType (*ptrToTrnFnc)();


//===========================>> BEGIN General use function prototypes

MpbOtpts_t otptsSttsUnpkg(uint32_t pkgOtpts);

unsigned long int findMCD(unsigned long int a, unsigned long int b);

//===========================>> END General use function prototypes


//==========================================================>> Classes declarations BEGIN


class DbncdMPBttn{

    static DbncdMPBttn** _mpbsInstncsLstPtr;

    static unsigned long int _updTimerPeriod;

/*

 * This is the callback function to be executed by the TimerOne managed timer INT.

 *

 * The callback function duties:

 * - Verify for a valid **_mpbsInstncsLstPtr**, if it's nullptr something failed, correct it by disabling the timer

 * - Save the **current time** for reference and traverse the list till the end (nullptr).

 * - For each MPB in the list verify the _updTmrAttchd == true

 * - If _updTmrAttchd == true -> verify the ("current time" - _lstPollTime) >= _pollPeriodMs. If the condition is true:

 *  - Execute the objects mpbPollCallback()

 *  - Set _lstPollTime = "current time" *

 */

    static void _ISRMpbsRfrshCb();


protected:

    enum fdaDmpbStts {

        stOffNotVPP,

        stOffVPP,

        stOn,

        stOnVRP,

        stDisabled

    };

    const unsigned long int _stdMinDbncTime {_HwMinDbncTime};


    uint8_t _mpbttnPin{};

    bool _pulledUp{};

    bool _typeNO{};

    unsigned long int _dbncTimeOrigSett{};


    unsigned long int _dbncRlsTimerStrt{0};

    unsigned long int _dbncRlsTimeTempSett{0};

    unsigned long int _dbncTimerStrt{0};

    unsigned long int _dbncTimeTempSett{0};

    void (*_fnWhnTrnOff)() {nullptr};

    void (*_fnWhnTrnOn)() {nullptr};

    bool _isEnabled{true};

    volatile bool _isOn{false};

    bool _isOnDisabled{false};

    volatile bool _isPressed{false};

    unsigned long int _lstPollTime{0};

    fdaDmpbStts _mpbFdaState {stOffNotVPP};

    DbncdMPBttn* _mpbInstnc{nullptr};

    volatile bool _outputsChange {false};

    uint32_t _outputsChangeCnt{0};

    unsigned long int _pollPeriodMs{0};

    bool _prssRlsCcl{false};

    unsigned long int _strtDelay {0};

    bool _sttChng {true};

    bool _updTmrAttchd{false};

    volatile bool _validDisablePend{false};

    volatile bool _validEnablePend{false};

    volatile bool _validPressPend{false};

    volatile bool _validReleasePend{false};


   void clrSttChng();

    const bool getIsPressed() const;

    virtual void mpbPollCallback();

    virtual uint32_t _otptsSttsPkg(uint32_t prevVal = 0);

    void _popMpb(DbncdMPBttn** &DMpbTmrUpdLst, DbncdMPBttn* mpbToPop);

    void _pushMpb(DbncdMPBttn** &DMpbTmrUpdLst, DbncdMPBttn* mpbToPush);

    void _setIsEnabled(const bool &newEnabledValue);

    void _setLstPollTime(const unsigned long int &newLstPollTIme);

    void setSttChng();

    void _turnOff();

    void _turnOn();

    virtual void updFdaState();

    bool updIsPressed();

    unsigned long int _updTmrsMCDCalc();

    virtual bool updValidPressesStatus();


public:

    DbncdMPBttn();

    DbncdMPBttn(const uint8_t &mpbttnPin, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0);

    virtual ~DbncdMPBttn();

    virtual bool begin(const unsigned long int &pollDelayMs = _StdPollDelay);

    void clrStatus(bool clrIsOn = true);

    void disable();

    void enable();

    bool end();

    const unsigned long int getCurDbncTime() const;

    fncPtrType getFnWhnTrnOff();

    fncPtrType getFnWhnTrnOn();

    const bool getIsEnabled() const;

    const bool getIsOn () const;

    const bool getIsOnDisabled() const;

    const unsigned long int getLstPollTime();

    const uint32_t getOtptsSttsPkgd();

    const bool getOutputsChange() const;

    const unsigned long int getPollPeriodMs();

    unsigned long int getStrtDelay();

    bool getUpdTmrAttchd();

    bool init(const uint8_t &mpbttnPin, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0);

    bool pause();

    void resetDbncTime();

    void resetFda();

    bool resume();

    bool setDbncTime(const unsigned long int &newDbncTime);

    void setFnWhnTrnOffPtr(void(*newFnWhnTrnOff)());

    void setFnWhnTrnOnPtr(void (*newFnWhnTrnOn)());

    void setIsOnDisabled(const bool &newIsOnDisabled);

    void setOutputsChange(bool newOutputsChange);

};


//==========================================================>>


class DbncdDlydMPBttn: public DbncdMPBttn{

public:

    DbncdDlydMPBttn();

    DbncdDlydMPBttn(const uint8_t &mpbttnPin, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0, const unsigned long int &strtDelay = 0);

    bool init(const uint8_t &mpbttnPin, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0, const unsigned long int &strtDelay = 0);

    void setStrtDelay(const unsigned long int &newStrtDelay);

};


//==========================================================>>


class LtchMPBttn: public DbncdDlydMPBttn{

protected:

    enum fdaLmpbStts {

        stOffNotVPP,

        stOffVPP,

        stOnNVRP,

        stOnVRP,

        stLtchNVUP,

        stLtchdVUP,

        stOffVUP,

        stOffNVURP,

        stOffVURP,

        stDisabled

    };

    bool _isLatched{false};

    fdaLmpbStts _mpbFdaState {stOffNotVPP};

    bool _trnOffASAP{true};

    volatile bool _validUnlatchPend{false};

    volatile bool _validUnlatchRlsPend{false};


    virtual void mpbPollCallback();

    virtual void stDisabled_In(){};

    virtual void stDisabled_Out(){};

    virtual void stLtchNVUP_Do(){};

    virtual void stOffNotVPP_In(){};

    virtual void stOffNotVPP_Out(){};

    virtual void stOffNVURP_Do(){};

    virtual void stOffVPP_Out(){};

    virtual void stOffVURP_Out(){};

    virtual void stOnNVRP_Do(){};

    virtual void updFdaState();

    virtual void updValidUnlatchStatus() = 0;

public:

    LtchMPBttn(const uint8_t &mpbttnPin, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0, const unsigned long int &strtDelay = 0);

    virtual bool begin(const unsigned long int &pollDelayMs = _StdPollDelay);

    void clrStatus(bool clrIsOn = true);

    const bool getIsLatched() const;

    bool getTrnOffASAP();

    const bool getUnlatchPend() const;

    const bool getUnlatchRlsPend() const;

    void setTrnOffASAP(const bool &newVal);

    void setUnlatchPend(const bool &newVal);

    void setUnlatchRlsPend(const bool &newVal);

    bool unlatch();

};


//==========================================================>>


class TgglLtchMPBttn: public LtchMPBttn{

protected:

    virtual void stOffNVURP_Do();

    virtual void updValidUnlatchStatus();

public:

    TgglLtchMPBttn(const uint8_t &mpbttnPin, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0, const unsigned long int &strtDelay = 0);

};


//==========================================================>>


class TmLtchMPBttn: public LtchMPBttn{

protected:

    bool _tmRstbl {true};

    unsigned long int _srvcTime {};

    unsigned long int _srvcTimerStrt{0};


    virtual void stOffNotVPP_Out();

    virtual void stOffVPP_Out();

    virtual void updValidUnlatchStatus();

public:

    TmLtchMPBttn(const uint8_t &mpbttnPin, const unsigned long int &svcTime, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0, const unsigned long int &strtDelay = 0);

    void clrStatus(bool clrIsOn = true);

    const unsigned long int getSrvcTime() const;

    bool setSrvcTime(const unsigned long int &newSrvcTime);

    void setTmerRstbl(const bool &newIsRstbl);

};


//==========================================================>>


class HntdTmLtchMPBttn: public TmLtchMPBttn{

protected:

    void (*_fnWhnTrnOffPilot)() {nullptr};

    void (*_fnWhnTrnOffWrnng)() {nullptr};

    void (*_fnWhnTrnOnPilot)() {nullptr};

    void (*_fnWhnTrnOnWrnng)() {nullptr};

    bool _keepPilot{false};

    volatile bool _pilotOn{false};

    unsigned long int _wrnngMs{0};

    volatile bool _wrnngOn {false};

    unsigned int _wrnngPrctg {0};


    bool _validWrnngSetPend{false};

    bool _validWrnngResetPend{false};

    bool _validPilotSetPend{false};

    bool _validPilotResetPend{false};


    virtual void mpbPollCallback();

    uint32_t _otptsSttsPkg(uint32_t prevVal = 0);

    virtual void stDisabled_In();

    virtual void stLtchNVUP_Do();

    virtual void stOffNotVPP_In();

    virtual void stOffVPP_Out();

    virtual void stOnNVRP_Do();

    void _turnOffPilot();

    void _turnOffWrnng();

    void _turnOnPilot();

    void _turnOnWrnng();

    bool updPilotOn();

    bool updWrnngOn();

public:

    HntdTmLtchMPBttn(const uint8_t &mpbttnPin, const unsigned long int &svcTime, const unsigned int &wrnngPrctg = 0, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0, const unsigned long int &strtDelay = 0);

    virtual bool begin(const unsigned long int &pollDelayMs = _StdPollDelay);

    void clrStatus(bool clrIsOn = true);

    fncPtrType getFnWhnTrnOffPilot();

    fncPtrType getFnWhnTrnOffWrnng();

    fncPtrType getFnWhnTrnOnPilot();

    fncPtrType getFnWhnTrnOnWrnng();

    const bool getPilotOn() const;

    const bool getWrnngOn() const;

    void setFnWhnTrnOffPilotPtr(void(*newFnWhnTrnOff)());

    void setFnWhnTrnOffWrnngPtr(void(*newFnWhnTrnOff)());

    void setFnWhnTrnOnPilotPtr(void(*newFnWhnTrnOn)());

    void setFnWhnTrnOnWrnngPtr(void(*newFnWhnTrnOn)());

    void setKeepPilot(const bool &newKeepPilot);

    bool setSrvcTime(const unsigned long int &newSvcTime);

    bool setWrnngPrctg (const unsigned int &newWrnngPrctg);

};


//==========================================================>>


class XtrnUnltchMPBttn: public LtchMPBttn{

protected:

    DbncdDlydMPBttn* _unLtchBttn {nullptr};

    bool _xtrnUnltchPRlsCcl {false};


    virtual void stOffNVURP_Do();

    virtual void updValidUnlatchStatus();

public:

    XtrnUnltchMPBttn(const uint8_t &mpbttnPin,  DbncdDlydMPBttn* unLtchBttn,

        const bool &pulledUp,  const bool &typeNO,  const unsigned long int &dbncTimeOrigSett,  const unsigned long int &strtDelay);

    XtrnUnltchMPBttn(const uint8_t &mpbttnPin,

        const bool &pulledUp,  const bool &typeNO,  const unsigned long int &dbncTimeOrigSett,  const unsigned long int &strtDelay);


    virtual bool begin(const unsigned long int &pollDelayMs = _StdPollDelay);

    void clrStatus(bool clrIsOn = true);

};


//==========================================================>>


class DblActnLtchMPBttn: public LtchMPBttn{

protected:

    enum fdaDALmpbStts{

        stOffNotVPP,

        stOffVPP,

        stOnMPBRlsd,

        //--------

        stOnStrtScndMod,

        stOnScndMod,

        stOnEndScndMod,

        //--------

        stOnTurnOff,

        //--------

        stDisabled

    };

   volatile bool _isOnScndry{false};

    fdaDALmpbStts _mpbFdaState {stOffNotVPP};

    unsigned long _scndModActvDly {2000};

    unsigned long _scndModTmrStrt {0};

    bool _validScndModPend{false};


    void (*_fnWhnTrnOffScndry)() {nullptr};

    void (*_fnWhnTrnOnScndry)() {nullptr};


    virtual void mpbPollCallback();

   virtual void stDisabled_In(){};

   virtual void stOnEndScndMod_Out(){};

   virtual void stOnScndMod_Do() = 0;

    virtual void stOnStrtScndMod_In(){};

    virtual void _turnOffScndry();

    virtual void _turnOnScndry();

    virtual void updFdaState();

    virtual bool updValidPressesStatus();

   virtual void updValidUnlatchStatus();


public:

   DblActnLtchMPBttn(const uint8_t &mpbttnPin, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0, const unsigned long int &strtDelay = 0);

    ~DblActnLtchMPBttn();

   virtual bool begin(const unsigned long int &pollDelayMs = _StdPollDelay);

   void clrStatus(bool clrIsOn = true);

    fncPtrType getFnWhnTrnOffScndry();

    fncPtrType getFnWhnTrnOnScndry();

   bool getIsOnScndry();

   unsigned long getScndModActvDly();

    void setFnWhnTrnOffScndryPtr(void(*newFnWhnTrnOff)());

    void setFnWhnTrnOnScndryPtr(void (*newFnWhnTrnOn)());

    bool setScndModActvDly(const unsigned long &newVal);

};


//==========================================================>>


class DDlydDALtchMPBttn: public DblActnLtchMPBttn{

protected:

    uint32_t _otptsSttsPkg(uint32_t prevVal = 0);

   // virtual void stDisabled_In();

   virtual void stOnEndScndMod_Out();

   virtual void stOnScndMod_Do();

   virtual void stOnStrtScndMod_In();

public:

   DDlydDALtchMPBttn(const uint8_t &mpbttnPin, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0, const unsigned long int &strtDelay = 0);

   ~DDlydDALtchMPBttn();

   void clrStatus(bool clrIsOn = true);

};


//==========================================================>>


class SldrDALtchMPBttn: public DblActnLtchMPBttn{


protected:

    bool _autoSwpDirOnEnd{true};    // Changes slider direction automatically when reaches _otptValMax or _otptValMin

    bool _autoSwpDirOnPrss{false};// Changes slider direction each time it enters slider mode

    bool _curSldrDirUp{true};

    uint16_t _initOtptCurVal{};

    uint16_t _otptCurVal{};

    unsigned long _otptSldrSpd{1};

    uint16_t _otptSldrStpSize{0x01};

    uint16_t _otptValMax{0xFFFF};

    uint16_t _otptValMin{0x0000};


    uint32_t _otptsSttsPkg(uint32_t prevVal = 0);

    bool _setSldrDir(const bool &newVal);

   // virtual void stDisabled_In();

    void stOnEndScndMod_Out();

   virtual void stOnScndMod_Do();

    virtual void stOnStrtScndMod_In();

public:

    SldrDALtchMPBttn(const uint8_t &mpbttnPin, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0, const unsigned long int &strtDelay = 0, const uint16_t initVal = 0xFFFF);

    ~SldrDALtchMPBttn();

   void clrStatus(bool clrIsOn = true);

   uint16_t getOtptCurVal();

   bool getOtptCurValIsMax();

   bool getOtptCurValIsMin();

    unsigned long getOtptSldrSpd();

    uint16_t getOtptSldrStpSize();

   uint16_t getOtptValMax();

    uint16_t getOtptValMin();

    bool getSldrDirUp();

    bool setOtptCurVal(const uint16_t &newVal);

    bool setOtptSldrSpd(const uint16_t &newVal);

    bool setOtptSldrStpSize(const uint16_t &newVal);

    bool setOtptValMax(const uint16_t &newVal);

    bool setOtptValMin(const uint16_t &newVal);

    bool setSldrDirDn();

    bool setSldrDirUp();

    void setSwpDirOnEnd(const bool &newVal);

    void setSwpDirOnPrss(const bool &newVal);

    bool swapSldrDir();

};


//==========================================================>>


class VdblMPBttn: public DbncdDlydMPBttn{

private:

   void setFrcdOtptWhnVdd(const bool &newVal);

   void setStOnWhnOtpFrcd(const bool &newVal);

protected:

    enum fdaVmpbStts{

        stOffNotVPP,

        stOffVPP,

        stOnNVRP,

        //--------

        stOnVVP,

        stOnVddNVUP,

        stOffVddNVUP,

        stOffVddVUP,

        stOffUnVdd,

        //--------

        stOnVRP,

        stOnTurnOff,

        stOff,

        //--------

        stDisabled

    };

    fdaVmpbStts _mpbFdaState {stOffNotVPP};


    void (*_fnWhnTrnOffVdd)() {nullptr};

    void (*_fnWhnTrnOnVdd)() {nullptr};

    bool _frcOtptLvlWhnVdd {true};

    bool _isVoided{false};

    bool _stOnWhnOtptFrcd{false};

    bool _validVoidPend{false};

    bool _validUnvoidPend{false};


    virtual void mpbPollCallback();

    uint32_t _otptsSttsPkg(uint32_t prevVal = 0);

    bool setVoided(const bool &newVoidValue);

    virtual void stDisabled_In();

    virtual void stDisabled_Out();

    virtual void stOffNotVPP_In(){};

    virtual void stOffVddNVUP_Do(){};   //This provides a setting point for calculating the _validUnvoidPend

    virtual void stOffVPP_Do(){};   // This provides a setting point for the voiding mechanism to be started

    void _turnOffVdd();

    void _turnOnVdd();

    virtual void updFdaState();

    virtual bool updVoidStatus() = 0;

public:

    VdblMPBttn(const uint8_t &mpbttnPin, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0, const unsigned long int &strtDelay = 0, const bool &isOnDisabled = false);

    virtual ~VdblMPBttn();

    void clrStatus(bool clrIsOn = true);

    fncPtrType getFnWhnTrnOffVdd();

    fncPtrType getFnWhnTrnOnVdd();

    bool getFrcOtptLvlWhnVdd();

    const bool getIsVoided() const;

    bool getStOnWhnOtpFrcd();

    void setFnWhnTrnOffVddPtr(void(*newFnWhnTrnOff)());

    void setFnWhnTrnOnVddPtr(void(*newFnWhnTrnOn)());

    bool setIsNotVoided();

    bool setIsVoided();

};


//==========================================================>>


class TmVdblMPBttn: public VdblMPBttn{

protected:

    unsigned long int _voidTime;

    unsigned long int _voidTmrStrt{0};


    virtual void stOffNotVPP_In();

    virtual void stOffVddNVUP_Do(); //This provides a setting point for calculating the _validUnvoidPend

    virtual void stOffVPP_Do(); // This provides a setting point for the voiding mechanism to be started

    bool updIsPressed();

    virtual bool updVoidStatus();

public:

    TmVdblMPBttn(const uint8_t &mpbttnPin, unsigned long int voidTime, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0, const unsigned long int &strtDelay = 0, const bool &isOnDisabled = false);

    virtual ~TmVdblMPBttn();

    virtual bool begin(const unsigned long int &pollDelayMs = _StdPollDelay);

    void clrStatus();

    const unsigned long int getVoidTime() const;

    bool setVoidTime(const unsigned long int &newVoidTime);

};


//==========================================================>>


class SnglSrvcVdblMPBttn: public VdblMPBttn{

protected:

   virtual void stOffVddNVUP_Do();  //This provides the calculation for the _validUnvoidPend

   virtual bool updVoidStatus();

public:

    SnglSrvcVdblMPBttn(const uint8_t &mpbttnPin, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0, const unsigned long int &strtDelay = 0);

   virtual ~SnglSrvcVdblMPBttn();

   virtual bool begin(const unsigned long int &pollDelayMs = _StdPollDelay);

};


//==========================================================>>


#endif   /*_BUTTONTOSWITCH_H_*/

DDlydDALtchMPBttn
Models a Debounced Delayed Double Action Latched MPB combo switch (Debounced Delayed DALDD-MPB - DD-D...
Definition ButtonToSwitch.h:1150

DDlydDALtchMPBttn::clrStatus
void clrStatus(bool clrIsOn=true)
See DbncddMPBttn::clrStatus(bool)
Definition ButtonToSwitch.cpp:1955

DDlydDALtchMPBttn::~DDlydDALtchMPBttn
~DDlydDALtchMPBttn()
Class virtual destructor.
Definition ButtonToSwitch.cpp:1951

DDlydDALtchMPBttn::DDlydDALtchMPBttn
DDlydDALtchMPBttn(const uint8_t &mpbttnPin, const bool &pulledUp=true, const bool &typeNO=true, const unsigned long int &dbncTimeOrigSett=0, const unsigned long int &strtDelay=0)
Class constructor.
Definition ButtonToSwitch.cpp:1946

DblActnLtchMPBttn
Abstract class, base to model Double Action LDD-MPBs (DALDD-MPBs).
Definition ButtonToSwitch.h:1018

DblActnLtchMPBttn::setScndModActvDly
bool setScndModActvDly(const unsigned long &newVal)
Sets a new value for the scndModActvDly class attribute.
Definition ButtonToSwitch.cpp:1689

DblActnLtchMPBttn::setFnWhnTrnOnScndryPtr
void setFnWhnTrnOnScndryPtr(void(*newFnWhnTrnOn)())
Sets the function that will be called to execute every time the object enters the Secondary On State.
Definition ButtonToSwitch.cpp:1682

DblActnLtchMPBttn::getFnWhnTrnOnScndry
fncPtrType getFnWhnTrnOnScndry()
Returns the function that is set to execute every time the object enters the Secondary On State.
Definition ButtonToSwitch.cpp:1646

DblActnLtchMPBttn::clrStatus
void clrStatus(bool clrIsOn=true)
See DbncddMPBttn::clrStatus(bool)
Definition ButtonToSwitch.cpp:1631

DblActnLtchMPBttn::getIsOnScndry
bool getIsOnScndry()
Returns the current value of the isOnScndry attribute flag.
Definition ButtonToSwitch.cpp:1651

DblActnLtchMPBttn::getScndModActvDly
unsigned long getScndModActvDly()
Returns the current value of the scndModActvDly class attribute.
Definition ButtonToSwitch.cpp:1656

DblActnLtchMPBttn::begin
virtual bool begin(const unsigned long int &pollDelayMs=_StdPollDelay)
See DbncdMPBttn::begin(const unsigned long int)
Definition ButtonToSwitch.cpp:1623

DblActnLtchMPBttn::setFnWhnTrnOffScndryPtr
void setFnWhnTrnOffScndryPtr(void(*newFnWhnTrnOff)())
Sets the function that will be called to execute every time the object enters the Secondary Off State...
Definition ButtonToSwitch.cpp:1674

DblActnLtchMPBttn::getFnWhnTrnOffScndry
fncPtrType getFnWhnTrnOffScndry()
returns the function that is set to execute every time the object enters the Secondary Off State.
Definition ButtonToSwitch.cpp:1641

DblActnLtchMPBttn::~DblActnLtchMPBttn
~DblActnLtchMPBttn()
Virtual destructor.
Definition ButtonToSwitch.cpp:1619

DblActnLtchMPBttn::DblActnLtchMPBttn
DblActnLtchMPBttn(const uint8_t &mpbttnPin, const bool &pulledUp=true, const bool &typeNO=true, const unsigned long int &dbncTimeOrigSett=0, const unsigned long int &strtDelay=0)
Abstract Class constructor.
Definition ButtonToSwitch.cpp:1614

DbncdDlydMPBttn
Models a Debounced Delayed MPB (DD-MPB).
Definition ButtonToSwitch.h:493

DbncdDlydMPBttn::DbncdDlydMPBttn
DbncdDlydMPBttn()
Default constructor.
Definition ButtonToSwitch.cpp:794

DbncdDlydMPBttn::setStrtDelay
void setStrtDelay(const unsigned long int &newStrtDelay)
Sets a new value to the "Start Delay" strtDelay attribute.
Definition ButtonToSwitch.cpp:815

DbncdDlydMPBttn::init
bool init(const uint8_t &mpbttnPin, const bool &pulledUp=true, const bool &typeNO=true, const unsigned long int &dbncTimeOrigSett=0, const unsigned long int &strtDelay=0)
see DbncdMPBttn::init(const uint8_t, const bool, const bool, const unsigned long int)
Definition ButtonToSwitch.cpp:805

DbncdMPBttn
Base class, models a Debounced Momentary Push Button (D-MPB).
Definition ButtonToSwitch.h:120

DbncdMPBttn::getFnWhnTrnOn
fncPtrType getFnWhnTrnOn()
Returns the function that is set to execute every time the object enters the On State.
Definition ButtonToSwitch.cpp:200

DbncdMPBttn::getPollPeriodMs
const unsigned long int getPollPeriodMs()
Returns the poll period time setting attribute's value.
Definition ButtonToSwitch.cpp:240

DbncdMPBttn::resetFda
void resetFda()
Resets the MPB behavior automaton to it's Initial or Start State
Definition ButtonToSwitch.cpp:420

DbncdMPBttn::clrStatus
void clrStatus(bool clrIsOn=true)
Clears and resets flags, timers and counters modified through the object's signals processing.
Definition ButtonToSwitch.cpp:140

DbncdMPBttn::getCurDbncTime
const unsigned long int getCurDbncTime() const
Returns the current debounce period time set for the object.
Definition ButtonToSwitch.cpp:190

DbncdMPBttn::enable
void enable()
Enables the input signal processing.
Definition ButtonToSwitch.cpp:169

DbncdMPBttn::pause
bool pause()
Pauses the software timer updating the computation of the object's internal flags value (object's sta...
Definition ButtonToSwitch.cpp:292

DbncdMPBttn::~DbncdMPBttn
virtual ~DbncdMPBttn()
Default virtual destructor.
Definition ButtonToSwitch.cpp:109

DbncdMPBttn::setIsOnDisabled
void setIsOnDisabled(const bool &newIsOnDisabled)
Sets the value of the isOnDisabled attribute.
Definition ButtonToSwitch.cpp:517

DbncdMPBttn::init
bool init(const uint8_t &mpbttnPin, const bool &pulledUp=true, const bool &typeNO=true, const unsigned long int &dbncTimeOrigSett=0)
Initializes an object instantiated by the default constructor.
Definition ButtonToSwitch.cpp:255

DbncdMPBttn::end
bool end()
Detaches the object from the timer that monitors the input pins, compute and updates the object's sta...
Definition ButtonToSwitch.cpp:174

DbncdMPBttn::begin
virtual bool begin(const unsigned long int &pollDelayMs=_StdPollDelay)
Attaches the instantiated object to a timer that monitors the input pins and updates the object statu...
Definition ButtonToSwitch.cpp:114

DbncdMPBttn::resetDbncTime
void resetDbncTime()
Resets the debounce process time of the object to the value used at instantiation.
Definition ButtonToSwitch.cpp:414

DbncdMPBttn::DbncdMPBttn
DbncdMPBttn()
Default class constructor.
Definition ButtonToSwitch.cpp:84

DbncdMPBttn::disable
void disable()
Disables the input signal processing, ignoring the changes of its values.
Definition ButtonToSwitch.cpp:164

DbncdMPBttn::resume
bool resume()
Restarts the software timer updating the calculation of the object internal flags.
Definition ButtonToSwitch.cpp:428

DbncdMPBttn::getIsEnabled
const bool getIsEnabled() const
Returns the value of the isEnabled attribute flag, indicating the Enabled or Disabled status of the o...
Definition ButtonToSwitch.cpp:205

DbncdMPBttn::getLstPollTime
const unsigned long int getLstPollTime()
Returns the time stamp of the last state update for the object.
Definition ButtonToSwitch.cpp:225

DbncdMPBttn::getIsOnDisabled
const bool getIsOnDisabled() const
Returns the value of the isOnDisabled attribute.
Definition ButtonToSwitch.cpp:215

DbncdMPBttn::setFnWhnTrnOffPtr
void setFnWhnTrnOffPtr(void(*newFnWhnTrnOff)())
Sets the function that will be called to execute every time the object enters the Off State.
Definition ButtonToSwitch.cpp:483

DbncdMPBttn::getOutputsChange
const bool getOutputsChange() const
Returns the value of the outputsChange attribute flag.
Definition ButtonToSwitch.cpp:235

DbncdMPBttn::getIsOn
const bool getIsOn() const
Returns the value of the isOn attribute flag.
Definition ButtonToSwitch.cpp:210

DbncdMPBttn::getUpdTmrAttchd
bool getUpdTmrAttchd()
Returns the value of the Attached to the update timer attribute.
Definition ButtonToSwitch.cpp:250

DbncdMPBttn::setFnWhnTrnOnPtr
void setFnWhnTrnOnPtr(void(*newFnWhnTrnOn)())
Sets the function that will be called to execute every time the object enters the On State.
Definition ButtonToSwitch.cpp:492

DbncdMPBttn::getStrtDelay
unsigned long int getStrtDelay()
Returns the current value of strtDelay attribute.
Definition ButtonToSwitch.cpp:245

DbncdMPBttn::getOtptsSttsPkgd
const uint32_t getOtptsSttsPkgd()
Returns the relevant attribute flags values for the object state encoded as a 32 bits value.
Definition ButtonToSwitch.cpp:230

DbncdMPBttn::getFnWhnTrnOff
fncPtrType getFnWhnTrnOff()
Returns the function that is set to execute every time the object enters the Off State.
Definition ButtonToSwitch.cpp:195

DbncdMPBttn::setOutputsChange
void setOutputsChange(bool newOutputsChange)
Sets the value of the attribute flag indicating if a change took place in any of the output attribute...
Definition ButtonToSwitch.cpp:540

DbncdMPBttn::setDbncTime
bool setDbncTime(const unsigned long int &newDbncTime)
Sets the debounce process time.
Definition ButtonToSwitch.cpp:468

HntdTmLtchMPBttn
Models a Hinted Timer Latch DD-MPB, a.k.a. Staircase Switch (HTiLDD-MPB).
Definition ButtonToSwitch.h:768

HntdTmLtchMPBttn::setSrvcTime
bool setSrvcTime(const unsigned long int &newSvcTime)
See TmLtchMPBttn::setSrvcTime(const unsigned long int)
Definition ButtonToSwitch.cpp:1337

HntdTmLtchMPBttn::getFnWhnTrnOnPilot
fncPtrType getFnWhnTrnOnPilot()
Returns the function that is set to execute every time the object's Pilot attribute flag enters the O...
Definition ButtonToSwitch.cpp:1248

HntdTmLtchMPBttn::setFnWhnTrnOffWrnngPtr
void setFnWhnTrnOffWrnngPtr(void(*newFnWhnTrnOff)())
Sets the function that will be called to execute every time the object's Warning is reset.
Definition ButtonToSwitch.cpp:1309

HntdTmLtchMPBttn::getFnWhnTrnOffWrnng
fncPtrType getFnWhnTrnOffWrnng()
Returns the function that is set to execute every time the object's Warning attribute flag enters the...
Definition ButtonToSwitch.cpp:1243

HntdTmLtchMPBttn::getWrnngOn
const bool getWrnngOn() const
Returns the current value of the warningOn attribute flag.
Definition ButtonToSwitch.cpp:1263

HntdTmLtchMPBttn::setFnWhnTrnOnPilotPtr
void setFnWhnTrnOnPilotPtr(void(*newFnWhnTrnOn)())
Sets the function that will be called to execute every time the object's Pilot is set.
Definition ButtonToSwitch.cpp:1316

HntdTmLtchMPBttn::HntdTmLtchMPBttn
HntdTmLtchMPBttn(const uint8_t &mpbttnPin, const unsigned long int &svcTime, const unsigned int &wrnngPrctg=0, const bool &pulledUp=true, const bool &typeNO=true, const unsigned long int &dbncTimeOrigSett=0, const unsigned long int &strtDelay=0)
Class constructor.
Definition ButtonToSwitch.cpp:1207

HntdTmLtchMPBttn::getPilotOn
const bool getPilotOn() const
Returns the current value of the pilotOn attribute flag.
Definition ButtonToSwitch.cpp:1258

HntdTmLtchMPBttn::clrStatus
void clrStatus(bool clrIsOn=true)
see DbncdMPBttn::clrStatus(bool)
Definition ButtonToSwitch.cpp:1221

HntdTmLtchMPBttn::getFnWhnTrnOffPilot
fncPtrType getFnWhnTrnOffPilot()
Returns the function that is set to execute every time the object's Pilot attribute flag enters the O...
Definition ButtonToSwitch.cpp:1238

HntdTmLtchMPBttn::setFnWhnTrnOnWrnngPtr
void setFnWhnTrnOnWrnngPtr(void(*newFnWhnTrnOn)())
Sets the function that will be called to execute every time the object's Wrnng is set.
Definition ButtonToSwitch.cpp:1323

HntdTmLtchMPBttn::setWrnngPrctg
bool setWrnngPrctg(const unsigned int &newWrnngPrctg)
Sets the value for the percentage of service time for calculating the warningOn flag value.
Definition ButtonToSwitch.cpp:1349

HntdTmLtchMPBttn::getFnWhnTrnOnWrnng
fncPtrType getFnWhnTrnOnWrnng()
Returns the function that is set to execute every time the object's Warning attribute flag enters the...
Definition ButtonToSwitch.cpp:1253

HntdTmLtchMPBttn::begin
virtual bool begin(const unsigned long int &pollDelayMs=_StdPollDelay)
See DbncdMPBttn::begin(const unsigned long int)
Definition ButtonToSwitch.cpp:1213

HntdTmLtchMPBttn::setFnWhnTrnOffPilotPtr
void setFnWhnTrnOffPilotPtr(void(*newFnWhnTrnOff)())
Sets the function that will be called to execute every time the object's Pilot is reset.
Definition ButtonToSwitch.cpp:1302

HntdTmLtchMPBttn::setKeepPilot
void setKeepPilot(const bool &newKeepPilot)
Sets the configuration of the keepPilot service attribute.
Definition ButtonToSwitch.cpp:1330

LtchMPBttn
Abstract class, base to model Latched Debounced Delayed MPBs (LDD-MPB).
Definition ButtonToSwitch.h:549

LtchMPBttn::getIsLatched
const bool getIsLatched() const
Returns the value of the isLatched attribute flag, indicating the Latched or Unlatched condition of t...
Definition ButtonToSwitch.cpp:846

LtchMPBttn::unlatch
bool unlatch()
Sets the values of the flags needed to unlatch a latched MPB.
Definition ButtonToSwitch.cpp:902

LtchMPBttn::getUnlatchRlsPend
const bool getUnlatchRlsPend() const
Returns the value of the "Valid Unlatch Release Pending" attribute.
Definition ButtonToSwitch.cpp:861

LtchMPBttn::LtchMPBttn
LtchMPBttn(const uint8_t &mpbttnPin, const bool &pulledUp=true, const bool &typeNO=true, const unsigned long int &dbncTimeOrigSett=0, const unsigned long int &strtDelay=0)
Class constructor.
Definition ButtonToSwitch.cpp:824

LtchMPBttn::getUnlatchPend
const bool getUnlatchPend() const
Returns the value of the "Valid Unlatch Pending" attribute.
Definition ButtonToSwitch.cpp:856

LtchMPBttn::setUnlatchPend
void setUnlatchPend(const bool &newVal)
Sets the value of the "Valid Unlatch Pending" attribute.
Definition ButtonToSwitch.cpp:888

LtchMPBttn::setTrnOffASAP
void setTrnOffASAP(const bool &newVal)
Sets the value of the trnOffASAP attribute.
Definition ButtonToSwitch.cpp:881

LtchMPBttn::getTrnOffASAP
bool getTrnOffASAP()
Returns the value of the trnOffASAP attribute flag.
Definition ButtonToSwitch.cpp:851

LtchMPBttn::setUnlatchRlsPend
void setUnlatchRlsPend(const bool &newVal)
Sets the value of the "Valid Unlatch Release Pending" attribute.
Definition ButtonToSwitch.cpp:895

LtchMPBttn::begin
virtual bool begin(const unsigned long int &pollDelayMs=_StdPollDelay)
See DbncdMPBttn::begin(const unsigned long int)
Definition ButtonToSwitch.cpp:829

LtchMPBttn::clrStatus
void clrStatus(bool clrIsOn=true)
See DbncdMPBttn::clrStatus(bool)
Definition ButtonToSwitch.cpp:837

SldrDALtchMPBttn
Models a Slider Double Action LDD-MPB combo switch, a.k.a. off/on/dimmer, a.k.a. off/on/volume radio ...
Definition ButtonToSwitch.h:1193

SldrDALtchMPBttn::clrStatus
void clrStatus(bool clrIsOn=true)
Definition ButtonToSwitch.cpp:2018

SldrDALtchMPBttn::setOtptSldrSpd
bool setOtptSldrSpd(const uint16_t &newVal)
Sets the output slider speed (otptSldrSpd) attribute.
Definition ButtonToSwitch.cpp:2087

SldrDALtchMPBttn::getOtptValMax
uint16_t getOtptValMax()
Returns the top output current value register setting.
Definition ButtonToSwitch.cpp:2052

SldrDALtchMPBttn::getOtptCurValIsMin
bool getOtptCurValIsMin()
Returns the result of comparing the Output Current Value to the Minimum value setting
Definition ButtonToSwitch.cpp:2037

SldrDALtchMPBttn::setSldrDirDn
bool setSldrDirDn()
Sets the value of the curSldrDirUp attribute to false.
Definition ButtonToSwitch.cpp:2170

SldrDALtchMPBttn::setOtptValMax
bool setOtptValMax(const uint16_t &newVal)
Sets the output current value register maximum value attribute (otptValMax attribute).
Definition ButtonToSwitch.cpp:2113

SldrDALtchMPBttn::swapSldrDir
bool swapSldrDir()
Inverts the current curSldrDirUp attribute value.
Definition ButtonToSwitch.cpp:2280

SldrDALtchMPBttn::~SldrDALtchMPBttn
~SldrDALtchMPBttn()
Virtual class destructor.
Definition ButtonToSwitch.cpp:2014

SldrDALtchMPBttn::setOtptCurVal
bool setOtptCurVal(const uint16_t &newVal)
Sets the output current value register.
Definition ButtonToSwitch.cpp:2074

SldrDALtchMPBttn::getOtptCurVal
uint16_t getOtptCurVal()
Returns the Output Current Value (otpCurVal) attribute.
Definition ButtonToSwitch.cpp:2027

SldrDALtchMPBttn::setSldrDirUp
bool setSldrDirUp()
Sets the value of the curSldrDirUp attribute to true.
Definition ButtonToSwitch.cpp:2175

SldrDALtchMPBttn::getSldrDirUp
bool getSldrDirUp()
Returns the value of the curSldrDirUp attribute.
Definition ButtonToSwitch.cpp:2062

SldrDALtchMPBttn::setOtptSldrStpSize
bool setOtptSldrStpSize(const uint16_t &newVal)
Sets the output slider step size (otptSldrStpSize) attribute value.
Definition ButtonToSwitch.cpp:2100

SldrDALtchMPBttn::getOtptCurValIsMax
bool getOtptCurValIsMax()
Returns a boolean value indicating if the "Output Current Value" equals the maximum limit.
Definition ButtonToSwitch.cpp:2032

SldrDALtchMPBttn::SldrDALtchMPBttn
SldrDALtchMPBttn(const uint8_t &mpbttnPin, const bool &pulledUp=true, const bool &typeNO=true, const unsigned long int &dbncTimeOrigSett=0, const unsigned long int &strtDelay=0, const uint16_t initVal=0xFFFF)
Class constructor.
Definition ButtonToSwitch.cpp:2008

SldrDALtchMPBttn::setSwpDirOnPrss
void setSwpDirOnPrss(const bool &newVal)
Sets the value of the "Auto-Swap Direction On Press" (autoSwpDirOnPrss) attribute.
Definition ButtonToSwitch.cpp:2187

SldrDALtchMPBttn::setOtptValMin
bool setOtptValMin(const uint16_t &newVal)
Sets the output current value register minimum value attribute (otptValMin attribute).
Definition ButtonToSwitch.cpp:2132

SldrDALtchMPBttn::getOtptValMin
uint16_t getOtptValMin()
Returns the bottom output current value register setting.
Definition ButtonToSwitch.cpp:2057

SldrDALtchMPBttn::getOtptSldrSpd
unsigned long getOtptSldrSpd()
Returns the current setting for the Output Slider Speed value.
Definition ButtonToSwitch.cpp:2042

SldrDALtchMPBttn::getOtptSldrStpSize
uint16_t getOtptSldrStpSize()
Returns the current setting for the Output Slider Step Size value.
Definition ButtonToSwitch.cpp:2047

SldrDALtchMPBttn::setSwpDirOnEnd
void setSwpDirOnEnd(const bool &newVal)
Sets the value of the "Auto-Swap Direction on Ends" (autoSwpDirOnEnd) attribute.
Definition ButtonToSwitch.cpp:2180

SnglSrvcVdblMPBttn
Models a Single Service Voidable DD-MPB a.k.a. Trigger switch (SSVDD-MPB)
Definition ButtonToSwitch.h:1674

SnglSrvcVdblMPBttn::begin
virtual bool begin(const unsigned long int &pollDelayMs=_StdPollDelay)
See DbncdMPBttn::begin(const unsigned long int)
Definition ButtonToSwitch.cpp:2733

SnglSrvcVdblMPBttn::SnglSrvcVdblMPBttn
SnglSrvcVdblMPBttn(const uint8_t &mpbttnPin, const bool &pulledUp=true, const bool &typeNO=true, const unsigned long int &dbncTimeOrigSett=0, const unsigned long int &strtDelay=0)
Class constructor.
Definition ButtonToSwitch.cpp:2721

SnglSrvcVdblMPBttn::~SnglSrvcVdblMPBttn
virtual ~SnglSrvcVdblMPBttn()
Class virtual destructor.
Definition ButtonToSwitch.cpp:2729

TgglLtchMPBttn
Models a Toggle Latch DD-MPB, a.k.a. a Toggle Switch (ToLDD-MPB).
Definition ButtonToSwitch.h:681

TgglLtchMPBttn::TgglLtchMPBttn
TgglLtchMPBttn(const uint8_t &mpbttnPin, const bool &pulledUp=true, const bool &typeNO=true, const unsigned long int &dbncTimeOrigSett=0, const unsigned long int &strtDelay=0)
Class constructor.
Definition ButtonToSwitch.cpp:1104

TmLtchMPBttn
Models a Timer Latch DD-MPB, a.k.a. Timer Switch (TiLDD-MPB).
Definition ButtonToSwitch.h:705

TmLtchMPBttn::getSrvcTime
const unsigned long int getSrvcTime() const
Returns the configured Service Time.
Definition ButtonToSwitch.cpp:1153

TmLtchMPBttn::setTmerRstbl
void setTmerRstbl(const bool &newIsRstbl)
Configures the timer for the Service Time to be reseted before it reaches unlatching time.
Definition ButtonToSwitch.cpp:1170

TmLtchMPBttn::setSrvcTime
bool setSrvcTime(const unsigned long int &newSrvcTime)
Sets a new value to the Service Time attribute.
Definition ButtonToSwitch.cpp:1158

TmLtchMPBttn::clrStatus
void clrStatus(bool clrIsOn=true)
see DbncdMPBttn::clrStatus(bool)
Definition ButtonToSwitch.cpp:1146

TmLtchMPBttn::TmLtchMPBttn
TmLtchMPBttn(const uint8_t &mpbttnPin, const unsigned long int &svcTime, const bool &pulledUp=true, const bool &typeNO=true, const unsigned long int &dbncTimeOrigSett=0, const unsigned long int &strtDelay=0)
Class constructor.
Definition ButtonToSwitch.cpp:1138

TmVdblMPBttn
Models a Time Voidable DD-MPB, a.k.a. Anti-tampering switch (TVDD-MPB)
Definition ButtonToSwitch.h:1605

TmVdblMPBttn::~TmVdblMPBttn
virtual ~TmVdblMPBttn()
Class virtual destructor.
Definition ButtonToSwitch.cpp:2643

TmVdblMPBttn::clrStatus
void clrStatus()
See DbncdMPBttn::clrStatus(bool)
Definition ButtonToSwitch.cpp:2655

TmVdblMPBttn::begin
virtual bool begin(const unsigned long int &pollDelayMs=_StdPollDelay)
See DbncdMPBttn::begin(const unsigned long int)
Definition ButtonToSwitch.cpp:2647

TmVdblMPBttn::TmVdblMPBttn
TmVdblMPBttn(const uint8_t &mpbttnPin, unsigned long int voidTime, const bool &pulledUp=true, const bool &typeNO=true, const unsigned long int &dbncTimeOrigSett=0, const unsigned long int &strtDelay=0, const bool &isOnDisabled=false)
Class constructor.
Definition ButtonToSwitch.cpp:2638

TmVdblMPBttn::getVoidTime
const unsigned long int getVoidTime() const
Returns the voidTime attribute current value.
Definition ButtonToSwitch.cpp:2662

TmVdblMPBttn::setVoidTime
bool setVoidTime(const unsigned long int &newVoidTime)
Sets a new value to the Void Time attribute.
Definition ButtonToSwitch.cpp:2667

VdblMPBttn
Abstract class, base to model Voidable DD-MPBs (VDD-MPB).
Definition ButtonToSwitch.h:1449

VdblMPBttn::setIsVoided
bool setIsVoided()
Sets the value of the isVoided attribute flag to true.
Definition ButtonToSwitch.cpp:2383

VdblMPBttn::getIsVoided
const bool getIsVoided() const
Returns the current value of the isVoided attribute flag.
Definition ButtonToSwitch.cpp:2321

VdblMPBttn::getFnWhnTrnOnVdd
fncPtrType getFnWhnTrnOnVdd()
Returns the function that is set to execute every time the object enters the Voided or "Voided On" St...
Definition ButtonToSwitch.cpp:2311

VdblMPBttn::clrStatus
void clrStatus(bool clrIsOn=true)
See DbncdMPBttn::clrStatus(bool)
Definition ButtonToSwitch.cpp:2297

VdblMPBttn::setFnWhnTrnOnVddPtr
void setFnWhnTrnOnVddPtr(void(*newFnWhnTrnOn)())
Sets the function that will be called to execute every time the object's isVoided attribute flag is s...
Definition ButtonToSwitch.cpp:2364

VdblMPBttn::~VdblMPBttn
virtual ~VdblMPBttn()
Default virtual destructor.
Definition ButtonToSwitch.cpp:2293

VdblMPBttn::getFnWhnTrnOffVdd
fncPtrType getFnWhnTrnOffVdd()
Returns the function that is set to execute every time the object exits the Voided State.
Definition ButtonToSwitch.cpp:2306

VdblMPBttn::setFnWhnTrnOffVddPtr
void setFnWhnTrnOffVddPtr(void(*newFnWhnTrnOff)())
Sets the function that will be called to execute every time the object's isVoided attribute flag is r...
Definition ButtonToSwitch.cpp:2356

VdblMPBttn::getFrcOtptLvlWhnVdd
bool getFrcOtptLvlWhnVdd()
Returns the value of the frcOtptLvlWhnVdd attribute.
Definition ButtonToSwitch.cpp:2316

VdblMPBttn::getStOnWhnOtpFrcd
bool getStOnWhnOtpFrcd()
Returns the value of the frcOtptLvlWhnVdd attribute.
Definition ButtonToSwitch.cpp:2326

VdblMPBttn::setIsNotVoided
bool setIsNotVoided()
Sets the value of the isVoided attribute flag to false.
Definition ButtonToSwitch.cpp:2378

VdblMPBttn::VdblMPBttn
VdblMPBttn(const uint8_t &mpbttnPin, const bool &pulledUp=true, const bool &typeNO=true, const unsigned long int &dbncTimeOrigSett=0, const unsigned long int &strtDelay=0, const bool &isOnDisabled=false)
Class constructor.
Definition ButtonToSwitch.cpp:2287

XtrnUnltchMPBttn
Models an External Unlatch LDD-MPB, a.k.a. Emergency Latched Switch (XULDD-MPB)
Definition ButtonToSwitch.h:949

XtrnUnltchMPBttn::clrStatus
void clrStatus(bool clrIsOn=true)
See DbncdMPBttn::clrStatus(bool)
Definition ButtonToSwitch.cpp:1571

XtrnUnltchMPBttn::XtrnUnltchMPBttn
XtrnUnltchMPBttn(const uint8_t &mpbttnPin, DbncdDlydMPBttn *unLtchBttn, const bool &pulledUp, const bool &typeNO, const unsigned long int &dbncTimeOrigSett, const unsigned long int &strtDelay)
Class constructor.
Definition ButtonToSwitch.cpp:1543

XtrnUnltchMPBttn::begin
virtual bool begin(const unsigned long int &pollDelayMs=_StdPollDelay)
See DbncdMPBttn::begin(const unsigned long int)
Definition ButtonToSwitch.cpp:1555

MpbOtpts_t
Type to hold the complete set of output attribute flags from any DbncdMPBttn class and subclasses obj...
Definition ButtonToSwitch.h:63