TgglLtchMPBttn Class Reference

Models a Toggle Latch DD-MPB, a.k.a. a Toggle Switch (ToLDD-MPB). More...

#include <ButtonToSwitch_STM32.h>

Inheritance diagram for TgglLtchMPBttn:

Collaboration diagram for TgglLtchMPBttn:

Public Member Functions
	TgglLtchMPBttn (GPIO_TypeDef *mpbttnPort, const uint16_t &mpbttnPin, const bool &pulledUp=true, const bool &typeNO=true, const unsigned long int &dbncTimeOrigSett=0, const unsigned long int &strtDelay=0)
	Class constructor.
	TgglLtchMPBttn (gpioPinId_t mpbttnPinStrct, const bool &pulledUp=true, const bool &typeNO=true, const unsigned long int &dbncTimeOrigSett=0, const unsigned long int &strtDelay=0)
	Class constructor.
Public Member Functions inherited from LtchMPBttn
	LtchMPBttn (GPIO_TypeDef *mpbttnPort, const uint16_t &mpbttnPin, const bool &pulledUp=true, const bool &typeNO=true, const unsigned long int &dbncTimeOrigSett=0, const unsigned long int &strtDelay=0)
	Class constructor.
	LtchMPBttn (gpioPinId_t mpbttnPinStrct, 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 trnOffASfAP class attribute flag.
const bool	getUnlatchPend () const
	Returns the value of the validUnlatchPending attribute.
const bool	getUnlatchRlsPend () const
	Returns the value of the validUnlatchReleasePending attribute.
bool	resetFda ()
	See DbncdMPBttn::resetFda()
void	setTrnOffASAP (const bool &newVal)
	Sets the value of the trnOffASAP attribute flag.
void	setUnlatchPend (const bool &newVal)
	Sets the value of the validUnlatchPending attribute.
void	setUnlatchRlsPend (const bool &newVal)
	Sets the value of the validUnlatchRlsPending 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 (GPIO_TypeDef *mpbttnPort, const uint16_t &mpbttnPin, const bool &pulledUp=true, const bool &typeNO=true, const unsigned long int &dbncTimeOrigSett=0, const unsigned long int &strtDelay=0)
	Class constructor.
	DbncdDlydMPBttn (gpioPinId_t mpbttnPinStrct, const bool &pulledUp=true, const bool &typeNO=true, const unsigned long int &dbncTimeOrigSett=0, const unsigned long int &strtDelay=0)
	Class constructor.
bool	init (GPIO_TypeDef *mpbttnPort, const uint16_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(GPIO_TypeDef*, const uint16_t, const bool, const bool, const unsigned long int)
bool	init (gpioPinId_t mpbttnPinStrct, const bool &pulledUp=true, const bool &typeNO=true, const unsigned long int &dbncTimeOrigSett=0, const unsigned long int &strtDelay=0)
	see DbncdMPBttn::init(gpioPinId_t, const bool, const bool, const unsigned long int)
void	setStrtDelay (const unsigned long int &newStrtDelay)
	Sets a new value to the delay attribute.
Public Member Functions inherited from DbncdMPBttn
	DbncdMPBttn ()
	Default class constructor.
	DbncdMPBttn (GPIO_TypeDef *mpbttnPort, const uint16_t &mpbttnPin, const bool &pulledUp=true, const bool &typeNO=true, const unsigned long int &dbncTimeOrigSett=0)
	Class constructor.
	DbncdMPBttn (gpioPinId_t mpbttnPinStrct, 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. 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 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 flag.
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 (GPIO_TypeDef *mpbttnPort, const uint16_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	init (gpioPinId_t mpbttnPinStrct, 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.
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 newOutputChange)
	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 pointer to the task to be notified by the object when its output attribute flags changes.
virtual void	setTaskWhileOn (const TaskHandle_t &newTaskHandle)
	Sets the handle to the task to be run while the object is in the On state.

Detailed Description

Models a Toggle Latch DD-MPB, a.k.a. a Toggle Switch (ToLDD-MPB).

The Toggle switch keeps the ON state since the moment the signal is stable (debouncing + delay process), and keeps the ON state after the push button is released and until it is pressed once again. So this simulates a simple On-Off switch like the one used to turn on/off a room light. The included methods lets the designer define the unlatch event as the instant the MPB is started to be pressed for the second time or when the MPB is released from that second press.

Constructor & Destructor Documentation

TgglLtchMPBttn() [1/2]

TgglLtchMPBttn::TgglLtchMPBttn	(	GPIO_TypeDef *	mpbttnPort,
		const uint16_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(GPIO_TypeDef*, const uint16_t, const bool, const bool, const unsigned long int, const unsigned long int)

TgglLtchMPBttn() [2/2]

TgglLtchMPBttn::TgglLtchMPBttn	(	gpioPinId_t	mpbttnPinStrct,
		const bool &	pulledUp = true,
		const bool &	typeNO = true,
		const unsigned long int &	dbncTimeOrigSett = 0,
		const unsigned long int &	strtDelay = 0 )

Class constructor.

Parameters

mpbttnPinStrct

GPIO port and Pin identification defined as a single gpioPinId_t parameter. For the rest of the parameters see DbncdMPBttn(GPIO_TypeDef*, const uint16_t, const bool, const bool, const unsigned long int)