Inheritance diagram for BinaryBase:

[legend]

Collaboration diagram for BinaryBase:

[legend]

Public Member Functions
virtual bool	getValue ()=0

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

Channel *	getChannel () override

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

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

Supla::ApplyConfigResult	applyChannelConfig (TSD_ChannelConfig *config, bool local=false) override

bool	isServerInvertLogic () const
	Get the invert logic setting.

bool	setServerInvertLogic (bool invertLogic, bool local=true)
	Set the invert logic.

uint16_t	getTimeoutDs () const
	Get the timeout in deciseconds (1 == 0.1 s).

bool	setTimeoutDs (uint16_t timeoutDs, bool local=true)
	Set the timeout in deciseconds (1 == 0.1 s).

uint16_t	getFilteringTimeMs () const
	Get the filtering time in ms.

bool	setFilteringTimeMs (uint16_t filteringTimeMs, bool local=true)
	Set the filtering time in ms.

uint8_t	getSensitivity () const
	Get the sensitivity.

bool	setSensitivity (uint8_t sensitivity, bool local=true)
	Set the sensitivity.

void	setReadIntervalMs (uint32_t intervalMs)
	Set the read interval in ms.

void	purgeConfig () override
	Purge the configuration.

void	fillChannelConfig (void channelConfig, int size, uint8_t configType) override
	Fill the channel config.

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

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

virtual bool	loadFunctionFromConfig ()

virtual bool	saveConfigChangeFlag () const

virtual bool	loadConfigChangeFlag ()

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

void	triggerSetChannelConfig (int configType=SUPLA_CONFIG_TYPE_DEFAULT)

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

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

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

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

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.

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

Protected Member Functions
void	saveConfig ()

void	printConfig ()

Protected Member Functions inherited from Supla::ElementWithChannelActions
bool	iterateConfigExchange ()

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

Protected Attributes
uint32_t	lastReadTime = 0

uint32_t	readIntervalMs = 100

BinarySensorChannel	channel

BinarySensorConfig	config

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

uint8_t	setChannelConfigAttempts = 0

ConfigTypesBitmap	usedConfigTypes

ConfigTypesBitmap	receivedConfigTypes

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

Additional Inherited Members
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 ()

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

static bool	invalidatePtr = false

Member Function Documentation

◆ applyChannelConfig()

Supla::ApplyConfigResult BinaryBase::applyChannelConfig	(	TSD_ChannelConfig *	config,
		bool	local = false )

overridevirtual

Reimplemented from Supla::ElementWithChannelActions.

◆ fillChannelConfig()

void BinaryBase::fillChannelConfig	(	void *	channelConfig,
		int *	size,
		uint8_t	configType )

overridevirtual

Fill the channel config.

Parameters

channelConfig
size
configType

Reimplemented from Supla::ElementWithChannelActions.

◆ getChannel() [1/2]

const Supla::Channel * BinaryBase::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 * BinaryBase::getChannel ( )

overridevirtual

Reimplemented from Supla::Element.

◆ getFilteringTimeMs()

uint16_t BinaryBase::getFilteringTimeMs ( ) const

Get the filtering time in ms.

0 - not used. Input state changes shorter than this time are ignored.

Returns: filtering time in ms

◆ getSensitivity()

uint8_t BinaryBase::getSensitivity ( ) const

Get the sensitivity.

0 - not used; 1..101 -> 0..100 % value 1 is 0% -> off Actual interpretation depends on the sensor implementation

Returns: sensitivity

◆ getTimeoutDs()

uint16_t BinaryBase::getTimeoutDs ( ) const

Get the timeout in deciseconds (1 == 0.1 s).

0 - not used. When timeout is used, sensor should clear it's state after configured time.

Returns: timeout in deciseconds

◆ isServerInvertLogic()

bool BinaryBase::isServerInvertLogic ( ) const

Get the invert logic setting.

Returns: true if invert logic is enabled

◆ iterateAlways()

void BinaryBase::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.

◆ onLoadConfig()

void BinaryBase::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.

◆ purgeConfig()

void BinaryBase::purgeConfig ( )

overridevirtual

Purge the configuration.

Reimplemented from Supla::Element.

◆ setFilteringTimeMs()

bool BinaryBase::setFilteringTimeMs	(	uint16_t	filteringTimeMs,
		bool	local = true )

Set the filtering time in ms.

0 - not used. Input state changes shorter than this time are ignored. Parameter is synchronized with the server.

Parameters

filteringTimeMs
local	use true if change originates locally from the device (i.e. from config mode)

Returns: true if filtering time was changed

◆ setReadIntervalMs()

void BinaryBase::setReadIntervalMs ( uint32_t intervalMs )

Set the read interval in ms.

Sensor will try to read value every interval. Setting to 0 will configure default value 100 ms

Parameters

intervalMs

◆ setSensitivity()

bool BinaryBase::setSensitivity	(	uint8_t	sensitivity,
		bool	local = true )

Set the sensitivity.

0 - not used; 1..101 -> 0..100 % value 1 is 0% -> off Parameter is synchronized with the server.

Parameters

sensitivity
local	use true if change originates locally from the device (i.e. from config mode)

Returns: true if sensitivity was changed

◆ setServerInvertLogic()

bool BinaryBase::setServerInvertLogic	(	bool	invertLogic,
		bool	local = true )

Set the invert logic.

Parameter is synchronized with the server.

Parameters

invertLogic	true if invert logic should be enabled
local	use true if change originates locally from the device (i.e. from config mode)

Returns: true if invert logic was changed

◆ setTimeoutDs()

bool BinaryBase::setTimeoutDs	(	uint16_t	timeoutDs,
		bool	local = true )

Set the timeout in deciseconds (1 == 0.1 s).

0 - not used. When timeout is used, sensor should clear it's state after configured time. Parameter is synchronized with the server.

Parameters

timeoutDs
local	use true if change originates locally from the device (i.e. from config mode)

Returns: true if timeout was changed

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

src/supla/sensor/binary_base.h
src/supla/sensor/binary_base.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ applyChannelConfig()

◆ fillChannelConfig()

◆ getChannel() [1/2]

◆ getChannel() [2/2]

◆ getFilteringTimeMs()

◆ getSensitivity()

◆ getTimeoutDs()

◆ isServerInvertLogic()

◆ iterateAlways()

◆ onLoadConfig()

◆ purgeConfig()

◆ setFilteringTimeMs()

◆ setReadIntervalMs()

◆ setSensitivity()

◆ setServerInvertLogic()

◆ setTimeoutDs()