Stack Information#

sl_802154_set_tx_power_mode#

sl_status_t sl_802154_set_tx_power_mode (uint16_t txPowerMode)

Enable boost power mode and/or the alternate transmit path.

Boost power mode is a high-performance radio mode, which offers increased transmit power and receive sensitivity at the cost of an increase in power consumption. sl_zigbee_init() calls this function using the power mode and transmitter output settings as specified in the MFG_PHY_CONFIG token (with each bit inverted so that the default token value of 0xffff corresponds to normal power mode and bi-directional RF transmitter output). The application only needs to call sl_802154_set_tx_power_mode() to use a power mode or transmitter output setting different than specified in the MFG_PHY_CONFIG token. After the initial call to sl_802154_set_tx_power_mode(), the stack will automatically maintain the specified power mode configuration across sleep/wake cycles.

Returns

• ::SL_STATUS_OK if successful; an error code otherwise.

sl_802154_get_tx_power_mode#

uint16_t sl_802154_get_tx_power_mode (void )

Return the current configuration of boost power mode and alternate transmitter output.

Returns

• The current TX power mode.

sl_zigbee_set_node_id#

sl_status_t sl_zigbee_set_node_id (sl_802154_short_addr_t nodeId)

Set the short node ID of the node. Notice that it can only be set if the stack is in the INITAL state.

Returns

• ::SL_STATUS_OK if successful; an error code otherwise.

sl_zigbee_get_phy_interface_count#

uint8_t sl_zigbee_get_phy_interface_count (void )

Return the number of PHY interfaces present.

Returns

• The number of PHY interface(s).

sl_zigbee_radio_needs_calibrating_handler#

void sl_zigbee_radio_needs_calibrating_handler (void )

The radio calibration callback function.

The Voltage Controlled Oscillator (VCO) can drift with temperature changes. During every call to sl_zigbee_tick(), the stack will check to see if the VCO has drifted. If the VCO has drifted, the stack will call sl_zigbee_radio_needs_calibrating_handler() to inform the application that it should perform calibration of the current channel as soon as possible. Calibration can take up to 150 ms. The default callback function implementation provided here performs the calibration immediately. The application can define its own callback by defining ::EMBER_APPLICATION_HAS_CUSTOM_RADIO_CALIBRATION_CALLBACK in its CONFIGURATION_HEADER. It can then failsafe any critical processes or peripherals before calling ::sl_802154_calibrate_current_channel(). The application must call ::sl_802154_calibrate_current_channel() in response to this callback to maintain expected radio performance.

sl_mac_calibrate_current_channel#

void sl_mac_calibrate_current_channel (void )

Calibrate the current channel. The stack will notify the application of the need for channel calibration via the sl_zigbee_radio_needs_calibrating_handler() callback function during sl_zigbee_tick(). This function should only be called from within the context of the sl_zigbee_radio_needs_calibrating_handler() callback function. Calibration can take up to 150 ms. Note if this function is called when the radio is off, it will turn the radio on and leave it on.

sl_802154_radio_get_scheduler_priorities#

sl_status_t sl_802154_radio_get_scheduler_priorities (sl_zigbee_multiprotocol_priorities_t * priorities)

Get the current scheduler priorities used for Zigbee multiprotocol operations.

Returns

• ::SL_STATUS_OK if called in a multiprotocol app and ::SL_STATUS_INVALID_STATE otherwise.

For more details on what these priorities are and how to use them see UG305, the Dynamic Multiprotocol User Guide.

sl_802154_radio_set_scheduler_priorities#

sl_status_t sl_802154_radio_set_scheduler_priorities (const sl_zigbee_multiprotocol_priorities_t * priorities)

Set the current scheduler priorities used for Zigbee multiprotocol operations.

Returns

• ::SL_STATUS_OK if called in a multiprotocol app and ::SL_STATUS_INVALID_STATE otherwise.

For more details on what these priorities are and how to use them see UG305, the Dynamic Multiprotocol User Guide.

