ButtonToSwitch_ESP32-4.3.1/docs/_button_to_switch___e_s_p32_8h_source.html

#ifndef _BUTTONTOSWITCH_ESP32_H_

#define _BUTTONTOSWITCH_ESP32_H_


#include <Arduino.h>

#include <stdint.h>


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

#define _StdPollDelay 10

#define _MinSrvcTime 100

#define _InvalidPinNum GPIO_NUM_NC  //Not Connected pin number (in this hardware platform -1), so a signed numeric type must be used! Value to give as "yet to be defined pin"

#define _maxValidPinNum GPIO_NUM_MAX-1


/*---------------- xTaskNotify() mechanism 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};


#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

/*---------------- xTaskNotify() mechanism 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);

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


//===========================>> BEGIN General use Global variables

//===========================>> END General use Global variables


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


class DbncdMPBttn{

protected:

    enum fdaDmpbStts {

        stOffNotVPP,

        stOffVPP,

        stOn,

        stOnVRP,

        stDisabled

    };

    const unsigned long int _stdMinDbncTime {_HwMinDbncTime};


    int8_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};

    fncPtrType _fnWhnTrnOff{nullptr};

    fncPtrType _fnWhnTrnOn{nullptr};

    bool _isEnabled{true};

    volatile bool _isOn{false};

    bool _isOnDisabled{false};

    volatile bool _isPressed{false};

    fdaDmpbStts _mpbFdaState {stOffNotVPP};

    TimerHandle_t _mpbPollTmrHndl {NULL};   //FreeRTOS returns NULL if creation fails (not nullptr)

    String _mpbPollTmrName {""};

    bool _outputsChange {false};

    uint32_t _outputsChangeCnt{0};

    bool _outputsChngTskTrggr{false};

    bool _prssRlsCcl{false};

    unsigned long int _strtDelay {0};

    bool _sttChng {true};

    TaskHandle_t _taskToNotifyHndl {NULL};

    TaskHandle_t _taskWhileOnHndl{NULL};

    volatile bool _validDisablePend{false};

    volatile bool _validEnablePend{false};

    volatile bool _validPressPend{false};

    volatile bool _validReleasePend{false};


   void clrSttChng();

    const bool getIsPressed() const;

    static void mpbPollCallback(TimerHandle_t mpbTmrCbArg);

    virtual uint32_t _otptsSttsPkg(uint32_t prevVal = 0);

    void _setIsEnabled(const bool &newEnabledValue);

    void setSttChng();

    void _turnOff();

    void _turnOn();

    virtual void updFdaState();

    bool updIsPressed();

    virtual bool updValidPressesStatus();

    const bool getOutputsChngTskTrggr() const;

    void resetOutputsChngTskTrggr();


public:

    DbncdMPBttn();

    DbncdMPBttn(const int8_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 uint32_t getOtptsSttsPkgd();

    const bool getOutputsChange() const;

    // const bool getOutputsChngTskTrggr() const;

    unsigned long int getStrtDelay();

    const TaskHandle_t getTaskToNotify() const;

    const TaskHandle_t getTaskWhileOn();

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

    bool pause();

    void resetDbncTime();

    void resetFda();

    // void resetOutputsChngTskTrggr();

    bool resume();

    bool setDbncTime(const unsigned long int &newDbncTime);

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

    void setFnWhnTrnOffPtr(fncPtrType newFnWhnTrnOff);


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

    void setFnWhnTrnOnPtr(fncPtrType newFnWhnTrnOn);

    void setIsOnDisabled(const bool &newIsOnDisabled);

    void setOutputsChange(bool newOutputsChange);

    void setTaskToNotify(const TaskHandle_t &newTaskHandle);

    virtual void setTaskWhileOn(const TaskHandle_t &newTaskHandle);

};


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


class DbncdDlydMPBttn: public DbncdMPBttn{

public:

    DbncdDlydMPBttn();

    DbncdDlydMPBttn(const int8_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 int8_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};


    static void mpbPollCallback(TimerHandle_t mpbTmrCbArg);


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

    LtchMPBttn(const int8_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();

    TgglLtchMPBttn(const int8_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();

    TmLtchMPBttn(const int8_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};


    static void mpbPollCallback(TimerHandle_t mpbTmrCbArg);

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

    HntdTmLtchMPBttn(const int8_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();

    XtrnUnltchMPBttn(const int8_t &mpbttnPin,  DbncdDlydMPBttn* unLtchBttn,

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

    XtrnUnltchMPBttn(const int8_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};

    TaskHandle_t _taskWhileOnScndryHndl{NULL};


    static void mpbPollCallback(TimerHandle_t mpbTmrCbArg);

    virtual uint32_t _otptsSttsPkg(uint32_t prevVal = 0);

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

   DblActnLtchMPBttn(const int8_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();

    const TaskHandle_t getTaskWhileOnScndry();

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

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

    bool setScndModActvDly(const unsigned long &newVal);

    void setTaskWhileOnScndry(const TaskHandle_t &newTaskHandle);


};


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


class DDlydDALtchMPBttn: public DblActnLtchMPBttn{

protected:

   virtual void stOnEndScndMod_Out();

   virtual void stOnScndMod_Do();

   virtual void stOnStrtScndMod_In();

public:

    DDlydDALtchMPBttn();

   DDlydDALtchMPBttn(const int8_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};


    virtual uint32_t _otptsSttsPkg(uint32_t prevVal = 0);

    bool _setSldrDir(const bool &newVal);

    void stOnEndScndMod_Out();

   virtual void stOnScndMod_Do();

    virtual void stOnStrtScndMod_In();

public:

    SldrDALtchMPBttn();

    SldrDALtchMPBttn(const int8_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};


    static void mpbPollCallback(TimerHandle_t mpbTmrCb);

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

    VdblMPBttn(const int8_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();

    TmVdblMPBttn(const int8_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 setTaskWhileOn(const TaskHandle_t &newTaskHandle);

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

   virtual bool updVoidStatus();

public:

    SnglSrvcVdblMPBttn();

    SnglSrvcVdblMPBttn(const int8_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_ESP32_H_*/

