| ButtonToSwitch Library for ESP32 (Arduino) v4.6.1 A library that provides elaborated switch mechanism behavior simulation for digital signals inputs

Loading...
Searching...
No Matches
DbncdMPBttn Class Reference

Base class, models a Debounced Momentary Push Button (D-MPB). More...

`#include <ButtonToSwitch_ESP32.h>`

Inheritance diagram for DbncdMPBttn:
[legend]
Collaboration diagram for DbncdMPBttn:
[legend]

## Public Member Functions
| DbncdMPBttn ()
| Default class constructor.
| DbncdMPBttn (const int8_t &mpbttnPin, const bool &pulledUp=true, const bool &typeNO=true, const unsigned long int &dbncTimeOrigSett=0)
| Class constructor.
| DbncdMPBttn (const DbncdMPBttn &other)
| Copy constructor.
virtual | ~DbncdMPBttn ()
| Default virtual destructor.
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 status.
void | clrStatus (bool clrIsOn=true)
| Clears and resets flags, timers and counters modified through the object's signals processing.
void | disable ()
| Disables the input signal processing, ignoring the changes of its values.
void | enable ()
| Enables the input signal processing.
bool | end ()
| Detaches the object from the timer that monitors the input pins, compute and updates the object's status. The timer daemon entry is deleted for the object.
const unsigned long int | getCurDbncTime () const
| Returns the current debounce period time set for the object.
fncPtrType | getFnWhnTrnOff ()
| Returns a pointer to a function that is set to execute every time the object enters the Off State.
fncPtrType | getFnWhnTrnOn ()
| Returns a pointer to a function that is set to execute every time the object enters the On State.
fncVdPtrPrmPtrType | getFVPPWhnTrnOff ()
| Returns a pointer to a function that is set to execute every time the object enters the Off State.
void * | getFVPPWhnTrnOffArgPtr ()
| Returns a pointer to the argument to be passed to the function set to execute every time the object enters the Off State.
fncVdPtrPrmPtrType | getFVPPWhnTrnOn ()
| Returns a pointer to a function that is set to execute every time the object enters the On State.
void * | getFVPPWhnTrnOnArgPtr ()
| Returns a pointer to the argument to be passed to the function set to execute every time the object enters the On State.
const bool | getIsEnabled () const
| Returns the value of the isEnabled attribute flag, indicating the Enabled or Disabled status of the object.
const bool | getIsOn () const
| Returns the value of the isOn attribute flag.
const bool | getIsOnDisabled () const
| Returns the value of the isOnDisabled attribute flag.
const DbncdMPBttn * | getMpbInstnc () const
| Returns a pointer to the present instanced object.
const uint32_t | getOtptsSttsPkgd ()
| Returns the relevant attribute flags values for the object state encoded as a 32 bits value, required to pass current state of the object to another thread/task managing the outputs.
const bool | getOutputsChange () const
| Returns the value of the outputsChange attribute flag.
unsigned long int | getStrtDelay ()
| Returns the current value of strtDelay attribute.
const TaskHandle_t | getTaskToNotify () const
| Returns the task to be notified by the object when its output flags changes.
const TaskHandle_t | getTaskWhileOn ()
| Returns the task to be run (resumed) while the object is in the On state.
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.
bool | pause ()
| Pauses the software timer updating the computation of the object's internal flags value.
void | resetDbncTime ()
| Resets the debounce process time of the object to the value used at instantiation.
void | resetFda ()
| Resets the MPB behavior automaton to it's Initial or Start State
bool | resume ()
| Restarts the software timer updating the calculation of the object internal flags.
void | setBeginDisabled (const bool &newBeginDisabled=false)
| Sets the starting isDisabled state.
bool | setDbncTime (const unsigned long int &newDbncTime)
| Sets the debounce process time.
void | setFnWhnTrnOffPtr (fncPtrType newFnWhnTrnOff)
| Sets the function that will be called to execute every time the object enters the Off State.
void | setFnWhnTrnOnPtr (fncPtrType newFnWhnTrnOn)
| Sets the function that will be called to execute every time the object enters the On State.
void | setFVPPWhnTrnOff (fncVdPtrPrmPtrType newFVPPWhnTrnOff, void *argPtr=nullptr)
| Sets a function to be executed every time the object enters the Off State.
void | setFVPPWhnTrnOffArgPtr (void *newFVPPWhnTrnOffArgPtr)
| Sets a pointer to an argument to be passed to the function set to execute every time the object enters the Off State.
void | setFVPPWhnTrnOn (fncVdPtrPrmPtrType newFVPPWhnTrnOn, void *argPtr=nullptr)
| Sets a function to be executed every time the object enters the On State.
void | setFVPPWhnTrnOnArgPtr (void *newFVPPWhnTrnOnArgPtr)
| Sets a pointer to an argument to be passed to the function set to execute every time the object enters the On State.
void | setIsOnDisabled (const bool &newIsOnDisabled)
| Sets the value of the isOnDisabled attribute flag.
void | setOutputsChange (bool newOutputsChange)
| Sets the value of the attribute flag indicating if a change took place in any of the output attribute flags (IsOn included).
void | setTaskToNotify (const TaskHandle_t &newTaskHandle)
| Sets the handle to the task to be notified by the object when its output attribute flags changes.
virtual void | setTaskWhileOn (const TaskHandle_t &newTaskHandle)
| Sets the task to be run while the object is in the On state.

## Detailed Description

Base class, models a Debounced Momentary Push Button (D-MPB).

This class provides the resources needed to process a momentary digital input signal -as the one provided by a MPB (Momentary Push Button)- returning a clean signal to be used as a switch, implementing the needed services to replace a wide range of physical related switch characteristics: Debouncing, deglitching, disabling.

More physical switch situations can be emulated, like temporarily disconnecting it (isDisabled=true and isOnDisabled=false), short circuiting it (isDisabled=true and isOnDisabled=true) and others.

## Constructor & Destructor Documentation

## ◆ DbncdMPBttn() [1/2]

DbncdMPBttn::DbncdMPBttn | ( | const int8_t & | mpbttnPin,
|  | const bool & | pulledUp = true,
|  | const bool & | typeNO = true,
|  | const unsigned long int & | dbncTimeOrigSett = 0 )

Class constructor.

Parameters

  mpbttnPin | Pin id number of the input signal pin
  pulledUp | (Optional) boolean, indicates if the input pin must be configured as INPUT_PULLUP (true, default value), or INPUT_PULLDOWN (false), to calculate correctly the expected voltage level in the input pin. The pin is configured by the constructor so no previous programming is needed. The pin must be free to be used as a digital input, and must be a pin with an internal pull-up circuit, as not every GPIO pin has the option.
  typeNO | (Optional) boolean, indicates if the MPB is a Normally Open (NO) switch (true, default value), or Normally Closed (NC) (false), to calculate correctly the expected level of voltage indicating the MPB is pressed.
  dbncTimeOrigSett | (Optional) unsigned long integer (uLong), indicates the time (in milliseconds) to wait for a stable input signal before considering the MPB to be pressed (or not pressed). If no value is passed the constructor will assign the minimum value provided in the class, that is 20 milliseconds as it is an empirical value obtained in various published tests.

Note
  The mpbttnpin parameter valid values is MCU dependant, as each one of the MCUs have a specific number of GPIO pins values available for use. The Arduino development environment have a minimum and maximum values constants set for each MCU it supports. The valid range for the mpbttnpin in an Espressif ESP32 mcu family then is GPIO_NUM_0 <= mpbttnpin < GPIO_NUM_MAX
  The Arduino development environment has defined a constant to indicate a non connected to a GPIO pin identified as GPIO_NUM_NC.

## ◆ DbncdMPBttn() [2/2]

DbncdMPBttn::DbncdMPBttn | ( | const DbncdMPBttn & | other | ) |

Copy constructor.

Parameters

  other | DbncdMPBttn object to copy

Here is the call graph for this function:

## Member Function Documentation

## ◆ begin()

bool DbncdMPBttn::begin | ( | const unsigned long int & | pollDelayMs = _StdPollDelay | ) |
| virtual

Attaches the instantiated object to a timer that monitors the input pins and updates the object status.

