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:

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 is done 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 is able to resume scanning for joinable networks from where it left off, via a call to emberScanForNextJoinableNetwork(). Thus 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#

emberScanForUnusedPanId(uint32_t channelMask, uint8_t duration)

Find an unused PAN id.

emberScanForJoinableNetwork(uint32_t channelMask, uint8_t *extendedPanId)

Finds a joinable network.

bool

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

bool

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

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

A callback the application needs to implement.

void
emberScanErrorHandler(EmberStatus status)

A callback the application needs to implement.

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.

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.

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.

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.

void

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

void

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

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.

Macros#

#define

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

#define

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.

Parameters
N/AchannelMask
N/Aduration

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.


Definition at line 133 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/util/common/form-and-join.h

emberScanForJoinableNetwork#

EmberStatus emberScanForJoinableNetwork (uint32_t channelMask, uint8_t * extendedPanId)

Finds a joinable network.

Parameters
N/AchannelMask
N/AextendedPanId

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.


Definition at line 161 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/util/common/form-and-join.h

emberScanForNextJoinableNetwork#

EmberStatus emberScanForNextJoinableNetwork (void )

See emberScanForJoinableNetwork().

Parameters
N/A

Definition at line 164 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/util/common/form-and-join.h

emberFormAndJoinIsScanning#

bool emberFormAndJoinIsScanning (void )

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

Parameters
N/A

Definition at line 170 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/util/common/form-and-join.h

emberFormAndJoinCanContinueJoinableNetworkScan#

bool emberFormAndJoinCanContinueJoinableNetworkScan (void )

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

Parameters
N/A

Definition at line 176 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/util/common/form-and-join.h

emberJoinableNetworkFoundHandler#

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

A callback the application needs to implement.

Parameters
N/AnetworkFound
N/Alqi

The lqi value of the received beacon.

N/Arssi

The rssi value of the received beacon.

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


Definition at line 191 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/util/common/form-and-join.h

emberScanErrorHandler#

void emberScanErrorHandler (EmberStatus status)

A callback the application needs to implement.

Parameters
N/Astatus

If an error occurs while scanning, this function is called and the scan effort is aborted.

Possible return status values are:


Definition at line 212 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/util/common/form-and-join.h

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.

Parameters
N/Achannel
N/Astatus

Returns

  • true iff the library made use of the call.


Definition at line 225 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/util/common/form-and-join.h

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.

Parameters
N/AnetworkFound
N/Alqi
N/Arssi

Returns

  • true iff the library made use of the call.


Definition at line 234 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/util/common/form-and-join.h

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.

Parameters
N/Achannel
N/AmaxRssiValue

Returns

  • true iff the library made use of the call.


Definition at line 245 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/util/common/form-and-join.h

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.

Parameters
N/ApanId
N/Achannel

Definition at line 252 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/util/common/form-and-join.h

emberFormAndJoinTick#

void emberFormAndJoinTick (void )
Parameters
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.


Definition at line 258 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/util/common/form-and-join.h

emberFormAndJoinTaskInit#

void emberFormAndJoinTaskInit (void )

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

Parameters
N/A

Definition at line 263 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/util/common/form-and-join.h

emberFormAndJoinRunTask#

void emberFormAndJoinRunTask (void )

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

Parameters
N/A

Definition at line 268 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/util/common/form-and-join.h

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.

Parameters
N/Astatus

Definition at line 274 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/util/common/form-and-join.h

Macro Definition Documentation#

NETWORK_STORAGE_SIZE#

#define NETWORK_STORAGE_SIZE
Value:
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).


Definition at line 80 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/util/common/form-and-join.h

NETWORK_STORAGE_SIZE_SHIFT#

#define NETWORK_STORAGE_SIZE_SHIFT
Value:
4

Log_base2 of NETWORK_STORAGE_SIZE.


Definition at line 84 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/util/common/form-and-join.h

FORM_AND_JOIN_MAX_NETWORKS#

#define FORM_AND_JOIN_MAX_NETWORKS
Value:
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.


Definition at line 106 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/util/common/form-and-join.h