sl_802154_radio_set_scheduler_sliptime#

sl_status_t sl_802154_radio_set_scheduler_sliptime (uint32_t slipTime)

Set the multiprotocol slip time.

Returns

• ::SL_STATUS_OK if called in a multiprotocol app and ::SL_STATUS_INVALID_STATE otherwise.

Use this to update the slip time passed to the radio scheduler for each transmit from the PHY layer. The smaller this is set the lower the potential multi-protocol induced latency is, but it makes packets more likely to fail to be transmitted. For more details on slip time see UG305.

sl_802154_radio_get_scheduler_sliptime#

sl_status_t sl_802154_radio_get_scheduler_sliptime (uint32_t * slipTime)

Get the multiprotocol slip time.

Returns

• ::SL_STATUS_OK if called in a multiprotocol app and ::SL_STATUS_INVALID_STATE otherwise.

Use this to get the current value of the multiprotocol slip time used for each transmit at the PHY layer. For more details on slip time see UG305.

slx_zigbee_routing_set_route_record_policy#

sl_status_t slx_zigbee_routing_set_route_record_policy (sl_zigbee_route_record_policy_type_t policy)

Set the route record policy.

Returns

• ::SL_STATUS_OK if route record policy was successfully set ::SL_STATUS_INVALID_PARAMETER otherwise.

Use this to set the policy for sending a route record message to a concentrator Note that policies other than the default ROUTE_RECORD_POLICY_ACK_BY_SOURCE_ROUTED_MESSAGE may result in behavior not compliant with the Zigbee specification

slx_zigbee_routing_get_route_record_policy#

uint8_t slx_zigbee_routing_get_route_record_policy (void )

Get the route record policy.

Returns

• The route record policy

Use this to get the current value of the route record policy

sl_zigbee_get_token_count#

uint8_t sl_zigbee_get_token_count (void )

Get the total count of the tokens configured.

Returns

• The token count.

Use this to get the number of tokens configured in a node.

sl_zigbee_get_token_info#

sl_status_t sl_zigbee_get_token_info (uint8_t index, sl_zigbee_token_info_t * tokenInfo)

Get information of a token by providing the index.

Returns

• Status of the call, SL_STATUS_OK upon success or SL_STATUS_INVALID_INDEX for bad index.

sl_zigbee_get_token_data#

sl_status_t sl_zigbee_get_token_data (uint32_t token, uint32_t index, sl_zigbee_token_data_t * tokenData)

Get token data by providing the token key and index for the indexed token.

Returns

• Status of the call, SL_STATUS_OK upon success or SL_STATUS_FAIL for errors.

sl_zigbee_set_token_data#

sl_status_t sl_zigbee_set_token_data (uint32_t token, uint32_t index, sl_zigbee_token_data_t * tokenData)

Set token data by providing the token key, index for an indexed token and token data.

Returns

• Status of the call, SL_STATUS_OK upon success or SL_STATUS_FAIL for errors.

sl_zigbee_internal_update_multi_mac_rejoin_channel_mask_for_selection_or_joining_device_handler#

uint32_t sl_zigbee_internal_update_multi_mac_rejoin_channel_mask_for_selection_or_joining_device_handler (uint32_t rejoinChannelMask)

Callback to allow the user configuration of a Multi-MAC end device to update channel mask for the scenario where a rejoin is initiated due to end device timeout event. Based on the Multi-MAC end device configuration this call is expected to update the mask so that the rejoin interface will be selected. As per the SE 1.4 errata, the "Multi-MAC Selection" end device can change the rejoin interface where as the Multi-MAC Joining end devices shall not. This callback may be run in either the stack or application task context depending on where it was called from, so implementations of this should make only thread-safe calls.

Returns

• The 32-bit channel mask to be used based on user input.

sl_zigbee_token_factory_reset#

void sl_zigbee_token_factory_reset (bool exclude_outgoing_fc, bool exclude_boot_counter)

