Models a Single Service Voidable DD-MPB a.k.a. Trigger switch (SSVDD-MPB) More...

#include <ButtonToSwitch.h>

Inheritance diagram for SnglSrvcVdblMPBttn:

[legend]

Collaboration diagram for SnglSrvcVdblMPBttn:

[legend]

Public Member Functions
	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.

virtual	~SnglSrvcVdblMPBttn ()
	Class virtual destructor.

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

Public Member Functions inherited from 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.

virtual	~VdblMPBttn ()
	Default virtual destructor.

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

fncPtrType	getFnWhnTrnOffVdd ()
	Returns the function that is set to execute every time the object exits the Voided State.

fncPtrType	getFnWhnTrnOnVdd ()
	Returns the function that is set to execute every time the object enters the Voided or "Voided On" State.

bool	getFrcOtptLvlWhnVdd ()
	Returns the value of the frcOtptLvlWhnVdd attribute.

const bool	getIsVoided () const
	Returns the current value of the isVoided attribute flag.

bool	getStOnWhnOtpFrcd ()
	Returns the value of the frcOtptLvlWhnVdd attribute.

void	setFnWhnTrnOffVddPtr (void(*newFnWhnTrnOff)())
	Sets the function that will be called to execute every time the object's isVoided attribute flag is reset.

void	setFnWhnTrnOnVddPtr (void(*newFnWhnTrnOn)())
	Sets the function that will be called to execute every time the object's isVoided attribute flag is set.

bool	setIsNotVoided ()
	Sets the value of the isVoided attribute flag to false.

bool	setIsVoided ()
	Sets the value of the isVoided attribute flag to true.

Public Member Functions inherited from DbncdDlydMPBttn
	DbncdDlydMPBttn ()
	Default constructor.

	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)
	Class constructor.

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)

void	setStrtDelay (const unsigned long int &newStrtDelay)
	Sets a new value to the "Start Delay" strtDelay attribute.

Public Member Functions inherited from DbncdMPBttn
	DbncdMPBttn ()
	Default class constructor.

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

virtual	~DbncdMPBttn ()
	Default virtual destructor.

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.

const unsigned long int	getCurDbncTime () const
	Returns the current debounce period time set for the object.

fncPtrType	getFnWhnTrnOff ()
	Returns the function that is set to execute every time the object enters the Off State.

fncPtrType	getFnWhnTrnOn ()
	Returns the function that is 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.

const unsigned long int	getLstPollTime ()
	Returns the time stamp of the last state update for the object.

const uint32_t	getOtptsSttsPkgd ()
	Returns the relevant attribute flags values for the object state encoded as a 32 bits value.

const bool	getOutputsChange () const
	Returns the value of the outputsChange attribute flag.

const unsigned long int	getPollPeriodMs ()
	Returns the poll period time setting attribute's value.

unsigned long int	getStrtDelay ()
	Returns the current value of strtDelay attribute.

bool	getUpdTmrAttchd ()
	Returns the value of the Attached to the update timer attribute.

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.

bool	pause ()
	Pauses the software timer updating the computation of the object's internal flags value (object's state).

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.

bool	setDbncTime (const unsigned long int &newDbncTime)
	Sets the debounce process time.

void	setFnWhnTrnOffPtr (void(*newFnWhnTrnOff)())
	Sets the function that will be called to execute every time the object enters the Off State.

void	setFnWhnTrnOnPtr (void(*newFnWhnTrnOn)())
	Sets the function that will be called to execute every time the object enters the On State.

void	setIsOnDisabled (const bool &newIsOnDisabled)
	Sets the value of the isOnDisabled attribute.

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).

Detailed Description

Models a Single Service Voidable DD-MPB a.k.a. Trigger switch (SSVDD-MPB)

The Single Service Voidable Momentary Push Button keeps the On state since the moment the signal is stable (debounce & delay process) and until the moment the provided mechanisms implemented to be executed when the switch enters the On State are started, that means calling the fnWhnTrnOn function, notifying the taskToNotify task and setting the isOn attribute flag. After the configured mechanisms are triggered and the attribute flag is set to true (the only mandatory action is the attribute flag setting, all the others are configurable to execute or not) the MPB will enter the Voided State, forcing the MPB into the Off State. The SnglSrvcVdblMPBttn class objects requires the MPB to be released to exit the Voided State, restarting the cycle. This kind of switches are used to handle "Single Shot Trigger" style signals, ensuring one single signal per push.

Attention: Depending on checking the isOn flag reading trough the getIsOn() method might surely fail due to the high risk of missing the short time the flag will be raised before it is again taken down by the voidance of the MPB. The use of the non-polling facilities ensures no loss of signals and enough time to execute the code depending on the "trigger activation", including the fnWhnTrnOn function, and the taskToNotify task.

Note: Due to the short time the isOn flag will be raised, as described above, the resuming of the taskWhileOn activation mechanism is disabled in this class. For that purpose the setTaskWhileOn(const TaskHandle_t) is made not accessible by setting it's accessibility to protected.; Due to the short time the isOn flag will be raised, as described above, the short time between the fnWhnTrnOn function and the fnWhnTrnOff function callings must also need to be evaluated by the user.

Constructor & Destructor Documentation

◆ 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.

Note: For the parameters see DbncdDlydMPBttn(const uint8_t, const bool, const bool, const unsigned long int, const unsigned long int)

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SnglSrvcVdblMPBttn()