Z-Wave Protocol Controller Reference
Z-Wave Controller Component

Z-Wave Controller component, glueing all the subcomponent of the Z-Wave Controller super component. More...

Collaboration diagram for Z-Wave Controller Component:

Modules

 Z-Wave Controller Callbacks
 zwave_controller callbacks registration system.
 
 Z-Wave Controller Internal definitions
 Internal types and definitions for Z-Wave Controller.
 
 Z-Wave Controller keyset utility
 Small utility allowing to process keyset structures.
 
 Z-Wave Controller Storage
 Callbacks registration system that enables an application to provide some functions performing look-ups in the persistent storage system.
 
 Z-Wave Controller Transport Framework
 Z-Wave Controller Transport Framework.
 
 Z-Wave Controller Types
 Z-Wave Controller shared type definitions.
 

Functions

void zwave_controller_set_application_nif (const uint8_t *command_classes, uint8_t command_classes_length)
 Set the application part of the node information frame (NIF). More...
 
void zwave_controller_set_secure_application_nif (const uint8_t *command_classes, uint8_t command_classes_length)
 Set the secure node information. More...
 
void zwave_controller_get_dsk (zwave_dsk_t *dsk)
 Retrieve the DSK of the controller. More...
 
void zwave_controller_reset ()
 Instructs the Z-Wave Controller to initiate a Set Default / Reset operation. More...
 
bool zwave_controller_is_reset_ongoing ()
 Tells if we are currently reseting the ZPC. More...
 
void zwave_controller_request_protocol_cc_encryption_callback (uint8_t status, const zwapi_tx_report_t *tx_info, uint8_t session_id)
 Callback function for requesting protocol Command Class encryption. More...
 

Detailed Description

Z-Wave Controller component, glueing all the subcomponent of the Z-Wave Controller super component.

Function Documentation

◆ zwave_controller_get_dsk()

void zwave_controller_get_dsk ( zwave_dsk_t dsk)

Retrieve the DSK of the controller.

Parameters
[out]dskThe DSK

◆ zwave_controller_is_reset_ongoing()

bool zwave_controller_is_reset_ongoing ( )

Tells if we are currently reseting the ZPC.

Returns
true if we are in the middle of a reset operation, false otherwise.
Here is the caller graph for this function:

◆ zwave_controller_request_protocol_cc_encryption_callback()

void zwave_controller_request_protocol_cc_encryption_callback ( uint8_t  status,
const zwapi_tx_report_t tx_info,
uint8_t  session_id 
)

Callback function for requesting protocol Command Class encryption.

Parameters
statusTX status of the ongoing session.
tx_infoTX report of the ongoing session.
session_idSession ID.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ zwave_controller_reset()

void zwave_controller_reset ( )

Instructs the Z-Wave Controller to initiate a Set Default / Reset operation.

Here is the call graph for this function:

◆ zwave_controller_set_application_nif()

void zwave_controller_set_application_nif ( const uint8_t *  command_classes,
uint8_t  command_classes_length 
)

Set the application part of the node information frame (NIF).

This sets the application part of the node information frame. The full node information frame may include additional command classes such as

  • COMMAND_CLASS_SECURITY
  • COMMAND_CLASS_SECURITY2
  • COMMAND_CLASS_TRANSPORT_SERVICE
  • COMMAND_CLASS_CRC16 which will added to the actual NIF.
Parameters
command_classesList of command classes
command_classes_lengthLength of command class list
Here is the call graph for this function:

◆ zwave_controller_set_secure_application_nif()

void zwave_controller_set_secure_application_nif ( const uint8_t *  command_classes,
uint8_t  command_classes_length 
)

Set the secure node information.

This sets the secure node information command class list. This list is the contents of the SECURE_COMMANDS_SUPPORTED frames for S0 and S2.

Parameters
command_classesList of command classes
command_classes_lengthLength of command class list
Here is the call graph for this function: