Models a Timer Latch DD-MPB, a.k.a. Timer Switch (TiLDD-MPB). More...

#include <ButtonToSwitch.h>

Inheritance diagram for TmLtchMPBttn:

[legend]

Collaboration diagram for TmLtchMPBttn:

[legend]

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

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

const unsigned long int	getSrvcTime () const
	Returns the configured Service Time.

bool	setSrvcTime (const unsigned long int &newSrvcTime)
	Sets a new value to the Service Time attribute.

void	setTmerRstbl (const bool &newIsRstbl)
	Configures the timer for the Service Time to be reseted before it reaches unlatching time.

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

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

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

const bool	getIsLatched () const
	Returns the value of the isLatched attribute flag, indicating the Latched or Unlatched condition of the object.

bool	getTrnOffASAP ()
	Returns the value of the trnOffASAP attribute flag.

const bool	getUnlatchPend () const
	Returns the value of the "Valid Unlatch Pending" attribute.

const bool	getUnlatchRlsPend () const
	Returns the value of the "Valid Unlatch Release Pending" attribute.

void	setTrnOffASAP (const bool &newVal)
	Sets the value of the trnOffASAP attribute.

void	setUnlatchPend (const bool &newVal)
	Sets the value of the "Valid Unlatch Pending" attribute.

void	setUnlatchRlsPend (const bool &newVal)
	Sets the value of the "Valid Unlatch Release Pending" attribute.

bool	unlatch ()
	Sets the values of the flags needed to unlatch a latched MPB.

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 Timer Latch DD-MPB, a.k.a. Timer Switch (TiLDD-MPB).

The Timer switch keeps the On state since the moment the signal is stable (debouncing + delay process), and until the unlatch signal is provided by a preset timer started immediately after the MPB has passed the debounce & delay process. The time count down might be reset by pressing the MPB before the timer expires by optionally configuring the object to do so with the provided method. The total count-down time might be changed by using a provided method.

class TmLtchMPBttn

Constructor & Destructor Documentation

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

Parameters

srvcTime The service time (time to keep the isOn attribute flag raised).

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

Member Function Documentation

◆ getSrvcTime()

const unsigned long int TmLtchMPBttn::getSrvcTime ( ) const

Returns the configured Service Time.

Returns: The current Service Time setting in milliseconds

◆ setSrvcTime()

bool TmLtchMPBttn::setSrvcTime ( const unsigned long int & newSrvcTime )

Sets a new value to the Service Time attribute.

Parameters

newSrvcTime New value for the Service Time attribute

Note: To ensure a safe and predictable behavior from the instantiated objects a minimum Service Time setting guard is provided, ensuring data and signals processing are completed before unlatching process is enforced by the timer. The guard is set by the defined _MinSrvcTime constant.

Return values

true	if the newSrvcTime parameter is equal to or greater than the minimum setting guard, the new value is set.
false	The newSrvcTime parameter is less than the minimum setting guard, the srvcTime attribute was not changed.

Attention: The "service time completed", as every other timing related behavior of the MPBttn objects, is computed and updated by the attached timer, and the checking period is the one set by the begin(unsigned long int) method. There must be some correlation between both values. If the timer is set to a very high value, the "service time" will not be checked so frequently, so the service time will be completed, but the MPBttn status will not be updated untill next timer update calling. That's also the reason why each MPBttn object might be configured with different update periods of time: to check more frequently on those objects with short service times, less frequently on those objects that don't require to be checked so frequently, and avoid the time loss by checking every MPBttn at it's optimal pace.

Here is the caller graph for this function:

◆ setTmerRstbl()

void TmLtchMPBttn::setTmerRstbl ( const bool & newIsRstbl )

Configures the timer for the Service Time to be reseted before it reaches unlatching time.

If the isResetable attribute flag is cleared the MPB will return to Off state when the Service Time is reached no matter if the MPB was pressed again during the service time period. If the attribute flag is set, pressing the MPB (debounce and delay times enforced) while on the On state resets the timer, starting back from 0. The reseting might be repeated as many times as desired.

Parameters

newIsRstbl The new setting for the isResetable flag.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ TmLtchMPBttn()

Member Function Documentation

◆ getSrvcTime()

◆ setSrvcTime()

◆ setTmerRstbl()