Z-Wave Protocol Controller Reference

Interface for requesting S0 bootstrapping of a node and resistering callbacks to get notified when the S0 bootstrapping has failed or succeeded. More...

Collaboration diagram for Security 0 Network:

Typedefs

typedef void(* s0_on_bootstrapping_complete_cb) (zwave_keyset_t granted_keys, zwave_kex_fail_type_t kex_fail_code)
 

Functions

sl_status_t zwave_s0_network_init ()
 Initialize the S0 network layer. More...
 
void zwave_s0_set_network_callbacks (const s0_on_bootstrapping_complete_cb cb)
 Set callback function for the S0 inclusion. This function ptr is saved internally in s0. More...
 
void zwave_s0_start_bootstrapping (zwave_node_id_t node_id, uint8_t is_controller)
 Start the S0 add node process. More...
 
void zwave_s0_stop_bootstrapping ()
 Stop the S2 bootstrapping. More...
 
void zwave_s0_start_learn_mode (zwave_node_id_t our_nodeid)
 Start S0 learn mode. More...
 

Detailed Description

Interface for requesting S0 bootstrapping of a node and resistering callbacks to get notified when the S0 bootstrapping has failed or succeeded.

Typedef Documentation

◆ s0_on_bootstrapping_complete_cb

typedef void(* s0_on_bootstrapping_complete_cb) (zwave_keyset_t granted_keys, zwave_kex_fail_type_t kex_fail_code)

Bootstrapping S0 complete event.

Parameters
granted_keys
kex_fail_code
Returns
true if success, false if failure

Function Documentation

◆ zwave_s0_network_init()

sl_status_t zwave_s0_network_init ( )

Initialize the S0 network layer.

This function must be called when ever the home ID or node ID of the controller changes.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ zwave_s0_set_network_callbacks()

void zwave_s0_set_network_callbacks ( const s0_on_bootstrapping_complete_cb  cb)

Set callback function for the S0 inclusion. This function ptr is saved internally in s0.

Parameters
cb
Here is the call graph for this function:
Here is the caller graph for this function:

◆ zwave_s0_start_bootstrapping()

void zwave_s0_start_bootstrapping ( zwave_node_id_t  node_id,
uint8_t  is_controller 
)

Start the S0 add node process.

Calling this function will make the S0 FSM start the inclusion process of a newly added node. This must be called right after ADD_NODE_DONE event for nodes supporting COMMAND_CLASS_SECURITY0

Parameters
node_idThe node we wish to S0 bootstrap
is_controllerSet to 1 if the node to bootstrap is a controller, 0 for an end node.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ zwave_s0_start_learn_mode()

void zwave_s0_start_learn_mode ( zwave_node_id_t  our_nodeid)

Start S0 learn mode.

Parameters
our_nodeidOur new node id
Here is the caller graph for this function:

◆ zwave_s0_stop_bootstrapping()

void zwave_s0_stop_bootstrapping ( )

Stop the S2 bootstrapping.

Here is the call graph for this function:
Here is the caller graph for this function: