Remote Manager interface class. More...

#include <eoRemoteManager.h>

Public Member Functions
	eoRemoteManager (eoGateway *gateway)

bool	GetKeyToUse () const

void	SetKeyToUse (uint8_t key)

bool	GetShallBeRepeated () const

void	SetShallBeRepeated (bool repeat)

eoReturn	UnLock (const uint32_t securityCode, const uint32_t destinationID)

eoReturn	Lock (const uint32_t securityCode, const uint32_t destinationID)

eoReturn	Start (const uint32_t destinationID)

eoReturn	ParseStartAnswear (START_RESPONSE &responseCode)

eoReturn	Close (const uint32_t destinationID)

eoReturn	SetCode (const uint32_t securityCode, const uint32_t destinationID)

eoReturn	Action (const uint32_t destinationID)

eoReturn	Ping (const uint32_t destinationID)

eoReturn	ParsePingAnswer (PING_RESPONSE &response)

eoReturn	QueryID (const QUERY_ID &msg)

eoReturn	ParseQueryIDAnswer (QUERY_ID_RESPONSE &response)

eoReturn	ParseQueryIDAnswer (QUERY_ID &response)

eoReturn	QueryFunction (const uint32_t destinationID)

eoReturn	ParseQueryFunctionAnswer (QUERY_FUNCTION_RESPONSE *response, uint8_t maxIDCount, uint8_t &IDCount)

eoReturn	QueryStatus (const uint32_t destinationID)

eoReturn	ParseQueryStatusAnswer (QUERY_STATUS_RESPONSE &response)

eoReturn	RemoteLearnIn (const uint32_t destinationID, REMOTE_TYPE learnFlag)

eoReturn	RemoteFlashWrite (const uint32_t destinationID, const uint16_t &memoryAddress, const uint16_t numOfBytes, const uint8_t data[])

eoReturn	RemoteFlashRead (const uint32_t destinationID, const uint16_t &memoryAddress, const uint16_t numOfBytes)

eoReturn	ParseRemoteFlashReadAnswer (FLASH_READ_RESPONSE response, uint16_t dataCount, uint8_t maxDataCount)

eoReturn	RemoteSmartReadMailboxSettings (const uint32_t destinationID)

eoReturn	ParseRemoteSmartReadMailboxSettingsAnswer (MAILBOX_SETTINGS_RESPONSE &response)

eoReturn	RemoteSmartReadLearnedSensors (const uint32_t destinationID)

eoReturn	ParseRemoteSmartReadLearnedSensors (LEARNED_SENSOR_RESPONSE response, uint8_t learnedCount, uint8_t maxLearnedCount)

eoReturn	RemoteSmartAddMailbox (const uint32_t destinationID, const uint8_t mailboxIndex, const uint32_t sensorID, const uint32_t postmasterID)

eoReturn	RemoteSmartDeleteMailbox (const uint32_t destinationID, const uint8_t mailboxIndex)

eoReturn	RemoteSmartLearnIn (const uint32_t destinationID, const uint8_t learnCount, const uint32_t sensorID, const uint32_t controllerID)

eoReturn	RemoteSmartLearnOut (const uint32_t destinationID, const uint8_t learnCount, const uint32_t sensorID, const uint32_t controllerID)

Detailed Description

Remote Manager interface class.

Constructor & Destructor Documentation

◆ eoRemoteManager()

eoRemoteManager::eoRemoteManager ( eoGateway * gateway )

Constructor.

Parameters

gateway eoGateway to be used for remote management.

Member Function Documentation

◆ Action()

eoReturn eoRemoteManager::Action ( const uint32_t destinationID )

When this command is received then the addressed device performs an action (audio, visual, etc), depending on the functionality of the device.

Parameters

destinationID The device ID of the end device

Here is the caller graph for this function:

◆ GetKeyToUse()

bool eoRemoteManager::GetKeyToUse ( ) const

inline

If greater 0, use the key x to encrypt

◆ GetShallBeRepeated()

