Network Utility Functions#

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

Network Utility Functions description.

API#

EmberStatus
emberAfFormNetwork(EmberNetworkParameters *parameters)

Form a new network using the specified network parameters.

EmberStatus
emberAfJoinNetwork(EmberNetworkParameters *parameters)

Associate with the network using the specified network parameters.

EmberStatus

Find an unused PAN ID and form a new network.

EmberStatus

Find a joinable network and join it.

EmberStatus
emberAfPushNetworkIndex(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 emberAfPopNetworkIndex.

EmberStatus

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 emberAfPopNetworkIndex.

EmberStatus

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 emberAfPopNetworkIndex.

EmberStatus

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 emberAfPushNetworkIndex, emberAfPushCallbackNetworkIndex, or emberAfPushEndpointNetworkIndex.

uint8_t

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

uint8_t

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

API Documentation#

emberAfFormNetwork#

EmberStatus emberAfFormNetwork (EmberNetworkParameters * parameters)

Form a new network using the specified network parameters.

Parameters
N/Aparameters

Specification of the new network.

Returns

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


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

emberAfJoinNetwork#

EmberStatus emberAfJoinNetwork (EmberNetworkParameters * 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 ::EmberStatus value that indicates either that the association process began successfully or the reason for failure.


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

emberAfFindUnusedPanIdAndForm#

EmberStatus emberAfFindUnusedPanIdAndForm (void )

Find an unused PAN ID and form a new network.

Parameters
N/A

Returns

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


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

emberAfStartSearchForJoinableNetwork#

EmberStatus emberAfStartSearchForJoinableNetwork (void )

Find a joinable network and join it.

Parameters
N/A

Returns

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


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

emberAfPushNetworkIndex#

EmberStatus emberAfPushNetworkIndex (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 emberAfPopNetworkIndex.

Parameters
N/AnetworkIndex

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

emberAfPushCallbackNetworkIndex#

EmberStatus emberAfPushCallbackNetworkIndex (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 emberAfPopNetworkIndex.

Parameters
N/A

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

emberAfPushEndpointNetworkIndex#

EmberStatus emberAfPushEndpointNetworkIndex (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 emberAfPopNetworkIndex.

Parameters
N/Aendpoint

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

emberAfPopNetworkIndex#

EmberStatus emberAfPopNetworkIndex (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 emberAfPushNetworkIndex, emberAfPushCallbackNetworkIndex, or emberAfPushEndpointNetworkIndex.

Parameters
N/A

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

emberAfPrimaryEndpointForNetworkIndex#

uint8_t emberAfPrimaryEndpointForNetworkIndex (uint8_t networkIndex)

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

Parameters
N/AnetworkIndex

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

emberAfPrimaryEndpointForCurrentNetworkIndex#

uint8_t emberAfPrimaryEndpointForCurrentNetworkIndex (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 2195 of file app/framework/include/af.h