The frequency of the periodic monitoring is passed as a parameter in milliseconds, and is a value that must be small (frequent) enough to keep the object updated, but not so frequent that wastes resources from other tasks. A default value is provided based on empirical results obtained in various published tests.

Parameters

  pollDelayMs | (Optional) unsigned long integer (ulong), the time between polls in milliseconds.

Returns
  Boolean indicating if the object could be attached to a timer.

Return values

  true | the object could be attached to a timer -or it was already attached to a timer when the method was invoked-.
  false | the object could not create the needed timer, or the object could not be attached to it.

Reimplemented in DblActnLtchMPBttn, HntdTmLtchMPBttn, LtchMPBttn, SnglSrvcVdblMPBttn, TmVdblMPBttn, and XtrnUnltchMPBttn.

## ◆ clrStatus()

void DbncdMPBttn::clrStatus | ( | bool | clrIsOn = true | ) |

Clears and resets flags, timers and counters modified through the object's signals processing.

Resets object's attributes to its initialization values to safely resume operations, either after pausing the timer, enabling the object after disabling it or any disruptive activity that might generate unexpected distorsions. This avoids risky behavior of the object due to dangling flags or partially consumed time counters.

Parameters

  clrIsOn | Optional boolean value, indicates if the _isOn flag must be included to be cleared:

- true (default value) includes the isOn flag.
- false excludes the isOn flag.

Here is the caller graph for this function:

## ◆ disable()

void DbncdMPBttn::disable | ( |  | ) |

Disables the input signal processing, ignoring the changes of its values.

Invoking the disable() method sends a message to the object requesting it to enter the Disabled state. Due to security and stability of the object's behavior the message will not be processed at every stage of the input signals detection and output computations, but in every safe and stable stage. When the message is processed the object will:

- Stop all input signal reading.
- Stop any new output flag computation.
- Reset all output flag values.
- Force the isOn flag according to the isOnDisabled flag setting.
- Keep this Disabled state behavior until an enabling message is received through a enable() method.

## ◆ enable()

void DbncdMPBttn::enable | ( |  | ) |

Enables the input signal processing.

Invoking the enable() method on a object in Disabled state sends it a message requesting to resume it's normal operation. The execution of the re-enabling of the object implies:

- Resuming all input signals reading.
- Resuming all output flag computation from the "fresh startup" state, including clearing the isOn state
- Due to strict security enforcement the object will not be allowed to enter the Enabled state if the MPB was pressed when the enable message was received and until a MPB release is efectively detected.

## ◆ end()

bool DbncdMPBttn::end | ( |  | ) |

Detaches the object from the timer that monitors the input pins, compute and updates the object's status. The timer daemon entry is deleted for the object.

The immediate detachment of the object from the timer that keeps it's state updated implies that the object's state will be kept, whatever that state is it. If a certain status is preferred some of the provided methods should be used for that including clrStatus(), resetFda(), disable(), setIsOnDisabled(), etc. Also consider that if a task is set to be executed while the object is in On state, the end() invocation wouldn't affect that task execution state.

Returns
  Boolean indicating the success of the operation

Return values

  true | the object detachment procedure and timer entry removal was successful.
  false | the object detachment and/or entry removal was rejected by the O.S..

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ getCurDbncTime()

const unsigned long int DbncdMPBttn::getCurDbncTime | ( |  | ) | const

Returns the current debounce period time set for the object.

The original value for the debouncing process used at instantiation time might be changed with the setDbncTime(const unsigned long int) or with the resetDbncTime() methods. This method gets the current value of the attribute in use.

Returns
  The current debounce time in milliseconds

## ◆ getFnWhnTrnOff()

fncPtrType DbncdMPBttn::getFnWhnTrnOff | ( |  | ) |

Returns a pointer to a function that is set to execute every time the object enters the Off State.

The function to be executed is an attribute that might be modified by the setFnWhnTrnOffPtr() method.

The function to be executed has a signature of void (funcName)(), that is, it receives no parameters and returns no values.

Returns
  A function pointer to the function set to execute every time the object enters the Off State.