bool eoRemoteManager::GetShallBeRepeated ( ) const

inline

If true the send telegrams are set in such a state that they can be repeated

◆ Lock()

eoReturn eoRemoteManager::Lock	(	const uint32_t	securityCode,
		const uint32_t	destinationID
	)

This command locks the device. Unicast: yes Broadcast: yes Device responses to command: no

Parameters

destinationID	The device ID of the end device
securityCode	Security code

Here is the caller graph for this function:

◆ ParsePingAnswer()

eoReturn eoRemoteManager::ParsePingAnswer ( PING_RESPONSE & response )

With this command the actor parse the remote management message into the PING_RESPONSE structure. Unicast: yes Broadcast: no Device responses to command: yes

Parameters

[out] response Pointer to the PING_RESPONSE structure

Here is the caller graph for this function:

◆ ParseQueryFunctionAnswer()

eoReturn eoRemoteManager::ParseQueryFunctionAnswer	(	QUERY_FUNCTION_RESPONSE *	response,
		uint8_t	maxIDCount,
		uint8_t &	IDCount
	)

With this command the actor parse the remote management message into the QUERY_FUNCTION_RESPONSE structure.

Parameters

[in]	maxIDCount	Size of the QUERY_FUNCTION_RESPONSE array
[out]	IDCount	The number of entry count on the RPC list
[out]	response	Pointer to the QUERY_FUNCTION_RESPONSE array

Here is the caller graph for this function:

◆ ParseQueryIDAnswer() [1/2]

eoReturn eoRemoteManager::ParseQueryIDAnswer ( QUERY_ID_RESPONSE & response )

With this command the actor parse the remote management message into the QUERY_ID structure.

Parameters

[out] response Pointer to the QUERY_ID_RESPONSE structure

Here is the caller graph for this function:

◆ ParseQueryIDAnswer() [2/2]

eoReturn eoRemoteManager::ParseQueryIDAnswer ( QUERY_ID & response )

With this command the actor parse the remote management message into the QUERY_ID structure.

Parameters

[out] response Pointer to the QUERY_ID structure

◆ ParseQueryStatusAnswer()

eoReturn eoRemoteManager::ParseQueryStatusAnswer ( QUERY_STATUS_RESPONSE & response )

With this command the actor parse the remote management message into the QUERY_STATUS_RESPONSE structure.

Parameters

[out] response Pointer to the QUERY_STATUS_RESPONSE array

Here is the caller graph for this function:

◆ ParseRemoteFlashReadAnswer()

eoReturn eoRemoteManager::ParseRemoteFlashReadAnswer	(	FLASH_READ_RESPONSE *	response,
		uint16_t *	dataCount,
		uint8_t	maxDataCount
	)

Using this command the actor parse the remote management message into FLASH_READ_RESPONSE structure.

Parameters

[out]	response	Pointer to the FLASH_READ_RESPONSE array
[out]	dataCount	The number of bytes the device read from the memory
[in]	maxDataCount	Size of the FLASH_READ_RESPONSE array

Here is the caller graph for this function:

◆ ParseRemoteSmartReadLearnedSensors()

eoReturn eoRemoteManager::ParseRemoteSmartReadLearnedSensors	(	LEARNED_SENSOR_RESPONSE *	response,
		uint8_t *	learnedCount,
		uint8_t	maxLearnedCount
	)

Using this command the actor parse the remote management message into LEARNED_SENSOR_RESPONSE structure

Parameters

[out]	response	Pointer to the LEARNED_SENSOR_RESPONSE array
[out]	learnedCount	Number of learned in devices
[in]	maxLearnedCount	Size of the LEARNED_SENSOR_RESPONSE array

Here is the caller graph for this function:

◆ ParseRemoteSmartReadMailboxSettingsAnswer()

eoReturn eoRemoteManager::ParseRemoteSmartReadMailboxSettingsAnswer ( MAILBOX_SETTINGS_RESPONSE & response )

Using this command the actor parse the remote management message into MAILBOX_SETTINGS_RESPONSE structure.

