Inheritance diagram for Supla::Protocol::SuplaSrpc:

Collaboration diagram for Supla::Protocol::SuplaSrpc:

[legend]

Public Member Functions
	SuplaSrpc (SuplaDeviceClass *sdc, int version=23)
void	setNetworkClient (Supla::Client *newClient)
void	onInit () override
bool	onLoadConfig () override
bool	verifyConfig () override
bool	isEnabled () override
void	disconnect () override
bool	iterate (uint32_t _millis) override
bool	isNetworkRestartRequested () override
uint32_t	getConnectionFailTime () override
bool	isRegisteredAndReady () override
void	initClient ()
void	sendActionTrigger (uint8_t channelNumber, uint32_t actionId) override
void	sendRegisterNotification (TDS_RegisterPushNotification *notification) override
bool	sendNotification (int context, const char title, const char message, int soundId) override
void	sendSubdeviceDetails (TDS_SubdeviceDetails *subdeviceDetails) override
void	getUserLocaltime () override
void	sendChannelValueChanged (uint8_t channelNumber, int8_t *value, uint8_t offline, uint32_t validityTimeSec) override
void	sendExtendedChannelValueChanged (uint8_t channelNumber, TSuplaChannelExtendedValue *value) override
void	getChannelConfig (uint8_t channelNumber, uint8_t configType) override
bool	setChannelConfig (uint8_t channelNumber, _supla_int_t channelFunction, void *channelConfig, int size, uint8_t configType) override
bool	setDeviceConfig (TSDS_SetDeviceConfig *deviceConfig) override
bool	setInitialCaption (uint8_t channelNumber, const char *caption) override
void	sendRemainingTimeValue (uint8_t channelNumber, uint32_t timeMs, uint8_t state, int32_t senderId) override
void	sendRemainingTimeValue (uint8_t channelNumber, uint32_t remainingTime, unsigned char state[SUPLA_CHANNELVALUE_SIZE], int32_t senderId, bool useSecondsInsteadOfMs) override
void	onVersionError (TSDC_SuplaVersionError *versionError)
void	onRegisterResult (TSD_SuplaRegisterDeviceResult *register_device_result)
void	onRegisterResultB (TSD_SuplaRegisterDeviceResult_B *registerDeviceResultB)
void	onSetActivityTimeoutResult (TSDC_SuplaSetActivityTimeoutResult *result)
void	setActivityTimeout (uint32_t activityTimeoutSec)
uint32_t	getActivityTimeout ()
void	updateLastResponseTime ()
void	updateLastSentTime ()
void	onGetUserLocaltimeResult (TSDC_UserLocalTimeResult *result)
void	sendChannelStateResult (int32_t receiverId, uint8_t channelNo) override
void	setServerPort (int value)
void	setVersion (int value)
void	setSuplaCACert (const char *)
void	setSupla3rdPartyCACert (const char *)
const char *	getSuplaCACert () const
const char *	getSupla3rdPartyCACert () const
void	setLowLevelDebugLogs (bool value)
bool	isUpdatePending () override
void	handleDeviceConfig (TSDS_SetDeviceConfig *deviceConfig)
void	handleSetDeviceConfigResult (TSDS_SetDeviceConfigResult *result)
void	sendPendingCalCfgResult (int16_t channelNo, int32_t result, int32_t command, int dataSize=0, void *data=nullptr)
void	sendPendingCalCfgResultForCommand (int16_t channelNo, int32_t result, int32_t pendingCommand, int32_t responseCommand, int dataSize=0, void *data=nullptr)
void	sendCalCfgResult (int32_t receiverId, int16_t channelNo, int32_t result, int32_t command, int dataSize=0, void *data=nullptr)
void	clearPendingCalCfgResult (int16_t channelNo, int32_t command=-1)
void	clearPendingCalCfgTimeout (int16_t channelNo, int32_t command=-1)
void	setChannelConflictResolver (Supla::Device::ChannelConflictResolver *resolver)
void	logSrpcPacket (bool send, int callId, const uint8_t *buf, size_t size)
Public Member Functions inherited from Supla::Protocol::ProtocolLayer
	ProtocolLayer (SuplaDeviceClass *sdc)
