Inheritance diagram for Supla::Control::ActionTrigger:

[legend]

Collaboration diagram for Supla::Control::ActionTrigger:

[legend]

Classes
union	ActionTriggerFlags

struct	RuntimeFlags

Public Member Functions
ActionTrigger *	getActionTrigger () override

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.

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	iterateAlways () override
	Method called on each SuplaDevice iteration.

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

void	fillChannelConfig (void channelConfig, int size, uint8_t configType) override

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

void	rebuildForAttachedButton ()

void	disableATCapability (uint32_t capToDisable)

void	enableStateStorage ()

bool	isAnyActionEnabledOnServer () const

void	setAlwaysUseOnClick1 ()

ActionTrigger &	setLocalUnlockAllowed (bool allowed=true)

bool	isLocalUnlockAllowed () const

ActionTrigger &	setKeepConfigButtonTriggerAlwaysAvailable (bool keep=true)

bool	keepsConfigButtonTriggerAlwaysAvailable () const

void	enable ()

void	disable ()

bool	isWeeklyScheduleSupported () const

ActionTrigger &	setWeeklyScheduleAvailable (bool available=true)

bool	setWeeklyScheduleController (WeeklyScheduleController controller, WeeklyScheduleConfigHandler configHandler=nullptr, WeeklyScheduleProgramSource *programSource=nullptr)

Public Member Functions inherited from Supla::ElementWithChannelActions
	ElementWithChannelActions (ElementMode mode=ElementMode::Registered)

void	addAction (uint16_t action, ActionHandler &client, uint16_t event, bool alwaysEnabled=false) override

void	addAction (uint16_t action, ActionHandler *client, uint16_t event, bool alwaysEnabled=false) override

virtual void	addAction (uint16_t action, ActionHandler &client, uint16_t event, Supla::Condition *condition, bool alwaysEnabled=false)
	Adds a conditional local action for a specific event.

virtual void	addAction (uint16_t action, ActionHandler client, uint16_t event, Supla::Condition condition, bool alwaysEnabled=false)
	Pointer variant of addAction(action, client, event, condition).

virtual void	addAction (uint16_t action, ActionHandler &client, Supla::Condition *condition, bool alwaysEnabled=false)

virtual void	addAction (uint16_t action, ActionHandler client, Supla::Condition condition, bool alwaysEnabled=false)

bool	isEventAlreadyUsed (uint16_t event, bool ignoreAlwaysEnabled) override

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

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

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

void	handleChannelConfigFinished (int channelNumber) override
	Handles "channel config finished" for a specific channel.

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

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

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

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

void	runAction (uint16_t event) const override

void	runAction (uint16_t event, const ActionAllowList &allowOnlyActions) const override

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

void	triggerSetChannelConfig (int configType=SUPLA_CONFIG_TYPE_DEFAULT, bool localChange=false)

virtual bool	iterateConnected (void *ptr)
	deprecated

Public Member Functions inherited from Supla::Element
	Element (ElementMode mode=ElementMode::Registered)

Element *	next ()
	Returns next Element from the list.

virtual bool	isStateStorageMigrationNeeded () const
	Method called after onInit() to check if state storage migration is needed.

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 void	fillSuplaChannelNewValue (TSD_SuplaChannelNewValue *value)
	Fills TSD_SuplaChannelNewValue based on current state.

virtual bool	getRemainingCountdownTimerSec (uint32_t *remainingSec) const
	Returns active countdown timer remaining time in seconds.

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 uint32_t	getCalcfgPendingTimeoutMs (TSD_DeviceCalCfgRequest *request) const
	Returns timeout in milliseconds for CALCFG requests that become pending.

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

const Channel *	getChannelByChannelNumber (int channelNumber) const
	Returns pointer to the channel matching channelNumber.

Channel *	getChannelByChannelNumber (int channelNumber)

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.

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 bool	setRuntimeFunction (uint32_t newFunction)
	Sets channel's function at runtime.

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

Public Member Functions inherited from Supla::LocalAction
virtual bool	hasEnabledAction (uint16_t event, uint16_t action) const

virtual ActionHandlerClient *	getHandlerForFirstClient (uint16_t event)

virtual ActionHandlerClient *	getHandlerForClient (ActionHandler *client, uint16_t event)

virtual void	disableOtherClients (const ActionHandler &client, uint16_t event)

virtual void	enableOtherClients (const ActionHandler &client, uint16_t event)

virtual void	disableOtherClients (const ActionHandler *client, uint16_t event)

virtual void	enableOtherClients (const ActionHandler *client, uint16_t event)

virtual void	disableAction (int32_t action, ActionHandler *client, int32_t event)

virtual void	enableAction (int32_t action, ActionHandler *client, int32_t event)

virtual bool	disableActionsInConfigMode ()

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.

Static Public Member Functions inherited from Supla::LocalAction
static void	DeleteActionsHandledBy (const ActionHandler *client)

static void	DeleteActionsHandledByExcept (const ActionHandler *client, const ActionAllowList &preservedActions)

static void	DeleteActionsTriggeredBy (const LocalAction *action)

static void	DeleteAction (const LocalAction trigger, const ActionHandler client, uint16_t event, uint16_t action)

static void	NullifyActionsHandledBy (const ActionHandler *client)

static ActionHandlerClient *	getClientListPtr ()

Protected Member Functions
ApplyConfigResult	applyChannelConfig (TSD_ChannelConfig *result, bool local) override