Parameters

[out] response Pointer to the MAILBOX_SETTINGS_RESPONSE structure

Here is the caller graph for this function:

◆ Ping()

eoReturn eoRemoteManager::Ping ( const uint32_t destinationID )

The ping command functionality is similar to ping in TCP / IP communication. The actor sends a ping request to see if the Remote Device is alive and communicating. Ping requests are processed also when device is in lock status. Remote device sends the radio signal strength of the received request within the ping response. Unicast: yes Broadcast: yes Device responses to command: no

Parameters

destinationID The device ID of the end device

Here is the caller graph for this function:

◆ QueryFunction()

eoReturn eoRemoteManager::QueryFunction ( const uint32_t destinationID )

With this command the actor requests the supported extended functions list. Unicast: yes Boradcast: no Device responses to command: yes

Parameters

destinationID The device ID of the end device

Here is the caller graph for this function:

◆ QueryID()

eoReturn eoRemoteManager::QueryID ( const QUERY_ID & msg )

With this command the actor requests an answer from a specific EEP. Unicast: no Broadcast: yes Device responses to command: yes

Parameters

msg	Pointer to the QUERY_ID structure

Here is the caller graph for this function:

◆ QueryStatus()

eoReturn eoRemoteManager::QueryStatus ( const uint32_t destinationID )

With this command the actor directly asks for the status info of the Remote Device. Unicast: yes Broadcast: yes Device responses to command: yes The Remote Device answers with remote management debug data.

Parameters

destinationID The device ID of the end device

Here is the caller graph for this function:

◆ RemoteFlashRead()

eoReturn eoRemoteManager::RemoteFlashRead	(	const uint32_t	destinationID,
		const uint16_t &	memoryAddress,
		const uint16_t	numOfBytes
	)

Using this command the flash can be read from the application. The data requested data area transmitted in RPC telegrams. Unicast: yes Broadcast: no Device responses to command: no

Parameters

destinationID	The device ID of the end device
memoryAddress	Destination where the data should be read from
numOfBytes	Number of bytes to be read from the flash

Here is the caller graph for this function:

◆ RemoteFlashWrite()

eoReturn eoRemoteManager::RemoteFlashWrite	(	const uint32_t	destinationID,
		const uint16_t &	memoryAddress,
		const uint16_t	numOfBytes,
		const uint8_t	data[]
	)

Using this command the flash of a device can be written. Unicast: yes Broadcast: yes Device responses to command: no

Parameters

destinationID	The device ID of the end device
memoryAddress	Destination where the data should be stored
numOfBytes	Number of bytes to be transfered and written to the flash
data[]	Array to be transfered and written to the flash

Here is the caller graph for this function:

◆ RemoteLearnIn()

eoReturn eoRemoteManager::RemoteLearnIn	(	const uint32_t	destinationID,
		REMOTE_TYPE	learnFlag
	)

Determines the device type to learn in, all other devices learn telegrams are ignored. Unicast: yes Broadcast: yes Device responses to command: no

Parameters

destinationID	The device ID of the end device
learnFlag	Determines different behaviour of the learn procedure

Here is the caller graph for this function:

◆ RemoteSmartAddMailbox()

eoReturn eoRemoteManager::RemoteSmartAddMailbox	(	const uint32_t	destinationID,
		const uint8_t	mailboxIndex,
		const uint32_t	sensorID,
		const uint32_t	postmasterID
	)

Using this command the device adds a mailbox. Only for controller! Unicast: yes Broadcast: no

Parameters

destinationID	The device ID of the end device
mailboxIndex	Index of the mailbox
sensorID	The device ID of the sensor
postmasterID	The device ID of the postmaster

Here is the caller graph for this function:

◆ RemoteSmartDeleteMailbox()

eoReturn eoRemoteManager::RemoteSmartDeleteMailbox	(	const uint32_t	destinationID,
		const uint8_t	mailboxIndex
	)

Using this command the device deletes the mailbox.

Parameters

destinationID	The device ID of the postmaster
mailboxIndex	Index of the mailbox