Factory reset all configured zigbee tokens.

sl_mac_set_cca_threshold#

void sl_mac_set_cca_threshold (int8_t threshold)

Set lower MAC CCA threshold.

sl_mac_get_ed_cca_threshold#

int8_t sl_mac_get_ed_cca_threshold (void )

Get lower MAC ED CCA threshold.

Returns

• ED CCA threshold

sl_mac_set_csma_params#

void sl_mac_set_csma_params (sl_mac_csma_parameters_t * csma_params)

Set lower MAC CSMA config.

sl_mac_get_csma_params#

void sl_mac_get_csma_params (sl_mac_csma_parameters_t * csma_params)

Get lower MAC CSMA param.

sl_zigbee_stack_profile_id#

const uint8_t sl_zigbee_stack_profile_id[]

The application must provide a definition for this variable.

endpoint#

uint8_t sl_zigbee_endpoint_t::endpoint

An endpoint of the application on this node.

description#

sl_zigbee_endpoint_description_t const* sl_zigbee_endpoint_t::description

The endpoint's description.

inputClusterList#

uint16_t const* sl_zigbee_endpoint_t::inputClusterList

Input clusters the endpoint will accept.

outputClusterList#

uint16_t const* sl_zigbee_endpoint_t::outputClusterList

Output clusters the endpoint may send.

sl_zigbee_endpoint_count#

uint8_t sl_zigbee_endpoint_count

The application must provide a definition for this variable.

sl_zigbee_endpoints#

sl_zigbee_endpoint_t sl_zigbee_endpoints[]

If sl_zigbee_endpoint_count is nonzero, the application must provide descriptions for each endpoint.

This can be done either by providing a definition of sl_zigbee_endpoints or by providing definitions of sl_zigbee_get_endpoint(), sl_zigbee_get_endpoint_description() and sl_zigbee_get_endpoint_cluster(). Using the array is often simpler, but consumes large amounts of memory if sl_zigbee_endpoint_count is large.

If the application provides definitions for the three functions, it must define SL_ZIGBEE_APPLICATION_HAS_GET_ENDPOINT in its CONFIGURATION_HEADER.

sl_zigbee_stack_status_handler#

void sl_zigbee_stack_status_handler (sl_status_t status)

A callback invoked when the status of the stack changes. If the status parameter equals ::SL_STATUS_NETWORK_UP, the sl_zigbee_get_network_parameters() function can be called to get the new network parameters. If any of the parameters are stored in nonvolatile memory by the application, the stored values should be updated.

The application is free to begin messaging after it receives the ::SL_STATUS_NETWORK_UP status. However, routes discovered immediately after the stack comes up may be suboptimal because the routes are based on the neighbor table's information about two-way links with neighboring nodes, which is obtained from periodic ZigBee Link Status messages. It can take two or three link status exchange periods (of 16 seconds each) before the neighbor table has a good estimate of link quality to neighboring nodes. Therefore, the application may improve the quality of initially discovered routes by waiting after startup to give the neighbor table time to be populated.

sl_zigbee_network_state#

sl_zigbee_network_status_t sl_zigbee_network_state (void )

Return the current join status.

Returns a value indicating whether the node is joining, joined to, or leaving a network.

Returns

• An sl_zigbee_network_status_t value indicating the current join status.

sl_zigbee_stack_is_up#

bool sl_zigbee_stack_is_up (void )

Indicate whether the stack is currently up.

Returns true if the stack is joined to a network and ready to send and receive messages. This reflects only the state of the local node; it does not indicate whether other nodes are able to communicate with this node.

Returns

• True if the stack is up, false otherwise.

sl_zigbee_write_node_data#

sl_status_t sl_zigbee_write_node_data (bool erase)

Write node data to the stack token.

Returns

• The status of the operation and an error code if unsuccessful.

sl_zigbee_ms_to_next_stack_event#

uint32_t sl_zigbee_ms_to_next_stack_event (void )

Check when the next stack event is scheduled to run.