otptsSttsUnpkg
MpbOtpts_t otptsSttsUnpkg(uint32_t pkgOtpts)
Unpackages a 32-bit value into a DbncdMPBttn object status.
Definition ButtonToSwitch_ESP32.cpp:3120

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

DDlydDALtchMPBttn::clrStatus
void clrStatus(bool clrIsOn=true)
See DbncddMPBttn::clrStatus(bool)
Definition ButtonToSwitch_ESP32.cpp:2209

DDlydDALtchMPBttn::~DDlydDALtchMPBttn
~DDlydDALtchMPBttn()
Class virtual destructor.
Definition ButtonToSwitch_ESP32.cpp:2205

DDlydDALtchMPBttn::DDlydDALtchMPBttn
DDlydDALtchMPBttn()
Default class constructor.
Definition ButtonToSwitch_ESP32.cpp:2196

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

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

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_ESP32.cpp:1878

DblActnLtchMPBttn::getTaskWhileOnScndry
const TaskHandle_t getTaskWhileOnScndry()
Returns the task to be run while the object is in the Secondary On state.
Definition ButtonToSwitch_ESP32.cpp:1823

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

DblActnLtchMPBttn::clrStatus
void clrStatus(bool clrIsOn=true)
See DbncddMPBttn::clrStatus(bool)
Definition ButtonToSwitch_ESP32.cpp:1789

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

DblActnLtchMPBttn::DblActnLtchMPBttn
DblActnLtchMPBttn()
Abstract Class default constructor.
Definition ButtonToSwitch_ESP32.cpp:1752

DblActnLtchMPBttn::setTaskWhileOnScndry
void setTaskWhileOnScndry(const TaskHandle_t &newTaskHandle)
Sets the task to be run while the object is in the On state.
Definition ButtonToSwitch_ESP32.cpp:1905

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

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

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_ESP32.cpp:1868

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

DblActnLtchMPBttn::~DblActnLtchMPBttn
~DblActnLtchMPBttn()
Virtual destructor.
Definition ButtonToSwitch_ESP32.cpp:1761

DbncdDlydMPBttn
Models a Debounced Delayed MPB (DD-MPB).
Definition ButtonToSwitch_ESP32.h:479

DbncdDlydMPBttn::DbncdDlydMPBttn
DbncdDlydMPBttn()
Default constructor.
Definition ButtonToSwitch_ESP32.cpp:752

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

DbncdDlydMPBttn::init
bool init(const int8_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 int8_t, const bool, const bool, const unsigned long int)
Definition ButtonToSwitch_ESP32.cpp:763

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

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

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

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

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

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

DbncdMPBttn::getTaskWhileOn
const TaskHandle_t getTaskWhileOn()
Returns the task to be run (resumed) while the object is in the On state.
Definition ButtonToSwitch_ESP32.cpp:210

DbncdMPBttn::enable
void enable()
Enables the input signal processing.
Definition ButtonToSwitch_ESP32.cpp:126

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

DbncdMPBttn::getTaskToNotify
const TaskHandle_t getTaskToNotify() const
Returns the task to be notified by the object when its output flags changes.
Definition ButtonToSwitch_ESP32.cpp:204

DbncdMPBttn::~DbncdMPBttn
virtual ~DbncdMPBttn()
Default virtual destructor.
Definition ButtonToSwitch_ESP32.cpp:64

DbncdMPBttn::setTaskWhileOn
virtual void setTaskWhileOn(const TaskHandle_t &newTaskHandle)
Sets the task to be run while the object is in the On state.
Definition ButtonToSwitch_ESP32.cpp:495

DbncdMPBttn::setIsOnDisabled
void setIsOnDisabled(const bool &newIsOnDisabled)
Sets the value of the isOnDisabled attribute flag.
Definition ButtonToSwitch_ESP32.cpp:420

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

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_ESP32.cpp:69

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

DbncdMPBttn::DbncdMPBttn
DbncdMPBttn()
Default class constructor.
Definition ButtonToSwitch_ESP32.cpp:38

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

DbncdMPBttn::resume
bool resume()
Resets the outputs change task unblocking trigger (outputsChngTskTrggr) attribute flag.
Definition ButtonToSwitch_ESP32.cpp:343

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_ESP32.cpp:164

DbncdMPBttn::getIsOnDisabled
const bool getIsOnDisabled() const
Returns the value of the isOnDisabled attribute flag.
Definition ButtonToSwitch_ESP32.cpp:174