Return values

  nullptr | if there is no function set to execute when the object enters the Off State.

Warning
  The function code execution will become part of the list of procedures the object executes when it entering the Off State, including the modification of affected attribute flags, suspending the execution of the task running while in On State and others. Making the function code too time demanding must be handled with care, using alternative execution schemes, for example the function might resume a independent task that suspends itself at the end of its code, to let a new function calling event resume it once again.

## ◆ getFnWhnTrnOn()

fncPtrType DbncdMPBttn::getFnWhnTrnOn | ( |  | ) |

Returns a pointer to a function that is set to execute every time the object enters the On State.

The function to be executed is an attribute that might be modified by the setFnWhnTrnOnPtr() method.

The function to be executed has a signature of void (funcName)(), that is, it receives no parameters and returns no values.

Returns
  A function pointer to the function set to execute every time the object enters the On State.

Return values

  nullptr | if there is no function set to execute when the object enters the On State.

Warning
  The function code execution will become part of the list of procedures the object executes when it entering the On State, including the modification of affected attribute flags, suspending the execution of the task running while in On State and others. Making the function code too time demanding must be handled with care, using alternative execution schemes, for example the function might resume a independent task that suspends itself at the end of its code, to let a new function calling event resume it once again.

## ◆ getFVPPWhnTrnOff()

fncVdPtrPrmPtrType DbncdMPBttn::getFVPPWhnTrnOff | ( |  | ) |

Returns a pointer to a function that is set to execute every time the object enters the Off State.

The pointer is one to a function with the signature void (fncPtr*) (void*) to allow for passing a void* argument to the function.

Returns
  fncVdPtrPrmPtrType The pointer to the function set to execute every time the object enters the Off State.

Return values

  nullptr | if there is no function with the described signature set to execute when the object enters the Off State.

## ◆ getFVPPWhnTrnOffArgPtr()

void * DbncdMPBttn::getFVPPWhnTrnOffArgPtr | ( |  | ) |

Returns a pointer to the argument to be passed to the function set to execute every time the object enters the Off State.

Returns
  void* Pointer to the argument to be passed to the function set to execute every time the object enters the Off State.

## ◆ getFVPPWhnTrnOn()

fncVdPtrPrmPtrType DbncdMPBttn::getFVPPWhnTrnOn | ( |  | ) |

Returns a pointer to a function that is set to execute every time the object enters the On State.

The pointer is one to a function with the signature void (fncPtr*) (void*) to allow for passing a void* argument to the function.

Returns
  fncVdPtrPrmPtrType The pointer to the function set to execute every time the object enters the On State.

Return values

  nullptr | if there is no function with the described signature set to execute when the object enters the On State.

## ◆ getFVPPWhnTrnOnArgPtr()

void * DbncdMPBttn::getFVPPWhnTrnOnArgPtr | ( |  | ) |

Returns a pointer to the argument to be passed to the function set to execute every time the object enters the On State.

Returns
  void* Pointer to the argument to be passed to the function set to execute every time the object enters the On State.

## ◆ getIsEnabled()

const bool DbncdMPBttn::getIsEnabled | ( |  | ) | const

Returns the value of the isEnabled attribute flag, indicating the Enabled or Disabled status of the object.

The isEnabled flag might be modified by the enable() and the disable() methods.

Return values

  true | the object is in Enabled state.
  false | The object is in Disabled state.

## ◆ getIsOn()

const bool DbncdMPBttn::getIsOn | ( |  | ) | const

Returns the value of the isOn attribute flag.

The isOn attribute flag is the fundamental attribute of the object, it might be considered the "Raison d'etre" of all this classes design: the isOn signal is not just the detection of an expected voltage value at a mcu pin, but the combination of that voltage level, filtered and verified, for a determined period of time and until a new event modifies that situation. While other mechanism are provided to execute code when the status of the object changes, all but the isOn flag value update are optionally executed.

Return values

  true | The object is in On state.
  false | The object is in Off state.

## ◆ getIsOnDisabled()

const bool DbncdMPBttn::getIsOnDisabled | ( |  | ) | const

Returns the value of the isOnDisabled attribute flag.

