Inheritance diagram for SuplaDeviceClass:

[legend]

Collaboration diagram for SuplaDeviceClass:

[legend]

Public Member Functions
void	fillStateData (TDSC_ChannelState *channelState) const

void	addClock (Supla::Clock *clock)

Supla::Clock *	getClock () const

bool	begin (const char GUID[SUPLA_GUID_SIZE], const char Server, const char email, const char authkey[SUPLA_AUTHKEY_SIZE], unsigned char protoVersion=23)

bool	begin (unsigned char protoVersion=23)

void	setName (const char *Name)

void	setGUID (const char GUID[SUPLA_GUID_SIZE])

void	setAuthKey (const char authkey[SUPLA_AUTHKEY_SIZE])

void	setEmail (const char *email)

void	setServer (const char *server)

void	setSwVersion (const char *)

void	setManufacturerId (int16_t)

void	setProductId (int16_t)

void	addFlags (int32_t)

void	removeFlags (int32_t)

bool	isSleepingDeviceEnabled () const

int	generateHostname (char *, int macSize=6)

void	onTimer (void)

void	onFastTimer (void)

void	iterate (void)

void	status (int status, const __FlashStringHelper *msg, bool alwaysLog=false)

void	setStatusFuncImpl (_impl_arduino_status impl_arduino_status)

void	setServerPort (int value)

int	handleCalcfgFromServer (TSD_DeviceCalCfgRequest request, TDS_DeviceCalCfgResult result=nullptr)

void	enterConfigMode ()

void	leaveConfigModeWithoutRestart ()

void	enterNormalMode ()

void	scheduleSoftRestart (int timeout=0)

void	scheduleProtocolsRestart (int timeout=0)

void	softRestart ()

void	saveStateToStorage ()

void	restartCfgModeTimeout (bool requireRestart)

void	resetToFactorySettings ()

void	disableLocalActionsIfNeeded ()

void	requestCfgMode ()

int8_t	getCurrentStatus () const

bool	loadDeviceConfig ()

bool	prepareLastStateLog ()

char *	getLastStateLog ()

void	addLastStateLog (const char *)

void	enableLastStateLog ()

void	disableLastStateLog ()

void	setRsaPublicKeyPtr (const uint8_t *ptr)

const uint8_t *	getRsaPublicKey () const

enum Supla::DeviceMode	getDeviceMode () const

void	setActivityTimeout (_supla_int_t newActivityTimeout)

uint32_t	getActivityTimeout ()

void	handleAction (int event, int action) override

void	setAutomaticResetOnConnectionProblem (unsigned int timeSec)

void	setLastStateLogger (Supla::Device::LastStateLogger *logger)

void	setSuplaCACert (const char *)

void	setSupla3rdPartyCACert (const char *)

const char *	getSuplaCACert () const

Supla::Protocol::SuplaSrpc *	getSrpcLayer ()

void	enableNetwork ()

void	disableNetwork ()

bool	getStorageInitResult ()

bool	isSleepingAllowed ()

void	allowWorkInOfflineMode (int mode=1)
	Allows device to work in offline mode DEPRECATED: use setInitialMode() instead.

void	setInitialMode (Supla::InitialMode mode)
	Sets the initial mode of the device.

Supla::InitialMode	getInitialMode () const
	Returns the initial mode of the device @See Supla::InitialMode.

bool	isRemoteDeviceConfigEnabled () const
	Checks if remote device configuration is enabled.

void	setShowUptimeInChannelState (bool value)
	Sets if "uptime" should be added to channel state (i)

void	setProtoVerboseLog (bool value)
	Enables/disables verbose logging of Supla protocol.

Supla::Mutex *	getTimerAccessMutex ()

void	setChannelConflictResolver (Supla::Device::ChannelConflictResolver *resolver)

void	setSubdevicePairingHandler (Supla::Device::SubdevicePairingHandler *handler)

void	setMacLengthInHostname (int value)
	Sets the byte length of MAC address in hostname and Wi-Fi Soft AP name.

void	setCustomHostnamePrefix (const char *prefix)
	Sets custom hostname prefix to be used in hostname and Wi-Fi Soft AP name.

void	setStatusLed (Supla::Device::StatusLed *led)

void	setLeaveCfgModeAfterInactivityMin (int valueMin)
	Sets the leave configuration mode after inactivity timeout in minutes.

bool	isLeaveCfgModeAfterInactivityEnabled () const
	Checks if leave configuration mode after inactivity is enabled.

bool	isAutomaticFirmwareUpdateEnabled () const
	Checks if automatic firmware update is supported.

void	setAutomaticFirmwareUpdateSupported (bool value)
	Sets automatic firmware update support.

void	identifyStatusLed ()
	Triggers "identify" action on status LED.

void	testStepStatusLed (int times)
	Triggers special status LED flashing sequence based on provided "times".

void	addSecurityLog (uint32_t source, const char *log) const
	Adds security log.

void	addSecurityLog (Supla::SecurityLogSource source, const char *log) const
	Adds security log.

