Network Utility Functions#
API and Callbacks for the Network Utility functionality in the Application Framework.
Network Utility Functions description.
API#
Use this function to form a new network using the specified network parameters.
Use this function to associate with the network using the specified network parameters.
Use this function to find an unused PAN id and form a new network.
Use this function to find a joinable network and join it.
Set the current network to that of the given index 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.
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.
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.
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.
Return the primary endpoint of the given network index or 0xFF if no endpoints belong to the network.emberAfStatus.
Returns 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)
Use this function to form a new network using the specified network parameters.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberNetworkParameters * | N/A | parameters | 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.
emberAfJoinNetwork#
EmberStatus emberAfJoinNetwork (EmberNetworkParameters * parameters)
Use this function to associate with the network using the specified network parameters.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberNetworkParameters * | N/A | parameters | 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.
emberAfFindUnusedPanIdAndForm#
EmberStatus emberAfFindUnusedPanIdAndForm (void )
Use this function to find an unused PAN id and form a new network.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns
An ::EmberStatus value that indicates either the process begin successfully or the reason for failure.
emberAfStartSearchForJoinableNetwork#
EmberStatus emberAfStartSearchForJoinableNetwork (void )
Use this function to find a joinable network and join it.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns
An ::EmberStatus value that indicates either the process begin successfully or the reason for failure.
emberAfPushNetworkIndex#
EmberStatus emberAfPushNetworkIndex (uint8_t networkIndex)
Set the current network to that of the given index 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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | networkIndex |
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint |
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | networkIndex |
emberAfPrimaryEndpointForCurrentNetworkIndex#
uint8_t emberAfPrimaryEndpointForCurrentNetworkIndex (void )
Returns the primary endpoint of the current network index or 0xFF if no endpoints belong to the current network.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |