Network Formation#

EmberNetworkFoundCallback#

typedef bool(* EmberNetworkFoundCallback) (EmberZigbeeNetwork *network, uint8_t rssi, int8_t lqi, uint16_t senderNodeId, uint8_t parentPriority) )(EmberZigbeeNetwork *network, uint8_t rssi, int8_t lqi, uint16_t senderNodeId, uint8_t parentPriority)

Handle the reception of a beacon.

NOTE: SoC only

EmberScanCompleteCallback#

typedef bool(* EmberScanCompleteCallback) (uint8_t channel, EmberStatus status) )(uint8_t channel, EmberStatus status)

Handle the conclusion of an active or energy scan.

NOTE: SoC only

emberInit#

EmberStatus emberInit (void)

Initialize the radio and the EmberZNet stack.

Device configuration functions must be called before emberInit() is called.

Note

• The application must check the return value of this function. If the initialization fails, normal messaging functions will not be available. Some failure modes are not fatal, but the application must follow certain procedures to permit recovery. Ignoring the return code will result in unpredictable radio and API behavior. (In particular, problems with association will occur.)

Returns

• An EmberStatus value indicating successful initialization or the reason for failure.

emberTick#

void emberTick (void)

A periodic tick routine that should be called:

• in the application's main event loop,

• as soon as possible after any radio interrupts, and

• after emberInit().

emberNetworkInit#

EmberStatus emberNetworkInit (EmberNetworkInitStruct *networkInitStruct)

Resume network operation after a reboot.

Call this function on boot prior to any network operations. It will initialize the networking system and attempt to resume the previous network identity and configuration. If the node was not previously joined, this routine should still be called.

If the node was previously joined to a network, it will retain its original type (e.g., coordinator, router, end device, and so on.)

EMBER_NOT_JOINED is returned if the node is not part of a network.

. This function has encapsulated the old behavior of emberNetworkInitExtended().

Returns

• An EmberStatus value that indicates one of the following:

  • successful initialization,

  • EMBER_NOT_JOINED if the node is not part of a network, or

  • the reason for failure.

emberFormNetwork#

EmberStatus emberFormNetwork (EmberNetworkParameters *parameters)

Form a new network by becoming the coordinator.

Note

• If using security, the application must call emberSetInitialSecurityState() prior to joining the network. This also applies when a device leaves a network and wants to form another one.

Returns

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

emberWireFreeNetworkStart#

EmberStatus emberWireFreeNetworkStart (EmberNetworkParameters *parameters, bool initiator)

Form a new Wirefree network.

Note

• If using security, the application must call emberSetInitialSecurityState() prior to joining the network. This also applies when a device leaves a network and wants to form another one.

Returns

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

emberPermitJoining#

EmberStatus emberPermitJoining (uint8_t duration)

Tell the stack to allow other nodes to join the network with this node as their parent. Joining is initially disabled by default. This function may only be called after the node is part of a network and the stack is up.

emberJoinNetwork#

EmberStatus emberJoinNetwork (EmberNodeType nodeType, EmberNetworkParameters *parameters)

Cause the stack to associate with the network using the specified network parameters. It can take several seconds for the stack to associate with the local network. Do not send messages until a call to the emberStackStatusHandler() callback informs you that the stack is up.

Note

• If using security, the application must call emberSetInitialSecurityState() prior to joining the network. This also applies when a device leaves a network and wants to join another one.

Returns

• An EmberStatus value that indicates either:

  • that the association process began successfully, or

  • the reason for failure.

emberJoinNetworkDirectly#

EmberStatus emberJoinNetworkDirectly (EmberNodeType localNodeType, EmberBeaconData *beacon, int8_t radioTxPower, bool clearBeaconsAfterNetworkUp)

Cause the stack to associate with the network using the specified network parameters in the beacon parameter. It can take several seconds for the stack to associate with the local network. Do not send messages until a call to the emberStackStatusHandler() callback informs you that the stack is up. This function, unlike emberJoinNetwork(), does not issue an active scan before joining. Instead, this function will cause the local node to issue a MAC Association Request directly to the specified target node. It is assumed that the beacon parameter is an artifact after issuing an active scan (see ::emberGetBestBeacon() and emberGetNextBeacon() for more).

Note

• If using security, the application must call emberSetInitialSecurityState() prior to joining the network. This also applies when a device leaves a network and wants to join another one.

Returns

• An EmberStatus value that indicates either:

  • that the association process began successfully, or

  • the reason for failure.

emberLeaveNetwork#

EmberStatus emberLeaveNetwork (void)

Cause the stack to leave the current network. This generates a call to the emberStackStatusHandler() callback to indicate that the network is down. The radio will not be used until after a later call to emberFormNetwork() or emberJoinNetwork().

Returns

• An EmberStatus value indicating success or reason for failure. A status of EMBER_INVALID_CALL indicates that the node is either not joined to a network or is already in the process of leaving.

emberSendZigbeeLeave#

EmberStatus emberSendZigbeeLeave (EmberNodeId destination, EmberLeaveRequestFlags flags)

Send a Zigbee NWK leave command to the specified destination.

Returns

• An EmberStatus value indicating success or reason for failure. A status of EMBER_INVALID_CALL indicates that the node not currently joined to the network, or the destination is the local node. To tell the local device to leave, use the emberLeaveNetwork() API.

emberFindAndRejoinNetworkWithReason#

EmberStatus emberFindAndRejoinNetworkWithReason (bool haveCurrentNetworkKey, uint32_t channelMask, EmberRejoinReason reason)

Call this function when contact with the network has been lost. The most common use case is when an end device can no longer communicate with its parent and wishes to find a new one. Another case is when a device has missed a Network Key update and no longer has the current Network Key.

Note that a call to emberPollForData() on an end device that has lost contact with its parent will automatically call ::emberRejoinNetwork(true).

The stack will call emberStackStatusHandler() to indicate that the network is down, then try to re-establish contact with the network by performing an active scan, choosing a network with matching extended pan ID, and sending a Zigbee network rejoin request. A second call to the emberStackStatusHandler() callback indicates either the success or the failure of the attempt. The process takes approximately 150 milliseconds per channel to complete.

This call replaces the ::emberMobileNodeHasMoved() API from EmberZNet 2.x, which used MAC association and consequently took half a second longer to complete.

Returns

• An EmberStatus value indicating success or reason for failure.

emberFindAndRejoinNetwork#

EmberStatus emberFindAndRejoinNetwork (bool haveCurrentNetworkKey, uint32_t channelMask)

This call is the same emberFindAndRejoinNetworkWithReason(). However, the reason is assumed to be ::EMBER_REJOIN_REASON_APP_EVENT_1.

emberFindAndRejoinNetworkWithNodeType#

EmberStatus emberFindAndRejoinNetworkWithNodeType (bool haveCurrentNetworkKey, uint32_t channelMask, EmberNodeType nodeType)

Attempt to rejoin the network with a different device type.

emberGetLastRejoinReason#

EmberRejoinReason emberGetLastRejoinReason (void)

Return the enumeration for why a previous rejoin.

emberRejoinNetwork#

EmberStatus emberRejoinNetwork (bool haveCurrentNetworkKey)

A convenience function which calls emberFindAndRejoinNetwork() with a channel mask value for scanning only the current channel. Included for back-compatibility.

emberStartScan#

EmberStatus emberStartScan (EmberNetworkScanType scanType, uint32_t channelMask, uint8_t duration)

Start a scan. EMBER_SUCCESS signals that the scan successfully started. Note that although a scan can be initiated while the node is currently joined to a network, the node will generally be unable to communicate with its PAN during the scan period. Take care when performing scans of any significant duration while presently joined to an existing PAN.

