Network Utility Functions#

API and Callbacks for the Network Utility functionality in the Application Framework.

Network Utility Functions description.

API#

sl_zigbee_af_form_network(sl_zigbee_network_parameters_t *parameters)

Form a new network using the specified network parameters.

sl_zigbee_af_join_network(sl_zigbee_network_parameters_t *parameters)

Associate with the network using the specified network parameters.

Find an unused PAN ID and form a new network.

Find a joinable network and join it.

sl_zigbee_af_push_network_index(uint8_t networkIndex)

Set the current network to that of the given index and add it to the stack of networks maintained by the framework. Every call to this API must be paired with a subsequent call to sl_zigbee_af_pop_network_index.

Set the current network to the callback network and adds it to the stack of networks maintained by the framework. Every call to this API must be paired with a subsequent call to sl_zigbee_af_pop_network_index.

Set the current network to that of the given endpoint and adds it to the stack of networks maintained by the framework. Every call to this API must be paired with a subsequent call to sl_zigbee_af_pop_network_index.

Remove the topmost network from the stack of networks maintained by the framework and sets the current network to the new topmost network. Every call to this API must be paired with a prior call to sl_zigbee_af_push_network_index, sl_zigbee_af_push_callback_network_index, or sl_zigbee_af_push_endpoint_network_index.

uint8_t

Return the primary endpoint of the given network index or 0xFF if no endpoints belong to the network.sl_zigbee_af_status.

uint8_t

Return the primary endpoint of the current network index or 0xFF if no endpoints belong to the current network.

API Documentation#

sl_zigbee_af_form_network#

sl_status_t sl_zigbee_af_form_network (sl_zigbee_network_parameters_t * parameters)

Form a new network using the specified network parameters.

Parameters
N/Aparameters

Specification of the new network.

Returns

  • An sl_status_t value that indicates either the successful formation of the new network or the reason that the network formation failed.


Definition at line 2165 of file app/framework/include/af.h

sl_zigbee_af_join_network#

sl_status_t sl_zigbee_af_join_network (sl_zigbee_network_parameters_t * parameters)

Associate with the network using the specified network parameters.

Parameters
N/Aparameters

Specification of the network with which the node should associate.

Returns

  • An sl_status_t value that indicates either that the association process began successfully or the reason for failure.


Definition at line 2175 of file app/framework/include/af.h

sl_zigbee_af_find_unused_pan_id_and_form#

sl_status_t sl_zigbee_af_find_unused_pan_id_and_form (void )

Find an unused PAN ID and form a new network.

Parameters
N/A

Returns

  • An sl_status_t value that indicates either the process begin successfully or the reason for failure.


Definition at line 2183 of file app/framework/include/af.h

sl_zigbee_af_start_search_for_joinable_network#

sl_status_t sl_zigbee_af_start_search_for_joinable_network (void )

Find a joinable network and join it.

Parameters
N/A

Returns

  • An sl_status_t value that indicates either the process begin successfully or the reason for failure.


Definition at line 2189 of file app/framework/include/af.h

sl_zigbee_af_push_network_index#

sl_status_t sl_zigbee_af_push_network_index (uint8_t networkIndex)

Set the current network to that of the given index and add it to the stack of networks maintained by the framework. Every call to this API must be paired with a subsequent call to sl_zigbee_af_pop_network_index.

Parameters
N/AnetworkIndex

Definition at line 2200 of file app/framework/include/af.h

sl_zigbee_af_push_callback_network_index#

sl_status_t sl_zigbee_af_push_callback_network_index (void )

Set the current network to the callback network and adds it to the stack of networks maintained by the framework. Every call to this API must be paired with a subsequent call to sl_zigbee_af_pop_network_index.

Parameters
N/A

Definition at line 2206 of file app/framework/include/af.h

sl_zigbee_af_push_endpoint_network_index#

sl_status_t sl_zigbee_af_push_endpoint_network_index (uint8_t endpoint)

Set the current network to that of the given endpoint and adds it to the stack of networks maintained by the framework. Every call to this API must be paired with a subsequent call to sl_zigbee_af_pop_network_index.

Parameters
N/Aendpoint

Definition at line 2212 of file app/framework/include/af.h

sl_zigbee_af_pop_network_index#

sl_status_t sl_zigbee_af_pop_network_index (void )

Remove the topmost network from the stack of networks maintained by the framework and sets the current network to the new topmost network. Every call to this API must be paired with a prior call to sl_zigbee_af_push_network_index, sl_zigbee_af_push_callback_network_index, or sl_zigbee_af_push_endpoint_network_index.

Parameters
N/A

Definition at line 2220 of file app/framework/include/af.h

sl_zigbee_af_primary_endpoint_for_network_index#

uint8_t sl_zigbee_af_primary_endpoint_for_network_index (uint8_t networkIndex)

Return the primary endpoint of the given network index or 0xFF if no endpoints belong to the network.sl_zigbee_af_status.

Parameters
N/AnetworkIndex

Definition at line 2225 of file app/framework/include/af.h

sl_zigbee_af_primary_endpoint_for_current_network_index#

uint8_t sl_zigbee_af_primary_endpoint_for_current_network_index (void )

Return the primary endpoint of the current network index or 0xFF if no endpoints belong to the current network.

Parameters
N/A

Definition at line 2230 of file app/framework/include/af.h