Returns

• Returns the number of milliseconds before the next stack event is scheduled to run.

sl_zigbee_set_power_descriptor#

sl_status_t sl_zigbee_set_power_descriptor (uint16_t descriptor)

Set the power descriptor to the specified value. The power descriptor is a dynamic value, therefore this function should be called whenever the value changes.

sl_zigbee_get_manufacturer_code#

uint16_t sl_zigbee_get_manufacturer_code (void )

Gets the manufacturer code. The manufacturer code is one of the fields of the node descriptor.

Returns

• The manufacturer code for the local node.

sl_zigbee_is_local_eui64#

bool sl_zigbee_is_local_eui64 (sl_802154_long_addr_t eui64)

Determine whether eui64 is the local node's EUI64 ID.

Returns

• True if eui64 is the local node's ID, otherwise false.

sl_zigbee_set_node_descriptor#

sl_status_t sl_zigbee_set_node_descriptor (sl_zigbee_node_descriptor_info_t * descriptor)

Set the maximum incoming transfer size, maximum outgoing transfer size, and descriptor capability field of the node. All these being different fields of sl_zigbee_node_descriptor_info_t.

sl_zigbee_get_node_descriptor#

sl_status_t sl_zigbee_get_node_descriptor (sl_zigbee_node_descriptor_info_t * descriptor)

Get the maximum incoming transfer size, maximum outgoing transfer size, and descriptor capability field of the node. All these being different fields of sl_zigbee_node_descriptor_info_t.

Returns

• status of whether the pointers were set correctly.

sl_zigbee_get_eui64#

sl_802154_long_addr_t sl_zigbee_get_eui64 (void )

Return the EUI64 ID of the local node.

Returns

• The 64-bit ID.

sl_zigbee_get_node_id#

sl_802154_short_addr_t sl_zigbee_get_node_id (void )

Return the 16-bit node ID of local node on the current logical network.

Returns

• The 16-bit ID.

sl_zigbee_radio_get_node_id#

sl_802154_short_addr_t sl_zigbee_radio_get_node_id (void )

Return the 16-bit node ID of local node on the network it is currently tuned on.

Returns

• The 16-bit ID.

sl_zigbee_get_network_parameters#

sl_status_t sl_zigbee_get_network_parameters (sl_zigbee_node_type_t * node_type, sl_zigbee_network_parameters_t * parameters)

Copy the current network parameters into the structure provided by the caller.

Returns

• An ::sl_status_t value indicating the success or failure of the command.

sl_zigbee_get_radio_parameters#

sl_status_t sl_zigbee_get_radio_parameters (uint8_t phyIndex, sl_zigbee_multi_phy_radio_parameters_t * parameters)

Copy the current radio parameters into the structure provided by the caller.

Returns

• An ::sl_status_t value indicating the success or failure of the command.

sl_zigbee_set_radio_channel#

sl_status_t sl_zigbee_set_radio_channel (uint8_t channel)

Set the channel to use for sending and receiving messages on the current logical network. For a list of available radio channels, see the technical specification for the RF communication module in your Developer Kit.

Note: When using this API, all devices on a network must use the same channel.

Returns

• An ::sl_status_t value indicating the success or failure of the command.

sl_zigbee_set_logical_and_radio_channel#

sl_status_t sl_zigbee_set_logical_and_radio_channel (uint8_t channel)

Set the current logical and physical channel.

sl_zigbee_get_radio_channel#

uint8_t sl_zigbee_get_radio_channel (void )

Get the radio channel to which a node is set on the current logical network. The possible return values depend on the radio in use. For a list of available radio channels, see the technical specification for the RF communication module in your Developer Kit.

Returns

• The current radio channel.

sl_zigbee_set_radio_power#

sl_status_t sl_zigbee_set_radio_power (int8_t power)

