Inheritance diagram for Relay:

[legend]

Collaboration diagram for Relay:

[legend]

Classes
struct	ButtonListElement

Public Member Functions
	Relay (Supla::Io *io, int pin, bool highIsOn=true, _supla_int_t functions=(0xFF ^ SUPLA_BIT_FUNC_CONTROLLINGTHEROLLERSHUTTER))

	Relay (int pin, bool highIsOn=true, _supla_int_t functions=(0xFF ^ SUPLA_BIT_FUNC_CONTROLLINGTHEROLLERSHUTTER))

virtual Relay &	setDefaultStateOn ()

virtual Relay &	setDefaultStateOff ()

virtual Relay &	setDefaultStateRestore ()

virtual Relay &	keepTurnOnDuration (bool keep=true)

virtual uint8_t	pinOnValue ()

virtual uint8_t	pinOffValue ()

virtual void	turnOn (_supla_int_t duration=0)

virtual void	turnOff (_supla_int_t duration=0)

virtual bool	isOn ()

virtual void	toggle (_supla_int_t duration=0)

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

void	handleAction (int event, int action) override

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

void	onInit () override
	Third 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.

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

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

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

uint8_t	applyChannelConfig (TSD_ChannelConfig *result, bool local=false) override

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

unsigned _supla_int_t	getStoredTurnOnDurationMs ()

bool	isStaircaseFunction () const

bool	isImpulseFunction () const

void	disableCountdownTimerFunction ()

void	enableCountdownTimerFunction ()

bool	isCountdownTimerFunctionEnabled () const

void	setMinimumAllowedDurationMs (uint32_t durationMs)

void	fillChannelConfig (void channelConfig, int size) override

void	setDefaultRelatedMeterChannelNo (int channelNo)

void	setTurnOffWhenEmptyAggregator (bool turnOff)

Public Member Functions inherited from Supla::ChannelElement
	ChannelElement (int channelNumber=-1)

Channel *	getChannel () override

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

Public Member Functions inherited from Supla::ElementWithChannelActions
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, 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	handleChannelConfigFinished () override
	Handles "channel config finished" message from server.

uint8_t	handleChannelConfig (TSD_ChannelConfig *result, bool local) override
	Handles "set channel config" 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	clearChannelConfigChangedFlag ()

void	runAction (uint16_t event) const override

virtual bool	setAndSaveFunction (_supla_int_t channelFunction)

virtual bool	loadFunctionFromConfig ()

virtual bool	saveConfigChangeFlag ()

virtual bool	loadConfigChangeFlag ()

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

virtual void	fillChannelOcrConfig (void channelConfig, int size)

void	triggerSetChannelConfig ()

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

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

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.

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

void	setDefaultFunction (int32_t defaultFunction)
	Sets default channel's function.

Public Member Functions inherited from Supla::LocalAction
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 void	activateAction (int action)

virtual bool	deleteClient ()

virtual ActionHandler *	getRealClient ()

Static Public Member Functions
static void	setRelayStorageSaveDelay (int delayMs)

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	DeleteActionsTriggeredBy (const LocalAction *action)

static void	NullifyActionsHandledBy (const ActionHandler *client)

static ActionHandlerClient *	getClientListPtr ()

Protected Member Functions
void	setChannelFunction (_supla_int_t newFunction)

void	updateTimerValue ()

void	updateRelayHvacAggregator ()

Protected Member Functions inherited from Supla::ElementWithChannelActions
virtual bool	hasOcrConfig () const

virtual bool	isOcrConfigMissing () const

virtual void	clearOcrConfig ()

Protected Attributes
int32_t	channelFunction = 0

uint32_t	durationMs = 0

uint32_t	storedTurnOnDurationMs = 0

uint32_t	durationTimestamp = 0

uint32_t	overcurrentThreshold = 0

uint32_t	timerUpdateTimestamp = 0

Supla::Io *	io = nullptr

ButtonListElement *	buttonList = nullptr

uint16_t	minimumAllowedDurationMs = 0

int16_t	pin = -1

bool	highIsOn = true

bool	keepTurnOnDurationMs = false

bool	lastStateOnTimerUpdate = false

bool	turnOffWhenEmptyAggregator = true

int8_t	stateOnInit = STATE_ON_INIT_OFF

int16_t	defaultRelatedMeterChannelNo = -1

Protected Attributes inherited from Supla::ChannelElement
Channel	channel

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

bool	configFinishedReceived = false

uint8_t	setChannelConfigAttempts = 0

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

Static Protected Attributes
static int16_t	relayStorageSaveDelay = 5000

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

static bool	invalidatePtr = false

Member Function Documentation

◆ applyChannelConfig()

uint8_t Relay::applyChannelConfig	(	TSD_ChannelConfig *	result,
		bool	local = false )

overridevirtual

Reimplemented from Supla::ElementWithChannelActions.

◆ fillChannelConfig()

void Relay::fillChannelConfig	(	void *	channelConfig,
		int *	size )

overridevirtual

Reimplemented from Supla::ElementWithChannelActions.

◆ fillSuplaChannelNewValue()

void Relay::fillSuplaChannelNewValue ( TSD_SuplaChannelNewValue * value )

overridevirtual

Fills TSD_SuplaChannelNewValue based on current state.

Parameters

value pointer to TSD_SuplaChannelNewValue which should be filled

Reimplemented from Supla::Element.

◆ handleAction()

void Relay::handleAction	(	int	event,
		int	action )

overridevirtual

Implements Supla::ActionHandler.

◆ handleNewValueFromServer()

int32_t Relay::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 Relay::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.

◆ iterateConnected()

bool Relay::iterateConnected ( )

overridevirtual

Method called on each SuplaDevice iteration when device is connected and registered to Supla server or other protocol.

Returns: false when element didn't communicate with server and next element should be iterated instead. true otherwise.

Reimplemented from Supla::ElementWithChannelActions.

◆ onInit()

void Relay::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 Relay::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 Relay::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 Relay::onRegistered ( Supla::Protocol::SuplaSrpc * suplaSrpc )

overridevirtual

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

Parameters

suplaSrpc

Reimplemented from Supla::ElementWithChannelActions.

◆ onSaveState()

void Relay::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/relay.h
src/supla/control/relay.cpp

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Member Function Documentation

◆ applyChannelConfig()

◆ fillChannelConfig()

◆ fillSuplaChannelNewValue()

◆ handleAction()

◆ handleNewValueFromServer()

◆ iterateAlways()

◆ iterateConnected()

◆ onInit()

◆ onLoadConfig()

◆ onLoadState()

◆ onRegistered()

◆ onSaveState()