void	setSecurityLogger (Supla::Device::SecurityLogger *logger)
	Sets instance of Supla::Device::SecurityLogger.

bool	isSecurityLogEnabled () const
	Checks if security log is enabled.

Public Member Functions inherited from Supla::ActionHandler
virtual void	activateAction (int action)

virtual bool	deleteClient ()

virtual ActionHandler *	getRealClient ()

Public Member Functions inherited from Supla::LocalAction
virtual void	addAction (uint16_t action, ActionHandler &client, uint16_t event, bool alwaysEnabled=false)

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

virtual void	runAction (uint16_t event) const

virtual bool	isEventAlreadyUsed (uint16_t event, bool ignoreAlwaysEnabled)

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 Attributes
Supla::Uptime	uptime

Protected Member Functions
void	iterateSwUpdate ()
	Performs software update if needed.

bool	initSwUpdateInstance (bool performUpdate, int securityOnly=-1)
	Initializes SW update instance.

void	iterateAlwaysElements (uint32_t _millis)

bool	iterateNetworkSetup ()

bool	iterateSuplaProtocol (uint32_t _millis)

void	handleLocalActionTriggers ()

void	checkIfLeaveCfgModeOrRestartIsNeeded ()

void	createSrpcLayerIfNeeded ()

void	setupDeviceMode ()

Protected Attributes
uint32_t	networkIsNotReadyCounter = 0

uint32_t	deviceRestartTimeoutTimestamp = 0

uint32_t	protocolRestartTimeoutTimestamp = 0

uint32_t	waitForIterate = 0

uint32_t	lastIterateTime = 0

uint32_t	enterConfigModeTimestamp = 0

uint32_t	forceRestartTimeMs = 0

uint32_t	protocolRestartTimeMs = 0

uint32_t	resetOnConnectionFailTimeoutSec = 0

uint32_t	lastSwUpdateCheckTimestamp = 0

enum Supla::DeviceMode	deviceMode = Supla::DEVICE_MODE_NOT_SET

bool	triggerResetToFactorySettings = false

bool	triggerStartLocalWebServer = false

bool	triggerStopLocalWebServer = false

bool	triggerCheckSwUpdate = false

bool	requestNetworkLayerRestart = false

bool	isNetworkSetupOk = false

bool	skipNetwork = false

bool	storageInitResult = false

bool	showUptimeInChannelState = true

bool	lastStateLogEnabled = true

bool	initializationDone = false

bool	goToConfigModeAsap = false

bool	triggerSwUpdateIfAvailable = false

uint8_t	leaveCfgModeAfterInactivityMin = 5

uint8_t	macLengthInHostname = 6

int8_t	currentStatus = STATUS_UNKNOWN

Supla::InitialMode	initialMode = Supla::InitialMode::StartInNotConfiguredMode

Supla::CfgModeState	cfgModeState = Supla::CfgModeState::NotSet

Supla::ConfigurationState	configurationState = {}

Supla::Protocol::SuplaSrpc *	srpcLayer = nullptr

Supla::Device::SwUpdate *	swUpdate = nullptr

Supla::Element *	iterateConnectedPtr = nullptr

Supla::Device::LastStateLogger *	lastStateLogger = nullptr

Supla::Mutex *	timerAccessMutex = nullptr

Supla::Device::SubdevicePairingHandler *	subdevicePairingHandler = nullptr

Supla::Device::StatusLed *	statusLed = nullptr

Supla::Device::SecurityLogger *	securityLogger = nullptr

const uint8_t *	rsaPublicKey = nullptr

char *	customHostnamePrefix = nullptr

_impl_arduino_status	impl_arduino_status = nullptr

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

Member Function Documentation

◆ addSecurityLog() [1/2]

void SuplaDeviceClass::addSecurityLog	(	Supla::SecurityLogSource	source,
		const char *	log ) const

Adds security log.

It requires instance of Supla::Device::SecurityLogger to be added earlier by calling setSecurityLogger

Parameters

source	source of security log
log	log text (max 52 B)

◆ addSecurityLog() [2/2]

void SuplaDeviceClass::addSecurityLog	(	uint32_t	source,
		const char *	log ) const

Adds security log.

It requires instance of Supla::Device::SecurityLogger to be added earlier by calling setSecurityLogger

Parameters

source	source of security log, i.e. IP address. Values < 10 have special meaning
log	log text (max 52 B)

◆ allowWorkInOfflineMode()

void SuplaDeviceClass::allowWorkInOfflineMode ( int mode = 1 )

Allows device to work in offline mode DEPRECATED: use setInitialMode() instead.

Parameters

mode	1 - offline mode with empty config, but communication protocols may be enabled 2 - offline mode only with empty config and communication protocols disabled 0 - no offline mode

◆ getInitialMode()

Supla::InitialMode SuplaDeviceClass::getInitialMode ( ) const

inline

Returns the initial mode of the device @See Supla::InitialMode.

Returns: the initial mode

◆ handleAction()

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

overridevirtual

Implements Supla::ActionHandler.

◆ initSwUpdateInstance()

