Inheritance diagram for SuplaDeviceClass:

[legend]

Collaboration diagram for SuplaDeviceClass:

[legend]

Public Member Functions
void	fillStateData (TDSC_ChannelState *channelState)

void	addClock (Supla::Clock *clock)

Supla::Clock *	getClock ()

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

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

int	getCurrentStatus ()

bool	loadDeviceConfig ()

bool	prepareLastStateLog ()

char *	getLastStateLog ()

void	addLastStateLog (const char *)

void	enableLastStateLog ()

void	disableLastStateLog ()

void	setRsaPublicKeyPtr (const uint8_t *ptr)

const uint8_t *	getRsaPublicKey ()

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

Supla::Protocol::SuplaSrpc *	getSrpcLayer ()

void	setCustomHostnamePrefix (const char *prefix)

void	enableNetwork ()

void	disableNetwork ()

bool	getStorageInitResult ()

bool	isSleepingAllowed ()

void	allowWorkInOfflineMode (int mode=1)

bool	isRemoteDeviceConfigEnabled () const

void	setShowUptimeInChannelState (bool value)

void	setProtoVerboseLog (bool value)

bool	isOfflineModeDuringConfig () const

Supla::Mutex *	getTimerAccessMutex ()

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

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

void	setMacLengthInHostname (int value)

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

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

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

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

Supla::AutoUpdateMode	getAutoUpdateMode () const
	Returns current automatic firmware update mode.

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	checkIfRestartIsNeeded (uint32_t _millis)

void	createSrpcLayerIfNeeded ()

void	setupDeviceMode ()

Protected Attributes
int	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

int	allowOfflineMode = 1

int	currentStatus = STATUS_UNKNOWN

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	configEmpty = true

bool	atLeastOneProtoIsEnabled = false

bool	showUptimeInChannelState = true

bool	lastStateLogEnabled = true

bool	initializationDone = false

bool	goToConfigModeAsap = false

bool	triggerSwUpdateIfAvailable = false

uint8_t	goToOfflineModeTimeout = 0

uint8_t	leaveCfgModeAfterInactivityMin = 5

uint8_t	macLengthInHostname = 6

Supla::Protocol::SuplaSrpc *	srpcLayer = nullptr

Supla::Device::SwUpdate *	swUpdate = nullptr

const uint8_t *	rsaPublicKey = nullptr

Supla::Element *	iterateConnectedPtr = nullptr

_impl_arduino_status	impl_arduino_status = nullptr

Supla::Device::LastStateLogger *	lastStateLogger = nullptr

char *	customHostnamePrefix = nullptr

Supla::Mutex *	timerAccessMutex = nullptr

Supla::Device::SubdevicePairingHandler *	subdevicePairingHandler = nullptr

Supla::Device::StatusLed *	statusLed = 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

◆ getAutoUpdateMode()

Supla::AutoUpdateMode SuplaDeviceClass::getAutoUpdateMode ( ) const

Returns current automatic firmware update mode.

Returns: current automatic firmware update 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

◆ setAutomaticFirmwareUpdateSupported()

void SuplaDeviceClass::setAutomaticFirmwareUpdateSupported ( bool value )

Sets automatic firmware update support.

Parameters

value true to enable, false to disable

◆ 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

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

◆ getAutoUpdateMode()

◆ handleAction()

◆ initSwUpdateInstance()

◆ isAutomaticFirmwareUpdateEnabled()

◆ setAutomaticFirmwareUpdateSupported()

◆ setLeaveCfgModeAfterInactivityMin()