Inheritance diagram for Supla::Control::ActionTrigger:

[legend]

Collaboration diagram for Supla::Control::ActionTrigger:

[legend]

Public Member Functions
void	attach (Supla::Control::Button *)

void	attach (Supla::Control::Button &)

void	setRelatedChannel (Element *)

void	setRelatedChannel (Channel *)

void	setRelatedChannel (Element &)

void	setRelatedChannel (Channel &)

void	handleAction (int event, int action) override

void	activateAction (int action) override

Supla::Channel *	getChannel () override

const Supla::Channel *	getChannel () const override
	Returns pointer to main channel.

void	onInit () override
	Third method called on element in SuplaDevice.begin()

void	onRegistered (Supla::Protocol::SuplaSrpc *suplaSrpc=nullptr) override
	Method called each time when device successfully registers to Supla server.

uint8_t	handleChannelConfig (TSD_ChannelConfig *result, bool local=false) override
	Handles "set channel config" request from server.

void	onLoadConfig (SuplaDeviceClass *) override
	First method called on element in SuplaDevice.begin().

void	onLoadState () override
	Second method called on element in SuplaDevice.begin().

void	onSaveState () override
	Method called periodically during SuplaDevice iteration.

void	disableATCapability (uint32_t capToDisable)

void	enableStateStorage ()

bool	isAnyActionEnabledOnServer () const

void	setAlwaysUseOnClick1 ()

Public Member Functions inherited from Supla::Element
Element *	next ()
	Returns next Element from the list.

virtual void	purgeConfig ()
	Removes all configration data related to the element from Storage::Config.

virtual void	iterateAlways ()
	Method called on each SuplaDevice iteration.

virtual bool	iterateConnected ()
	Method called on each SuplaDevice iteration when device is connected and registered to Supla server or other protocol.

virtual bool	iterateConnected (void *ptr)
	deprecated

virtual void	onTimer ()
	Method called on timer interupt.

virtual void	onFastTimer ()
	Method called on fast timer interupt.

virtual void	onSoftReset ()
	Method called when device soft restart is triggered.

virtual void	onDeviceConfigChange (uint64_t fieldBit)
	Method called when device config is changed.

virtual int32_t	handleNewValueFromServer (TSD_SuplaChannelNewValue *newValue)
	Handles "new value" request from server.

virtual void	fillSuplaChannelNewValue (TSD_SuplaChannelNewValue *value)
	Fills TSD_SuplaChannelNewValue based on current state.

virtual void	handleGetChannelState (TDSC_ChannelState *channelState)
	Handles "get channel state (i)" request from server.

virtual int	handleCalcfgFromServer (TSD_DeviceCalCfgRequest *request)
	Handles CALCFG requests from server.

virtual uint8_t	handleWeeklySchedule (TSD_ChannelConfig *newWeeklySchedule, bool altSchedule=false, bool local=false)
	Handles "set channel config" with "weekly schedule" type request from server.

virtual void	handleSetChannelConfigResult (TSDS_SetChannelConfigResult *result)
	Handles "set channel config" reply from server.

virtual void	handleChannelConfigFinished ()
	Handles "channel config finished" message from server.

int	getChannelNumber () const
	Returns channel number.

int	getSecondaryChannelNumber () const
	Returns secondary channel number.

virtual bool	isOwnerOfSubDeviceId (int subDeviceId) const
	Returns true if element is owner of subDeviceId.

virtual const Channel *	getSecondaryChannel () const
	Returns pointer to secondary channel.

virtual Channel *	getSecondaryChannel ()

virtual void	generateKey (char output, const char key) const
	Generates key used for Config.

Element &	disableChannelState ()
	Disables channel state (i) function.

bool	isChannelStateEnabled () const
	Returns true if channel state (i) function is enabled.

virtual bool	isAnyUpdatePending ()
	Returns true if any update is pending.

void	setInitialCaption (const char *caption, bool secondaryChannel=false)
	Sets initial caption.

bool	setDefaultFunction (uint32_t defaultFunction)
	Sets default channel's function.

bool	setFunction (uint32_t newFunction)
	Sets channel's function.

virtual void	onFunctionChange (uint32_t currentFunction, uint32_t newFunction)
	Called when channel function changes.

Public Member Functions inherited from Supla::ActionHandler
virtual bool	deleteClient ()

virtual ActionHandler *	getRealClient ()

Static Public Member Functions
static int	actionTriggerCapToButtonEvent (uint32_t actionCap)

static int	actionTriggerCapToActionId (uint32_t actionCap)

static int	getActionTriggerCap (int action)

Static Public Member Functions inherited from Supla::Element
static Element *	begin ()
	Returns first Element (based on creation order)

static Element *	last ()
	Returns last Element (based on creation order)

static Element *	getElementByChannelNumber (int channelNumber)
	Returns Element by channel number.

static Element *	getOwnerOfSubDeviceId (int subDeviceId)
	Returns Element which owns given subDeviceId.

static bool	IsAnyUpdatePending ()
	Checks if any element has pending update for remote server.

static void	NotifyElementsAboutConfigChange (uint64_t fieldBit)
	Notifies all elements about device config change.

static bool	IsInvalidPtrSet ()
	When "invalid pointer" is set, previously obtained Element pointer may be invalid.

static void	ClearInvalidPtr ()
	Clears "invalid pointer" flag.

Protected Member Functions
void	addActionToButtonAndDisableIt (int event, int action)

void	parseActiveActionsFromServer ()

Protected Attributes
Supla::Control::Button *	attachedButton = nullptr

Supla::ActionHandlerClient *	localHandlerForEnabledAt = nullptr

Supla::ActionHandlerClient *	localHandlerForDisabledAt = nullptr

uint32_t	activeActionsFromServer = 0

uint32_t	disablesLocalOperation = 0

uint32_t	disabledCapabilities = 0

Supla::AtChannel	channel

ActionHandlingType	actionHandlingType = ActionHandlingType_RelayOnSuplaServer

bool	storageEnabled = false

bool	alwaysUseOnClick1 = false

Protected Attributes inherited from Supla::Element
Element *	nextPtr = nullptr

Additional Inherited Members
Static Protected Attributes inherited from Supla::Element
static Element *	firstPtr = nullptr

static bool	invalidatePtr = false

Member Function Documentation

◆ activateAction()

void Supla::Control::ActionTrigger::activateAction ( int action )

overridevirtual

Reimplemented from Supla::ActionHandler.

◆ getChannel() [1/2]

const Supla::Channel * Supla::Control::ActionTrigger::getChannel ( ) const

overridevirtual

Returns pointer to main channel.

Returns: pointer to main channel, nullptr if element has no channel

Reimplemented from Supla::Element.

◆ getChannel() [2/2]

Supla::Channel * Supla::Control::ActionTrigger::getChannel ( )

overridevirtual

Reimplemented from Supla::Element.

◆ handleAction()

void Supla::Control::ActionTrigger::handleAction	(	int	event,
		int	action )

overridevirtual

Implements Supla::ActionHandler.

◆ handleChannelConfig()

uint8_t Supla::Control::ActionTrigger::handleChannelConfig	(	TSD_ChannelConfig *	newChannelConfig,
		bool	local = false )

overridevirtual

Handles "set channel config" request from server.

Parameters

newChannelConfig	pointer to new channel configuration
local	true if request is local (issued by device itself), false when requests originates from server.

Returns: SUPLA_RESULTCODE_* (see proto.h)

Reimplemented from Supla::Element.

◆ onInit()

void Supla::Control::ActionTrigger::onInit ( )

overridevirtual

Third method called on element in SuplaDevice.begin()

Method called during SuplaDevice initialization. I.e. load initial state, initialize pins etc.

Reimplemented from Supla::Element.

◆ onLoadConfig()

void Supla::Control::ActionTrigger::onLoadConfig ( SuplaDeviceClass * sdc )

overridevirtual

First method called on element in SuplaDevice.begin().

Called only if Config Storage class is configured. Element should read its configration in this method.

Parameters

sdc

Reimplemented from Supla::Element.

◆ onLoadState()

void Supla::Control::ActionTrigger::onLoadState ( )

overridevirtual

Second method called on element in SuplaDevice.begin().

Method called during state Storage initialization (i.e. read from EEPROM, FRAM). Called only if Storage class is configured.

Reimplemented from Supla::Element.

◆ onRegistered()

void Supla::Control::ActionTrigger::onRegistered ( Supla::Protocol::SuplaSrpc * suplaSrpc = nullptr )

overridevirtual

Method called each time when device successfully registers to Supla server.

Parameters

suplaSrpc

Reimplemented from Supla::Element.

◆ onSaveState()

void Supla::Control::ActionTrigger::onSaveState ( )

overridevirtual

Method called periodically during SuplaDevice iteration.

It should provide state saving for this elemnet to Storage

Reimplemented from Supla::Element.

The documentation for this class was generated from the following files:

src/supla/control/action_trigger.h
src/supla/control/action_trigger.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ activateAction()

◆ getChannel() [1/2]

◆ getChannel() [2/2]

◆ handleAction()

◆ handleChannelConfig()

◆ onInit()

◆ onLoadConfig()

◆ onLoadState()

◆ onRegistered()

◆ onSaveState()