This submodule provides APIs to trigger a node neighbor discovery. More...

Collaboration diagram for UCL Network Management Node Neighbor Discovery:

Macros
#define	UCL_NM_REQUEST_NODE_NEIGHBOR_UPDATE_DEFAULT_TIMEOUT 3000000

Enumerations
enum	ucl_network_management_neighbor_discovery_t { UCL_NM_REQUEST_NODE_NEIGHBOR_UPDATE_STARTED = 0x21 , UCL_NM_REQUEST_NODE_NEIGHBOR_UPDATE_COMPLETED = 0x22 , UCL_NM_REQUEST_NODE_NEIGHBOR_UPDATE_FAILED = 0x23 , UCL_NM_REQUEST_NODE_NEIGHBOR_UPDATE_NOT_SUPPORTED = 255 }
	All possible values for Node Request Node Neighbor Discovery Statuses zwapi_request_neighbor_update() callback status values i.e., UCL_NM_REQUEST_NODE_NEIGHBOR_UPDATE_STARTED = 0x21. More...

Functions
void	ucl_nm_trigger_node_neighbor_update (zwave_node_id_t node_id)
	Trigger the request node neighbor discovery. More...

void	ucl_nm_neighbor_discovery_init ()
	intialize ucl network management node neighbor discovery submodule More...

Detailed Description

This submodule provides APIs to trigger a node neighbor discovery.

Macro Definition Documentation

◆ UCL_NM_REQUEST_NODE_NEIGHBOR_UPDATE_DEFAULT_TIMEOUT

#define UCL_NM_REQUEST_NODE_NEIGHBOR_UPDATE_DEFAULT_TIMEOUT 3000000

setting a 5 minutes timeout to tackle a defect in protocol which may not send a callback message to the host application. The value is estimated considering that neigbour discovery is triggered in a large network (i.e., 232 nodes)

Enumeration Type Documentation

◆ ucl_network_management_neighbor_discovery_t

enum ucl_network_management_neighbor_discovery_t

All possible values for Node Request Node Neighbor Discovery Statuses zwapi_request_neighbor_update() callback status values i.e., UCL_NM_REQUEST_NODE_NEIGHBOR_UPDATE_STARTED = 0x21.

Enumerator
UCL_NM_REQUEST_NODE_NEIGHBOR_UPDATE_STARTED
UCL_NM_REQUEST_NODE_NEIGHBOR_UPDATE_COMPLETED
UCL_NM_REQUEST_NODE_NEIGHBOR_UPDATE_FAILED
UCL_NM_REQUEST_NODE_NEIGHBOR_UPDATE_NOT_SUPPORTED

Function Documentation

◆ ucl_nm_neighbor_discovery_init()

void ucl_nm_neighbor_discovery_init ( )

intialize ucl network management node neighbor discovery submodule

◆ ucl_nm_trigger_node_neighbor_update()

void ucl_nm_trigger_node_neighbor_update ( zwave_node_id_t node_id )

Trigger the request node neighbor discovery.

Parameters

node_id The NodeID of the node for which the node neighbor discovery is requested.

Macros

Enumerations

Functions