Forming and Joining Networks#
Functions for finding an existing network to join and for finding an unused PAN id with which to form a network.
Summary of application requirements:
For the SoC:
Define ::EMBER_APPLICATION_HAS_ENERGY_SCAN_RESULT_HANDLER in the configuration header.
Call emberFormAndJoinTick() regularly in the main loop.
Include form-and-join.c and form-and-join-node-adapter.c in the build.
Optionally include form-and-join-node-callbacks.c in the build.
If processor idling is desired: – Call emberFormAndJoinTaskInit() to initialize the form and join task – Call emberFormAndJoinRunTask() regularly in the main loop instead of emberFormAndJoinTick()
For an EZSP Host:
Define ::EZSP_APPLICATION_HAS_ENERGY_SCAN_RESULT_HANDLER in the configuration header.
Include form-and-join.c and form-and-join-host-adapter.c in the build.
Optionally include form-and-join-host-callbacks.c in the build.
For either platform, the application can omit the form-and-join-*-callback.c file from the build and implement the callbacks itself if necessary. In this case, the appropriate form-and-join callback function must be called from within each callback as within the form-and-join-*-callback.c files.
On either platform, FORM_AND_JOIN_MAX_NETWORKS can be explicitly defined to limit (or expand) the number of joinable networks that the library will save for consideration during the scan process.
The library can resume scanning for joinable networks from where it left off, via a call to emberScanForNextJoinableNetwork(). Therefore, if the first joinable network found is not the correct one, the application can continue scanning without starting from the beginning and without finding the same network that it has already rejected. The library can also be used on the host processor.
Functions#
Find an unused PAN ID.
Find a joinable network.
Return true if and only if the form and join library is in the process of scanning and is therefore expecting scan results to be passed to it from the application.
Return true if and only if the application can continue a joinable network scan by calling emberScanForNextJoinableNetwork(). See emberScanForJoinableNetwork().
A callback the application needs to implement.
A callback the application needs to implement.
The application must call this function from within its emberScanCompleteHandler() (on the node) or ezspScanCompleteHandler() (on an EZSP host). Default callback implementations are provided in the form-and-join-*-callbacks.c files.
The application must call this function from within its emberNetworkFoundHandler() (on the node) or ezspNetworkFoundHandler() (on an EZSP host). Default callback implementations are provided in the form-and-join-*-callbacks.c files.
The application must call this function from within its emberEnergyScanResultHandler() (on the node) or ezspEnergyScanResultHandler() (on an EZSP host). Default callback implementations are provided in the form-and-join-*-callbacks.c files.
The application must call this function from within its emberUnusedPandIdFoundHandler() (on the node) or ezspEnergyScanResultHandler() (on an EZSP host). Default callback implementations are provided in the form-and-join-*-callbacks.c files.
When processor idling is desired on the SOC, this must be called to properly initialize the form and join library.
When processor idling is desired on the SOC, this should be called regularly instead of emberFormAndJoinTick()
When form-and-join state is no longer needed, the application can call this routine to cleanup and free resources. On the SOC platforms this will free the allocated message buffer.
Network found.
Unused Pan ID found.
Macros#
Number of bytes required to store relevant info for a saved network.
Log_base2 of NETWORK_STORAGE_SIZE.
Number of joinable networks that can be remembered during the scan process.
Function Documentation#
emberScanForUnusedPanId#
EmberStatus emberScanForUnusedPanId (uint32_t channelMask, uint8_t duration)
Find an unused PAN ID.
| N/A | channelMask | |
| N/A | duration | The duration of the energy scan. See the documentation for emberStartScan() in stack/include/network-formation.h for information on duration values. |
Does an energy scan on the indicated channels and randomly chooses one from amongst those with the least average energy. Then picks a short PAN ID that does not appear during an active scan on the chosen channel. The chosen PAN ID and channel are returned via the emberUnusedPanIdFoundHandler() callback. If an error occurs, the application is informed via the emberScanErrorHandler().
Returns
EMBER_LIBRARY_NOT_PRESENT if the form and join library is not available.
133 of file app/util/common/form-and-join.hemberScanForJoinableNetwork#
EmberStatus emberScanForJoinableNetwork (uint32_t channelMask, uint8_t * extendedPanId)
Find a joinable network.
| N/A | channelMask | |
| N/A | extendedPanId |
Performs an active scan on the specified channels looking for networks that:
currently permit joining,
match the stack profile of the application,
match the extended PAN id argument if it is not NULL.
Upon finding a matching network, the application is notified via the emberJoinableNetworkFoundHandler() callback, and scanning stops. If an error occurs during the scanning process, the application is informed via the emberScanErrorHandler(), and scanning stops.
If the application determines that the discovered network is not the correct one, it may call emberScanForNextJoinableNetwork() to continue the scanning process where it was left off and find a different joinable network. If the next network is not the correct one, the application can continue to call emberScanForNextJoinableNetwork(). Each call must occur within 30 seconds of the previous one, otherwise the state of the scan process is deleted to free up memory. Calling emberScanForJoinableNetwork() causes any old state to be forgotten and starts scanning from the beginning.
Returns
EMBER_LIBRARY_NOT_PRESENT if the form and join library is not available.
161 of file app/util/common/form-and-join.hemberScanForNextJoinableNetwork#
EmberStatus emberScanForNextJoinableNetwork (void )
See emberScanForJoinableNetwork().
| N/A |
164 of file app/util/common/form-and-join.hemberFormAndJoinIsScanning#
bool emberFormAndJoinIsScanning (void )
Return true if and only if the form and join library is in the process of scanning and is therefore expecting scan results to be passed to it from the application.
| N/A |
170 of file app/util/common/form-and-join.hemberFormAndJoinCanContinueJoinableNetworkScan#
bool emberFormAndJoinCanContinueJoinableNetworkScan (void )
Return true if and only if the application can continue a joinable network scan by calling emberScanForNextJoinableNetwork(). See emberScanForJoinableNetwork().
| N/A |
176 of file app/util/common/form-and-join.hemberJoinableNetworkFoundHandler#
void emberJoinableNetworkFoundHandler (EmberZigbeeNetwork * networkFound, uint8_t lqi, int8_t rssi)
A callback the application needs to implement.
| N/A | networkFound | |
| N/A | lqi | The LQI value of the received beacon. |
| N/A | rssi | The RSSI value of the received beacon. |
Notifies the application of the network found after a call to emberScanForJoinableNetwork() or emberScanForNextJoinableNetwork().
191 of file app/util/common/form-and-join.hemberScanErrorHandler#
void emberScanErrorHandler (EmberStatus status)
A callback the application needs to implement.
| N/A | status |
If an error occurs while scanning, this function is called and the scan effort is aborted.
Possible return status values are:
EMBER_INVALID_CALL: if emberScanForNextJoinableNetwork() is called more than 30 seconds after a previous call to emberScanForJoinableNetwork() or emberScanForNextJoinableNetwork().
EMBER_NO_BUFFERS: if there is not enough memory to start a scan.
EMBER_NO_BEACONS: if no joinable beacons are found.
EMBER_MAC_SCANNING: if a scan is already in progress.
212 of file app/util/common/form-and-join.hemberFormAndJoinScanCompleteHandler#
bool emberFormAndJoinScanCompleteHandler (uint8_t channel, EmberStatus status)
The application must call this function from within its emberScanCompleteHandler() (on the node) or ezspScanCompleteHandler() (on an EZSP host). Default callback implementations are provided in the form-and-join-*-callbacks.c files.
| N/A | channel | |
| N/A | status |
Returns
true if the library made use of the call.
225 of file app/util/common/form-and-join.hemberFormAndJoinNetworkFoundHandler#
bool emberFormAndJoinNetworkFoundHandler (EmberZigbeeNetwork * networkFound, uint8_t lqi, int8_t rssi)
The application must call this function from within its emberNetworkFoundHandler() (on the node) or ezspNetworkFoundHandler() (on an EZSP host). Default callback implementations are provided in the form-and-join-*-callbacks.c files.
| N/A | networkFound | |
| N/A | lqi | |
| N/A | rssi |
Returns
true if the library made use of the call.
234 of file app/util/common/form-and-join.hemberFormAndJoinEnergyScanResultHandler#
bool emberFormAndJoinEnergyScanResultHandler (uint8_t channel, int8_t maxRssiValue)
The application must call this function from within its emberEnergyScanResultHandler() (on the node) or ezspEnergyScanResultHandler() (on an EZSP host). Default callback implementations are provided in the form-and-join-*-callbacks.c files.
| N/A | channel | |
| N/A | maxRssiValue |
Returns
true if the library made use of the call.
245 of file app/util/common/form-and-join.hemberFormAndJoinUnusedPanIdFoundHandler#
bool emberFormAndJoinUnusedPanIdFoundHandler (EmberPanId panId, uint8_t channel)
The application must call this function from within its emberUnusedPandIdFoundHandler() (on the node) or ezspEnergyScanResultHandler() (on an EZSP host). Default callback implementations are provided in the form-and-join-*-callbacks.c files.
| N/A | panId | |
| N/A | channel |
252 of file app/util/common/form-and-join.hemberFormAndJoinTick#
void emberFormAndJoinTick (void )
| N/A |
Used by the form and join code on the node to time out a joinable scan after 30 seconds of inactivity. The application must call emberFormAndJoinTick() regularly. This function does not exist for the EZSP host library.
258 of file app/util/common/form-and-join.hemberFormAndJoinTaskInit#
void emberFormAndJoinTaskInit (void )
When processor idling is desired on the SOC, this must be called to properly initialize the form and join library.
| N/A |
263 of file app/util/common/form-and-join.hemberFormAndJoinRunTask#
void emberFormAndJoinRunTask (void )
When processor idling is desired on the SOC, this should be called regularly instead of emberFormAndJoinTick()
| N/A |
268 of file app/util/common/form-and-join.hemberFormAndJoinCleanup#
void emberFormAndJoinCleanup (EmberStatus status)
When form-and-join state is no longer needed, the application can call this routine to cleanup and free resources. On the SOC platforms this will free the allocated message buffer.
| N/A | status |
274 of file app/util/common/form-and-join.hemberAfPluginFormAndJoinNetworkFoundCallback#
void emberAfPluginFormAndJoinNetworkFoundCallback (EmberZigbeeNetwork * networkFound, uint8_t lqi, int8_t rssi)
Network found.
| N/A | networkFound | Ver.: always |
| N/A | lqi | Ver.: always |
| N/A | rssi | Ver.: always |
This is called by the form-and-join library to notify the application of the network found after a call to emberScanForJoinableNetwork() or emberScanForNextJoinableNetwork(). See form-and-join documentation for more information.
287 of file app/util/common/form-and-join.hemberAfPluginFormAndJoinUnusedPanIdFoundCallback#
void emberAfPluginFormAndJoinUnusedPanIdFoundCallback (EmberPanId panId, uint8_t channel)
Unused Pan ID found.
| N/A | panId | A randomly generated PAN ID without other devices on it. Ver.: always |
| N/A | channel | The channel where the PAN ID can be used to form a new network. Ver.: always |
This function is called when the form-and-join library finds an unused PAN ID that can be used to form a new network on.
301 of file app/util/common/form-and-join.h