DbncdMPBttn::init
bool init(const int8_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_ESP32.cpp:215

DbncdMPBttn::setTaskToNotify
void setTaskToNotify(const TaskHandle_t &newTaskHandle)
Sets the handle to the task to be notified by the object when its output attribute flags changes.
Definition ButtonToSwitch_ESP32.cpp:472

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

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

DbncdMPBttn::getStrtDelay
unsigned long int getStrtDelay()
Returns the current value of the outputs change task unblocking trigger (outputsChngTskTrggr) attribu...
Definition ButtonToSwitch_ESP32.cpp:194

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

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

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

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_ESP32.cpp:440

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

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

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

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_ESP32.cpp:1319

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_ESP32.cpp:1397

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

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

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_ESP32.cpp:1408

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

HntdTmLtchMPBttn::clrStatus
void clrStatus(bool clrIsOn=true)
see DbncdMPBttn::clrStatus(bool)
Definition ButtonToSwitch_ESP32.cpp:1289

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_ESP32.cpp:1309

HntdTmLtchMPBttn::HntdTmLtchMPBttn
HntdTmLtchMPBttn()
Default constructor.
Definition ButtonToSwitch_ESP32.cpp:1255

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_ESP32.cpp:1419

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_ESP32.cpp:1456

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

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

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_ESP32.cpp:1386

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

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

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

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

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

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

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

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

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

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

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

LtchMPBttn::clrStatus
void clrStatus(bool clrIsOn=true)
See DbncdMPBttn::clrStatus(bool)
Definition ButtonToSwitch_ESP32.cpp:819

LtchMPBttn::LtchMPBttn
LtchMPBttn()
Default constructor.
Definition ButtonToSwitch_ESP32.cpp:786

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_ESP32.h:1242

SldrDALtchMPBttn::clrStatus
void clrStatus(bool clrIsOn=true)
Definition ButtonToSwitch_ESP32.cpp:2257

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

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

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

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

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

SldrDALtchMPBttn::swapSldrDir
bool swapSldrDir()
Inverts the current curSldrDirUp attribute value.
Definition ButtonToSwitch_ESP32.cpp:2528

SldrDALtchMPBttn::~SldrDALtchMPBttn
~SldrDALtchMPBttn()
Virtual class destructor.
Definition ButtonToSwitch_ESP32.cpp:2253

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

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

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

SldrDALtchMPBttn::SldrDALtchMPBttn
SldrDALtchMPBttn()
Default constructor.
Definition ButtonToSwitch_ESP32.cpp:2243

SldrDALtchMPBttn::getSldrDirUp
bool getSldrDirUp()
Returns the value of the curSldrDirUp attribute.
Definition ButtonToSwitch_ESP32.cpp:2305

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

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

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

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

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

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

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

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

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

SnglSrvcVdblMPBttn::setTaskWhileOn
virtual void setTaskWhileOn(const TaskHandle_t &newTaskHandle)
Sets the task to be run while the object is in the On state.
Definition ButtonToSwitch_ESP32.cpp:3085

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

SnglSrvcVdblMPBttn::~SnglSrvcVdblMPBttn
virtual ~SnglSrvcVdblMPBttn()
Class virtual destructor.
Definition ButtonToSwitch_ESP32.cpp:3059

SnglSrvcVdblMPBttn::SnglSrvcVdblMPBttn
SnglSrvcVdblMPBttn()
Default constructor.
Definition ButtonToSwitch_ESP32.cpp:3047

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

TgglLtchMPBttn::TgglLtchMPBttn
TgglLtchMPBttn()
Default constructor.
Definition ButtonToSwitch_ESP32.cpp:1127

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

TmLtchMPBttn::TmLtchMPBttn
TmLtchMPBttn()
Default constructor.
Definition ButtonToSwitch_ESP32.cpp:1169

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

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

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

TmLtchMPBttn::clrStatus
void clrStatus(bool clrIsOn=true)
see DbncdMPBttn::clrStatus(bool)
Definition ButtonToSwitch_ESP32.cpp:1181

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

TmVdblMPBttn::TmVdblMPBttn
TmVdblMPBttn()
Default constructor.
Definition ButtonToSwitch_ESP32.cpp:2939

TmVdblMPBttn::~TmVdblMPBttn
virtual ~TmVdblMPBttn()
Class virtual destructor.
Definition ButtonToSwitch_ESP32.cpp:2948

TmVdblMPBttn::clrStatus
void clrStatus()
See DbncdMPBttn::clrStatus(bool)
Definition ButtonToSwitch_ESP32.cpp:2974

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

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

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

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

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

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

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_ESP32.cpp:2566

VdblMPBttn::clrStatus
void clrStatus(bool clrIsOn=true)
See DbncdMPBttn::clrStatus(bool)
Definition ButtonToSwitch_ESP32.cpp:2549

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_ESP32.cpp:2640

VdblMPBttn::~VdblMPBttn
virtual ~VdblMPBttn()
Default virtual destructor.
Definition ButtonToSwitch_ESP32.cpp:2545

VdblMPBttn::VdblMPBttn
VdblMPBttn()
Default constructor.
Definition ButtonToSwitch_ESP32.cpp:2535

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

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_ESP32.cpp:2628

VdblMPBttn::getFrcOtptLvlWhnVdd
bool getFrcOtptLvlWhnVdd()
Returns the value of the frcOtptLvlWhnVdd attribute.
Definition ButtonToSwitch_ESP32.cpp:2571

VdblMPBttn::getStOnWhnOtpFrcd
bool getStOnWhnOtpFrcd()
Returns the value of the frcOtptLvlWhnVdd attribute.
Definition ButtonToSwitch_ESP32.cpp:2581

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

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

XtrnUnltchMPBttn::clrStatus
void clrStatus(bool clrIsOn=true)
See DbncdMPBttn::clrStatus(bool)
Definition ButtonToSwitch_ESP32.cpp:1705

XtrnUnltchMPBttn::XtrnUnltchMPBttn
XtrnUnltchMPBttn()
Default constructor.
Definition ButtonToSwitch_ESP32.cpp:1661

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

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