Forming and Joining Networks#

emberScanForUnusedPanId#

EmberStatus emberScanForUnusedPanId (uint32_t channelMask, uint8_t duration)

Find an unused PAN ID.

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.

emberScanForJoinableNetwork#

EmberStatus emberScanForJoinableNetwork (uint32_t channelMask, uint8_t * extendedPanId)

Find a joinable network.

Performs an active scan on the specified channels looking for networks that:

1. currently permit joining,

2. match the stack profile of the application,

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

emberScanForNextJoinableNetwork#

EmberStatus emberScanForNextJoinableNetwork (void )

See emberScanForJoinableNetwork().

emberFormAndJoinIsScanning#

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.

emberFormAndJoinCanContinueJoinableNetworkScan#

bool emberFormAndJoinCanContinueJoinableNetworkScan (void )

Return true if and only if the application can continue a joinable network scan by calling emberScanForNextJoinableNetwork(). See emberScanForJoinableNetwork().

emberJoinableNetworkFoundHandler#

void emberJoinableNetworkFoundHandler (EmberZigbeeNetwork * networkFound, uint8_t lqi, int8_t rssi)

A callback the application needs to implement.

Notifies the application of the network found after a call to emberScanForJoinableNetwork() or emberScanForNextJoinableNetwork().

emberScanErrorHandler#

void emberScanErrorHandler (EmberStatus status)

A callback the application needs to implement.

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.

emberFormAndJoinScanCompleteHandler#

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.

Returns

• true if the library made use of the call.

emberFormAndJoinNetworkFoundHandler#

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.

Returns

• true if the library made use of the call.

emberFormAndJoinEnergyScanResultHandler#

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.

Returns

• true if the library made use of the call.

emberFormAndJoinUnusedPanIdFoundHandler#

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.

emberFormAndJoinTick#

void emberFormAndJoinTick (void )

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.

emberFormAndJoinTaskInit#

void emberFormAndJoinTaskInit (void )

When processor idling is desired on the SOC, this must be called to properly initialize the form and join library.

emberFormAndJoinRunTask#

void emberFormAndJoinRunTask (void )

When processor idling is desired on the SOC, this should be called regularly instead of emberFormAndJoinTick()

emberFormAndJoinCleanup#

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.

emberAfPluginFormAndJoinNetworkFoundCallback#

void emberAfPluginFormAndJoinNetworkFoundCallback (EmberZigbeeNetwork * networkFound, uint8_t lqi, int8_t rssi)

Network found.

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.

emberAfPluginFormAndJoinUnusedPanIdFoundCallback#

void emberAfPluginFormAndJoinUnusedPanIdFoundCallback (EmberPanId panId, uint8_t channel)

Unused Pan ID found.

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.

NETWORK_STORAGE_SIZE#

#define NETWORK_STORAGE_SIZE

16

Number of bytes required to store relevant info for a saved network.

This constant represents the minimum number of bytes required to store all members of the NetworkInfo struct used in the adapter code. Its value should not be changed unless the underlying adapter code is updated accordingly. Note that this constant's value may be different than sizeof(NetworkInfo) because some compilers pad the structs to align on word boundaries. Thus, the adapter code stores/retrieves these pieces of data individually (to be platform-agnostic) rather than as a struct.

For efficiency's sake, this number should be kept to a power of 2 and not and not exceed 32 (PACKET_BUFFER_SIZE).

NETWORK_STORAGE_SIZE_SHIFT#

#define NETWORK_STORAGE_SIZE_SHIFT

4

Log_base2 of NETWORK_STORAGE_SIZE.

FORM_AND_JOIN_MAX_NETWORKS#

#define FORM_AND_JOIN_MAX_NETWORKS

15

Number of joinable networks that can be remembered during the scan process.

Note for SoC Platforms: This is currently limited to a maximum of 15 due to the size of each network entry (16 bytes) and the EmberMessageBuffer API's requirement that total buffer storage length be kept to an 8-bit quantity (less than 256).

Note for EZSP Host Platforms: In the host implementation of this library, the storage size for the detected networks buffer is controlled by ::EZSP_HOST_FORM_AND_JOIN_BUFFER_SIZE, so that limits the highest value that the host can set for FORM_AND_JOIN_MAX_NETWORKS.