ProtocolLayer *	next ()
SuplaDeviceClass *	getSdc ()
void	setVerboseLog (bool value)
virtual bool	isConfigEmpty ()
virtual bool	isConnectionError ()
virtual bool	isConnecting ()
virtual bool	isMqtt () const
virtual void	sendRemainingTimeValue (uint8_t channelNumber, uint32_t remainingTime, uint8_t *state, int32_t senderId, bool useSecondsInsteadOfMs)
virtual void	notifyConfigChange (int channelNumber)

Static Public Member Functions
static const char *	configResultToCStr (int result)
static void	onPacketSent (void userParam, unsigned _supla_int_t callId, void data, unsigned _supla_int_t dataSize, void *reserved)
static void	onPacketReceived (void userParam, unsigned _supla_int_t callId, void data, unsigned _supla_int_t dataSize, void *reserved)
static const char *	callIdToName (int callId)
static bool	isSensitiveCallId (int callId)
Static Public Member Functions inherited from Supla::Protocol::ProtocolLayer
static ProtocolLayer *	first ()
static ProtocolLayer *	last ()
static bool	IsAnyUpdatePending ()

Public Attributes
Supla::Client *	client = nullptr
CalCfgResultPending	calCfgResultPending

Static Public Attributes
static bool	isSuplaSSLEnabled = true

Protected Member Functions
bool	ping ()
void	initializeSrpc ()
void	deinitializeSrpc ()
void	addLastStateAdError (char *buf)

Protected Attributes
uint8_t	version = 0
uint8_t	activityTimeoutS = 30
uint8_t	securityLevel = 0
int8_t	registered = 0
bool	requestNetworkRestart = false
bool	enabled = true
bool	setDeviceConfigReceivedAfterRegistration = false
bool	firstConnectionAttempt = true
bool	adErrorLogged = false
uint8_t	autodiscoverRetryCounter = 0
uint16_t	connectionFailCounter = 0
uint32_t	lastPingTimeMs = 0
uint32_t	waitForIterate = 0
uint32_t	lastIterateTime = 0
uint32_t	lastResponseMs = 0
uint32_t	lastSentMs = 0
int	port = -1
const char *	suplaCACert = nullptr
const char *	supla3rdPartyCACert = nullptr
const char *	selectedCertificate = nullptr
void *	srpc = nullptr
Supla::Device::ChannelConflictResolver *	channelConflictResolver = nullptr
Protected Attributes inherited from Supla::Protocol::ProtocolLayer
ProtocolLayer *	nextPtr = nullptr
SuplaDeviceClass *	sdc = nullptr
bool	configEmpty = true
bool	verboseLog = false

Additional Inherited Members
Static Protected Attributes inherited from Supla::Protocol::ProtocolLayer
static ProtocolLayer *	firstPtr = nullptr

Member Function Documentation

◆ disconnect()

void Supla::Protocol::SuplaSrpc::disconnect ( )

overridevirtual

Implements Supla::Protocol::ProtocolLayer.

◆ getChannelConfig()

void Supla::Protocol::SuplaSrpc::getChannelConfig	(	uint8_t	channelNumber,
		uint8_t	configType )

overridevirtual

Reimplemented from Supla::Protocol::ProtocolLayer.

◆ getConnectionFailTime()

uint32_t Supla::Protocol::SuplaSrpc::getConnectionFailTime ( )

overridevirtual

Implements Supla::Protocol::ProtocolLayer.

◆ getUserLocaltime()

void Supla::Protocol::SuplaSrpc::getUserLocaltime ( )

overridevirtual

Reimplemented from Supla::Protocol::ProtocolLayer.

◆ isEnabled()

bool Supla::Protocol::SuplaSrpc::isEnabled ( )

overridevirtual

Implements Supla::Protocol::ProtocolLayer.

◆ isNetworkRestartRequested()

bool Supla::Protocol::SuplaSrpc::isNetworkRestartRequested ( )

overridevirtual

Implements Supla::Protocol::ProtocolLayer.

◆ isRegisteredAndReady()

bool Supla::Protocol::SuplaSrpc::isRegisteredAndReady ( )

overridevirtual

Implements Supla::Protocol::ProtocolLayer.

◆ isUpdatePending()

bool Supla::Protocol::SuplaSrpc::isUpdatePending ( )

overridevirtual

Reimplemented from Supla::Protocol::ProtocolLayer.

◆ iterate()

bool Supla::Protocol::SuplaSrpc::iterate ( uint32_t _millis )

overridevirtual

Implements Supla::Protocol::ProtocolLayer.

