ZAF_Transport_Security

Collaboration diagram for ZAF_Transport_Security:

Macros
#define	APPL_NODEPARM_MAX   35

Functions
void	Transport_ApplicationCommandHandler (ZW_APPLICATION_TX_BUFFER *pCmd, uint8_t cmdLength, RECEIVE_OPTIONS_TYPE *rxOpt)
void	ApplicationCommandHandler (void *pSubscriberContext, SZwaveReceivePackage *pRxPackage)
uint8_t	Transport_OnApplicationInitSW (void)
uint8_t	Transport_OnLearnCompleted (node_id_t nodeID)
	Register the new node id in the transport layer after learn mode completes.
void	ZAF_Transport_OnLearnCompleted (void)
bool	TransportCmdClassSupported (uint8_t commandClass, uint8_t command, enum SECURITY_KEY eKey)
enum SECURITY_KEY	GetHighestSecureLevel (uint8_t protocolSecBits)
	Get highest secure level.
zaf_cc_list_t *	GetCommandClassList (bool included, security_key_t eKey, uint8_t endpoint)
	Get command class list from device.

Detailed Description

Macro Definition Documentation

APPL_NODEPARM_MAX

#define APPL_NODEPARM_MAX   35

Max number of command classes a command class list can contain.

Function Documentation

ApplicationCommandHandler()

void ApplicationCommandHandler	(	void *	pSubscriberContext,
		SZwaveReceivePackage *	pRxPackage )

Callback function triggered by Cmd Publisher when the frame is received from protocol See ZAF_CmdPublisher.h for more details

Parameters

pSubscriberContext	A handle to the Transport layer
pRxPackage	Received package containing: payload from received frame, number of command bytes (including the command) and rxOpt struct

GetCommandClassList()

zaf_cc_list_t * GetCommandClassList	(	bool	included,
		security_key_t	eKey,
		uint8_t	endpoint )

Get command class list from device.

Parameters

[in]	included	boolean value for node is included
[in]	eKey	security key of type security_key_t
[in]	endpoint	0 - root 1 - X endpoint number

GetHighestSecureLevel()

enum SECURITY_KEY GetHighestSecureLevel

(

uint8_t

protocolSecBits

)

Get highest secure level.

Parameters

protocolSecBits

secure bits

Returns

secure level

Transport_ApplicationCommandHandler()

void Transport_ApplicationCommandHandler ( ZW_APPLICATION_TX_BUFFER * pCmd, uint8_t cmdLength, RECEIVE_OPTIONS_TYPE * rxOpt )

extern

Called when the frame is received

Parameters

pCmd	Payload from the received frame, the command is the very first byte
cmdLength	Number of command bytes including the command
rxOpt	Struct to use (may be partially filled out if parsing encapsulated command)

Transport_OnApplicationInitSW()

uint8_t Transport_OnApplicationInitSW

(

void

)

Initializes the ZAF transport layer.

Returns

true if transport layer is initialized, false otherwise.

Transport_OnLearnCompleted()

uint8_t Transport_OnLearnCompleted

(

node_id_t

nodeID

)

Register the new node id in the transport layer after learn mode completes.

This function must be called in LearnCompleted application function

Deprecated

Use ZAF_Transport_OnLearnCompleted().

Parameters

nodeID

The newly assigned node id.

Returns

true on success.

TransportCmdClassSupported()

bool TransportCmdClassSupported	(	uint8_t	commandClass,
		uint8_t	command,
		enum SECURITY_KEY	eKey )

Returns whether a given command is supported.

Parameters

commandClass	Command class to check for.
command	Command to check for.
eKey	Security key that the frame was received with.

Returns

Returns true if the command is supported and false otherwise.

ZAF_Transport_OnLearnCompleted()

void ZAF_Transport_OnLearnCompleted

(

void

)

Updates the active NIF depending on learn mode result.

Must be invoked when learn mode has completed (on inclusion/exclusion).