Possible error responses and their meanings:

• EMBER_MAC_SCANNING, already scanning.

• EMBER_MAC_BAD_SCAN_DURATION, a duration value that is not 0..14 inclusive is set.

• EMBER_MAC_INCORRECT_SCAN_TYPE, an undefined scanning type is requested;

• EMBER_MAC_INVALID_CHANNEL_MASK, the channel mask did not specify any valid channels on the current platform.

emberSurveyBeacons#

EmberStatus emberSurveyBeacons (bool useStandardBeacons, EmberNetworkFoundCallback networkFoundCallback, EmberScanCompleteCallback scanCompleteCallback)

Kick off a procedure to scan for beacons, filter results, and provide a response ZCL frame including the best eligible parents. This procedure uses the emberStartScan() API.

NOTE: SoC only

emberFindUnusedPanId#

EmberStatus emberFindUnusedPanId (uint32_t channelMask, uint8_t duration)

Kick off a procedure to find an unused panId on a low-activity channel that is included in the passed-in channel mask. This procedure uses the emberStartScan() API.

emberStopScan#

EmberStatus emberStopScan (void)

Terminate a scan in progress.

Returns

• Returns EMBER_SUCCESS if successful.

emberIsRadioOffScanActivated#

bool emberIsRadioOffScanActivated (void)

Check if radio_off scan mode is activated and radio has shut down as a result.

Returns

• Returns ::true if radio has shut down successfully. There is no EZSP/NCP implementation for this.

emberScanCompleteHandler#

void emberScanCompleteHandler (uint8_t channel, EmberStatus status)

Indicate the status of the current scan. When the scan has completed, the stack will call this function with status set to EMBER_SUCCESS. Prior to the scan completing, the stack may call this function with other status values. Non-EMBER_SUCCESS status values indicate that the scan failed to start successfully on the channel indicated by the channel parameter. The current scan is ongoing until the stack calls this function with status set to EMBER_SUCCESS.

emberEnergyScanResultHandler#

void emberEnergyScanResultHandler (uint8_t channel, int8_t maxRssiValue)

Report the maximum RSSI value measured on the channel.

emberNetworkFoundHandler#

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

Report that a network was found and gives the network parameters used for deciding which network to join.

emberUnusedPanIdFoundHandler#

void emberUnusedPanIdFoundHandler (EmberPanId panId, uint8_t channel)

Return an unused panID and channel pair found via the find unused panId scan procedure.

emberStackIsPerformingRejoin#

bool emberStackIsPerformingRejoin (void)

Indicate whether the stack is in the process of performing a rejoin.

Returns

• Returns true if the device is in the process of performing a rejoin. Returns false otherwise.

emberGetLastLeaveReason#

EmberLeaveReason emberGetLastLeaveReason (EmberNodeId *returnNodeIdThatSentLeave)

Indicate the reason why the device left the network (if any). This also will return the device that sent the leave message, if the leave was due to an over-the-air message.

If returnNodeIdThatSentLeave is a non-NULL pointer, the node ID of the device that sent the leave message will be written to the value indicated by the pointer. If the leave was not due to an over-the-air message (but an internal API call instead), EMBER_UNKNOWN_NODE_ID is returned.

Returns

• Returns EmberLeaveReason enumeration, or EMBER_LEAVE_REASON_NONE if the device has not left the network.

emberGetPermitJoining#

bool emberGetPermitJoining (void)

Indicate the state of the permit joining in the MAC.

emberSetNwkUpdateId#

EmberStatus emberSetNwkUpdateId (uint8_t nwkUpdateId)

Set the Network Update ID to the desired value. The Network Update ID value cannot be manually changed after a network is joined, so this function must be called before calling emberFormNetwork.

Note

• This Network Update ID should not normally be changed, as it is used by the stack to track changes in the network.

Returns

• EMBER_SUCCESS if called when not on network, else EMBER_INVALID_CALL.