◆ onInit()

void Supla::Protocol::SuplaSrpc::onInit ( )

overridevirtual

Implements Supla::Protocol::ProtocolLayer.

◆ onLoadConfig()

bool Supla::Protocol::SuplaSrpc::onLoadConfig ( )

overridevirtual

Implements Supla::Protocol::ProtocolLayer.

◆ sendActionTrigger()

void Supla::Protocol::SuplaSrpc::sendActionTrigger	(	uint8_t	channelNumber,
		uint32_t	actionId )

overridevirtual

Implements Supla::Protocol::ProtocolLayer.

◆ sendChannelStateResult()

void Supla::Protocol::SuplaSrpc::sendChannelStateResult	(	int32_t	receiverId,
		uint8_t	channelNo )

overridevirtual

Reimplemented from Supla::Protocol::ProtocolLayer.

◆ sendChannelValueChanged()

void Supla::Protocol::SuplaSrpc::sendChannelValueChanged	(	uint8_t	channelNumber,
		int8_t *	value,
		uint8_t	offline,
		uint32_t	validityTimeSec )

overridevirtual

Implements Supla::Protocol::ProtocolLayer.

◆ sendExtendedChannelValueChanged()

void Supla::Protocol::SuplaSrpc::sendExtendedChannelValueChanged	(	uint8_t	channelNumber,
		TSuplaChannelExtendedValue *	value )

overridevirtual

Implements Supla::Protocol::ProtocolLayer.

◆ sendNotification()

bool Supla::Protocol::SuplaSrpc::sendNotification	(	int	context,
		const char *	title,
		const char *	message,
		int	soundId )

overridevirtual

Reimplemented from Supla::Protocol::ProtocolLayer.

◆ sendRegisterNotification()

void Supla::Protocol::SuplaSrpc::sendRegisterNotification ( TDS_RegisterPushNotification * notification )

overridevirtual

Reimplemented from Supla::Protocol::ProtocolLayer.

◆ sendRemainingTimeValue()

void Supla::Protocol::SuplaSrpc::sendRemainingTimeValue	(	uint8_t	channelNumber,
		uint32_t	timeMs,
		uint8_t	state,
		int32_t	senderId )

overridevirtual

Reimplemented from Supla::Protocol::ProtocolLayer.

◆ sendSubdeviceDetails()

void Supla::Protocol::SuplaSrpc::sendSubdeviceDetails ( TDS_SubdeviceDetails * subdeviceDetails )

overridevirtual

Reimplemented from Supla::Protocol::ProtocolLayer.

◆ setChannelConfig()

bool Supla::Protocol::SuplaSrpc::setChannelConfig	(	uint8_t	channelNumber,
		_supla_int_t	channelFunction,
		void *	channelConfig,
		int	size,
		uint8_t	configType )

overridevirtual

Reimplemented from Supla::Protocol::ProtocolLayer.

◆ setDeviceConfig()

bool Supla::Protocol::SuplaSrpc::setDeviceConfig ( TSDS_SetDeviceConfig * deviceConfig )

overridevirtual

Reimplemented from Supla::Protocol::ProtocolLayer.

◆ setInitialCaption()

bool Supla::Protocol::SuplaSrpc::setInitialCaption	(	uint8_t	channelNumber,
		const char *	caption )

overridevirtual

Reimplemented from Supla::Protocol::ProtocolLayer.

◆ verifyConfig()

bool Supla::Protocol::SuplaSrpc::verifyConfig ( )

overridevirtual

Implements Supla::Protocol::ProtocolLayer.

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

src/supla/protocol/supla_srpc.h
src/supla/protocol/supla_srpc.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ disconnect()

◆ getChannelConfig()

◆ getConnectionFailTime()

◆ getUserLocaltime()

◆ isEnabled()

◆ isNetworkRestartRequested()

◆ isRegisteredAndReady()

◆ isUpdatePending()

◆ iterate()

◆ onInit()

◆ onLoadConfig()

◆ sendActionTrigger()

◆ sendChannelStateResult()

◆ sendChannelValueChanged()

◆ sendExtendedChannelValueChanged()

◆ sendNotification()

◆ sendRegisterNotification()

◆ sendRemainingTimeValue()

◆ sendSubdeviceDetails()

◆ setChannelConfig()

◆ setDeviceConfig()

◆ setInitialCaption()

◆ verifyConfig()