Set the radio output power at which a node is to operate for the current logical network. Ember radios have discrete power settings. For a list of available power settings, see the technical specification for the RF communication module in your Developer Kit. Note that using this API on a running network will directly impact the established link qualities which the neighboring nodes have with the node on which it is called. This can lead to disruption of existing routes and erratic network behavior. Note that, if the requested power level is not available on a given radio, this function will use the next higher available power level.

Returns

• An ::sl_status_t value indicating the success or failure of the command. Failure indicates that the requested power level is out of range.

sl_zigbee_get_radio_power#

int8_t sl_zigbee_get_radio_power (void )

Get the radio output power of the current logical network at which a node is operating. Ember radios have discrete power settings. For a list of available power settings, see the technical specification for the RF communication module in your Developer Kit.

Returns

• The current radio output power, in dBm.

sl_zigbee_get_rail_handle#

void * sl_zigbee_get_rail_handle (void )

Return the RAIL level handle required to make RAIL API calls. Will return NULL if RAIL is not in use.

Returns

• A RAIL handle

sl_zigbee_get_pan_id#

sl_802154_pan_id_t sl_zigbee_get_pan_id (void )

Return the local node's PAN ID of the current logical network.

Returns

• A PAN ID.

sl_zigbee_set_radio_ieee802154_cca_mode#

sl_status_t sl_zigbee_set_radio_ieee802154_cca_mode (uint8_t ccaMode)

Set the configured 802.15.4 CCA mode in the radio. For a list of CCA modes, please refer to RAIL documentation regarding RAIL_IEEE802154_CcaMode_t.

Returns

• SL_STATUS_OK upon success, SL_STATUS_FAIL otherwise.

Note

• The default CCA mode for Zigbee is RAIL_IEEE802154_CCA_MODE_RSSI.

• As mentioned in the RAIL documentation, on platforms that don't support different CCA modes, a call to this function will do nothing.

sl_zigbee_get_extended_pan_id#

void sl_zigbee_get_extended_pan_id (uint8_t * resultLocation)

Fetch a node's 8 byte Extended PAN identifier. If this is called when a device is not currently on a network (see sl_zigbee_network_state), the Extended PAN ID returned will be an invalid value.

sl_zigbee_get_endpoint#

uint8_t sl_zigbee_get_endpoint (uint8_t index)

Retrieve the endpoint number for the index'th endpoint. index must be less than the value of sl_zigbee_endpoint_count.

This function is provided by the stack, using the data from sl_zigbee_endpoints, unless the application defines SL_ZIGBEE_APPLICATION_HAS_GET_ENDPOINT in its CONFIGURATION_HEADER.

Returns

• The endpoint number for the index'th endpoint.

sl_zigbee_get_endpoint_count#

uint8_t sl_zigbee_get_endpoint_count (void )

Retrieve the number of configured endpoints.

the value of sl_zigbee_endpoint_count.

This function return the number of configured endpoints on SoC, or the number of configured endpoints on Host + on NCP.

Returns

• The number of configured endpoint.

sl_zigbee_get_endpoint_description#

bool sl_zigbee_get_endpoint_description (uint8_t endpoint, sl_zigbee_endpoint_description_t * result)

Retrieve the endpoint description for the given endpoint.

This function is provided by the stack, using the data from sl_zigbee_endpoints, unless the application defines ::SL_ZIGBEE_APPLICATION_HAS_GET_ENDPOINT in its ::CONFIGURATION_HEADER.

Returns

• True if the description was copied to result, or false if the endpoint is not active.

sl_zigbee_get_endpoint_cluster#

uint16_t sl_zigbee_get_endpoint_cluster (uint8_t endpoint, sl_zigbee_cluster_list_id_t listId, uint8_t listIndex)

Retrieve a cluster ID from one of the cluster lists associated with the given endpoint.

This function is provided by the stack, using the data from sl_zigbee_endpoints, unless the application defines ::SL_ZIGBEE_APPLICATION_HAS_GET_ENDPOINT in its CONFIGURATION_HEADER.

Returns

• The cluster ID at position listIndex in the specified endpoint cluster list.