When instantiated the class, the object is created in Enabled state. That might be changed when needed. In the Disabled state the input signals for the MPB are not processed, and the output will be set to the On state or the Off state depending on this attribute flag's value. The reasons to disable the ability to change the output, and keep it on either state until re-enabled are design and use dependent. The flag value might be changed by the use of the setIsOnDisabled() method.

Return values

  true | the object is configured to be set to the On state while it is in Disabled state.
  false | the object is configured to be set to the Off state while it is in Disabled state.

## ◆ getMpbInstnc()

const DbncdMPBttn * DbncdMPBttn::getMpbInstnc | ( |  | ) | const

Returns a pointer to the present instanced object.

Returns
  DbncdMPBttn* Pointer to the object

Here is the call graph for this function:

## ◆ getOtptsSttsPkgd()

const uint32_t DbncdMPBttn::getOtptsSttsPkgd | ( |  | ) |

Returns the relevant attribute flags values for the object state encoded as a 32 bits value, required to pass current state of the object to another thread/task managing the outputs.

The inter-tasks communication mechanisms implemented on the class includes a xTaskNotify() that works as a light-weigh mailbox, unblocking the receiving tasks and sending to it a 32_bit value notification. This function returns the relevant attribute flags values encoded in a 32 bit value, according the provided encoding documented.

Returns
  A 32-bit unsigned value representing the attribute flags current values.

## ◆ getOutputsChange()

const bool DbncdMPBttn::getOutputsChange | ( |  | ) | const

Returns the value of the outputsChange attribute flag.

The instantiated objects include attributes linked to their computed state, which represent the behavior expected from their respective electromechanical simulated counterparts. When any of those attributes values change, the outputsChange flag is set. The flag only signals changes have happened -not which flags, nor how many times changes have taken place- since the last outputsChange flag reset. The outputsChange flag must be reset (or set if desired) through the setOutputsChange() method.

Return values

  true | any of the object's behavior flags have changed value since last time outputsChange flag was reseted.
  false | no object's behavior flags have changed value since last time outputsChange flag was reseted.

## ◆ getStrtDelay()

unsigned long int DbncdMPBttn::getStrtDelay | ( |  | ) |

Returns the current value of strtDelay attribute.

Returns the current value of time used by the object to rise the isOn flag, after the debouncing process ends, in milliseconds. If the MPB is released before completing the debounce and the strtDelay time, no press will be detected by the object, and the isOn flag will not be affected. The original value for the delay process used at instantiation time might be changed with the setStrtDelay() method, so this method is provided to get the current value in use.

Returns
  The current strtDelay time in milliseconds.