emberSetBeaconJitterDuration#

EmberStatus emberSetBeaconJitterDuration (uint8_t beaconJitterDuration)

Set the duration of a beacon jitter, in the units used by the 15.4 scan parameter (((1 << duration) + 1) * 15 ms), when responding to a beacon request.

Note

• Because the recommended scan duration of a joining device is 3 for 2.4 GHz devices, any value passed in to this function greater than 3 will be rejected.

Returns

• EMBER_BAD_ARGUMENT if the argument is invalid, else EMBER_SUCCESS.

emberSetTcRejoinsUsingWellKnownKeyAllowed#

void emberSetTcRejoinsUsingWellKnownKeyAllowed (bool allow)

Set the policy decision for Trust Center (insecure) rejoins for devices using the well-known link key. If rejoining using the well-known key is allowed, it is disabled again after emAllowTcRejoinsUsingWellKnownKeyTimeoutSec seconds.

emberTcRejoinsUsingWellKnownKeyAllowed#

bool emberTcRejoinsUsingWellKnownKeyAllowed (void)

Get the policy decision for Trust Center (insecure) rejoins for devices using the well-known link key.

emberSetupDelayedJoin#

EmberStatus emberSetupDelayedJoin (uint8_t networkKeyTimeoutS)

emberGetNetworkKeyTimeout#

uint8_t emberGetNetworkKeyTimeout (void)

emberRescheduleLinkStatusMsg#

void emberRescheduleLinkStatusMsg (void)

emberSetMinRSSI#

void emberSetMinRSSI (int8_t minRSSI)

Configure the minimum RSSI for receiving packets.

The minimum RSSI is used to classify good/bad parent signal strengths. Any packet in the range of minimum RSSI + 30 db is considered to be "bad". By default, this value is set to -100. Currently, there is no EZSP support. This is left here for backward compatibility. You can achieve the same EZSP applicable setting with emberSetBeaconClassificationParams

emberSetParentClassificationEnabled#

void emberSetParentClassificationEnabled (bool enabled)

Enable/disable the parent classification algorithm on the stack side. Parent classification considers whether a received beacon indicates trust center connectivity and long uptime on the network. This is left here for backward compatibility. You can achieve the same with emberSetBeaconClassificationParams.

emberGetParentClassificationEnabled#

bool emberGetParentClassificationEnabled (void)

Get the enable state the parent classification algorithm. This is left here for backward compatibility. You can achieve the same with emberGetBeaconClassificationParams.

emberSetPendingNetworkUpdatePanId#

void emberSetPendingNetworkUpdatePanId (uint16_t panId)

Set the short PAN ID the device will accept in a NLME Network Update command.

If a NLME Network Update command is received by the device specifying a short PAN ID that does not match with the given PAN ID, then the NLME Network Update message will be ignored by the device. A value of 0xFFFF indicates that any short PAN ID received in a NLME Network Update command will be accepted which is also the default value set by the stack.

emberGetNeighborLastLqiRssi#

EmberStatus emberGetNeighborLastLqiRssi (EmberNodeId nodeId, uint8_t *lqi, int8_t *rssi)

emberSendPanIdUpdate#

bool emberSendPanIdUpdate (EmberPanId newPan)

emberClearStoredBeacons#

void emberClearStoredBeacons (void)

Clear all cached beacons that have been collected from an active scan.

emberSetNumBeaconsToStore#

EmberStatus emberSetNumBeaconsToStore (uint8_t numBeacons)

emberGetFirstBeacon#

EmberStatus emberGetFirstBeacon (EmberBeaconIterator *beaconIterator)

emberGetNextBeacon#

EmberStatus emberGetNextBeacon (EmberBeaconData *beacon)

emberGetNumStoredBeacons#

uint8_t emberGetNumStoredBeacons (void)

Return the number of cached beacons that have been collected from a scan.