ZAF_Transport_Security#
Functions#
Called when the frame is received.
Callback function triggered by Cmd Publisher when the frame is received from protocol See ZAF_CmdPublisher.h for more details.
Initializes the ZAF transport layer.
Register the new node id in the transport layer after learn mode completes.
Updates the active NIF depending on learn mode result.
Returns whether a given command is supported.
Get highest secure level.
Get command class list from device.
Macros#
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| ZW_APPLICATION_TX_BUFFER * | N/A | pCmd | Payload from the received frame, the command is the very first byte |
| uint8_t | N/A | cmdLength | Number of command bytes including the command |
| RECEIVE_OPTIONS_TYPE * | N/A | rxOpt | Struct to use (may be partially filled out if parsing encapsulated command) |
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void * | N/A | pSubscriberContext | A handle to the Transport layer |
| SZwaveReceivePackage * | N/A | pRxPackage | Received package containing: payload from received frame, number of command bytes (including the command) and rxOpt struct |
Transport_OnApplicationInitSW#
uint8_t Transport_OnApplicationInitSW (void )
Initializes the ZAF transport layer.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| node_id_t | N/A | nodeID | The newly assigned node id. |
This function must be called in LearnCompleted application function
DeprecatedUse ZAF_Transport_OnLearnCompleted().
Returns
true on success.
ZAF_Transport_OnLearnCompleted#
void ZAF_Transport_OnLearnCompleted (void )
Updates the active NIF depending on learn mode result.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Must be invoked when learn mode has completed (on inclusion/exclusion).
TransportCmdClassSupported#
bool TransportCmdClassSupported (uint8_t commandClass, uint8_t command, enum SECURITY_KEY eKey)
Returns whether a given command is supported.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | commandClass | Command class to check for. |
| uint8_t | N/A | command | Command to check for. |
| enum SECURITY_KEY | N/A | eKey | Security key that the frame was received with. |
Returns
Returns true if the command is supported and false otherwise.
GetHighestSecureLevel#
enum SECURITY_KEY GetHighestSecureLevel (uint8_t protocolSecBits)
Get highest secure level.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | protocolSecBits | secure bits |
Returns
secure level
GetCommandClassList#
zaf_cc_list_t * GetCommandClassList (bool included, security_key_t eKey, uint8_t endpoint)
Get command class list from device.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| bool | [in] | included | boolean value for node is included |
| security_key_t | [in] | eKey | security key of type security_key_t |
| uint8_t | [in] | endpoint | 0 - root 1 - X endpoint number |