bool SuplaDeviceClass::initSwUpdateInstance	(	bool	performUpdate,
		int	securityOnly = -1 )

protected

Initializes SW update instance.

Parameters

performUpdate	true to perform SW update, false to check for update
securityOnly	0 to check for all updates, 1 to check for security updates, -1 will use value from device config

Returns: true if SW update instance was initialized

◆ isAutomaticFirmwareUpdateEnabled()

bool SuplaDeviceClass::isAutomaticFirmwareUpdateEnabled ( ) const

Checks if automatic firmware update is supported.

Returns: true if automatic update is supported

◆ isLeaveCfgModeAfterInactivityEnabled()

bool SuplaDeviceClass::isLeaveCfgModeAfterInactivityEnabled ( ) const

Checks if leave configuration mode after inactivity is enabled.

It requires leaveCfgModeAfterInactivityMin > 0 and initialMode to be set to: StartWithCfgModeThenOffline, StartOffline, StartInNotConfiguredMode

Returns: true if function is enabled

◆ isRemoteDeviceConfigEnabled()

bool SuplaDeviceClass::isRemoteDeviceConfigEnabled ( ) const

Checks if remote device configuration is enabled.

Returns: true if remote device configuration is enabled

◆ isSecurityLogEnabled()

bool SuplaDeviceClass::isSecurityLogEnabled ( ) const

Checks if security log is enabled.

Returns: true if security log is enabled

◆ setAutomaticFirmwareUpdateSupported()

void SuplaDeviceClass::setAutomaticFirmwareUpdateSupported ( bool value )

Sets automatic firmware update support.

Parameters

value true to enable, false to disable

◆ setCustomHostnamePrefix()

void SuplaDeviceClass::setCustomHostnamePrefix ( const char * prefix )

Sets custom hostname prefix to be used in hostname and Wi-Fi Soft AP name.

By default device name is used as prefix. If custom prefix is set, it will be used instead. Prefix length is limited to 31 chars minus MAC appendix length (1 + 2*macLengthInHostname) Hostname prefix has to start with "SUPLA" in order to be accepted by Supla mobile app in Add Device Wizard. There are also vendor specific prefixes supported by Supla mobile app, but their usage is only for vendor's use.

Parameters

prefix custom hostname prefix

◆ setInitialMode()

void SuplaDeviceClass::setInitialMode ( Supla::InitialMode mode )

Sets the initial mode of the device.

This defines the behavior when the device starts up with factory defaults (missing configuration). @See Supla::InitialMode

Parameters

mode	the initial mode

◆ setLeaveCfgModeAfterInactivityMin()

void SuplaDeviceClass::setLeaveCfgModeAfterInactivityMin ( int valueMin )

Sets the leave configuration mode after inactivity timeout in minutes.

Device will automatically leave configuration mode after specified inactivity timeout (no HTTP GET/POST requests).

Parameters

valueMin inactivity timeout in minutes. Use 0 to disable

◆ setMacLengthInHostname()

void SuplaDeviceClass::setMacLengthInHostname ( int value )

Sets the byte length of MAC address in hostname and Wi-Fi Soft AP name.

Default value is 6. Only values 2 and 6 are accepted by Supla mobile app in Add Device Wizard. MAC appendix will consume 1 + 2*value bytes of hostname (which is 31 chars)

Parameters

value byte length of MAC address to be used in hostname.

◆ setProtoVerboseLog()

void SuplaDeviceClass::setProtoVerboseLog ( bool value )

Enables/disables verbose logging of Supla protocol.

Parameters

value true to enable verbose logging

◆ setSecurityLogger()

void SuplaDeviceClass::setSecurityLogger ( Supla::Device::SecurityLogger * logger )

Sets instance of Supla::Device::SecurityLogger.

Parameters

logger

◆ setShowUptimeInChannelState()

void SuplaDeviceClass::setShowUptimeInChannelState ( bool value )

Sets if "uptime" should be added to channel state (i)

Parameters

value true if "uptime" should be added

◆ testStepStatusLed()

void SuplaDeviceClass::testStepStatusLed ( int times )

Triggers special status LED flashing sequence based on provided "times".

Parameters

times number of times to flash

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

src/SuplaDevice.h
src/SuplaDevice.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ addSecurityLog() [1/2]

◆ addSecurityLog() [2/2]

◆ allowWorkInOfflineMode()

◆ getInitialMode()

◆ handleAction()

◆ initSwUpdateInstance()

◆ isAutomaticFirmwareUpdateEnabled()

◆ isLeaveCfgModeAfterInactivityEnabled()

◆ isRemoteDeviceConfigEnabled()

◆ isSecurityLogEnabled()

◆ setAutomaticFirmwareUpdateSupported()

◆ setCustomHostnamePrefix()

◆ setInitialMode()

◆ setLeaveCfgModeAfterInactivityMin()

◆ setMacLengthInHostname()

◆ setProtoVerboseLog()

◆ setSecurityLogger()

◆ setShowUptimeInChannelState()

◆ testStepStatusLed()