Here is the caller graph for this function:

◆ RemoteSmartLearnIn()

eoReturn eoRemoteManager::RemoteSmartLearnIn	(	const uint32_t	destinationID,
		const uint8_t	learnCount,
		const uint32_t	sensorID,
		const uint32_t	controllerID
	)

Using this command the device learns out the sensor. Only for controller!

Parameters

destinationID	The device ID of the controller
learnCount	Learn count
sensorID	Device ID of the sensor
controllerID	Device ID of the controller or postmaster

Here is the caller graph for this function:

◆ RemoteSmartLearnOut()

eoReturn eoRemoteManager::RemoteSmartLearnOut	(	const uint32_t	destinationID,
		const uint8_t	learnCount,
		const uint32_t	sensorID,
		const uint32_t	controllerID
	)

Using this command the device learns out the sensor. Only for controller!

Parameters

destinationID	The device ID of the controller
learnCount	Learn count
sensorID	Device ID of the sensor
controllerID	Device ID of the controller or postmaster

Here is the caller graph for this function:

◆ RemoteSmartReadLearnedSensors()

eoReturn eoRemoteManager::RemoteSmartReadLearnedSensors ( const uint32_t destinationID )

Using this command the learned in sensors can be read. Unicast: yes Broadcast: no Device responses to command: yes

Parameters

destinationID The device ID of the end device

Here is the caller graph for this function:

◆ RemoteSmartReadMailboxSettings()

eoReturn eoRemoteManager::RemoteSmartReadMailboxSettings ( const uint32_t destinationID )

Using this command the mailbox setting can be read. Unicast: yes Broadcast: no Device responses to command: yes

Parameters

destinationID The device ID of the end device

Here is the caller graph for this function:

◆ SetCode()

eoReturn eoRemoteManager::SetCode	(	const uint32_t	securityCode,
		const uint32_t	destinationID
	)

This command sets the security code of the device. Unicast: yes Broadcast: yes Device responses to command: no

Parameters

destinationID	The device ID of the end device
securityCode	Security code

Here is the caller graph for this function:

◆ SetKeyToUse()

void eoRemoteManager::SetKeyToUse ( uint8_t key )

inline

Parameters

if	greater 0, use the key x to encrypt

◆ SetShallBeRepeated()

void eoRemoteManager::SetShallBeRepeated ( bool repeat )

inline

Parameters

repeat = if true, the send telegrams can be repeated

Here is the call graph for this function:

◆ UnLock()

eoReturn eoRemoteManager::UnLock	(	const uint32_t	securityCode,
		const uint32_t	destinationID
	)

This command unlocks the device. Unicast: yes Broadcast: yes Device responses to command: no

Parameters

destinationID	The device ID of the end device
securityCode	Security code

Here is the caller graph for this function:

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ eoRemoteManager()

Member Function Documentation

◆ Action()

◆ GetKeyToUse()

◆ GetShallBeRepeated()

◆ Lock()

◆ ParsePingAnswer()

◆ ParseQueryFunctionAnswer()

◆ ParseQueryIDAnswer() [1/2]

◆ ParseQueryIDAnswer() [2/2]

◆ ParseQueryStatusAnswer()

◆ ParseRemoteFlashReadAnswer()

◆ ParseRemoteSmartReadLearnedSensors()

◆ ParseRemoteSmartReadMailboxSettingsAnswer()

◆ Ping()

◆ QueryFunction()

◆ QueryID()

◆ QueryStatus()

◆ RemoteFlashRead()

◆ RemoteFlashWrite()

◆ RemoteLearnIn()

◆ RemoteSmartAddMailbox()

◆ RemoteSmartDeleteMailbox()

◆ RemoteSmartLearnIn()

◆ RemoteSmartLearnOut()

◆ RemoteSmartReadLearnedSensors()

◆ RemoteSmartReadMailboxSettings()

◆ SetCode()

◆ SetKeyToUse()

◆ SetShallBeRepeated()

◆ UnLock()