sl_zigbee_is_node_id_valid#

bool sl_zigbee_is_node_id_valid (sl_802154_short_addr_t nodeId)

Determine whether nodeId is valid.

Returns

• True if nodeId is valid, false otherwise.

sl_zigbee_lookup_node_id_by_eui64#

sl_status_t sl_zigbee_lookup_node_id_by_eui64 (sl_802154_long_addr_t eui64, sl_802154_short_addr_t * node_id)

Return the node ID that corresponds to the specified EUI64. The node ID is found by searching through all stack tables for the specified EUI64.

Returns

• An ::sl_status_t value:
  
  

  • ::SL_STATUS_OK - short ID Return has been set to the short ID of the node; An error code otherwise.

sl_zigbee_lookup_eui64_by_node_id#

sl_status_t sl_zigbee_lookup_eui64_by_node_id (sl_802154_short_addr_t nodeId, sl_802154_long_addr_t eui64Return)

Return the EUI64 that corresponds to the specified node ID. The EUI64 is found by searching through all stack tables for the specified node ID.

Returns

• An ::sl_status_t value:
  
  

  • ::SL_STATUS_OK - eui64Return has been set to the EUI64 of the node.

  • ::SL_STATUS_FAIL - The EUI64 of the node is not known.

sl_zigbee_read_and_clear_counters#

void sl_zigbee_read_and_clear_counters (uint16_t * counter_array, uint8_t len)

Read and clear Zigbee stack counters.

This function reads and clears the specified Zigbee stack counters. The counter values are stored in the provided counter_array, which should have a length of len. The maximum number of counters that can be read is defined by SL_ZIGBEE_COUNTER_TYPE_COUNT.

Note

• This function is used to retrieve the current values of Zigbee stack counters and clear them to zero.

sl_zigbee_read_counters#

void sl_zigbee_read_counters (uint16_t * counter_array, uint8_t len)

Retrieves Zigbee stack counters.

This function retrieves the values of the specified Zigbee stack counters. The counter values are stored in the provided counter_array, which should have a length of len. The maximum number of counters that can be read is defined by SL_ZIGBEE_COUNTER_TYPE_COUNT.

Note

• This function is used to retrieve the current values of Zigbee stack counters without clearing them.

Returns

• A list of all counter values ordered according to the sl_zigbee_counter_type_t enumeration.

sl_zigbee_clear_counters#

sl_status_t sl_zigbee_clear_counters (void )

Clear all Zigbee stack counters.

Returns

• Status code indicating the success or failure of the operation.

sl_zigbee_reset_counters_thresholds#

sl_status_t sl_zigbee_reset_counters_thresholds (void )

Reset all Zigbee stack counter thresholds to their default values.

Returns

• Status code indicating the success or failure of the operation.

sl_zigbee_set_counter_threshold#

sl_status_t sl_zigbee_set_counter_threshold (sl_zigbee_counter_type_t type, uint16_t threshold)

Set the threshold value for a specific Zigbee stack counter.

Returns

• Status code indicating the success or failure of the operation.

sl_zigbee_counter_requires_phy_index#

bool sl_zigbee_counter_requires_phy_index (sl_zigbee_counter_type_t type)

Checks if a specific Zigbee stack counter requires a PHY index.

Returns

• True if the counter requires a PHY index, false otherwise.

sl_zigbee_counter_requires_destination_node_id#

bool sl_zigbee_counter_requires_destination_node_id (sl_zigbee_counter_type_t type)

Check if a specific Zigbee stack counter requires a destination node ID.

Returns

• True if the counter requires a destination node ID, false otherwise.

sl_zigbee_stack_token_changed_handler#

void sl_zigbee_stack_token_changed_handler (uint16_t tokenAddress)

A callback invoked to inform the application that a stack token has changed.

sl_zigbee_rtos_stack_wakeup_isr_handler#

void sl_zigbee_rtos_stack_wakeup_isr_handler (void )

A callback to request the application to wake up the stack task.