Attention
  The strtDelay attribute is forced to a 0 ms value at instantiation of DbncdMPBttn class objects, and no setter mechanism is provided in this class. The inherited DbncdDlydMPBttn class objects (and all it's subclasses) constructor includes a parameter to initialize the strtDelay value, and a method to set that attribute to a new value. This implementation is needed to keep backwards compatibility to old versions of the library.

## ◆ getTaskToNotify()

const TaskHandle_t DbncdMPBttn::getTaskToNotify | ( |  | ) | const

Returns the task to be notified by the object when its output flags changes.

The task handle of the task to be notified by the object when its outputsChange attribute flag is set (see getOutputsChange()) holds a NULL when the object is created. A valid task's TaskHandle_t value might be set by using the setTaskToNotify() method, and even set back to NULL to disable the task notification mechanism.

Returns
  TaskHandle_t value of the task to be notified of the outputs change.

Return values

  NULL | there is no task configured to be notified of the outputs change.

Note
  The notification is done through a direct to task notification using the xTaskNotify() RTOS macro, the notification includes passing the notified task a 32-bit notification value.

## ◆ getTaskWhileOn()

const TaskHandle_t DbncdMPBttn::getTaskWhileOn | ( |  | ) |

Returns the task to be run (resumed) while the object is in the On state.

Returns the task handle of the task to be resumed every time the object enters the On state, and will be paused when the object enters the Off state. This task execution mechanism dependent of the On state extends the concept of the Switch object far away of the simple turning On/Off a single hardware signal, attaching to it all the task execution capabilities of the MCU.

Returns
  The TaskHandle_t value of the task to be resumed while the object is in On state.

Return values

  NULL | if there is no task configured to be resumed while the object is in On state.

Warning
  ESP-IDF FreeRTOS has no mechanism implemented to notify a task that it is about to be set in paused state, so there is no way to that task to ensure it will be set to be paused in an orderly fashion. The task to be designated to be used by this mechanism has to be task that can withstand being interrupted at any point of it's execution, and be restarted from that same point next time the isOn flag is set. For tasks that might need attaching resources or other issues every time it is resumed and releasing resources of any kind before being paused, using the function attached by using setFnWhnTrnOnPtr() to gain control of the resources before resuming a task, and the function attached by using setFnWhnTrnOffPtr() to release the resources and pause the task in an orderly fashion, or use those functions to manage a binary semaphore for managing the execution of a task.

## ◆ init()

bool DbncdMPBttn::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.

All the parameters correspond to the non-default constructor of the class, DbncdMPBttn(const int8_t, const bool, const bool, const unsigned long int)

Here is the caller graph for this function:

## ◆ pause()

bool DbncdMPBttn::pause | ( |  | ) |

Pauses the software timer updating the computation of the object's internal flags value.

The immediate stop of the timer that keeps the object's state updated implies that the object's state will be kept, whatever that state is it. The same consideration as the end() method applies referring to options to modify the state in which the object will be while in the Pause state.

Return values

  true | the object's timer could be stopped by the O.S.(or it was already stopped).
  false | the object's timer couldn't be stopped by the O.S..

Here is the caller graph for this function:

## ◆ resetDbncTime()

void DbncdMPBttn::resetDbncTime | ( |  | ) |

Resets the debounce process time of the object to the value used at instantiation.

The debounce process time used at instantiation might be changed with the setDbncTime() as needed, as many times as needed. This method reverts the value to the instantiation time value. In case the value was not specified at instantiation time the default debounce time value will be used.

Here is the call graph for this function:

## ◆ resetFda()

void DbncdMPBttn::resetFda | ( |  | ) |

Resets the MPB behavior automaton to it's Initial or Start State

This method is provided for security and for error handling purposes, so that in case of unexpected situations detected, the driving Deterministic Finite Automaton used to compute the MPB objects states might be reset to it's initial state to safely restart it, maybe as part of an Error Handling procedure.

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ resume()

bool DbncdMPBttn::resume | ( |  | ) |

Restarts the software timer updating the calculation of the object internal flags.

The timer will stop calling the functions for computing the flags values after calling the pause() method and will not be updated until the timer is restarted with this method.

Return values

  true | the object's timer could be restarted by the O.S..
  false | the object's timer couldn't be restarted by the O.S..

Warning
  This method will restart the inactive timer after a pause() method. If the object's timer was modified by an end()* method then a **begin() method will be needed to restart it's timer.

Here is the call graph for this function:

## ◆ setBeginDisabled()

void DbncdMPBttn::setBeginDisabled | ( | const bool & | newBeginDisabled = false | ) |

Sets the starting isDisabled state.

This method adds the possibility to start the object either in Enabled or Disabled state. The default is to be started in Enabled state (isEnabled = true). The selected state must be set before the object update timer is started, i.e. before the .begin() method is executed. Once the update timer is started the use of this method has no consequences over the object behavior.

Parameters

  newBeginDisabled | States if the object must be started in the default Enabled state (false), or in the Disabled state (true).

## ◆ setDbncTime()

bool DbncdMPBttn::setDbncTime | ( | const unsigned long int & | newDbncTime | ) |

Sets the debounce process time.

Sets a new time for the debouncing period. The value must be equal or greater than the minimum empirical value set as a property for all the classes, that value is defined in the _HwMinDbncTime constant (20 milliseconds). A long debounce time will produce a delay in the press event generation, making it less "responsive".

Parameters

  newDbncTime | unsigned long integer, the new debounce value for the object.

Returns
  A boolean indicating if the debounce time setting was successful.

Return values

  true | the new value is in the accepted range, the attribute value is updated.
  false | the value was out of the accepted range, no change was made.

Here is the caller graph for this function:

## ◆ setFnWhnTrnOffPtr()

void DbncdMPBttn::setFnWhnTrnOffPtr | ( | fncPtrType | newFnWhnTrnOff | ) |

Sets the function that will be called to execute every time the object enters the Off State.

The function to be executed must be of the form void (*newFnWhnTrnOff)(), meaning it must take no arguments and must return no value, it will be executed only once by the object (recursion must be handled with the usual precautions). When instantiated the attribute value is set to nullptr.

Parameters

  newFnWhnTrnOff | Function pointer to the function intended to be called when the object enters the Off State. Passing nullptr as parameter deactivates the function execution mechanism.

## ◆ setFnWhnTrnOnPtr()

void DbncdMPBttn::setFnWhnTrnOnPtr | ( | fncPtrType | newFnWhnTrnOn | ) |

Sets the function that will be called to execute every time the object enters the On State.

The function to be executed must be of the form void (*newFnWhnTrnOff)(), meaning it must take no arguments and must return no value, it will be executed only once by the object (recursion must be handled with the usual precautions). When instantiated the attribute value is set to nullptr.

Parameters

  newFnWhnTrnOn | function pointer to the function intended to be called when the object enters the On State. Passing nullptr as parameter deactivates the function execution mechanism.

## ◆ setFVPPWhnTrnOff()

void DbncdMPBttn::setFVPPWhnTrnOff | ( | fncVdPtrPrmPtrType | newFVPPWhnTrnOff,
|  | void * | argPtr = nullptr )

Sets a function to be executed every time the object enters the Off State.

The function to be executed must be of the form void (newFVPPWhnTrnOff)(void), meaning it must take a void pointer as argument and must return no value, it will be executed only once by the object (recursion must be handled with the usual precautions). When the object is instantiated the attribute value is set to nullptr.

Parameters

  newFVPPWhnTrnOff | Function pointer to the function intended to be called when the object enters the Off State. Passing nullptr as parameter deactivates the function execution mechanism.
  argPtr | void pointer to an argument to be passed to the function when it is called.

## ◆ setFVPPWhnTrnOffArgPtr()

void DbncdMPBttn::setFVPPWhnTrnOffArgPtr | ( | void * | newFVPPWhnTrnOffArgPtr | ) |

Sets a pointer to an argument to be passed to the function set to execute every time the object enters the Off State.

The argument pointer is passed to the function set to execute when the object enters the Off State. The pointer is set to nullptr when the object is instantiated.

Parameters

  newFVPPWhnTrnOffArgPtr | Pointer to an argument to be passed to the function set to execute every time the object enters the Off State.

## ◆ setFVPPWhnTrnOn()

void DbncdMPBttn::setFVPPWhnTrnOn | ( | fncVdPtrPrmPtrType | newFVPPWhnTrnOn,
|  | void * | argPtr = nullptr )

Sets a function to be executed every time the object enters the On State.

The function to be executed must be of the form void (newFVPPWhnTrnOn)(void), meaning it must take a void pointer as argument and must return no value, it will be executed only once by the object (recursion must be handled with the usual precautions). When the object is instantiated the attribute value is set to nullptr.

Parameters

  newFVPPWhnTrnOn | Function pointer to the function intended to be called when the object enters the On State. Passing nullptr as parameter deactivates the function execution mechanism.
  argPtr | void pointer to an argument to be passed to the function when it is called.

## ◆ setFVPPWhnTrnOnArgPtr()

void DbncdMPBttn::setFVPPWhnTrnOnArgPtr | ( | void * | newFVPPWhnTrnOnArgPtr | ) |

Sets a pointer to an argument to be passed to the function set to execute every time the object enters the On State.

The argument pointer is passed to the function set to execute when the object enters the On State. The pointer is set to nullptr when the object is instantiated.

Parameters

  newFVPPWhnTrnOnArgPtr | Pointer to an argument to be passed to the function set to execute every time the object enters the On State.

## ◆ setIsOnDisabled()

void DbncdMPBttn::setIsOnDisabled | ( | const bool & | newIsOnDisabled | ) |

Sets the value of the isOnDisabled attribute flag.

When instantiated the class, the object is created in Enabled state. That might be changed as needed. While in the Disabled state the input signals for the MPB are not processed, and the output will be set to the On state or the Off state depending on this flag value.

Note
  The reasons to disable the ability to change the output, and keep it on either state until re-enabled are design and use dependent, being an obvious one security reasons, disabling the ability of the users to manipulate the switch while keeping the desired On/Off state. A simple example would be to keep a light on in a place where a meeting is taking place, disabling the lights switches and keeping the On State. Another obvious one would be to keep a machine off while servicing it's internal mechanisms, disabling the possibility of turning it on.

Warning
  If the method is invoked while the object is disabled, and the isOnDisabled attribute flag is changed, then the isOn attribute flag will have to change accordingly. Changing the isOn flag value implies that all the implemented mechanisms related to the change of the isOn attribute flag value will be invoked.

## ◆ setOutputsChange()

void DbncdMPBttn::setOutputsChange | ( | bool | newOutputsChange | ) |

Sets the value of the attribute flag indicating if a change took place in any of the output attribute flags (IsOn included).

The usual path for the outputsChange flag is to be set by any method changing an output attribute flag, the callback function signaled to take care of the hardware actions because of this changes clears back outputsChange after taking care of them. In the unusual case the developer wants to "intercept" this sequence, this method is provided to set (true) or clear (false) outputsChange value.

Parameters

  newOutputChange | The new value to set the outputsChange flag to.

Here is the caller graph for this function:

## ◆ setTaskToNotify()

void DbncdMPBttn::setTaskToNotify | ( | const TaskHandle_t & | newTaskHandle | ) |

Sets the handle to the task to be notified by the object when its output attribute flags changes.

When the object is created, this value is set to NULL, and a valid TaskHandle_t value might be set by using this method. The task notifying mechanism will not be used while the task handle keeps the NULL value, in which case the solution implementation will have to use any of the other provided mechanisms to test the object status, and act accordingly. After the TaskHandle value is set it might be changed to point to other task. If at the point this method is invoked the attribute holding the pointer was not NULL, the method will suspend the pointed task before proceeding to change the attribute value. The method does not provide any verification mechanism to ensure the passed parameter is a valid task handle nor the state of the task the passed pointer might be.

Parameters

  newTaskHandle | A valid task handle of an actual existent task/thread running.

Note
  As simple as this mechanism is, it's an un-expensive effective solution in terms of resources involved. The ESP-IDF FreeRTOS xTaskNotify() mechanism is used and the status of the object is passed as an encoded 32-bits value -the Notification Value- to the notified task. The MpbOtpts_t otptsSttsUnpkg(uint32_t pkgOtpts) function is provided to decode the 32-bit value into boolean values for each of the pertaining attribute flags state of the object.

## ◆ setTaskWhileOn()

void DbncdMPBttn::setTaskWhileOn | ( | const TaskHandle_t & | newTaskHandle | ) |
| virtual

Sets the task to be run while the object is in the On state.

Sets the task handle of the task to be resumed when the object enters the On state, and will be paused when the object enters the Off state. This task execution mechanism dependent of the On state extends the concept of the Switch object far away of the simple turning On/Off a single hardware signal, attaching to it all the task execution capabilities of the MCU.

If the existing value for the task handle was not NULL before the invocation, the method will verify the Task Handle was pointing to a deleted or suspended task, in which case will proceed to suspend that task before changing the Task Handle to the new provided value.

Setting the value to NULL will disable the task execution mechanism.

Note
  The method does not implement any task handle validation for the new task handle, a valid handle to a valid task is assumed as parameter.
  Consider the implications of the task that's going to get suspended every time the MPB goes to the Off state, so that the the task to be run might be interrupted at any point of its execution. This implies that the task must be designed with that consideration in mind to avoid dangerous situations generated by a task not completely done when suspended.

Warning
  Take special consideration about the implications of the execution priority of the task to be executed while the MPB is in On state and its relation to the priority of the calling task, as it might affect the normal execution of the application.

Reimplemented in SnglSrvcVdblMPBttn.