Network Formation#

sl_zigbee_network_found_callback_t#

typedef bool(* sl_zigbee_network_found_callback_t) (sl_zigbee_zigbee_network_t *network, sl_zigbee_beacon_data_t *beacon) )(sl_zigbee_zigbee_network_t *network, sl_zigbee_beacon_data_t *beacon)

Handle the reception of a beacon.

NOTE: SoC only

sl_zigbee_scan_complete_callback_t#

typedef bool(* sl_zigbee_scan_complete_callback_t) (uint8_t channel, sl_status_t status) )(uint8_t channel, sl_status_t status)

Handle the conclusion of an active or energy scan.

NOTE: SoC only

sl_zigbee_init#

sl_status_t sl_zigbee_init (void )

Initialize the radio and the EmberZNet stack.

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

Note

• Users do not normally need to call this API, as the Applicaton Framework code automatically calls this routine upon startup. 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 ::sl_status_t value indicating successful initialization or the reason for failure.

sl_zigbee_tick#

void sl_zigbee_tick (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 sl_zigbee_init().

Note

• Users do not normally need to call this API, as the Applicaton Framework code automatically calls this routine upon startup.

sl_zigbee_network_init#

sl_status_t sl_zigbee_network_init (sl_zigbee_network_init_struct_t * 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.)

::SL_STATUS_NOT_JOINED is returned if the node is not part of a network.

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

Returns

• An ::sl_status_t value that indicates one of the following:

  • successful initialization,

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

  • the reason for failure.

sl_zigbee_form_network#

sl_status_t sl_zigbee_form_network (sl_zigbee_network_parameters_t * parameters)

Form a new network by becoming the coordinator.

Note

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

Returns

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

sl_zigbee_sleepy_to_sleepy_network_start#

sl_status_t sl_zigbee_sleepy_to_sleepy_network_start (sl_zigbee_network_parameters_t * parameters, bool initiator)

Form a new Sleepy-to-Sleepy network.

Note

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

Returns

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

sl_zigbee_permit_joining#

sl_status_t sl_zigbee_permit_joining (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.

sl_zigbee_join_network#

sl_status_t sl_zigbee_join_network (sl_zigbee_node_type_t nodeType, sl_zigbee_network_parameters_t * 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 sl_zigbee_stack_status_handler() callback informs you that the stack is up.

Note

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

Returns

• An ::sl_status_t value that indicates either:

  • that the association process began successfully, or

  • the reason for failure.

sl_zigbee_join_network_directly#

sl_status_t sl_zigbee_join_network_directly (sl_zigbee_node_type_t localNodeType, sl_zigbee_beacon_data_t * 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 sl_zigbee_stack_status_handler() callback informs you that the stack is up. This function, unlike sl_zigbee_join_network(), 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 sl_zigbee_get_stored_beacon() for more).

Note

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

Returns

• An ::sl_status_t value that indicates either:

  • that the association process began successfully, or

  • the reason for failure.

sl_zigbee_leave_network#

sl_status_t sl_zigbee_leave_network (sl_zigbee_leave_network_option_t options)

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

Returns

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

sl_zigbee_send_zigbee_leave#

sl_status_t sl_zigbee_send_zigbee_leave (sl_802154_short_addr_t destination, sl_zigbee_leave_request_flags_t flags)

Send a Zigbee NWK leave command to the specified destination.

Returns

• An ::sl_status_t value indicating success or reason for failure. A status of ::SL_STATUS_INVALID_STATE 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 sl_zigbee_leave_network() API.

sl_zigbee_find_and_rejoin_network#

sl_status_t sl_zigbee_find_and_rejoin_network (bool haveCurrentNetworkKey, uint32_t channelMask, sl_zigbee_rejoin_reason_t reason, sl_zigbee_node_type_t nodeType)

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 sl_zigbee_poll_for_data() on an end device that has lost contact with its parent will automatically call ::emberRejoinNetwork(true).

The stack will call sl_zigbee_stack_status_handler() 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 sl_zigbee_stack_status_handler() 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 ::sl_status_t value indicating success or reason for failure.

sl_zigbee_get_last_rejoin_reason#

sl_zigbee_rejoin_reason_t sl_zigbee_get_last_rejoin_reason (void )

Return the enumeration for why a previous rejoin.

sl_zigbee_start_scan#

sl_status_t sl_zigbee_start_scan (sl_zigbee_network_scan_type_t scanType, uint32_t channelMask, uint8_t duration)

Start a scan. ::SL_STATUS_OK 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:

• ::SL_STATUS_MAC_SCANNING, already scanning.

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

• ::SL_STATUS_MAC_INCORRECT_SCAN_TYPE, an undefined scanning type is requested;

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

sl_zigbee_survey_beacons#

sl_status_t sl_zigbee_survey_beacons (bool useStandardBeacons, uint32_t channel_mask, sl_zigbee_network_found_callback_t networkFoundCallback, sl_zigbee_scan_complete_callback_t 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 sl_zigbee_start_scan() API.

NOTE: SoC only

sl_zigbee_find_unused_pan_id#

sl_status_t sl_zigbee_find_unused_pan_id (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 sl_zigbee_start_scan() API.

sl_zigbee_stop_scan#

sl_status_t sl_zigbee_stop_scan (void )

Terminate a scan in progress.

Returns

• Returns ::SL_STATUS_OK if successful.

sl_zigbee_scan_complete_handler#

void sl_zigbee_scan_complete_handler (uint8_t channel, sl_status_t status)

Indicate the status of the current scan. When the scan has completed, the stack will call this function with status set to ::SL_STATUS_OK. Prior to the scan completing, the stack may call this function with other status values. Non-SL_STATUS_OK 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 ::SL_STATUS_OK.

sl_zigbee_energy_scan_result_handler#

void sl_zigbee_energy_scan_result_handler (uint8_t channel, int8_t maxRssiValue)

Report the maximum RSSI value measured on the channel.

sl_zigbee_network_found_handler#

void sl_zigbee_network_found_handler (sl_zigbee_zigbee_network_t * 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.

sl_zigbee_unused_pan_id_found_handler#

void sl_zigbee_unused_pan_id_found_handler (sl_802154_pan_id_t panId, uint8_t channel)

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

sl_zigbee_orphan_notification_handler#

void sl_zigbee_orphan_notification_handler (sl_802154_long_addr_t longId)

Handle the orphan notification for a Zigbee network.

This function is called when an orphan notification is received for a Zigbee network. The function takes the long address of the orphaned device as a parameter.

sl_zigbee_is_performing_rejoin#

bool sl_zigbee_is_performing_rejoin (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.

sl_zigbee_get_last_leave_reason#

sl_zigbee_leave_reason_t sl_zigbee_get_last_leave_reason (sl_802154_short_addr_t * 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), SL_ZIGBEE_UNKNOWN_NODE_ID is returned.

Returns

• Returns sl_zigbee_leave_reason_t enumeration, or SL_ZIGBEE_LEAVE_REASON_NONE if the device has not left the network.

sl_zigbee_get_permit_joining#

bool sl_zigbee_get_permit_joining (void )

Indicate the state of the permit joining in the MAC.

Returns

• Returns true if permit, else returns false.

sl_zigbee_set_nwk_update_id#

sl_status_t sl_zigbee_set_nwk_update_id (uint8_t nwkUpdateId, bool set_when_on_network)

Set the Network Update ID to the desired value. If this function is called when the node is not part of a network, the desired Network Update ID is saved and will be aplied to the newly formed network when calling sl_zigbee_form_network. If this function is called in case the node is part of a network, the node's Network Update ID will only be updated in case set_even_if_on_network is set to TRUE.

Note

• When on a network, the Network Update ID should not normally be changed, as it is used by the stack to track changes in the network. Unless specifically required set_even_if_on_network should always be set to FALSE

Returns

• SL_STATUS_OK if update was successful, else SL_STATUS_INVALID_STATE.

sl_zigbee_set_beacon_jitter_duration#

sl_status_t sl_zigbee_set_beacon_jitter_duration (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

• SL_STATUS_INVALID_PARAMETER if the argument is invalid, else SL_STATUS_OK.

sl_zigbee_set_tc_rejoins_using_well_known_key_allowed#

sl_status_t sl_zigbee_set_tc_rejoins_using_well_known_key_allowed (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 sli_zigbee_allow_tc_rejoins_using_well_known_key_timeout_sec seconds.

Returns

• A valid error code.

sl_zigbee_set_tc_rejoins_using_well_known_key_timeout_sec#

sl_status_t sl_zigbee_set_tc_rejoins_using_well_known_key_timeout_sec (uint16_t timeout_sec)

Set the timeout in seconds 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 this timeout.

Returns

• A valid error code.

sl_zigbee_tc_rejoins_using_well_known_key_allowed#

bool sl_zigbee_tc_rejoins_using_well_known_key_allowed (void )

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

Returns

• Return true if allowed, else false.

sl_zigbee_setup_delayed_join#

sl_status_t sl_zigbee_setup_delayed_join (uint8_t networkKeyTimeoutS)

sl_zigbee_delayed_join_is_activated#

bool sl_zigbee_delayed_join_is_activated (void )

Return true if the TC is delaying in sending the network key to newly joining devices. The delay amount is configured via the Delayed Join component.

sl_zigbee_delayed_join_activate#

void sl_zigbee_delayed_join_activate (bool activated)

Set the activation state of Delayed Join. If Delayed Join is activated, the TC will delay in sending network key to newly joining devices.

sl_zigbee_get_network_key_timeout#

uint8_t sl_zigbee_get_network_key_timeout (void )

sl_zigbee_reschedule_link_status_msg#

sl_status_t sl_zigbee_reschedule_link_status_msg (void )

Reschedule sending link status message, first one being sent immediately.

Returns

• A valid error code.

sl_zigbee_set_pending_network_update_pan_id#

void sl_zigbee_set_pending_network_update_pan_id (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.

sl_zigbee_send_pan_id_update#

bool sl_zigbee_send_pan_id_update (sl_802154_pan_id_t newPan)

sl_zigbee_clear_stored_beacons#

sl_status_t sl_zigbee_clear_stored_beacons (void )

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

Returns

• An appropriate error code.

sl_zigbee_set_num_beacons_to_store#

sl_status_t sl_zigbee_set_num_beacons_to_store (uint8_t numBeacons)

sl_zigbee_get_stored_beacon#

sl_status_t sl_zigbee_get_stored_beacon (uint8_t beacon_number, sl_zigbee_beacon_data_t * beacon)

Fetches the specified beacon in the cache. User should first issue an active scan to populate the beacon cache, then users may call sl_zigbee_get_num_stored_beacons to identify how many beacons have been stored in cache. Following that, users may retrieve beacons based on the number of cached beacons.

Returns

• An appropriate sl_status_t status code.

sl_zigbee_get_num_stored_beacons#

uint8_t sl_zigbee_get_num_stored_beacons (void )

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

sl_zigbee_get_beacon_classification_params#

sl_status_t sl_zigbee_get_beacon_classification_params (sl_zigbee_beacon_classification_params_t * param)

Get current beacon classification parameter settings. The parameters related to beacon prioritization, could be all accessed with this function. The values returned in beaconClassificationMask must be decoded by using sl_zigbee_beacon_classification_flags_t.

Returns

• SL_STATUS_OK if successful, and error code otherwise.

sl_zigbee_set_beacon_classification_params#

sl_status_t sl_zigbee_set_beacon_classification_params (sl_zigbee_beacon_classification_params_t * param)

Set current beacon classification parameters. The parameters related to beacon prioritization, could be all set with this function. The values in beaconClassificationMask must be encoded by using sl_zigbee_beacon_classification_flags_t.

Returns

• SL_STATUS_OK if successful, and error code otherwise.