sl_zigbee_get_neighbor#

sl_status_t sl_zigbee_get_neighbor (uint8_t index, sl_zigbee_neighbor_table_entry_t * result)

Copy a neighbor table entry to the structure that result points to. Neighbor table entries are stored in ascending order by node ID, with all unused entries at the end of the table. The number of active neighbors can be obtained using sl_zigbee_neighbor_count().

Returns

• ::SL_STATUS_FAIL if the index is greater or equal to the number of active neighbors, or if the device is an end device. Returns ::SL_STATUS_OK otherwise.

sl_zigbee_set_routing_shortcut_threshold#

sl_status_t sl_zigbee_set_routing_shortcut_threshold (uint8_t costThresh)

Set the routing shortcut threshold to directly use a neighbor instead of performing routing.

Returns

• ::return SL_STATUS_INVALID_PARAMETER if the costThresh is not 1, 3, 5, 7 Returns ::SL_STATUS_OK otherwise.

sl_zigbee_get_routing_shortcut_threshold#

uint8_t sl_zigbee_get_routing_shortcut_threshold (void )

Get the routing shortcut threshold used to separate between directly using a neighbor vs. performing routing.

Returns

• the routingShortcutThresh which takes one of the following values: 1, 3, 5, or 7.

sl_zigbee_set_initial_neighbor_outgoing_cost#

sl_status_t sl_zigbee_set_initial_neighbor_outgoing_cost (uint8_t cost)

Set neighbor's initial outgoing link cost.

Returns

• ::SL_STATUS_INVALID_PARAMETER if the cost is not any of 0, 1, 3, 5, or 7. Returns ::SL_STATUS_OK otherwise NOTE: There is no EZSP version of this function yet.

sl_zigbee_get_initial_neighbor_outgoing_cost#

uint8_t sl_zigbee_get_initial_neighbor_outgoing_cost (void )

Get neighbor's initial outgoing link cost.

Returns

• The default cost associated with new neighbor's outgoing links. NOTE: There is no EZSP version of this function yet.

sl_zigbee_reset_rejoining_neighbors_frame_counter#

void sl_zigbee_reset_rejoining_neighbors_frame_counter (bool reset)

Indicate whether a rejoining neighbor's incoming FC should be reset.

Returns

• ::void NOTE: There is no EZSP version of this function yet.

sl_zigbee_is_reset_rejoining_neighbors_frame_counter_enabled#

bool sl_zigbee_is_reset_rejoining_neighbors_frame_counter_enabled (void )

Check whether resetting the incoming FC for a rejoining neighbor is enabled.

Returns

• ::True or False. NOTE: There is no EZSP version of this function yet.

sl_zigbee_get_neighbor_frame_counter#

sl_status_t sl_zigbee_get_neighbor_frame_counter (sl_802154_long_addr_t nodeEui64, uint32_t * returnFrameCounter)

Get the last received frame counter as found in the Network Auxiliary header for the specified neighbor or child.

Returns

• sl_status_t depending on whether the frame counter is found in the neighbor or child table.

sl_zigbee_set_neighbor_frame_counter#

sl_status_t sl_zigbee_set_neighbor_frame_counter (sl_802154_long_addr_t nodeEui64, uint32_t frameCounter)

Set the frame counter for the specified neighbor or child.

Returns

• sl_status_t depending on whether the frame counter is set in the neighbor or child table.

sl_zigbee_get_route_table_entry#

sl_status_t sl_zigbee_get_route_table_entry (uint8_t index, sl_zigbee_route_table_entry_t * result)

Copy a route table entry to the structure that the result points to. Unused route table entries have a destination of 0xFFFF. The route table size can be obtained via sl_zigbee_get_route_table_size().

Returns

• ::SL_STATUS_FAIL if the index is out of range or the device is an end device, and ::SL_STATUS_OK otherwise.

sl_zigbee_stack_profile#

uint8_t sl_zigbee_stack_profile (void )

