Z-Wave Protocol Controller Reference
UCL Network Management

Handle ucl/by-unid/<node>/ProtocolController/NetworkManagement topic. More...

Collaboration diagram for UCL Network Management:

Macros

#define UCL_NM_REMOVE_FAILED_NODE_TIMEOUT_DEFAULT   1000
 

Functions

 PROCESS_NAME (ucl_network_management_process)
 Name the of contiki process for the Ucl Network Management. More...
 
sl_status_t ucl_network_management_remove_offline_node (zwave_node_id_t node_id)
 Initiates the removal process of an offline node. More...
 
sl_status_t ucl_network_management_request_node_neighbor_update (zwave_node_id_t node_id)
 Initiate the request node neighbor discovery. More...
 

Detailed Description

Handle ucl/by-unid/<node>/ProtocolController/NetworkManagement topic.

Interface between ucl/by-unid/<node>/ProtocolController/NetworkManagement MQTT topic and Z-Wave NetworkManagement for adding and removing nodes. Subscribes to ucl/by-unid/<node>/ProtocolController/NetworkManagement/Write and handle UCL NetworkManagement requests. Publish UCL NetworkManagement State to ucl/by-unid/<node>/ProtocolController/NetworkManagement.

Add Node Example
Remove Node Example
Remove Offline Node Example

Macro Definition Documentation

◆ UCL_NM_REMOVE_FAILED_NODE_TIMEOUT_DEFAULT

#define UCL_NM_REMOVE_FAILED_NODE_TIMEOUT_DEFAULT   1000

Function Documentation

◆ PROCESS_NAME()

PROCESS_NAME ( ucl_network_management_process  )

Name the of contiki process for the Ucl Network Management.

This is used to register the name of the Ucl Network Management Process.

◆ ucl_network_management_remove_offline_node()

sl_status_t ucl_network_management_remove_offline_node ( zwave_node_id_t  node_id)

Initiates the removal process of an offline node.

Parameters
node_idThe NodeID of the node to be removed.
Returns
SL_STATUS_OK if the removal of the node has been initiated, SL_STATUS_FAIL if an error occureed.

◆ ucl_network_management_request_node_neighbor_update()

sl_status_t ucl_network_management_request_node_neighbor_update ( zwave_node_id_t  node_id)

Initiate the request node neighbor discovery.

Parameters
node_idThe NodeID of the node for which the node neighbor discovery is requested.
Returns
SL_STATUS_OK if he node neighbor discovery has been requested, SL_STATUS_FAIL if an error occureed.