bool	shouldProcessChannelFunctionFromConfig () const override

virtual void	fillDefaultWeeklySchedule (TChannelConfig_WeeklySchedule *schedule)

virtual bool	isWeeklyScheduleProgramModeSupported (uint8_t mode) const

bool	ensureNativeWeeklyScheduleController ()

void	updateWeeklyScheduleCapabilities ()

void	scheduleStateSave (uint32_t delayMsMax=5000, uint32_t delayMsMin=2000)

void	applyButtonMode (uint8_t mode)

void	applyManualButtonMode (uint8_t mode)

void	addActionToButtonAndDisableIt (int event, int action)

void	parseActiveActionsFromServer ()

bool	hasDirectionalPair () const

bool	requiresClickMode () const

Protected Member Functions inherited from Supla::ElementWithChannelActions
virtual bool	setAndSaveFunction (uint32_t channelFunction)

virtual bool	loadFunctionFromConfig ()

bool	setAndSaveConfigChangeFlag (bool value)

virtual bool	saveConfigChangeFlag () const

virtual bool	loadConfigChangeFlag ()

void	clearChannelConfigChangedFlag ()

void	markChannelConfigReceived (int configType)

void	markAllChannelConfigsReceived ()

bool	isChannelConfigFinishedReceived () const

bool	isLocalChannelConfigChangePending (int configType) const

bool	iterateConfigExchange ()

int	getNextConfigType () const
	Returns the next config type to be sent.

int	getNextLocalConfigType () const

bool	setLocalConfigChange (int configType, bool value=true)

void	clearLocalConfigChanges (int configType, int secondConfigType=-1)

uint8_t	getUsedLocalConfigTypes () const

Static Protected Member Functions
static void	synchronizeDirectionalButtonModes ()

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

Supla::ActionHandlerClient *	localHandlerForEnabledAt = nullptr

Supla::ActionHandlerClient *	localHandlerForDisabledAt = nullptr

Supla::ActionHandler *	localHandlerClient = nullptr

uint32_t	activeActionsFromServer = 0

uint32_t	lastReceivedActiveActions = 0

uint32_t	disablesLocalOperation = 0

uint32_t	disabledCapabilities = 0

Supla::AtChannel	channel

uint16_t	localHandlerAction = 0

ActionHandlingType	actionHandlingType = ActionHandlingType_RelayOnSuplaServer

RuntimeFlags	runtimeFlags

WeeklyScheduleComponents	weeklyScheduleComponents

Protected Attributes inherited from Supla::ElementWithChannelActions
ChannelConfigState	channelConfigState: 4

uint8_t	setChannelConfigAttempts: 2

uint8_t	configFinishedReceived: 1

uint8_t	reserved: 1

ConfigTypesBitmap	locallyChangedConfigTypes

ConfigTypesBitmap	usedConfigTypes

ConfigTypesBitmap	receivedConfigTypes

Protected Attributes inherited from Supla::Element
bool	registeredElement = true

Element *	nextPtr = nullptr

Friends
class	ActionTriggerWeeklySchedule

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.

◆ applyChannelConfig()

Supla::ApplyConfigResult Supla::Control::ActionTrigger::applyChannelConfig	(	TSD_ChannelConfig *	result,
		bool	local )

overrideprotectedvirtual

Reimplemented from Supla::ElementWithChannelActions.

◆ fillChannelConfig()

void Supla::Control::ActionTrigger::fillChannelConfig	(	void *	channelConfig,
		int *	size,
		uint8_t	configType )

overridevirtual

Reimplemented from Supla::ElementWithChannelActions.

◆ getActionTrigger()

ActionTrigger * Supla::Control::ActionTrigger::getActionTrigger ( )

inlineoverridevirtual

Reimplemented from Supla::Element.

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

◆ handleNewValueFromServer()

int32_t Supla::Control::ActionTrigger::handleNewValueFromServer ( TSD_SuplaChannelNewValue * newValue )

overridevirtual

Handles "new value" request from server.

Parameters

newValue pointer to TSD_SuplaChannelNewValue

Returns: -1 - don't send reply to server 0 - success==false 1 - success==true

Reimplemented from Supla::Element.

◆ iterateAlways()

void Supla::Control::ActionTrigger::iterateAlways ( )

overridevirtual

Method called on each SuplaDevice iteration.

It should provide all actions that have to be executed periodically regardless of network state.

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.

◆ purgeConfig()

void Supla::Control::ActionTrigger::purgeConfig ( )

overridevirtual

Removes all configration data related to the element from Storage::Config.

Reimplemented from Supla::Element.

◆ shouldProcessChannelFunctionFromConfig()

bool Supla::Control::ActionTrigger::shouldProcessChannelFunctionFromConfig ( ) const

overrideprotectedvirtual

Reimplemented from Supla::ElementWithChannelActions.

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

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

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Member Function Documentation

◆ activateAction()

◆ applyChannelConfig()

◆ fillChannelConfig()

◆ getActionTrigger()

◆ getChannel() [1/2]

◆ getChannel() [2/2]

◆ handleAction()

◆ handleNewValueFromServer()

◆ iterateAlways()

◆ onInit()

◆ onLoadConfig()

◆ onLoadState()

◆ onRegistered()

◆ onSaveState()

◆ purgeConfig()

◆ shouldProcessChannelFunctionFromConfig()