ZAF_Transport_Security#

Functions#

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

Called when the frame is received.

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.

uint8_t
Transport_OnApplicationInitSW(void)

Initializes the ZAF transport layer.

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)

Updates the active NIF depending on learn mode result.

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

Returns whether a given command is supported.

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.

Macros#

#define
APPL_NODEPARM_MAX 35

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

Function Documentation#

Transport_ApplicationCommandHandler#

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

Called when the frame is received.

Parameters
N/ApCmd

Payload from the received frame, the command is the very first byte

N/AcmdLength

Number of command bytes including the command

N/ArxOpt

Struct to use (may be partially filled out if parsing encapsulated command)


Definition at line 37 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZW_TransportSecProtocol.h

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
N/ApSubscriberContext

A handle to the Transport layer

N/ApRxPackage

Received package containing: payload from received frame, number of command bytes (including the command) and rxOpt struct


Definition at line 52 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZW_TransportSecProtocol.h

Transport_OnApplicationInitSW#

uint8_t Transport_OnApplicationInitSW (void)

Initializes the ZAF transport layer.

Parameters
N/A

Returns

  • true if transport layer is initialized, false otherwise.


Definition at line 59 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZW_TransportSecProtocol.h

Transport_OnLearnCompleted#

uint8_t Transport_OnLearnCompleted (node_id_t nodeID)

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

Parameters
N/AnodeID

The newly assigned node id.

This function must be called in LearnCompleted application function

DeprecatedUse ZAF_Transport_OnLearnCompleted().

Returns

  • true on success.


Definition at line 71 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZW_TransportSecProtocol.h

ZAF_Transport_OnLearnCompleted#

void ZAF_Transport_OnLearnCompleted (void)

Updates the active NIF depending on learn mode result.

Parameters
N/A

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


Definition at line 78 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZW_TransportSecProtocol.h

TransportCmdClassSupported#

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

Returns whether a given command is supported.

Parameters
N/AcommandClass

Command class to check for.

N/Acommand

Command to check for.

N/AeKey

Security key that the frame was received with.

Returns

  • Returns true if the command is supported and false otherwise.


Definition at line 89 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZW_TransportSecProtocol.h

GetHighestSecureLevel#

enum SECURITY_KEY GetHighestSecureLevel (uint8_t protocolSecBits)

Get highest secure level.

Parameters
N/AprotocolSecBits

secure bits

Returns

  • secure level


Definition at line 99 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZW_TransportSecProtocol.h

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


Definition at line 109 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZW_TransportSecProtocol.h

Macro Definition Documentation#

APPL_NODEPARM_MAX#

#define APPL_NODEPARM_MAX
Value:
35

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


Definition at line 27 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZW_TransportSecProtocol.h