Return the stack profile of the network which the node has joined.

Returns

• The stack profile.

sl_zigbee_security_level#

uint8_t sl_zigbee_security_level (void )

Return the security level of the network which the node has joined.

Returns

• The security level.

sl_zigbee_get_stack_compliance_revision#

uint8_t sl_zigbee_get_stack_compliance_revision (void )

return the value of the stack compliance revision, as is reflected in the node descriptor

Returns

• integer value of the compliance revision

sl_zigbee_neighbor_count#

uint8_t sl_zigbee_neighbor_count (void )

Return the number of active entries in the neighbor table.

Returns

• The number of active entries in the neighbor table.

sl_zigbee_get_route_table_size#

uint8_t sl_zigbee_get_route_table_size (void )

Return the size of the route table.

Returns

• The size of the route table.

sl_zigbee_set_route_table_size#

void sl_zigbee_set_route_table_size (uint8_t size)

Sets the size of the route table.

sl_zigbee_get_source_route_table_size#

uint8_t sl_zigbee_get_source_route_table_size (void )

Return the size of the source route table.

Returns

• The size of the source route table.

sl_zigbee_set_source_route_table_size#

void sl_zigbee_set_source_route_table_size (uint8_t size)

Sets the size of the source route table.

sl_zigbee_set_stack_profile#

void sl_zigbee_set_stack_profile (uint8_t stackProfile)

Set the stack profile of the network.

sl_zigbee_set_security_level#

void sl_zigbee_set_security_level (uint8_t securityLevel)

Set the security level of the network.

sl_zigbee_next_zigbee_sequence_number#

uint8_t sl_zigbee_next_zigbee_sequence_number (void )

Increment and returns the Zigbee sequence number.

Returns

• The next Zigbee sequence number.

sl_zigbee_get_max_nwk_retries#

uint8_t sl_zigbee_get_max_nwk_retries (void )

Get maximum number of NWK retries.

Returns the maximum number of NWK retries that will be attempted

Returns

• uint8_t Max NWK retries

sl_zigbee_get_library_status#

enum sl_zigbee_library_status_t enum sl_zigbee_library_id_t sl_zigbee_library_status_t sl_zigbee_get_library_status (sl_zigbee_library_id_t libraryId)

This indicates the presence, absence, or status of an Ember stack library.

An enumerated list of library identifiers.

This routine takes a library identifier and returns whether the library is enabled or not. See ::sl_zigbee_library_status_t for return codes.

R21_COMPLIANCE_REVISION#

#define R21_COMPLIANCE_REVISION

21

named constants for supported stack revisions

R22_COMPLIANCE_REVISION#

#define R22_COMPLIANCE_REVISION

22

R23_COMPLIANCE_REVISION#

#define R23_COMPLIANCE_REVISION

23

PRE_R21_COMPLIANCE_REVISION#

#define PRE_R21_COMPLIANCE_REVISION

0

SL_ZIGBEE_MAJOR_VERSION#

#define SL_ZIGBEE_MAJOR_VERSION

8

SL_ZIGBEE_MINOR_VERSION#

#define SL_ZIGBEE_MINOR_VERSION

0

SL_ZIGBEE_PATCH_VERSION#

#define SL_ZIGBEE_PATCH_VERSION

2

SL_ZIGBEE_SPECIAL_VERSION#

#define SL_ZIGBEE_SPECIAL_VERSION

0

SL_ZIGBEE_BUILD_NUMBER#

#define SL_ZIGBEE_BUILD_NUMBER

0

SL_ZIGBEE_FULL_VERSION#

#define SL_ZIGBEE_FULL_VERSION

SL_ZIGBEE_VERSION_TYPE#

#define SL_ZIGBEE_VERSION_TYPE

SL_ZIGBEE_VERSION_TYPE_GA

SOFTWARE_VERSION#

#define SOFTWARE_VERSION

SL_ZIGBEE_FULL_VERSION

Software version. High byte = release number, low byte = patch number.