Type Definitions

TypeAliasDescription
booluint8_tBoolean type with values true and false.
sl_zigbee_ezsp_config_id_tuint8_tIdentifies a configuration value.
sl_zigbee_ezsp_value_id_tuint8_tIdentifies a value.
sl_zigbee_ezsp_extended_value_id_tuint8_tIdentifies a value based on specified characteristics. Each set of characteristics is unique to that value and is specified during the call to get the extended value.
sl_zigbee_ezsp_endpoint_flags_tuint16_tFlags associated with the endpoint data configured on the NCP.
EmberConfigTxPowerModeuint16_tValues for SL_ZIGBEE_EZSP_CONFIG_TX_POWER_MODE.
sl_zigbee_ezsp_policy_id_tuint8_tIdentifies a policy.
sl_zigbee_ezsp_decision_bitmask_tuint16_tThis is the policy decision bitmask that controls the trust center decision strategies. The bitmask is modified and extracted from the sl_zigbee_ezsp_decision_id_t for supporting bitmask operations.
sl_zigbee_ezsp_decision_id_tuint8_tIdentifies a policy decision.
sl_zigbee_ezsp_mfg_token_id_tuint8_tManufacturing token IDs used by sl_zigbee_ezsp_get_mfg_token().
sl_zigbee_ezsp_status_tuint8_tStatus values used by EZSP.
sl_zigbee_af_status_tuint8_tA ZCL status. See relevant header files for enumeration and possible values.
sl_zigbee_event_units_tuint8_tEither marks an event as inactive or specifies the units for the event execution time.
sl_zigbee_node_type_tuint8_tThe type of the node.
sl_zigbee_network_status_tuint8_tThe possible join states for a node.
sl_zigbee_incoming_message_type_tuint8_tIncoming message types.
sl_zigbee_outgoing_message_type_tuint8_tOutgoing message types.
sl_zigbee_mac_passthrough_type_tuint8_tMAC passthrough message type flags.
sl_zigbee_binding_type_tuint8_tBinding types.
sl_zigbee_aps_option_tuint16_tOptions to use when sending a message.
sl_zigbee_ezsp_network_scan_type_tuint8_tNetwork scan types.
sl_zigbee_join_decision_tuint8_tDecision made by the trust center when a node attempts to join.
sl_zigbee_leave_network_option_tuint8_tUse in case zigbee leave network with options
sl_zigbee_initial_security_bitmask_tuint16_tThis is the Initial Security Bitmask that controls the use of various security features.
sl_zigbee_current_security_bitmask_tuint16_tThis is the Current Security Bitmask that details the use of various security features.
sl_zigbee_key_type_tuint8_tDescribes the type of ZigBee security key.
sl_zigbee_key_struct_bitmask_tuint16_tDescribes the presence of valid data within the sl_zigbee_key_struct_t structure.
sl_zigbee_device_update_tuint8_tThe status of the device update.
sl_zigbee_key_status_tuint8_tThe status of the attempt to establish a key.
sl_zigbee_counter_type_tuint8_tDefines the events reported to the application by the readAndClearCounters command.
sl_zigbee_join_method_tuint8_tThe type of method used for joining.
sl_zigbee_zdo_configuration_flags_tuint8_tFlags for controlling which incoming ZDO requests are passed to the application. To see if the application is required to send a ZDO response to an incoming message, the application must check the APS options bitfield within the incomingMessageHandler callback to see if the SL_ZIGBEE_APS_OPTION_ZDO_RESPONSE_REQUIRED flag is set.
EmberConcentratorTypeuint16_tType of concentrator.
sl_zigbee_zll_state_tuint16_tZLL device state identifier
sl_zigbee_zll_key_index_tuint8_tZLL key encryption algorithm enumeration.
sl_zigbee_ezsp_zll_network_operation_tuint8_tDifferentiates among ZLL network operations.
sl_zigbee_network_init_bitmask_tuint16_tBitmask options for sli_zigbee_stack_network_init()
sl_zigbee_multi_phy_nwk_config_tuint8_tNetwork configuration for the desired radio interface for multi phy network.
sl_zigbee_duty_cycle_state_tuint8_tDuty cycle states.
sl_zigbee_radio_power_mode_tuint8_tRadio power modes.
sl_zigbee_entropy_source_tuint8_tEntropy sources.
sl_zigbee_sec_man_key_type_tuint8_tKey types recognized by Zigbee Security Manager.
sl_zigbee_sec_man_derived_key_type_tuint16_tDerived key types recognized by Zigbee Security Manager.
sl_zigbee_sec_man_flags_tuint8_tFlags for key operations.
sl_zigbee_leave_request_flags_tuint8_tFlags for NWK leave request command.
sl_802154_short_addr_tuint16_t16-bit ZigBee network address.
sl_status_tuint32_tSee sl_status.h for an enumerated list.
sl_zigbee_gp_status_tuint8_tSee enumeration in gp-types.h
sl_802154_pan_id_tuint16_t802.15.4 PAN ID.
sl_zigbee_multicast_id_tuint16_t16-bit ZigBee multicast group identifier.
sl_802154_long_addr_tuint8_t[8]EUI 64-bit ID (an IEEE address).
sl_zigbee_mac_interface_id_tuint8_tThe 8-bit identifier to uniquely identify the interface.
sl_zigbee_manufacturing_string_tuint8_t[16]A 16-byte array for the manufacturing string.
sl_zigbee_duty_cycle_hecto_pct_tuint16_tThe percent of duty cycle for a limit. Duty Cycle, Limits, and Thresholds are reported in units of Percent * 100 (i.e. 10000 = 100.00%, 1 = 0.01%).
sl_zigbee_library_id_tuint8_tA library identifier
sl_zigbee_mac_filter_match_data_tuint16_tThis is a bitmask describing a filter for MAC data messages that the stack should accept and pass through to the application.
sl_zigbee_library_status_tuint8_tThe presence and status of the Ember library.
sl_zigbee_gp_security_level_tuint8_tThe security level of the GPD.
sl_zigbee_gp_key_type_tuint8_tThe type of security key to use for the GPD.
sl_zigbee_gp_proxy_table_entry_status_tuint8_tThe proxy table entry status
sl_zigbee_gp_security_frame_counter_tuint32_tThe security frame counter
sl_zigbee_gp_sink_table_entry_status_tuint8_tThe sink table entry status

Structure Definitions

StructureFieldDescription
sl_zigbee_network_parameters_tNetwork parameters.
uint8_t[8] extendedPanIdThe network's extended PAN identifier.
uint16_t panIdThe network's PAN identifier.
int8_t radioTxPowerA power setting, in dBm.
uint8_t radioChannelA radio channel.
sl_zigbee_join_method_t joinMethodThe method used to initially join the network.
sl_802154_short_addr_t nwkManagerIdNWK Manager ID. The ID of the network manager in the current network. This may only be set at joining when using SL_ZIGBEE_USE_CONFIGURED_NWK_STATE as the join method.
uint8_t nwkUpdateIdNWK Update ID. The value of the ZigBee nwkUpdateId known by the stack. This is used to determine the newest instance of the network after a PAN ID or channel change. This may only be set at joining when using SL_ZIGBEE_USE_CONFIGURED_NWK_STATE as the join method.
uint32_t channelsNWK channel mask. The list of preferred channels that the NWK manager has told this device to use when searching for the network. This may only be set at joining when using SL_ZIGBEE_USE_CONFIGURED_NWK_STATE as the join method.
sl_zigbee_alt_mac_config_tDefines alternate MAC configuration parameters.
uint16_t scanDurationScan duration over alternate MAC.
MacTransmitCallback macTransmitTo register the transmit callback. Called when there is packet to transmit.
sl_zigbee_multi_phy_radio_parameters_tRadio parameters.
int8_t radioTxPowerA power setting, in dBm.
uint8_t radioPageA radio page.
uint8_t radioChannelA radio channel.
sl_zigbee_zigbee_network_tThe parameters of a ZigBee network.
uint8_t channelThe 802.15.4 channel associated with the network.
uint16_t panIdThe network's PAN identifier.
uint8_t[8] extendedPanIdThe network's extended PAN identifier.
bool allowingJoinWhether the network is allowing MAC associations.
uint8_t stackProfileThe Stack Profile associated with the network.
uint8_t nwkUpdateIdThe instance of the Network.
sl_zigbee_aps_frame_tZigBee APS frame parameters.
uint16_t profileIdThe application profile ID that describes the format of the message.
uint16_t clusterIdThe cluster ID for this message.
uint8_t sourceEndpointThe source endpoint.
uint8_t destinationEndpointThe destination endpoint.
sl_zigbee_aps_option_t optionsA bitmask of options.
uint16_t groupIdThe group ID for this message, if it is multicast mode.
uint8_t sequenceThe sequence number.
uint8_t radiusThe radius of the message. Note that in context of use of this in a send API, it gets updated internally based on message type and radius supplied in the API.
sl_zigbee_binding_table_entry_tAn entry in the binding table.
sl_zigbee_binding_type_t typeThe type of binding.
uint8_t localThe endpoint on the local node.
uint16_t clusterIdA cluster ID that matches one from the local endpoint's simple descriptor. This cluster ID is set by the provisioning application to indicate which part an endpoint's functionality is bound to this particular remote node and is used to distinguish between unicast and multicast bindings. Note that a binding can be used to send messages with any cluster ID, not just the one listed in the binding.
uint8_t remoteThe endpoint on the remote node (specified by identifier).
sl_802154_long_addr_t identifierA 64-bit identifier. This is either the destination EUI64 (for unicasts) or the 64-bit group address (for multicasts).
uint8_t networkIndexThe index of the network the binding belongs to.
sl_zigbee_multicast_table_entry_tA multicast table entry indicates that a particular endpoint is a member of a particular multicast group. Only devices with an endpoint in a multicast group will receive messages sent to that multicast group.
sl_zigbee_multicast_id_t multicastIdThe multicast group ID.
uint8_t endpointThe endpoint that is a member, or 0 if this entry is not in use (the ZDO is not a member of any multicast groups.)
uint8_t networkIndexThe network index of the network the entry is related to.
sl_zigbee_key_data_tA 128-bit key.
uint8_t[16] contentsThe key data.
sl_zigbee_certificate_data_tThe implicit certificate used in CBKE.
uint8_t[48] contentsThe certificate data.
sl_zigbee_public_key_data_tThe public key data used in CBKE.
uint8_t[22] contentsThe public key data.
sl_zigbee_private_key_data_tThe private key data used in CBKE.
uint8_t[21] contentsThe private key data.
sl_zigbee_smac_data_tThe Shared Message Authentication Code data used in CBKE.
uint8_t[16] contentsThe Shared Message Authentication Code data.
sl_zigbee_signature_data_tAn ECDSA signature
uint8_t[42] contentsThe signature data.
sl_zigbee_certificate_283k1_data_tThe implicit certificate used in CBKE.
uint8_t[74] contentsThe 283k1 certificate data.
sl_zigbee_public_key_283k1_data_tThe public key data used in CBKE.
uint8_t[37] contentsThe 283k1 public key data.
sl_zigbee_private_key_283k1_data_tThe private key data used in CBKE.
uint8_t[36] contentsThe 283k1 private key data.
sl_zigbee_signature_283k1_data_tAn ECDSA signature
uint8_t[72] contentsThe 283k1 signature data.
sl_zigbee_message_digest_tThe calculated digest of a message
uint8_t[16] contentsThe calculated digest of a message.
sl_zigbee_aes_mmo_hash_context_tThe hash context for an ongoing hash operation.
uint8_t[16] resultThe result of ongoing the hash operation.
uint32_t lengthThe total length of the data that has been hashed so far.
sl_zigbee_beacon_data_tBeacon data structure.
uint8_t channelThe channel of the received beacon.
uint8_t lqiThe LQI of the received beacon.
int8_t rssiThe RSSI of the received beacon.
uint8_t depthThe depth of the received beacon.
uint8_t nwkUpdateIdThe network update ID of the received beacon.
int8_t powerThe power level of the received beacon. This field is valid only if the beacon is an enhanced beacon.
int8_t parentPriorityThe TC connectivity and long uptime from capacity field.
sl_802154_pan_id_t panIdThe PAN ID of the received beacon.
uint8_t[8] extendedPanIdThe extended PAN ID of the received beacon.
sl_802154_short_addr_t senderThe sender of the received beacon.
bool enhancedWhether or not the beacon is enhanced.
bool permitJoinWhether the beacon is advertising permit join.
bool hasCapacityWhether the beacon is advertising capacity.
sl_zigbee_beacon_classification_params_tThe parameters related to beacon prioritization.
int8_t minRssiForReceivingPktsThe min rssi value for receiving packets that is used is some beacon prioritization algorithms.
uint16_t beaconClassificationMaskThe beacon classification mask that identifies which beacon prioritization algorithm to pick, and defines the relevant parameters.
sl_zigbee_neighbor_table_entry_tA neighbor table entry stores information about the reliability of RF links to and from neighboring nodes.
uint16_t shortIdThe neighbor's two byte network id
uint8_t averageLqiAn exponentially weighted moving average of the link quality values of incoming packets from this neighbor as reported by the PHY.
uint8_t inCostThe incoming cost for this neighbor, computed from the average LQI. Values range from 1 for a good link to 7 for a bad link.
uint8_t outCostThe outgoing cost for this neighbor, obtained from the most recently received neighbor exchange message from the neighbor. A value of zero means that a neighbor exchange message from the neighbor has not been received recently enough, or that our id was not present in the most recently received one.
uint8_t ageThe number of aging periods elapsed since a link status message was last received from this neighbor. The aging period is 16 seconds.
sl_802154_long_addr_t longIdThe 8 byte EUI64 of the neighbor.
sl_zigbee_route_table_entry_tA route table entry stores information about the next hop along the route to the destination.
uint16_t destinationThe short id of the destination. A value of 0xFFFF indicates the entry is unused.
uint16_t nextHopThe short id of the next hop to this destination.
uint8_t statusIndicates whether this entry is active (0), being discovered (1), unused (3), or validating (4).
uint8_t ageThe number of seconds since this route entry was last used to send a packet.
uint8_t concentratorTypeIndicates whether this destination is a High RAM Concentrator (2), a Low RAM Concentrator (1), or not a concentrator (0).
uint8_t routeRecordStateFor a High RAM Concentrator, indicates whether a route record is needed (2), has been sent (1), or is no long needed (0) because a source routed message from the concentrator has been received.
sl_zigbee_initial_security_state_tThe security data used to set the configuration for the stack, or the retrieved configuration currently in use.
sl_zigbee_initial_security_bitmask_t bitmaskA bitmask indicating the security state used to indicate what the security configuration will be when the device forms or joins the network.
sl_zigbee_key_data_t preconfiguredKeyThe pre-configured Key data that should be used when forming or joining the network. The security bitmask must be set with the SL_ZIGBEE_HAVE_PRECONFIGURED_KEY bit to indicate that the key contains valid data.
sl_zigbee_key_data_t networkKeyThe Network Key that should be used by the Trust Center when it forms the network, or the Network Key currently in use by a joined device. The security bitmask must be set with SL_ZIGBEE_HAVE_NETWORK_KEY to indicate that the key contains valid data.
uint8_t networkKeySequenceNumberThe sequence number associated with the network key. This is only valid if the SL_ZIGBEE_HAVE_NETWORK_KEY has been set in the security bitmask.
sl_802154_long_addr_t preconfiguredTrustCenterEui64This is the long address of the trust center on the network that will be joined. It is usually NOT set prior to joining the network and instead it is learned during the joining message exchange. This field is only examined if ::SL_ZIGBEE_HAVE_TRUST_CENTER_EUI64 is set in the sl_zigbee_initial_security_state_t::bitmask. Most devices should clear that bit and leave this field alone. This field must be set when using commissioning mode.
sl_zigbee_current_security_state_tThe security options and information currently used by the stack.
sl_zigbee_current_security_bitmask_t bitmaskA bitmask indicating the security options currently in use by a device joined in the network.
sl_802154_long_addr_t trustCenterLongAddressThe IEEE Address of the Trust Center device.
sl_zigbee_key_struct_tA structure containing a key and its associated data.
sl_zigbee_key_struct_bitmask_t bitmaskA bitmask indicating the presence of data within the various fields in the structure.
sl_zigbee_key_type_t typeThe type of the key.
sl_zigbee_key_data_t keyThe actual key data.
uint32_t outgoingFrameCounterThe outgoing frame counter associated with the key.
uint32_t incomingFrameCounterThe frame counter of the partner device associated with the key.
uint8_t sequenceNumberThe sequence number associated with the key.
sl_802154_long_addr_t partnerEUI64The IEEE address of the partner device also in possession of the key.
sl_zigbee_network_init_struct_tNetwork Initialization parameters.
sl_zigbee_network_init_bitmask_t bitmaskConfiguration options for network init.
sl_zigbee_zll_security_algorithm_data_tData associated with the ZLL security algorithm.
uint32_t transactionIdTransaction identifier.
uint32_t responseIdResponse identifier.
uint16_t bitmaskBitmask.
sl_zigbee_zll_network_tThe parameters of a ZLL network.
sl_zigbee_zigbee_network_t zigbeeNetworkThe parameters of a ZigBee network.
sl_zigbee_zll_security_algorithm_data_t securityAlgorithmData associated with the ZLL security algorithm.
sl_802154_long_addr_t eui64Associated EUI64.
sl_802154_short_addr_t nodeIdThe node id.
sl_zigbee_zll_state_t stateThe ZLL state.
sl_zigbee_node_type_t nodeTypeThe node type.
uint8_t numberSubDevicesThe number of sub devices.
uint8_t totalGroupIdentifiersThe total number of group identifiers.
uint8_t rssiCorrectionRSSI correction value.
sl_zigbee_zll_initial_security_state_tDescribes the initial security features and requirements that will be used when forming or joining ZLL networks.
uint32_t bitmaskUnused bitmask; reserved for future use.
sl_zigbee_zll_key_index_t keyIndexThe key encryption algorithm advertised by the application.
sl_zigbee_key_data_t encryptionKeyThe encryption key for use by algorithms that require it.
sl_zigbee_key_data_t preconfiguredKeyThe pre-configured link key used during classical ZigBee commissioning.
sl_zigbee_zll_device_info_record_tInformation about a specific ZLL Device.
sl_802154_long_addr_t ieeeAddressEUI64 associated with the device.
uint8_t endpointIdEndpoint id.
uint16_t profileIdProfile id.
uint16_t deviceIdDevice id.
uint8_t versionAssociated version.
uint8_t groupIdCountNumber of relevant group ids.
sl_zigbee_zll_address_assignment_tZLL address assignment data.
sl_802154_short_addr_t nodeIdRelevant node id.
sl_802154_short_addr_t freeNodeIdMinMinimum free node id.
sl_802154_short_addr_t freeNodeIdMaxMaximum free node id.
sl_zigbee_multicast_id_t groupIdMinMinimum group id.
sl_zigbee_multicast_id_t groupIdMaxMaximum group id.
sl_zigbee_multicast_id_t freeGroupIdMinMinimum free group id.
sl_zigbee_multicast_id_t freeGroupIdMaxMaximum free group id.
sl_zigbee_tok_type_stack_zll_data_tPublic API for ZLL stack data token.
uint32_t bitmaskToken bitmask.
uint16_t freeNodeIdMinMinimum free node id.
uint16_t freeNodeIdMaxMaximum free node id.
uint16_t myGroupIdMinLocal minimum group id.
uint16_t freeGroupIdMinMinimum free group id.
uint16_t freeGroupIdMaxMaximum free group id.
uint8_t rssiCorrectionRSSI correction value.
sl_zigbee_tok_type_stack_zll_security_tPublic API for ZLL stack security token.
uint32_t bitmaskToken bitmask.
uint8_t keyIndexKey index.
uint8_t[16] encryptionKeyEncryption key.
uint8_t[16] preconfiguredKeyPreconfigured key.
sl_zigbee_duty_cycle_limits_tA structure containing duty cycle limit configurations. All limits are absolute, and are required to be as follows: suspLimit > critThresh > limitThresh For example: suspLimit = 250 (2.5%), critThresh = 180 (1.8%), limitThresh 100 (1.00%).
sl_zigbee_duty_cycle_hecto_pct_t limitThreshThe Limited Threshold in % * 100
sl_zigbee_duty_cycle_hecto_pct_t critThreshThe Critical Threshold in % * 100.
sl_zigbee_duty_cycle_hecto_pct_t suspLimitThe Suspended Limit (LBT) in % * 100.
sl_zigbee_per_device_duty_cycle_tA structure containing per device overall duty cycle consumed (up to the suspend limit).
sl_802154_short_addr_t nodeIdNode Id of device whose duty cycle is reported.
sl_zigbee_duty_cycle_hecto_pct_t dutyCycleConsumedAmount of overall duty cycle consumed (up to suspend limit).
sl_zigbee_transient_key_data_tThe transient key data structure.
sl_802154_long_addr_t eui64The IEEE address paired with the transient link key.
sl_zigbee_key_data_t keyDataThe key data structure matching the transient key.
uint32_t incomingFrameCounterThe incoming frame counter associated with this key.
sl_zigbee_key_struct_bitmask_t bitmaskThis bitmask indicates whether various fields in the structure contain valid data.
uint16_t remainingTimeSecondsThe number of seconds remaining before the key is automatically timed out of the transient key table.
uint8_t networkIndexThe network index indicates which NWK uses this key.
sl_zigbee_child_data_tA structure containing a child node's data.
sl_802154_long_addr_t eui64The EUI64 of the child
sl_zigbee_node_type_t typeThe node type of the child
sl_802154_short_addr_t idThe short address of the child
uint8_t phyThe phy of the child
uint8_t powerThe power of the child
uint8_t timeoutThe timeout of the child
sl_zigbee_sec_man_key_tA 128-bit key.
uint8_t[16] keyThe key data.
sl_zigbee_sec_man_context_tContext for Zigbee Security Manager operations.
sl_zigbee_sec_man_key_type_t core_key_typeThe type of key being referenced.
uint8_t key_indexThe index of the referenced key.
sl_zigbee_sec_man_derived_key_type_t derived_typeThe type of key derivation operation to perform on a key.
sl_802154_long_addr_t eui64The EUI64 associated with this key.
uint8_t multi_network_indexMulti-network index.
sl_zigbee_sec_man_flags_t flagsFlag bitmask.
uint32_t psa_key_alg_permissionAlgorithm to use with this key (for PSA APIs)
sl_zigbee_sec_man_network_key_info_tMetadata for network keys.
bool network_key_setWhether the current network key is set.
bool alternate_network_key_setWhether the alternate network key is set.
uint8_t network_key_sequence_numberCurrent network key sequence number.
uint8_t alt_network_key_sequence_numberAlternate network key sequence number.
uint32_t network_key_frame_counterFrame counter for the network key.
sl_zigbee_sec_man_aps_key_metadata_tMetadata for APS link keys.
sl_zigbee_key_struct_bitmask_t bitmaskBitmask of key properties
uint32_t outgoing_frame_counterOutgoing frame counter.
uint32_t incoming_frame_counterIncoming frame counter.
uint16_t ttl_in_secondsRemaining lifetime (for transient keys).
sl_802154_radio_priorities_tScheduler priorities for radio operations
uint8_t background_rxThe priority of a Zigbee RX operation while not receiving a packet
uint8_t min_tx_priorityStarting priority of a Zigbee TX operation. The first transmit of the packet, before retries, uses this priority
uint8_t tx_stepThe increase in TX priority (which is a decrement in value) for each retry
uint8_t max_tx_priorityMaximum priority of a Zigbee TX operation. Retried messages have priorities bumped by tx_step, up to a maximum of max_tx_priority
uint8_t active_rxThe priority of a Zigbee RX operation while receiving a packet
sl_zigbee_endpoint_description_tDescription of a particular endpoint.
uint16_t profileIdThe endpoint's application profile.
uint16_t deviceIdThe endpoint's device ID within the application profile.
uint8_t deviceVersionThe endpoint's device version.
uint8_t inputClusterCountThe number of input clusters.
uint8_t outputClusterCountThe number of output clusters.
sl_zigbee_rx_packet_info_tIncoming message Information
uint16_t sender_short_idShort ID of the sender of the message.
sl_802154_long_addr_t sender_long_idEUI64 of the sender of the message if the sender chose to this information in the message. The ::SL_ZIGBEE_APS_OPTION_SOURCE_EUI64 bit in the options field of the APS frame of the incoming message indicates that the EUI64 is present in the message.
uint8_t binding_indexThe index of the entry in the binding table that matches the sender of the message or 0xFF if there is no matching entry.
uint8_t address_indexThe index of the entry in the address table that matches the sender of the message or 0xFF if there is no matching entry.
uint8_t lasy_hop_lqiLink quality of the node that last relayed the current message.
int8_t lasy_hop_rssiReceived signal strength indicator (RSSI) of the node that last relayed the message.
uint32_t lasy_hop_timestampTimestamp of the moment when Start Frame Delimiter (SFD) was received.
sl_zigbee_gp_address_tA GP address structure.
uint8_t[8] idContains either a 4-byte source ID or an 8-byte IEEE address, as indicated by the value of the applicationId field.
uint8_t applicationIdThe GPD Application ID specifying either source ID (0x00) or IEEE address (0x02).
uint8_t endpointThe GPD endpoint.
sl_zigbee_gp_sink_list_entry_tA sink list entry.
uint8_t typeThe sink list type.
sl_802154_long_addr_t sinkEUIThe EUI64 of the target sink.
sl_802154_short_addr_t sinkNodeIdThe short address of the target sink.
sl_zigbee_gp_params_tGP parameters list.
sl_zigbee_gp_status_t statusThe status of the GPDF receive.
uint8_t gpdLinkThe gpdLink value of the received GPDF.
uint8_t sequenceNumberThe GPDF sequence number.
sl_zigbee_gp_address_t addrThe address of the source GPD.
sl_zigbee_gp_security_level_t gpdfSecurityLevelThe security level of the received GPDF.
sl_zigbee_gp_key_type_t gpdfSecurityKeyTypeThe securityKeyType used to decrypt/authenticate the incoming GPDF.
bool autoCommissioningWhether the incoming GPDF had the auto-commissioning bit set.
uint8_t bidirectionalInfoBidirectional information represented in bitfields, where bit0 holds the rxAfterTx of incoming GPDF and bit1 holds if TX queue is available for outgoing GPDF.
uint32_t gpdSecurityFrameCounterThe security frame counter of the incoming GPDF.
uint8_t gpdCommandIdThe gpdCommandId of the incoming GPDF.
uint32_t micThe received MIC of the GPDF.
uint8_t proxyTableIndexThe proxy table index of the corresponding proxy table entry to the incoming GPDF.
uint8_t gpdCommandPayloadLengthThe length of the GPD command payload.
uint8_t gpdCommandPayload[SL_ZIGBEE_GP_MAX_APPLICATION_PAYLOAD]The GPD command payload.
sl_zigbee_rx_packet_info_t packetInfoRx packet information.
sl_zigbee_gp_proxy_table_entry_tThe internal representation of a proxy table entry.
sl_zigbee_gp_proxy_table_entry_status_t statusInternal status of the proxy table entry.
uint32_t optionsThe tunneling options (this contains both options and extendedOptions from the spec).
sl_zigbee_gp_address_t gpdThe addressing info of the GPD.
sl_802154_short_addr_t assignedAliasThe assigned alias for the GPD.
uint8_t securityOptionsThe security options field.
sl_zigbee_gp_security_frame_counter_t gpdSecurityFrameCounterThe security frame counter of the GPD.
sl_zigbee_key_data_t gpdKeyThe key to use for GPD.
sl_zigbee_gp_sink_list_entry_t sinkList[GP_SINK_LIST_ENTRIES]The list of sinks (hardcoded to 2 which is the spec minimum).
uint8_t groupcastRadiusThe groupcast radius.
uint8_t searchCounterThe search counter.
sl_zigbee_gp_sink_table_entry_tThe internal representation of a sink table entry.
sl_zigbee_gp_sink_table_entry_status_t statusInternal status of the sink table entry.
uint32_t optionsThe tunneling options (this contains both options and extendedOptions from the spec).
sl_zigbee_gp_address_t gpdThe addressing info of the GPD.
uint8_t deviceIdThe device id for the GPD.
sl_zigbee_gp_sink_list_entry_t sinkList[GP_SINK_LIST_ENTRIES]The list of sinks (hardcoded to 2 which is the spec minimum).
sl_802154_short_addr_t assignedAliasThe assigned alias for the GPD.
uint8_t groupcastRadiusThe groupcast radius.
uint8_t securityOptionsThe security options field.
sl_zigbee_gp_security_frame_counter_t gpdSecurityFrameCounterThe security frame counter of the GPD.
sl_zigbee_key_data_t gpdKeyThe key to use for GPD.
sl_zigbee_token_info_tInformation of a token in the token table.
uint32_t nvm3KeyNVM3 key of the token
bool isCntToken is a counter type
bool isIdxToken is an indexed token
uint8_t sizeSize of the token
uint8_t arraySizeArray size of the token
sl_zigbee_token_data_tToken Data
uint32_t sizeToken data size in bytes
uint8_t[64] dataToken data pointer

Named Values

bool
false0x00An alias for zero, used for clarity.
true0x01An alias for one, used for clarity.

sl_zigbee_ezsp_config_id_t
SL_ZIGBEE_EZSP_CONFIG_PACKET_BUFFER_HEAP_SIZE0x01The NCP no longer supports configuration of packet buffer heap at runtime using this parameter. Packet buffer heap space must be configured using the SL_ZIGBEE_PACKET_BUFFER_HEAP_SIZE macro when building the NCP project.
SL_ZIGBEE_EZSP_CONFIG_NEIGHBOR_TABLE_SIZE0x02The maximum number of router neighbors the stack can keep track of. A neighbor is a node within radio range.
SL_ZIGBEE_EZSP_CONFIG_APS_UNICAST_MESSAGE_COUNT0x03The maximum number of APS retried messages the stack can be transmitting at any time.
SL_ZIGBEE_EZSP_CONFIG_BINDING_TABLE_SIZE0x04The maximum number of non-volatile bindings supported by the stack.
SL_ZIGBEE_EZSP_CONFIG_ADDRESS_TABLE_SIZE0x05The maximum number of EUI64 to network address associations that the stack can maintain for the application. (Note, the total number of such address associations maintained by the NCP is the sum of the value of this setting and the value of ::SL_ZIGBEE_EZSP_CONFIG_TRUST_CENTER_ADDRESS_CACHE_SIZE.
SL_ZIGBEE_EZSP_CONFIG_MULTICAST_TABLE_SIZE0x06The maximum number of multicast groups that the device may be a member of.
SL_ZIGBEE_EZSP_CONFIG_ROUTE_TABLE_SIZE0x07The maximum number of destinations to which a node can route messages. This includes both messages originating at this node and those relayed for others.
SL_ZIGBEE_EZSP_CONFIG_DISCOVERY_TABLE_SIZE0x08The number of simultaneous route discoveries that a node will support.
SL_ZIGBEE_EZSP_CONFIG_STACK_PROFILE0x0CSpecifies the stack profile.
SL_ZIGBEE_EZSP_CONFIG_SECURITY_LEVEL0x0DThe security level used for security at the MAC and network layers. The supported values are 0 (no security) and 5 (payload is encrypted and a four-byte MIC is used for authentication).
SL_ZIGBEE_EZSP_CONFIG_MAX_HOPS0x10The maximum number of hops for a message.
SL_ZIGBEE_EZSP_CONFIG_MAX_END_DEVICE_CHILDREN0x11The maximum number of end device children that a router will support.
SL_ZIGBEE_EZSP_CONFIG_INDIRECT_TRANSMISSION_TIMEOUT0x12The maximum amount of time that the MAC will hold a message for indirect transmission to a child.
SL_ZIGBEE_EZSP_CONFIG_END_DEVICE_POLL_TIMEOUT0x13The maximum amount of time that an end device child can wait between polls. If no poll is heard within this timeout, then the parent removes the end device from its tables. Value range 0-14. The timeout corresponding to a value of zero is 10 seconds. The timeout corresponding to a nonzero value N is 2^N minutes, ranging from 2^1 = 2 minutes to 2^14 = 16384 minutes.
SL_ZIGBEE_EZSP_CONFIG_TX_POWER_MODE0x17Enables boost power mode and/or the alternate transmitter output.
SL_ZIGBEE_EZSP_CONFIG_DISABLE_RELAY0x180: Allow this node to relay messages. 1: Prevent this node from relaying messages.
SL_ZIGBEE_EZSP_CONFIG_TRUST_CENTER_ADDRESS_CACHE_SIZE0x19The maximum number of EUI64 to network address associations that the Trust Center can maintain. These address cache entries are reserved for and reused by the Trust Center when processing device join/rejoin authentications. This cache size limits the number of overlapping joins the Trust Center can process within a narrow time window (e.g. two seconds), and thus should be set to the maximum number of near simultaneous joins the Trust Center is expected to accommodate. (Note, the total number of such address associations maintained by the NCP is the sum of the value of this setting and the value of ::SL_ZIGBEE_EZSP_CONFIG_ADDRESS_TABLE_SIZE.)
SL_ZIGBEE_EZSP_CONFIG_SOURCE_ROUTE_TABLE_SIZE0x1AThe size of the source route table.
SL_ZIGBEE_EZSP_CONFIG_FRAGMENT_WINDOW_SIZE0x1CThe number of blocks of a fragmented message that can be sent in a single window.
SL_ZIGBEE_EZSP_CONFIG_FRAGMENT_DELAY_MS0x1DThe time the stack will wait (in milliseconds) between sending blocks of a fragmented message.
SL_ZIGBEE_EZSP_CONFIG_KEY_TABLE_SIZE0x1EThe size of the Key Table used for storing individual link keys (if the device is a Trust Center) or Application Link Keys (if the device is a normal node).
SL_ZIGBEE_EZSP_CONFIG_APS_ACK_TIMEOUT0x1FThe APS ACK timeout value. The stack waits this amount of time between resends of APS retried messages.
SL_ZIGBEE_EZSP_CONFIG_BEACON_JITTER_DURATION0x20The duration of a beacon jitter, in the units used by the 15.4 scan parameter (((1 << duration) + 1) * 15ms), when responding to a beacon request.
SL_ZIGBEE_EZSP_CONFIG_PAN_ID_CONFLICT_REPORT_THRESHOLD0x22The number of PAN id conflict reports that must be received by the network manager within one minute to trigger a PAN id change.
SL_ZIGBEE_EZSP_CONFIG_REQUEST_KEY_TIMEOUT0x24The timeout value in minutes for how long the Trust Center or a normal node waits for the ZigBee Request Key to complete. On the Trust Center this controls whether or not the device buffers the request, waiting for a matching pair of ZigBee Request Key. If the value is non-zero, the Trust Center buffers and waits for that amount of time. If the value is zero, the Trust Center does not buffer the request and immediately responds to the request. Zero is the most compliant behavior.
SL_ZIGBEE_EZSP_CONFIG_CERTIFICATE_TABLE_SIZE0x29This value indicates the size of the runtime modifiable certificate table. Normally certificates are stored in MFG tokens but this table can be used to field upgrade devices with new Smart Energy certificates. This value cannot be set, it can only be queried.
SL_ZIGBEE_EZSP_CONFIG_APPLICATION_ZDO_FLAGS0x2AThis is a bitmask that controls which incoming ZDO request messages are passed to the application. The bits are defined in the sl_zigbee_zdo_configuration_flags_t enumeration. To see if the application is required to send a ZDO response in reply to an incoming message, the application must check the APS options bitfield within the incomingMessageHandler callback to see if the SL_ZIGBEE_APS_OPTION_ZDO_RESPONSE_REQUIRED flag is set.
SL_ZIGBEE_EZSP_CONFIG_BROADCAST_TABLE_SIZE0x2BThe maximum number of broadcasts during a single broadcast timeout period.
SL_ZIGBEE_EZSP_CONFIG_MAC_FILTER_TABLE_SIZE0x2CThe size of the MAC filter list table.
SL_ZIGBEE_EZSP_CONFIG_SUPPORTED_NETWORKS0x2DThe number of supported networks.
SL_ZIGBEE_EZSP_CONFIG_SEND_MULTICASTS_TO_SLEEPY_ADDRESS0x2EWhether multicasts are sent to the RxOnWhenIdle=true address (0xFFFD) or the sleepy broadcast address (0xFFFF). The RxOnWhenIdle=true address is the ZigBee compliant destination for multicasts.
SL_ZIGBEE_EZSP_CONFIG_ZLL_GROUP_ADDRESSES0x2FZLL group address initial configuration.
SL_ZIGBEE_EZSP_CONFIG_ZLL_RSSI_THRESHOLD0x30ZLL rssi threshold initial configuration.
SL_ZIGBEE_EZSP_CONFIG_MTORR_FLOW_CONTROL0x33Toggles the MTORR flow control in the stack.
SL_ZIGBEE_EZSP_CONFIG_RETRY_QUEUE_SIZE0x34Setting the retry queue size. Applies to all queues. Default value in the sample applications is 16.
SL_ZIGBEE_EZSP_CONFIG_NEW_BROADCAST_ENTRY_THRESHOLD0x35Setting the new broadcast entry threshold. The number (BROADCAST_TABLE_SIZE - NEW_BROADCAST_ENTRY_THRESHOLD) of broadcast table entries are reserved for relaying the broadcast messages originated on other devices. The local device will fail to originate a broadcast message after this threshold is reached. Setting this value to BROADCAST_TABLE_SIZE and greater will effectively kill this limitation.
SL_ZIGBEE_EZSP_CONFIG_TRANSIENT_KEY_TIMEOUT_S0x36 The length of time, in seconds, that a trust center will store a transient link key that a device can use to join its network. A transient key is added with a call to emberAddTransientLinkKey. After the transient key is added, it will be removed once this amount of time has passed. A joining device will not be able to use that key to join until it is added again on the trust center. The default value is 300 seconds, i.e., 5 minutes.
SL_ZIGBEE_EZSP_CONFIG_BROADCAST_MIN_ACKS_NEEDED0x37The number of passive acknowledgements to record from neighbors before we stop re-transmitting broadcasts
SL_ZIGBEE_EZSP_CONFIG_TC_REJOINS_USING_WELL_KNOWN_KEY_TIMEOUT_S0x38The length of time, in seconds, that a trust center will allow a Trust Center (insecure) rejoin for a device that is using the well-known link key. This timeout takes effect once rejoins using the well-known key has been allowed. This command updates the sli_zigbee_allow_tc_rejoins_using_well_known_key_timeout_sec value.
SL_ZIGBEE_EZSP_CONFIG_CTUNE_VALUE0x39Valid range of a CTUNE value is 0x0000-0x01FF. Higher order bits (0xFE00) of the 16-bit value are ignored. Note setting this parameter using ezsp API for setting configuration value invokes internal manufacturer library function call, mfglibInternalSetCtune, unlike a zigbee stack call, and hence the return value of the ezsp set API should be interpreted of type sl_status_t type.
SL_ZIGBEE_EZSP_CONFIG_ASSUME_TC_CONCENTRATOR_TYPE0x40To configure non trust center node to assume a concentrator type of the trust center it join to, until it receive many-to-one route request from the trust center. For the trust center node, concentrator type is configured from the concentrator plugin. The stack by default assumes trust center be a low RAM concentrator that make other devices send route record to the trust center even without receiving a many-to-one route request. The default concentrator type can be changed by setting appropriate sl_zigbee_assume_trust_center_concentrator_type_t config value.
SL_ZIGBEE_EZSP_CONFIG_GP_PROXY_TABLE_SIZE0x41This is green power proxy table size. This value is read-only and cannot be set at runtime
SL_ZIGBEE_EZSP_CONFIG_GP_SINK_TABLE_SIZE0x42This is green power sink table size. This value is read-only and cannot be set at runtime
SL_ZIGBEE_EZSP_CONFIG_END_DEVICE_CONFIGURATION0x43This is The configuration advertised by the end device to the parent when joining/rejoining, either SL_ZIGBEE_END_DEVICE_CONFIG_NONE or SL_ZIGBEE_END_DEVICE_CONFIG_PERSIST_DATA_ON_PARENT.

sl_zigbee_ezsp_value_id_t
SL_ZIGBEE_EZSP_VALUE_TOKEN_STACK_NODE_DATA0x00The contents of the node data stack token.
SL_ZIGBEE_EZSP_VALUE_MAC_PASSTHROUGH_FLAGS0x01The types of MAC passthrough messages that the host wishes to receive.
SL_ZIGBEE_EZSP_VALUE_EMBERNET_PASSTHROUGH_SOURCE_ADDRESS0x02The source address used to filter legacy EmberNet messages when the SL_802154_PASSTHROUGH_EMBERNET_SOURCE flag is set in SL_ZIGBEE_EZSP_VALUE_MAC_PASSTHROUGH_FLAGS.
SL_ZIGBEE_EZSP_VALUE_BUFFER_HEAP_FREE_SIZE0x03The amount in bytes (max 2^16) of available general purpose heap memory
SL_ZIGBEE_EZSP_VALUE_UART_SYNCH_CALLBACKS0x04Selects sending synchronous callbacks in ezsp-uart.
SL_ZIGBEE_EZSP_VALUE_MAXIMUM_INCOMING_TRANSFER_SIZE0x05The maximum incoming transfer size for the local node. Default value is set to 82 and does not use fragmentation. Sets the value in Node Descriptor. To set, this takes the input of a uint8 array of length 2 where you pass the lower byte at index 0 and upper byte at index 1.
SL_ZIGBEE_EZSP_VALUE_MAXIMUM_OUTGOING_TRANSFER_SIZE0x06The maximum outgoing transfer size for the local node. Default value is set to 82 and does not use fragmentation. Sets the value in Node Descriptor. To set, this takes the input of a uint8 array of length 2 where you pass the lower byte at index 0 and upper byte at index 1.
SL_ZIGBEE_EZSP_VALUE_STACK_TOKEN_WRITING0x07A bool indicating whether stack tokens are written to persistent storage as they change.
SL_ZIGBEE_EZSP_VALUE_STACK_IS_PERFORMING_REJOIN0x08A read-only value indicating whether the stack is currently performing a rejoin.
SL_ZIGBEE_EZSP_VALUE_MAC_FILTER_LIST0x09A list of sl_zigbee_mac_filter_match_data_t values.
SL_ZIGBEE_EZSP_VALUE_EXTENDED_SECURITY_BITMASK0x0AThe Ember Extended Security Bitmask.
SL_ZIGBEE_EZSP_VALUE_NODE_SHORT_ID0x0BThe node short ID.
SL_ZIGBEE_EZSP_VALUE_DESCRIPTOR_CAPABILITY0x0CThe descriptor capability of the local node. Write only.
SL_ZIGBEE_EZSP_VALUE_STACK_DEVICE_REQUEST_SEQUENCE_NUMBER0x0DThe stack device request sequence number of the local node.
SL_ZIGBEE_EZSP_VALUE_RADIO_HOLD_OFF0x0EEnable or disable radio hold-off.
SL_ZIGBEE_EZSP_VALUE_ENDPOINT_FLAGS0x0FThe flags field associated with the endpoint data.
SL_ZIGBEE_EZSP_VALUE_MFG_SECURITY_CONFIG0x10Enable/disable the Mfg security config key settings.
SL_ZIGBEE_EZSP_VALUE_VERSION_INFO0x11Retrieves the version information from the stack on the NCP.
SL_ZIGBEE_EZSP_VALUE_LAST_REJOIN_REASON0x13This is the reason that the last rejoin took place. This value may only be retrieved, not set. The rejoin may have been initiated by the stack (NCP) or the application (host). If a host initiated a rejoin the reason will be set by default to SL_ZIGBEE_REJOIN_DUE_TO_APP_EVENT_1. If the application wishes to denote its own rejoin reasons it can do so by calling sl_zigbee_ezsp_set_value(EMBER_VALUE_HOST_REJOIN_REASON, SL_ZIGBEE_REJOIN_DUE_TO_APP_EVENT_X). X is a number corresponding to one of the app events defined. If the NCP initiated a rejoin it will record this value internally for retrieval by sl_zigbee_ezsp_get_value(EZSP_VALUE_REAL_REJOIN_REASON).
SL_ZIGBEE_EZSP_VALUE_NEXT_ZIGBEE_SEQUENCE_NUMBER0x14The next ZigBee sequence number.
SL_ZIGBEE_EZSP_VALUE_CCA_THRESHOLD0x15CCA energy detect threshold for radio.
SL_ZIGBEE_EZSP_VALUE_SET_COUNTER_THRESHOLD0x17The threshold value for a counter
SL_ZIGBEE_EZSP_VALUE_RESET_COUNTER_THRESHOLDS0x18Resets all counters thresholds to 0xFF
SL_ZIGBEE_EZSP_VALUE_CLEAR_COUNTERS0x19Clears all the counters
SL_ZIGBEE_EZSP_VALUE_CERTIFICATE_283K10x1AThe node's new certificate signed by the CA.
SL_ZIGBEE_EZSP_VALUE_PUBLIC_KEY_283K10x1BThe Certificate Authority's public key.
SL_ZIGBEE_EZSP_VALUE_PRIVATE_KEY_283K10x1CThe node's new static private key.
SL_ZIGBEE_EZSP_VALUE_NWK_FRAME_COUNTER0x23The NWK layer security frame counter value
SL_ZIGBEE_EZSP_VALUE_APS_FRAME_COUNTER0x24The APS layer security frame counter value. Managed by the stack. Users should not set these unless doing backup and restore.
SL_ZIGBEE_EZSP_VALUE_RETRY_DEVICE_TYPE0x25Sets the device type to use on the next rejoin using device type
SL_ZIGBEE_EZSP_VALUE_ENABLE_R21_BEHAVIOR0x29Setting this byte enables R21 behavior on the NCP.
SL_ZIGBEE_EZSP_VALUE_ANTENNA_MODE0x30Configure the antenna mode(0-don't switch,1-primary,2-secondary,3-TX antenna diversity).
SL_ZIGBEE_EZSP_VALUE_ENABLE_PTA0x31Enable or disable packet traffic arbitration.
SL_ZIGBEE_EZSP_VALUE_PTA_OPTIONS0x32Set packet traffic arbitration configuration options.
SL_ZIGBEE_EZSP_VALUE_MFGLIB_OPTIONS0x33Configure manufacturing library options (0-non-CSMA transmits,1-CSMA transmits). To be used with Manufacturing Library.
SL_ZIGBEE_EZSP_VALUE_USE_NEGOTIATED_POWER_BY_LPD0x34Sets the flag to use either negotiated power by link power delta (LPD) or fixed power value provided by user while forming/joining a network for packet transmissions on sub-ghz interface. This is mainly for testing purposes.
SL_ZIGBEE_EZSP_VALUE_PTA_PWM_OPTIONS0x35Set packet traffic arbitration PWM options.
SL_ZIGBEE_EZSP_VALUE_PTA_DIRECTIONAL_PRIORITY_PULSE_WIDTH0x36Set packet traffic arbitration directional priority pulse width in microseconds.
SL_ZIGBEE_EZSP_VALUE_PTA_PHY_SELECT_TIMEOUT0x37Set packet traffic arbitration phy select timeout(ms).
SL_ZIGBEE_EZSP_VALUE_ANTENNA_RX_MODE0x38Configure the RX antenna mode: (0-do not switch; 1-primary; 2-secondary; 3-RX antenna diversity).
SL_ZIGBEE_EZSP_VALUE_NWK_KEY_TIMEOUT0x39Configure the timeout to wait for the network key before failing a join. Acceptable timeout range [3,255]. Value is in seconds.
SL_ZIGBEE_EZSP_VALUE_FORCE_TX_AFTER_FAILED_CCA_ATTEMPTS0x3AThe number of failed CSMA attempts due to failed CCA made by the MAC before continuing transmission with CCA disabled. This is the same as calling the sli_zigbee_stack_force_tx_after_failed_cca(uint8_t csmaAttempts) API. A value of 0 disables the feature.
SL_ZIGBEE_EZSP_VALUE_TRANSIENT_KEY_TIMEOUT_S0x3BThe length of time, in seconds, that a trust center will store a transient link key that a device can use to join its network. A transient key is added with a call to sli_zigbee_stack_sec_man_import_transient_key. After the transient key is added, it will be removed once this amount of time has passed. A joining device will not be able to use that key to join until it is added again on the trust center. The default value is 300 seconds (5 minutes).
SL_ZIGBEE_EZSP_VALUE_COULOMB_COUNTER_USAGE0x3CCumulative energy usage metric since the last value reset of the coulomb counter plugin. Setting this value will reset the coulomb counter.
SL_ZIGBEE_EZSP_VALUE_MAX_BEACONS_TO_STORE0x3DWhen scanning, configure the maximum number of beacons to store in cache. Each beacon consumes on average 32-bytes (+ buffer overhead) in RAM.
SL_ZIGBEE_EZSP_VALUE_END_DEVICE_TIMEOUT_OPTIONS_MASK0x3ESet the mask to filter out unacceptable child timeout options on a router.
SL_ZIGBEE_EZSP_VALUE_END_DEVICE_KEEP_ALIVE_SUPPORT_MODE0x3FThe end device keep-alive mode supported by the parent.
SL_ZIGBEE_EZSP_VALUE_ACTIVE_RADIO_CONFIG0x41Return the active radio config. Read only. Values are 0: Default, 1: Antenna Diversity, 2: Co-Existence, 3: Antenna Diversity and Co-Existence.
SL_ZIGBEE_EZSP_VALUE_NWK_OPEN_DURATION0x42Return the number of seconds the network will remain open. A return value of 0 indicates that the network is closed. Read only.
SL_ZIGBEE_EZSP_VALUE_TRANSIENT_DEVICE_TIMEOUT0x43Timeout in milliseconds to store entries in the transient device table. If the devices are not authenticated before the timeout, the entry shall be purged
SL_ZIGBEE_EZSP_VALUE_KEY_STORAGE_VERSION0x44Return information about the key storage on an NCP. Returns 0 if keys are in classic key storage, and 1 if they are located in PSA key storage. Read only.
SL_ZIGBEE_EZSP_VALUE_DELAYED_JOIN_ACTIVATION0x45Return activation state about TC Delayed Join on an NCP. A return value of 0 indicates that the feature is not activated.
SL_ZIGBEE_EZSP_VALUE_MAX_NWK_RETRIES0x46The maximum number of NWK retries that will be attempted.
SL_ZIGBEE_EZSP_VALUE_REJOIN_MODE0x47Policies for allowing/disallowing rejoins.
SL_ZIGBEE_EZSP_VALUE_JOIN_USE_INSTALL_CODE_ENABLE0x48Controls whether devices must use an install code when joining.

sl_zigbee_ezsp_extended_value_id_t
SL_ZIGBEE_EZSP_EXTENDED_VALUE_ENDPOINT_FLAGS0x00The flags field associated with the specified endpoint.
SL_ZIGBEE_EZSP_EXTENDED_VALUE_LAST_LEAVE_REASON0x01This is the reason for the node to leave the network as well as the device that told it to leave. The leave reason is the 1st byte of the value while the node ID is the 2nd and 3rd byte. If the leave was caused due to an API call rather than an over the air message, the node ID will be SL_ZIGBEE_UNKNOWN_NODE_ID (0xFFFD).
SL_ZIGBEE_EZSP_EXTENDED_VALUE_GET_SOURCE_ROUTE_OVERHEAD0x02This number of bytes of overhead required in the network frame for source routing to a particular destination.
SL_ZIGBEE_EZSP_EXTENDED_VALUE_MEMORY_USAGE_DATA0x03These values are current or boot-time metrics gathered by the memory manager/buffer manager.

sl_zigbee_ezsp_endpoint_flags_t
SL_ZIGBEE_EZSP_ENDPOINT_DISABLED0x00Indicates that the endpoint is disabled and NOT discoverable via ZDO.
SL_ZIGBEE_EZSP_ENDPOINT_ENABLED0x01Indicates that the endpoint is enabled and discoverable via ZDO.

EmberConfigTxPowerMode
SL_ZIGBEE_TX_POWER_MODE_DEFAULT0x00Normal power mode and bi-directional RF transmitter output.
SL_ZIGBEE_TX_POWER_MODE_BOOST0x01Enable boost power mode. This is a high-performance radio mode which offers increased receive sensitivity and transmit power at the cost of an increase in power consumption.
SL_ZIGBEE_TX_POWER_MODE_ALTERNATE0x02Enable the alternate transmitter output. This allows for simplified connection to an external power amplifier via the RF_TX_ALT_P and RF_TX_ALT_N pins.
SL_ZIGBEE_TX_POWER_MODE_BOOST_AND_ALTERNATE0x03Enable both boost mode and the alternate transmitter output.

sl_zigbee_ezsp_policy_id_t
SL_ZIGBEE_EZSP_TRUST_CENTER_POLICY0x00Controls trust center behavior.
SL_ZIGBEE_EZSP_BINDING_MODIFICATION_POLICY0x01Controls how external binding modification requests are handled.
SL_ZIGBEE_EZSP_UNICAST_REPLIES_POLICY0x02Controls whether the Host supplies unicast replies.
SL_ZIGBEE_EZSP_POLL_HANDLER_POLICY0x03Controls whether pollHandler callbacks are generated.
SL_ZIGBEE_EZSP_MESSAGE_CONTENTS_IN_CALLBACK_POLICY0x04Controls whether the message contents are included in the messageSentHandler callback.
SL_ZIGBEE_EZSP_TC_KEY_REQUEST_POLICY0x05Controls whether the Trust Center will respond to Trust Center link key requests.
SL_ZIGBEE_EZSP_APP_KEY_REQUEST_POLICY0x06Controls whether the Trust Center will respond to application link key requests.
SL_ZIGBEE_EZSP_PACKET_VALIDATE_LIBRARY_POLICY0x07Controls whether ZigBee packets that appear invalid are automatically dropped by the stack. A counter will be incremented when this occurs.
SL_ZIGBEE_EZSP_ZLL_POLICY0x08Controls whether the stack will process ZLL messages.
SL_ZIGBEE_EZSP_TC_REJOINS_USING_WELL_KNOWN_KEY_POLICY0x09Controls whether Trust Center (insecure) rejoins for devices using the well-known link key are accepted. 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.

sl_zigbee_ezsp_decision_bitmask_t
SL_ZIGBEE_EZSP_DECISION_BITMASK_DEFAULT_CONFIGURATION0x0000Disallow joins and rejoins.
SL_ZIGBEE_EZSP_DECISION_ALLOW_JOINS0x0001Send the network key to all joining devices.
SL_ZIGBEE_EZSP_DECISION_ALLOW_UNSECURED_REJOINS0x0002Send the network key to all rejoining devices.
SL_ZIGBEE_EZSP_DECISION_SEND_KEY_IN_CLEAR0x0004Send the network key in the clear.
SL_ZIGBEE_EZSP_DECISION_IGNORE_UNSECURED_REJOINS0x0008Do nothing for unsecured rejoins.
SL_ZIGBEE_EZSP_DECISION_JOINS_USE_INSTALL_CODE_KEY0x0010Allow joins if there is an entry in the transient key table.
SL_ZIGBEE_EZSP_DECISION_DEFER_JOINS0x0020Delay sending the network key to a new joining device.

sl_zigbee_ezsp_decision_id_t
SL_ZIGBEE_EZSP_DISALLOW_BINDING_MODIFICATION0x10SL_ZIGBEE_EZSP_BINDING_MODIFICATION_POLICY default decision. Do not allow the local binding table to be changed by remote nodes.
SL_ZIGBEE_EZSP_ALLOW_BINDING_MODIFICATION0x11SL_ZIGBEE_EZSP_BINDING_MODIFICATION_POLICY decision. Allow remote nodes to change the local binding table.
SL_ZIGBEE_EZSP_CHECK_BINDING_MODIFICATIONS_ARE_VALID_ENDPOINT_CLUSTERS0x12SL_ZIGBEE_EZSP_BINDING_MODIFICATION_POLICY decision. Allows remote nodes to set local binding entries only if the entries correspond to endpoints defined on the device, and for output clusters bound to those endpoints.
SL_ZIGBEE_EZSP_HOST_WILL_NOT_SUPPLY_REPLY0x20SL_ZIGBEE_EZSP_UNICAST_REPLIES_POLICY default decision. The NCP will automatically send an empty reply (containing no payload) for every unicast received.
SL_ZIGBEE_EZSP_HOST_WILL_SUPPLY_REPLY0x21SL_ZIGBEE_EZSP_UNICAST_REPLIES_POLICY decision. The NCP will only send a reply if it receives a sendReply command from the Host.
SL_ZIGBEE_EZSP_POLL_HANDLER_IGNORE0x30SL_ZIGBEE_EZSP_POLL_HANDLER_POLICY default decision. Do not inform the Host when a child polls.
SL_ZIGBEE_EZSP_POLL_HANDLER_CALLBACK0x31SL_ZIGBEE_EZSP_POLL_HANDLER_POLICY decision. Generate a pollHandler callback when a child polls.
SL_ZIGBEE_EZSP_MESSAGE_TAG_ONLY_IN_CALLBACK0x40SL_ZIGBEE_EZSP_MESSAGE_CONTENTS_IN_CALLBACK_POLICY default decision. Include only the message tag in the messageSentHandler callback.
SL_ZIGBEE_EZSP_MESSAGE_TAG_AND_CONTENTS_IN_CALLBACK0x41SL_ZIGBEE_EZSP_MESSAGE_CONTENTS_IN_CALLBACK_POLICY decision. Include both the message tag and the message contents in the messageSentHandler callback.
SL_ZIGBEE_EZSP_DENY_TC_KEY_REQUESTS0x50SL_ZIGBEE_EZSP_TC_KEY_REQUEST_POLICY decision. When the Trust Center receives a request for a Trust Center link key, it will be ignored.
SL_ZIGBEE_EZSP_ALLOW_TC_KEY_REQUESTS_AND_SEND_CURRENT_KEY0x51SL_ZIGBEE_EZSP_TC_KEY_REQUEST_POLICY decision. When the Trust Center receives a request for a Trust Center link key, it will reply to it with the corresponding key.
SL_ZIGBEE_EZSP_ALLOW_TC_KEY_REQUEST_AND_GENERATE_NEW_KEY0x52SL_ZIGBEE_EZSP_TC_KEY_REQUEST_POLICY decision. When the Trust Center receives a request for a Trust Center link key, it will generate a key to send to the joiner. After generation, the key will be added to the transient key tabe and After verification, this key will be added into the link key table
SL_ZIGBEE_EZSP_DENY_APP_KEY_REQUESTS0x60SL_ZIGBEE_EZSP_APP_KEY_REQUEST_POLICY decision. When the Trust Center receives a request for an application link key, it will be ignored.
SL_ZIGBEE_EZSP_ALLOW_APP_KEY_REQUESTS0x61SL_ZIGBEE_EZSP_APP_KEY_REQUEST_POLICY decision. When the Trust Center receives a request for an application link key, it will randomly generate a key and send it to both partners.
SL_ZIGBEE_EZSP_PACKET_VALIDATE_LIBRARY_CHECKS_ENABLED0x62Indicates that packet validate library checks are enabled on the NCP.
SL_ZIGBEE_EZSP_PACKET_VALIDATE_LIBRARY_CHECKS_DISABLED0x63Indicates that packet validate library checks are NOT enabled on the NCP.

sl_zigbee_ezsp_mfg_token_id_t
SL_ZIGBEE_EZSP_MFG_CUSTOM_VERSION0x00Custom version (2 bytes).
SL_ZIGBEE_EZSP_MFG_STRING0x01Manufacturing string (16 bytes).
SL_ZIGBEE_EZSP_MFG_BOARD_NAME0x02Board name (16 bytes).
SL_ZIGBEE_EZSP_MFG_MANUF_ID0x03Manufacturing ID (2 bytes).
SL_ZIGBEE_EZSP_MFG_PHY_CONFIG0x04Radio configuration (2 bytes).
SL_ZIGBEE_EZSP_MFG_BOOTLOAD_AES_KEY0x05Bootload AES key (16 bytes).
SL_ZIGBEE_EZSP_MFG_ASH_CONFIG0x06ASH configuration (40 bytes).
SL_ZIGBEE_EZSP_MFG_SL_ZIGBEE_EZSP_STORAGE0x07EZSP storage (8 bytes).
SL_ZIGBEE_EZSP_STACK_CAL_DATA0x08Radio calibration data (64 bytes). 4 bytes are stored for each of the 16 channels. This token is not stored in the Flash Information Area. It is updated by the stack each time a calibration is performed.
SL_ZIGBEE_EZSP_MFG_CBKE_DATA0x09Certificate Based Key Exchange (CBKE) data (92 bytes).
SL_ZIGBEE_EZSP_MFG_INSTALLATION_CODE0x0AInstallation code (20 bytes).
SL_ZIGBEE_EZSP_STACK_CAL_FILTER0x0BRadio channel filter calibration data (1 byte). This token is not stored in the Flash Information Area. It is updated by the stack each time a calibration is performed.
SL_ZIGBEE_EZSP_MFG_CUSTOM_EUI_640x0CCustom EUI64 MAC address (8 bytes).
SL_ZIGBEE_EZSP_MFG_CTUNE0x0DCTUNE value (2 byte).

sl_zigbee_ezsp_status_t
SL_ZIGBEE_EZSP_SUCCESS0x00Success.
SL_ZIGBEE_EZSP_SPI_ERR_FATAL0x10Fatal error.
SL_ZIGBEE_EZSP_SPI_ERR_NCP_RESET0x11The Response frame of the current transaction indicates the NCP has reset.
SL_ZIGBEE_EZSP_SPI_ERR_OVERSIZED_SL_ZIGBEE_EZSP_FRAME0x12The NCP is reporting that the Command frame of the current transaction is oversized (the length byte is too large).
SL_ZIGBEE_EZSP_SPI_ERR_ABORTED_TRANSACTION0x13The Response frame of the current transaction indicates the previous transaction was aborted (nSSEL deasserted too soon).
SL_ZIGBEE_EZSP_SPI_ERR_MISSING_FRAME_TERMINATOR0x14The Response frame of the current transaction indicates the frame terminator is missing from the Command frame.
SL_ZIGBEE_EZSP_SPI_ERR_WAIT_SECTION_TIMEOUT0x15The NCP has not provided a Response within the time limit defined by WAIT_SECTION_TIMEOUT.
SL_ZIGBEE_EZSP_SPI_ERR_NO_FRAME_TERMINATOR0x16The Response frame from the NCP is missing the frame terminator.
SL_ZIGBEE_EZSP_SPI_ERR_SL_ZIGBEE_EZSP_COMMAND_OVERSIZED0x17The Host attempted to send an oversized Command (the length byte is too large) and the AVR's spi-protocol.c blocked the transmission.
SL_ZIGBEE_EZSP_SPI_ERR_SL_ZIGBEE_EZSP_RESPONSE_OVERSIZED0x18The NCP attempted to send an oversized Response (the length byte is too large) and the AVR's spi-protocol.c blocked the reception.
SL_ZIGBEE_EZSP_SPI_WAITING_FOR_RESPONSE0x19The Host has sent the Command and is still waiting for the NCP to send a Response.
SL_ZIGBEE_EZSP_SPI_ERR_HANDSHAKE_TIMEOUT0x1AThe NCP has not asserted nHOST_INT within the time limit defined by WAKE_HANDSHAKE_TIMEOUT.
SL_ZIGBEE_EZSP_SPI_ERR_STARTUP_TIMEOUT0x1BThe NCP has not asserted nHOST_INT after an NCP reset within the time limit defined by STARTUP_TIMEOUT.
SL_ZIGBEE_EZSP_SPI_ERR_STARTUP_FAIL0x1CThe Host attempted to verify the SPI Protocol activity and version number, and the verification failed.
SL_ZIGBEE_EZSP_SPI_ERR_UNSUPPORTED_SPI_COMMAND0x1DThe Host has sent a command with a SPI Byte that is unsupported by the current mode the NCP is operating in.
SL_ZIGBEE_EZSP_ASH_IN_PROGRESS0x20Operation not yet complete.
SL_ZIGBEE_EZSP_HOST_FATAL_ERROR0x21Fatal error detected by host.
SL_ZIGBEE_EZSP_ASH_NCP_FATAL_ERROR0x22Fatal error detected by NCP.
SL_ZIGBEE_EZSP_DATA_FRAME_TOO_LONG0x23Tried to send DATA frame too long.
SL_ZIGBEE_EZSP_DATA_FRAME_TOO_SHORT0x24Tried to send DATA frame too short.
SL_ZIGBEE_EZSP_NO_TX_SPACE0x25No space for tx'ed DATA frame.
SL_ZIGBEE_EZSP_NO_RX_SPACE0x26No space for rec'd DATA frame.
SL_ZIGBEE_EZSP_NO_RX_DATA0x27No receive data available.
SL_ZIGBEE_EZSP_NOT_CONNECTED0x28Not in Connected state.
SL_ZIGBEE_EZSP_ERROR_VERSION_NOT_SET0x30The NCP received a command before the EZSP version had been set.
SL_ZIGBEE_EZSP_ERROR_INVALID_FRAME_ID0x31The NCP received a command containing an unsupported frame ID.
SL_ZIGBEE_EZSP_ERROR_WRONG_DIRECTION0x32The direction flag in the frame control field was incorrect.
SL_ZIGBEE_EZSP_ERROR_TRUNCATED0x33The truncated flag in the frame control field was set, indicating there was not enough memory available to complete the response or that the response would have exceeded the maximum EZSP frame length.
SL_ZIGBEE_EZSP_ERROR_OVERFLOW0x34The overflow flag in the frame control field was set, indicating one or more callbacks occurred since the previous response and there was not enough memory available to report them to the Host.
SL_ZIGBEE_EZSP_ERROR_OUT_OF_MEMORY0x35Insufficient memory was available.
SL_ZIGBEE_EZSP_ERROR_INVALID_VALUE0x36The value was out of bounds.
SL_ZIGBEE_EZSP_ERROR_INVALID_ID0x37The configuration id was not recognized.
SL_ZIGBEE_EZSP_ERROR_INVALID_CALL0x38Configuration values can no longer be modified.
SL_ZIGBEE_EZSP_ERROR_NO_RESPONSE0x39The NCP failed to respond to a command.
SL_ZIGBEE_EZSP_ERROR_COMMAND_TOO_LONG0x40The length of the command exceeded the maximum EZSP frame length.
SL_ZIGBEE_EZSP_ERROR_QUEUE_FULL0x41The UART receive queue was full causing a callback response to be dropped.
SL_ZIGBEE_EZSP_ERROR_COMMAND_FILTERED0x42The command has been filtered out by NCP.
SL_ZIGBEE_EZSP_ERROR_SECURITY_KEY_ALREADY_SET0x43EZSP Security Key is already set
SL_ZIGBEE_EZSP_ERROR_SECURITY_TYPE_INVALID0x44EZSP Security Type is invalid
SL_ZIGBEE_EZSP_ERROR_SECURITY_PARAMETERS_INVALID0x45EZSP Security Parameters are invalid
SL_ZIGBEE_EZSP_ERROR_SECURITY_PARAMETERS_ALREADY_SET0x46EZSP Security Parameters are already set
SL_ZIGBEE_EZSP_ERROR_SECURITY_KEY_NOT_SET0x47EZSP Security Key is not set
SL_ZIGBEE_EZSP_ERROR_SECURITY_PARAMETERS_NOT_SET0x48EZSP Security Parameters are not set
SL_ZIGBEE_EZSP_ERROR_UNSUPPORTED_CONTROL0x49Received frame with unsupported control byte
SL_ZIGBEE_EZSP_ERROR_UNSECURE_FRAME0x4AReceived frame is unsecure, when security is established
SL_ZIGBEE_EZSP_ASH_ERROR_VERSION0x50Incompatible ASH version
SL_ZIGBEE_EZSP_ASH_ERROR_TIMEOUTS0x51Exceeded max ACK timeouts
SL_ZIGBEE_EZSP_ASH_ERROR_RESET_FAIL0x52Timed out waiting for RSTACK
SL_ZIGBEE_EZSP_ASH_ERROR_NCP_RESET0x53Unexpected ncp reset
SL_ZIGBEE_EZSP_ERROR_SERIAL_INIT0x54Serial port initialization failed
SL_ZIGBEE_EZSP_ASH_ERROR_NCP_TYPE0x55Invalid ncp processor type
SL_ZIGBEE_EZSP_ASH_ERROR_RESET_METHOD0x56Invalid ncp reset method
SL_ZIGBEE_EZSP_ASH_ERROR_XON_XOFF0x57XON/XOFF not supported by host driver
SL_ZIGBEE_EZSP_ASH_STARTED0x70ASH protocol started
SL_ZIGBEE_EZSP_ASH_CONNECTED0x71ASH protocol connected
SL_ZIGBEE_EZSP_ASH_DISCONNECTED0x72ASH protocol disconnected
SL_ZIGBEE_EZSP_ASH_ACK_TIMEOUT0x73Timer expired waiting for ack
SL_ZIGBEE_EZSP_ASH_CANCELLED0x74Frame in progress cancelled
SL_ZIGBEE_EZSP_ASH_OUT_OF_SEQUENCE0x75Received frame out of sequence
SL_ZIGBEE_EZSP_ASH_BAD_CRC0x76Received frame with CRC error
SL_ZIGBEE_EZSP_ASH_COMM_ERROR0x77Received frame with comm error
SL_ZIGBEE_EZSP_ASH_BAD_ACKNUM0x78Received frame with bad ackNum
SL_ZIGBEE_EZSP_ASH_TOO_SHORT0x79Received frame shorter than minimum
SL_ZIGBEE_EZSP_ASH_TOO_LONG0x7AReceived frame longer than maximum
SL_ZIGBEE_EZSP_ASH_BAD_CONTROL0x7BReceived frame with illegal control byte
SL_ZIGBEE_EZSP_ASH_BAD_LENGTH0x7CReceived frame with illegal length for its type
SL_ZIGBEE_EZSP_ASH_ACK_RECEIVED0x7DReceived ASH Ack
SL_ZIGBEE_EZSP_ASH_ACK_SENT0x7ESent ASH Ack
SL_ZIGBEE_EZSP_ASH_NAK_RECEIVED0x7FReceived ASH Nak
SL_ZIGBEE_EZSP_ASH_NAK_SENT0x80Sent ASH Nak
SL_ZIGBEE_EZSP_ASH_RST_RECEIVED0x81Received ASH RST
SL_ZIGBEE_EZSP_ASH_RST_SENT0x82Sent ASH RST
SL_ZIGBEE_EZSP_ASH_STATUS0x83ASH Status
SL_ZIGBEE_EZSP_ASH_TX0x84ASH TX
SL_ZIGBEE_EZSP_ASH_RX0x85ASH RX
SL_ZIGBEE_EZSP_CPC_ERROR_INIT0x86Failed to connect to CPC daemon or failed to open CPC endpoint
SL_ZIGBEE_EZSP_NO_ERROR0xFFNo reset or error

sl_zigbee_af_status_t

sl_zigbee_event_units_t
SL_ZIGBEE_EVENT_INACTIVE0x00The event is not scheduled to run.
SL_ZIGBEE_EVENT_MS_TIME0x01The execution time is in approximate milliseconds.
SL_ZIGBEE_EVENT_QS_TIME0x02The execution time is in 'binary' quarter seconds (256 approximate milliseconds each).
SL_ZIGBEE_EVENT_MINUTE_TIME0x03The execution time is in 'binary' minutes (65536 approximate milliseconds each).

sl_zigbee_node_type_t
SL_ZIGBEE_UNKNOWN_DEVICE0x00Device is not joined.
SL_ZIGBEE_DEVICE_TYPE_UNCHANGED0x00Device type has not changed since last join.
SL_ZIGBEE_COORDINATOR0x01Will relay messages and can act as a parent to other nodes.
SL_ZIGBEE_ROUTER0x02Will relay messages and can act as a parent to other nodes.
SL_ZIGBEE_END_DEVICE0x03Communicates only with its parent and will not relay messages.
SL_ZIGBEE_SLEEPY_END_DEVICE0x04An end device whose radio can be turned off to save power. The application must poll to receive messages.

sl_zigbee_network_status_t
SL_ZIGBEE_NO_NETWORK0x00The node is not associated with a network in any way.
SL_ZIGBEE_JOINING_NETWORK0x01The node is currently attempting to join a network.
SL_ZIGBEE_JOINED_NETWORK0x02The node is joined to a network.
SL_ZIGBEE_JOINED_NETWORK_NO_PARENT0x03The node is an end device joined to a network but its parent is not responding.
SL_ZIGBEE_LEAVING_NETWORK0x04The node is in the process of leaving its current network.

sl_zigbee_incoming_message_type_t
SL_ZIGBEE_INCOMING_UNICAST0x00Unicast.
SL_ZIGBEE_INCOMING_UNICAST_REPLY0x01Unicast reply.
SL_ZIGBEE_INCOMING_MULTICAST0x02Multicast.
SL_ZIGBEE_INCOMING_MULTICAST_LOOPBACK0x03Multicast sent by the local device.
SL_ZIGBEE_INCOMING_BROADCAST0x04Broadcast.
SL_ZIGBEE_INCOMING_BROADCAST_LOOPBACK0x05Broadcast sent by the local device.
EMBER_INCOMING_MANY_TO_ONE_ROUTE_REQUEST0x06Many to one route request.

sl_zigbee_outgoing_message_type_t
SL_ZIGBEE_OUTGOING_DIRECT0x00Unicast sent directly to an sl_802154_short_addr_t.
SL_ZIGBEE_OUTGOING_VIA_ADDRESS_TABLE0x01Unicast sent using an entry in the address table.
SL_ZIGBEE_OUTGOING_VIA_BINDING0x02Unicast sent using an entry in the binding table.
SL_ZIGBEE_OUTGOING_MULTICAST0x03Multicast message. This value is passed to sli_zigbee_stack_message_sent_handler() only. It may not be passed to sli_zigbee_stack_send_unicast().
SL_ZIGBEE_OUTGOING_BROADCAST0x04Broadcast message. This value is passed to sli_zigbee_stack_message_sent_handler() only. It may not be passed to sli_zigbee_stack_send_unicast().

sl_zigbee_mac_passthrough_type_t
SL_802154_PASSTHROUGH_NONE0x00No MAC passthrough messages.
SL_802154_PASSTHROUGH_SE_INTERPAN0x01SE InterPAN messages.
SL_802154_PASSTHROUGH_EMBERNET0x02Legacy EmberNet messages.
SL_802154_PASSTHROUGH_EMBERNET_SOURCE0x04Legacy EmberNet messages filtered by their source address.

sl_zigbee_binding_type_t
SL_ZIGBEE_UNUSED_BINDING0x00A binding that is currently not in use.
SL_ZIGBEE_UNICAST_BINDING0x01A unicast binding whose 64-bit identifier is the destination EUI64.
SL_ZIGBEE_MANY_TO_ONE_BINDING0x02A unicast binding whose 64-bit identifier is the aggregator EUI64.
SL_ZIGBEE_MULTICAST_BINDING0x03A multicast binding whose 64-bit identifier is the group address. A multicast binding can be used to send messages to the group and to receive messages sent to the group.

sl_zigbee_aps_option_t
SL_ZIGBEE_APS_OPTION_NONE0x0000No options.
SL_ZIGBEE_APS_OPTION_ENCRYPTION0x0020Send the message using APS Encryption, using the Link Key shared with the destination node to encrypt the data at the APS Level.
SL_ZIGBEE_APS_OPTION_RETRY0x0040Resend the message using the APS retry mechanism.
SL_ZIGBEE_APS_OPTION_ENABLE_ROUTE_DISCOVERY0x0100Causes a route discovery to be initiated if no route to the destination is known.
SL_ZIGBEE_APS_OPTION_FORCE_ROUTE_DISCOVERY0x0200Causes a route discovery to be initiated even if one is known.
SL_ZIGBEE_APS_OPTION_SOURCE_EUI640x0400Include the source EUI64 in the network frame.
SL_ZIGBEE_APS_OPTION_DESTINATION_EUI640x0800Include the destination EUI64 in the network frame.
SL_ZIGBEE_APS_OPTION_ENABLE_ADDRESS_DISCOVERY0x1000Send a ZDO request to discover the node ID of the destination, if it is not already know.
SL_ZIGBEE_APS_OPTION_POLL_RESPONSE0x2000Reserved.
SL_ZIGBEE_APS_OPTION_ZDO_RESPONSE_REQUIRED0x4000This incoming message is a ZDO request not handled by the EmberZNet stack, and the application is responsible for sending a ZDO response. This flag is used only when the ZDO is configured to have requests handled by the application. See the EZSP_CONFIG_APPLICATION_ZDO_CONFIGURATION configuration parameter for more information.
SL_ZIGBEE_APS_OPTION_FRAGMENT0x8000This message is part of a fragmented message. This option may only be set for unicasts. The groupId field gives the index of this fragment in the low-order byte. If the low-order byte is zero this is the first fragment and the high-order byte contains the number of fragments in the message.

sl_zigbee_ezsp_network_scan_type_t
SL_ZIGBEE_EZSP_ENERGY_SCAN0x00An energy scan scans each channel for its RSSI value.
SL_ZIGBEE_EZSP_ACTIVE_SCAN0x01An active scan scans each channel for available networks.

sl_zigbee_join_decision_t
SL_ZIGBEE_USE_PRECONFIGURED_KEY0x00Allow the node to join. The joining node should have a pre-configured key. The security data sent to it will be encrypted with that key.
SL_ZIGBEE_SEND_KEY_IN_THE_CLEAR0x01Allow the node to join. Send the network key in-the-clear to the joining device.
SL_ZIGBEE_DENY_JOIN0x02Deny join.
SL_ZIGBEE_NO_ACTION0x03Take no action.

sl_zigbee_leave_network_option_t
SL_ZIGBEE_LEAVE_NWK_WITH_NO_OPTION0x00Leave with no option.
SL_ZIGBEE_LEAVE_NWK_WITH_OPTION_REJOIN0x20Leave with option rejoin.
SL_ZIGBEE_LEAVE_NWK_IS_REQUESTED0x40Leave is requested.

sl_zigbee_initial_security_bitmask_t
SL_ZIGBEE_STANDARD_SECURITY_MODE0x0000This enables ZigBee Standard Security on the node.
SL_ZIGBEE_DISTRIBUTED_TRUST_CENTER_MODE0x0002This enables Distributed Trust Center Mode for the device forming the network. (Previously known as SL_ZIGBEE_NO_TRUST_CENTER_MODE)
SL_ZIGBEE_TRUST_CENTER_GLOBAL_LINK_KEY0x0004This enables a Global Link Key for the Trust Center. All nodes will share the same Trust Center Link Key.
SL_ZIGBEE_PRECONFIGURED_NETWORK_KEY_MODE0x0008This enables devices that perform MAC Association with a pre-configured Network Key to join the network. It is only set on the Trust Center.
SL_ZIGBEE_TRUST_CENTER_USES_HASHED_LINK_KEY0x0084This denotes that the preconfiguredKey is not the actual Link Key but a Secret Key known only to the Trust Center. It is hashed with the IEEE Address of the destination device in order to create the actual Link Key used in encryption. This is bit is only used by the Trust Center. The joining device need not set this.
SL_ZIGBEE_HAVE_PRECONFIGURED_KEY0x0100This denotes that the preconfiguredKey element has valid data that should be used to configure the initial security state.
SL_ZIGBEE_HAVE_NETWORK_KEY0x0200This denotes that the networkKey element has valid data that should be used to configure the initial security state.
SL_ZIGBEE_GET_LINK_KEY_WHEN_JOINING0x0400This denotes to a joining node that it should attempt to acquire a Trust Center Link Key during joining. This is only necessary if the device does not have a pre-configured key.
SL_ZIGBEE_REQUIRE_ENCRYPTED_KEY0x0800This denotes that a joining device should only accept an encrypted network key from the Trust Center (using its pre-configured key). A key sent in-the-clear by the Trust Center will be rejected and the join will fail. This option is only valid when utilizing a pre-configured key.
SL_ZIGBEE_NO_FRAME_COUNTER_RESET0x1000This denotes whether the device should NOT reset its outgoing frame counters (both NWK and APS) when ::sli_zigbee_stack_set_initial_security_state() is called. Normally it is advised to reset the frame counter before joining a new network. However in cases where a device is joining to the same network a again (but not using ::emberRejoinNetwork()) it should keep the NWK and APS frame counters stored in its tokens.
SL_ZIGBEE_GET_PRECONFIGURED_KEY_FROM_INSTALL_CODE0x2000This denotes that the device should obtain its preconfigured key from an installation code stored in the manufacturing token. The token contains a value that will be hashed to obtain the actual preconfigured key. If that token is not valid, then the call to sli_zigbee_stack_set_initial_security_state() will fail.
SL_ZIGBEE_HAVE_TRUST_CENTER_EUI640x0040This denotes that the ::sl_zigbee_initial_security_state_t::preconfiguredTrustCenterEui64 has a value in it containing the trust center EUI64. The device will only join a network and accept commands from a trust center with that EUI64. Normally this bit is NOT set, and the EUI64 of the trust center is learned during the join process. When commissioning a device to join onto an existing network, which is using a trust center, and without sending any messages, this bit must be set and the field ::sl_zigbee_initial_security_state_t::preconfiguredTrustCenterEui64 must be populated with the appropriate EUI64.

sl_zigbee_current_security_bitmask_t
SL_ZIGBEE_STANDARD_SECURITY_MODE0x0000This denotes that the device is running in a network with ZigBee Standard Security.
SL_ZIGBEE_DISTRIBUTED_TRUST_CENTER_MODE0x0002This denotes that the device is running in a network without a centralized Trust Center.
SL_ZIGBEE_TRUST_CENTER_GLOBAL_LINK_KEY0x0004This denotes that the device has a Global Link Key. The Trust Center Link Key is the same across multiple nodes.
SL_ZIGBEE_HAVE_TRUST_CENTER_LINK_KEY0x0010This denotes that the node has a Trust Center Link Key.
SL_ZIGBEE_TRUST_CENTER_USES_HASHED_LINK_KEY0x0084This denotes that the Trust Center is using a Hashed Link Key.

sl_zigbee_key_type_t
SL_ZIGBEE_TRUST_CENTER_LINK_KEY0x01A shared key between the Trust Center and a device.
SL_ZIGBEE_CURRENT_NETWORK_KEY0x03The current active Network Key used by all devices in the network.
SL_ZIGBEE_NEXT_NETWORK_KEY0x04The alternate Network Key that was previously in use, or the newer key that will be switched to.
SL_ZIGBEE_APPLICATION_LINK_KEY0x05An Application Link Key shared with another (non-Trust Center) device.

sl_zigbee_key_struct_bitmask_t
SL_ZIGBEE_KEY_HAS_SEQUENCE_NUMBER0x0001The key has a sequence number associated with it.
SL_ZIGBEE_KEY_HAS_OUTGOING_FRAME_COUNTER0x0002The key has an outgoing frame counter associated with it.
SL_ZIGBEE_KEY_HAS_INCOMING_FRAME_COUNTER0x0004The key has an incoming frame counter associated with it.
SL_ZIGBEE_KEY_HAS_PARTNER_EUI640x0008The key has a Partner IEEE address associated with it.

sl_zigbee_device_update_t
SL_ZIGBEE_STANDARD_SECURITY_SECURED_REJOIN0x0
SL_ZIGBEE_STANDARD_SECURITY_UNSECURED_JOIN0x1
SL_ZIGBEE_DEVICE_LEFT0x2
SL_ZIGBEE_STANDARD_SECURITY_UNSECURED_REJOIN0x3

sl_zigbee_key_status_t
SL_ZIGBEE_APP_LINK_KEY_ESTABLISHED0x01
SL_ZIGBEE_TRUST_CENTER_LINK_KEY_ESTABLISHED0x03
SL_ZIGBEE_KEY_ESTABLISHMENT_TIMEOUT0x04
SL_ZIGBEE_KEY_TABLE_FULL0x05
SL_ZIGBEE_TC_RESPONDED_TO_KEY_REQUEST0x06
SL_ZIGBEE_TC_APP_KEY_SENT_TO_REQUESTER0x07
SL_ZIGBEE_TC_RESPONSE_TO_KEY_REQUEST_FAILED0x08
SL_ZIGBEE_TC_REQUEST_KEY_TYPE_NOT_SUPPORTED0x09
SL_ZIGBEE_TC_NO_LINK_KEY_FOR_REQUESTER0x0A
SL_ZIGBEE_TC_REQUESTER_EUI64_UNKNOWN0x0B
SL_ZIGBEE_TC_RECEIVED_FIRST_APP_KEY_REQUEST0x0C
SL_ZIGBEE_TC_TIMEOUT_WAITING_FOR_SECOND_APP_KEY_REQUEST0x0D
SL_ZIGBEE_TC_NON_MATCHING_APP_KEY_REQUEST_RECEIVED0x0E
SL_ZIGBEE_TC_FAILED_TO_SEND_APP_KEYS0x0F
SL_ZIGBEE_TC_FAILED_TO_STORE_APP_KEY_REQUEST0x10
SL_ZIGBEE_TC_REJECTED_APP_KEY_REQUEST0x11

sl_zigbee_counter_type_t
SL_ZIGBEE_COUNTER_MAC_RX_BROADCAST0The MAC received a broadcast.
SL_ZIGBEE_COUNTER_MAC_TX_BROADCAST1The MAC transmitted a broadcast.
SL_ZIGBEE_COUNTER_MAC_RX_UNICAST2The MAC received a unicast.
SL_ZIGBEE_COUNTER_MAC_TX_UNICAST_SUCCESS3The MAC successfully transmitted a unicast.
SL_ZIGBEE_COUNTER_MAC_TX_UNICAST_RETRY4The MAC retried a unicast.
SL_ZIGBEE_COUNTER_MAC_TX_UNICAST_FAILED5The MAC unsuccessfully transmitted a unicast.
SL_ZIGBEE_COUNTER_APS_DATA_RX_BROADCAST6The APS layer received a data broadcast.
SL_ZIGBEE_COUNTER_APS_DATA_TX_BROADCAST7The APS layer transmitted a data broadcast.
SL_ZIGBEE_COUNTER_APS_DATA_RX_UNICAST8The APS layer received a data unicast.
SL_ZIGBEE_COUNTER_APS_DATA_TX_UNICAST_SUCCESS9The APS layer successfully transmitted a data unicast.
SL_ZIGBEE_COUNTER_APS_DATA_TX_UNICAST_RETRY10The APS layer retried a data unicast.
SL_ZIGBEE_COUNTER_APS_DATA_TX_UNICAST_FAILED11The APS layer unsuccessfully transmitted a data unicast.
SL_ZIGBEE_COUNTER_ROUTE_DISCOVERY_INITIATED12The network layer successfully submitted a new route discovery to the MAC.
SL_ZIGBEE_COUNTER_NEIGHBOR_ADDED13An entry was added to the neighbor table.
SL_ZIGBEE_COUNTER_NEIGHBOR_REMOVED14An entry was removed from the neighbor table.
SL_ZIGBEE_COUNTER_NEIGHBOR_STALE15A neighbor table entry became stale because it had not been heard from.
SL_ZIGBEE_COUNTER_JOIN_INDICATION16A node joined or rejoined to the network via this node.
SL_ZIGBEE_COUNTER_CHILD_REMOVED17An entry was removed from the child table.
SL_ZIGBEE_COUNTER_ASH_OVERFLOW_ERROR18EZSP-UART only. An overflow error occurred in the UART.
SL_ZIGBEE_COUNTER_ASH_FRAMING_ERROR19EZSP-UART only. A framing error occurred in the UART.
SL_ZIGBEE_COUNTER_ASH_OVERRUN_ERROR20EZSP-UART only. An overrun error occurred in the UART.
SL_ZIGBEE_COUNTER_NWK_FRAME_COUNTER_FAILURE21A message was dropped at the network layer because the NWK frame counter was not higher than the last message seen from that source.
SL_ZIGBEE_COUNTER_APS_FRAME_COUNTER_FAILURE22A message was dropped at the APS layer because the APS frame counter was not higher than the last message seen from that source.
EMBER_COUNTER_UTILITY23Utility counter for general debugging use.
SL_ZIGBEE_COUNTER_APS_LINK_KEY_NOT_AUTHORIZED24A message was dropped at the APS layer because it had APS encryption but the key associated with the sender has not been authenticated, and thus the key is not authorized for use in APS data messages.
SL_ZIGBEE_COUNTER_NWK_DECRYPTION_FAILURE25An NWK encrypted message was received but dropped because decryption failed.
SL_ZIGBEE_COUNTER_APS_DECRYPTION_FAILURE26An APS encrypted message was received but dropped because decryption failed.
SL_ZIGBEE_COUNTER_ALLOCATE_PACKET_BUFFER_FAILURE27The number of times we failed to allocate a set of linked packet buffers. This doesn't necessarily mean that the packet buffer count was 0 at the time, but that the number requested was greater than the number free.
SL_ZIGBEE_COUNTER_RELAYED_UNICAST28The number of relayed unicast packets.
SL_ZIGBEE_COUNTER_PHY_TO_MAC_QUEUE_LIMIT_REACHED29The number of times we dropped a packet due to reaching the preset PHY to MAC queue limit (sli_802154mac_max_phy_to_mac_queue_length).
SL_ZIGBEE_COUNTER_PACKET_VALIDATE_LIBRARY_DROPPED_COUNT30The number of times we dropped a packet due to the packet-validate library checking a packet and rejecting it due to length or other formatting problems.
SL_ZIGBEE_COUNTER_TYPE_NWK_RETRY_OVERFLOW31The number of times the NWK retry queue is full and a new message failed to be added.
SL_ZIGBEE_COUNTER_PHY_CCA_FAIL_COUNT32The number of times the PHY layer was unable to transmit due to a failed CCA.
SL_ZIGBEE_COUNTER_BROADCAST_TABLE_FULL33The number of times an NWK broadcast was dropped because the broadcast table was full.
SL_ZIGBEE_COUNTER_PTA_LO_PRI_REQUESTED34The number of low priority packet traffic arbitration requests.
SL_ZIGBEE_COUNTER_PTA_HI_PRI_REQUESTED35The number of high priority packet traffic arbitration requests.
SL_ZIGBEE_COUNTER_PTA_LO_PRI_DENIED36The number of low priority packet traffic arbitration requests denied.
SL_ZIGBEE_COUNTER_PTA_HI_PRI_DENIED37The number of high priority packet traffic arbitration requests denied.
SL_ZIGBEE_COUNTER_PTA_LO_PRI_TX_ABORTED38The number of aborted low-priority packet traffic arbitration transmissions.
SL_ZIGBEE_COUNTER_PTA_HI_PRI_TX_ABORTED39The number of aborted high-priority packet traffic arbitration transmissions.
SL_ZIGBEE_COUNTER_TYPE_COUNT40A placeholder giving the number of Ember counter types.

sl_zigbee_join_method_t
SL_ZIGBEE_USE_MAC_ASSOCIATION0x0Normally devices use MAC Association to join a network, which respects the "permit joining" flag in the MAC Beacon. This value should be used by default.
SL_ZIGBEE_USE_NWK_REJOIN0x1For those networks where the "permit joining" flag is never turned on, they will need to use a ZigBee NWK Rejoin. This value causes the rejoin to be sent without NWK security and the Trust Center will be asked to send the NWK key to the device. The NWK key sent to the device can be encrypted with the device's corresponding Trust Center link key. That is determined by the ::sl_zigbee_join_decision_t on the Trust Center returned by the ::sl_zigbee_internal_trust_center_join_handler().
SL_ZIGBEE_USE_NWK_REJOIN_HAVE_NWK_KEY0x2For those networks where the "permit joining" flag is never turned on, they will need to use an NWK Rejoin. If those devices have been preconfigured with the NWK key (including sequence number) they can use a secured rejoin. This is only necessary for end devices since they need a parent. Routers can simply use the ::SL_ZIGBEE_USE_CONFIGURED_NWK_STATE join method below.
SL_ZIGBEE_USE_CONFIGURED_NWK_STATE0x3For those networks where all network and security information is known ahead of time, a router device may be commissioned such that it does not need to send any messages to begin communicating on the network.

sl_zigbee_zdo_configuration_flags_t
SL_ZIGBEE_APP_RECEIVES_SUPPORTED_ZDO_REQUESTS0x01Set this flag in order to receive supported ZDO request messages via the incomingMessageHandler callback. A supported ZDO request is one that is handled by the EmberZNet stack. The stack will continue to handle the request and send the appropriate ZDO response even if this configuration option is enabled.
SL_ZIGBEE_APP_HANDLES_UNSUPPORTED_ZDO_REQUESTS0x02Set this flag in order to receive unsupported ZDO request messages via the incomingMessageHandler callback. An unsupported ZDO request is one that is not handled by the EmberZNet stack, other than to send a 'not supported' ZDO response. If this configuration option is enabled, the stack will no longer send any ZDO response, and it is the application's responsibility to do so.
SL_ZIGBEE_APP_HANDLES_ZDO_ENDPOINT_REQUESTS0x04Set this flag in order to receive the following ZDO request messages via the incomingMessageHandler callback: SIMPLE_DESCRIPTOR_REQUEST, MATCH_DESCRIPTORS_REQUEST, and ACTIVE_ENDPOINTS_REQUEST. If this configuration option is enabled, the stack will no longer send any ZDO response for these requests, and it is the application's responsibility to do so.
SL_ZIGBEE_APP_HANDLES_ZDO_BINDING_REQUESTS0x08Set this flag in order to receive the following ZDO request messages via the incomingMessageHandler callback: BINDING_TABLE_REQUEST, BIND_REQUEST, and UNBIND_REQUEST. If this configuration option is enabled, the stack will no longer send any ZDO response for these requests, and it is the application's responsibility to do so.

EmberConcentratorType
SL_ZIGBEE_LOW_RAM_CONCENTRATOR0xFFF8A concentrator with insufficient memory to store source routes for the entire network. Route records are sent to the concentrator prior to every inbound APS unicast.
SL_ZIGBEE_HIGH_RAM_CONCENTRATOR0xFFF9A concentrator with sufficient memory to store source routes for the entire network. Remote nodes stop sending route records once the concentrator has successfully received one.

sl_zigbee_zll_state_t
SL_ZIGBEE_ZLL_STATE_NONE0x0000No state.
SL_ZIGBEE_ZLL_STATE_FACTORY_NEW0x0001The device is factory new.
SL_ZIGBEE_ZLL_STATE_ADDRESS_ASSIGNMENT_CAPABLE0x0002The device is capable of assigning addresses to other devices.
SL_ZIGBEE_ZLL_STATE_LINK_INITIATOR0x0010The device is initiating a link operation.
SL_ZIGBEE_ZLL_STATE_LINK_PRIORITY_REQUEST0x0020The device is requesting link priority.
SL_ZIGBEE_ZLL_STATE_NON_ZLL_NETWORK0x0100The device is on a non-ZLL network.

sl_zigbee_zll_key_index_t
SL_ZIGBEE_ZLL_KEY_INDEX_DEVELOPMENT0x00Key encryption algorithm for use during development.
SL_ZIGBEE_ZLL_KEY_INDEX_MASTER0x04Key encryption algorithm shared by all certified devices.
SL_ZIGBEE_ZLL_KEY_INDEX_CERTIFICATION0x0FKey encryption algorithm for use during development and certification.

sl_zigbee_ezsp_zll_network_operation_t
SL_ZIGBEE_EZSP_ZLL_FORM_NETWORK0x00ZLL form network command.
SL_ZIGBEE_EZSP_ZLL_JOIN_TARGET0x01ZLL join target command.

sl_zigbee_network_init_bitmask_t
SL_ZIGBEE_NETWORK_INIT_NO_OPTIONS0x0000No options for Network Init
SL_ZIGBEE_NETWORK_INIT_PARENT_INFO_IN_TOKEN0x0001Save parent info (node ID and EUI64) in a token during joining/rejoin, and restore on reboot.
SL_ZIGBEE_NETWORK_INIT_END_DEVICE_REJOIN_ON_REBOOT0x0002Send a rejoin request as an end device on reboot if parent information is persisted.

sl_zigbee_multi_phy_nwk_config_t
SL_ZIGBEE_BROADCAST_SUPPORT0x01Enable broadcast support on Routers

sl_zigbee_duty_cycle_state_t
SL_ZIGBEE_DUTY_CYCLE_TRACKING_OFF0No Duty cycle tracking or metrics are taking place.
SL_ZIGBEE_DUTY_CYCLE_LBT_NORMAL1Duty Cycle is tracked and has not exceeded any thresholds.
SL_ZIGBEE_DUTY_CYCLE_LBT_LIMITED_THRESHOLD_REACHED2We have exceeded the limited threshold of our total duty cycle allotment.
SL_ZIGBEE_DUTY_CYCLE_LBT_CRITICAL_THRESHOLD_REACHED3We have exceeded the critical threshold of our total duty cycle allotment
SL_ZIGBEE_DUTY_CYCLE_LBT_SUSPEND_LIMIT_REACHED4We have reached the suspend limit and are blocking all outbound transmissions.

sl_zigbee_radio_power_mode_t
SL_ZIGBEE_RADIO_POWER_MODE_RX_ON0The radio receiver is switched on.
SL_ZIGBEE_RADIO_POWER_MODE_OFF1The radio receiver is switched off.

sl_zigbee_entropy_source_t
SL_ZIGBEE_ENTROPY_SOURCE_ERROR0Entropy source error.
SL_ZIGBEE_ENTROPY_SOURCE_RADIO1Entropy source is the radio.
SL_ZIGBEE_ENTROPY_SOURCE_MBEDTLS_TRNG2Entropy source is the TRNG powered by mbed TLS.
SL_ZIGBEE_ENTROPY_SOURCE_MBEDTLS3Entropy source is powered by mbed TLS, the source is not TRNG.

sl_zigbee_sec_man_key_type_t
SL_ZB_SEC_MAN_KEY_TYPE_NONE0No key type.
SL_ZB_SEC_MAN_KEY_TYPE_NETWORK1Network Key (either current or alternate).
SL_ZB_SEC_MAN_KEY_TYPE_TC_LINK2Preconfigured Trust Center Link Key.
SL_ZB_SEC_MAN_KEY_TYPE_TC_LINK_WITH_TIMEOUT3Transient key.
SL_ZB_SEC_MAN_KEY_TYPE_APP_LINK4Link key in table.
SL_ZB_SEC_MAN_KEY_TYPE_ZLL_ENCRYPTION_KEY6Encryption key in ZLL.
SL_ZB_SEC_MAN_KEY_TYPE_ZLL_PRECONFIGURED_KEY7Preconfigured key in ZLL.
SL_ZB_SEC_MAN_KEY_TYPE_GREEN_POWER_PROXY_TABLE_KEY8GP Proxy table key.
SL_ZB_SEC_MAN_KEY_TYPE_GREEN_POWER_SINK_TABLE_KEY9GP Sink table key.
SL_ZB_SEC_MAN_KEY_TYPE_INTERNAL10Generic key type available to use for crypto operations.

sl_zigbee_sec_man_derived_key_type_t
SL_ZB_SEC_MAN_DERIVED_KEY_TYPE_NONE0No derivation (use core key type directly).
SL_ZB_SEC_MAN_DERIVED_KEY_TYPE_KEY_TRANSPORT_KEY1Hash core key with Key Transport Key hash.
SL_ZB_SEC_MAN_DERIVED_KEY_TYPE_KEY_LOAD_KEY2Hash core key with Key Load Key hash.
SL_ZB_SEC_MAN_DERIVED_KEY_TYPE_VERIFY_KEY3Perform Verify Key hash.
SL_ZB_SEC_MAN_DERIVED_KEY_TYPE_TC_SWAP_OUT_KEY4Perform a simple AES hash of the key for TC backup.
SL_ZB_SEC_MAN_DERIVED_KEY_TYPE_TC_HASHED_LINK_KEY5For a TC using hashed link keys, hashed the root key against the supplied EUI in context.

sl_zigbee_sec_man_flags_t
ZB_SEC_MAN_FLAG_NONE0No flags on operation.
ZB_SEC_MAN_FLAG_KEY_INDEX_IS_VALID1Context has a valid key index.
ZB_SEC_MAN_FLAG_EUI_IS_VALID2Context has a valid EUI64.
ZB_SEC_MAN_FLAG_UNCONFIRMED_TRANSIENT_KEY4Transient key being added hasn't yet been verified.

sl_zigbee_leave_request_flags_t
SL_ZIGBEE_ZIGBEE_LEAVE_AND_REJOIN0x80Leave and rejoin the network.
SL_ZIGBEE_ZIGBEE_LEAVE_WITHOUT_REJOIN0x00Leave the network and do not rejoin.

Configuration Frames

Name: versionID: 0x0000
Description: The command allows the Host to specify the desired EZSP version and must be sent before any other command. The response provides information about the firmware running on the NCP.
Command Parameters:
uint8_t desiredProtocolVersionThe EZSP version the Host wishes to use. To successfully set the version and allow other commands, this must be same as EZSP_PROTOCOL_VERSION.
Response Parameters:
uint8_t protocolVersionThe EZSP version the NCP is using.
uint8_t stackTypeThe type of stack running on the NCP (2).
uint16_t stackVersionThe version number of the stack.

Name: getConfigurationValueID: 0x0052
Description: Reads a configuration value from the NCP.
Command Parameters:
sl_zigbee_ezsp_config_id_t configIdIdentifies which configuration value to read.
Response Parameters:
sl_status_t statusSL_STATUS_OK if the value was read successfully, SL_STATUS_ZIGBEE_EZSP_ERROR (for SL_ZIGBEE_EZSP_ERROR_INVALID_ID) if the NCP does not recognize configId.
uint16_t valueThe configuration value.

Name: setConfigurationValueID: 0x0053
Description: Writes a configuration value to the NCP. Configuration values can be modified by the Host after the NCP has reset. Once the status of the stack changes to SL_STATUS_NETWORK_UP, configuration values can no longer be modified and this command will respond with SL_ZIGBEE_EZSP_ERROR_INVALID_CALL.
Command Parameters:
sl_zigbee_ezsp_config_id_t configIdIdentifies which configuration value to change.
uint16_t valueThe new configuration value.
Response Parameters:
sl_status_t statusSL_STATUS_OK if the configuration value was changed, SL_STATUS_ZIGBEE_EZSP_ERROR if there was an error. Retrievable EZSP errors can be SL_ZIGBEE_EZSP_ERROR_OUT_OF_MEMORY if the new value exceeded the available memory, SL_ZIGBEE_EZSP_ERROR_INVALID_VALUE if the new value was out of bounds, SL_ZIGBEE_EZSP_ERROR_INVALID_ID if the NCP does not recognize configId, SL_ZIGBEE_EZSP_ERROR_INVALID_CALL if configuration values can no longer be modified.

Name: readAttributeID: 0x0108
Description: Read attribute data on NCP endpoints.
Command Parameters:
uint8_t endpointEndpoint
uint16_t clusterCluster.
uint16_t attributeIdAttribute ID.
uint8_t maskMask.
uint16_t manufacturerCodeManufacturer code.
Response Parameters:
sl_zigbee_af_status_t af_statusAn sl_zigbee_af_status_t value indicating success or the reason for failure, handled by the EZSP layer as a uint8_t. 255 indicates an EZSP-specific error.
uint8_t dataTypeAttribute data type.
uint8_t readLengthLength of attribute data.
uint8_t[] dataPtrAttribute data.

Name: writeAttributeID: 0x0109
Description: Write attribute data on NCP endpoints.
Command Parameters:
uint8_t endpointEndpoint
uint16_t clusterCluster.
uint16_t attributeIdAttribute ID.
uint8_t maskMask.
uint16_t manufacturerCodeManufacturer code.
bool overrideReadOnlyAndDataTypeOverride read only and data type.
bool justTestOverride read only and data type.
uint8_t dataTypeAttribute data type.
uint8_t dataLengthAttribute data length.
uint8_t[] dataAttribute data.
Response Parameters:
sl_zigbee_af_status_t af_statusAn sl_zigbee_af_status_t value indicating success or the reason for failure.

Name: addEndpointID: 0x0002
Description: Configures endpoint information on the NCP. The NCP does not remember these settings after a reset. Endpoints can be added by the Host after the NCP has reset. Once the status of the stack changes to SL_STATUS_NETWORK_UP, endpoints can no longer be added and this command will respond with SL_ZIGBEE_EZSP_ERROR_INVALID_CALL.
Command Parameters:
uint8_t endpointThe application endpoint to be added.
uint16_t profileIdThe endpoint's application profile.
uint16_t deviceIdThe endpoint's device ID within the application profile.
uint8_t deviceVersionThe endpoint's device version.
uint8_t inputClusterCountThe number of cluster IDs in inputClusterList.
uint8_t outputClusterCountThe number of cluster IDs in outputClusterList.
uint16_t[] inputClusterListInput cluster IDs the endpoint will accept.
uint16_t[] outputClusterListOutput cluster IDs the endpoint may send.
Response Parameters:
sl_status_t statusSL_STATUS_OK if the endpoint was added, SL_STATUS_ZIGBEE_EZSP_ERROR if there was an error. Errors could be SL_ZIGBEE_EZSP_ERROR_OUT_OF_MEMORY if there is not enough memory available to add the endpoint, SL_ZIGBEE_EZSP_ERROR_INVALID_VALUE if the endpoint already exists, SL_ZIGBEE_EZSP_ERROR_INVALID_CALL if endpoints can no longer be added.

Name: setPolicyID: 0x0055
Description: Allows the Host to change the policies used by the NCP to make fast decisions.
Command Parameters:
sl_zigbee_ezsp_policy_id_t policyIdIdentifies which policy to modify.
sl_zigbee_ezsp_decision_id_t decisionIdThe new decision for the specified policy.
Response Parameters:
sl_status_t statusSL_STATUS_OK if the policy was changed, SL_STATUS_ZIGBEE_EZSP_ERROR (for SL_ZIGBEE_EZSP_ERROR_INVALID_ID) if the NCP does not recognize policyId.

Name: getPolicyID: 0x0056
Description: Allows the Host to read the policies used by the NCP to make fast decisions.
Command Parameters:
sl_zigbee_ezsp_policy_id_t policyIdIdentifies which policy to read.
Response Parameters:
sl_status_t statusSL_STATUS_OK if the policy was read successfully, SL_STATUS_ZIGBEE_EZSP_ERROR (for SL_ZIGBEE_EZSP_ERROR_INVALID_ID) if the NCP does not recognize policyId.
sl_zigbee_ezsp_decision_id_t decisionIdThe current decision for the specified policy.

Name: sendPanIdUpdateID: 0x0057
Description: Triggers a pan id update message.
Command Parameters:
sl_802154_pan_id_t newPanThe new Pan Id
Response Parameters:
bool statustrue if the request was successfully handed to the stack, false otherwise

Name: getValueID: 0x00AA
Description: Reads a value from the NCP.
Command Parameters:
sl_zigbee_ezsp_value_id_t valueIdIdentifies which value to read.
Response Parameters:
sl_status_t statusSL_STATUS_OK if the value was read successfully, SL_STATUS_ZIGBEE_EZSP_ERROR otherwise. Errors could be SL_ZIGBEE_EZSP_ERROR_INVALID_ID if the NCP does not recognize valueId, SL_ZIGBEE_EZSP_ERROR_INVALID_VALUE if the length of the returned value exceeds the size of local storage allocated to receive it.
uint8_t valueLengthBoth a command and response parameter. On command, the maximum size in bytes of local storage allocated to receive the returned value. On response, the actual length in bytes of the returned value.
uint8_t[] valueThe value.

Name: getExtendedValueID: 0x0003
Description: Reads a value from the NCP but passes an extra argument specific to the value being retrieved.
Command Parameters:
sl_zigbee_ezsp_extended_value_id_t valueIdIdentifies which extended value ID to read.
uint32_t characteristicsIdentifies which characteristics of the extended value ID to read. These are specific to the value being read.
Response Parameters:
sl_status_t statusSL_STATUS_OK if the value was read successfully, SL_STATUS_ZIGBEE_EZSP_ERROR otherwise. Errors could be SL_ZIGBEE_EZSP_ERROR_INVALID_ID if the NCP does not recognize valueId, SL_ZIGBEE_EZSP_ERROR_INVALID_VALUE if the length of the returned value exceeds the size of local storage allocated to receive it.
uint8_t valueLengthBoth a command and response parameter. On command, the maximum size in bytes of local storage allocated to receive the returned value. On response, the actual length in bytes of the returned value.
uint8_t[] valueThe value.

Name: setValueID: 0x00AB
Description: Writes a value to the NCP.
Command Parameters:
sl_zigbee_ezsp_value_id_t valueIdIdentifies which value to change.
uint8_t valueLengthThe length of the value parameter in bytes.
uint8_t[] valueThe new value.
Response Parameters:
sl_status_t statusSL_STATUS_OK if the value was changed, SL_STATUS_ZIGBEE_EZSP_ERROR otherwise. Errors could be SL_ZIGBEE_EZSP_ERROR_INVALID_VALUE if the new value was out of bounds, SL_ZIGBEE_EZSP_ERROR_INVALID_ID if the NCP does not recognize valueId, SL_ZIGBEE_EZSP_ERROR_INVALID_CALL if the value could not be modified.

Name: setPassiveAckConfigID: 0x0105
Description: Allows the Host to control the broadcast behaviour of a routing device used by the NCP.
Command Parameters:
uint8_t configPassive ack config enum.
uint8_t minAcksNeededThe minimum number of acknowledgments (re-broadcasts) to wait for until deeming the broadcast transmission complete.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: setPendingNetworkUpdatePanIdID: 0x011E
Description: Set the PAN ID to be accepted by the device in a NLME Network Update command. If this is set to a different value than its default 0xFFFF, NLME network update messages will be ignored if they do not match this PAN ID.
Command Parameters:
uint16_t panIdPAN ID to be accepted in a network update.
Response Parameters: None

Name: getEndpointID: 0x012E
Description: Retrieve the endpoint number located at the specified index.
Command Parameters:
uint8_t indexIndex to retrieve the endpoint number for.
Response Parameters:
uint8_t endpointEndpoint number at the index.

Name: getEndpointCountID: 0x012F
Description: Get the number of configured endpoints.
Command Parameters: None
Response Parameters:
uint8_t countNumber of configured endpoints.

Name: getEndpointDescriptionID: 0x0130
Description: Retrieve the endpoint description for the given endpoint number.
Command Parameters:
uint8_t endpointEndpoint number to get the description of.
Response Parameters:
sl_zigbee_endpoint_description_t resultDescription of this endpoint.

Name: getEndpointClusterID: 0x0131
Description: Retrieve one of the cluster IDs associated with the given endpoint.
Command Parameters:
uint8_t endpointEndpoint number to get a cluster ID for.
uint8_t listIdWhich list to get the cluster ID from. (0 for input, 1 for output).
uint8_t listIndexIndex from requested list to look at the cluster ID of.
Response Parameters:
uint16_t endpoint_clusterID of the requested cluster.

Utilities Frames

Name: nopID: 0x0005
Description: A command which does nothing. The Host can use this to set the sleep mode or to check the status of the NCP.
Command Parameters: None
Response Parameters: None

Name: echoID: 0x0081
Description: Variable length data from the Host is echoed back by the NCP. This command has no other effects and is designed for testing the link between the Host and NCP.
Command Parameters:
uint8_t dataLengthThe length of the data parameter in bytes.
uint8_t[] dataThe data to be echoed back.
Response Parameters:
uint8_t echoLengthThe length of the echo parameter in bytes.
uint8_t[] echoThe echo of the data.

Name: invalidCommandID: 0x0058
Description: Indicates that the NCP received an invalid command.
This frame is a response to an invalid command.
Response Parameters:
sl_zigbee_ezsp_status_t reasonThe reason why the command was invalid.

Name: callbackID: 0x0006
Description: Allows the NCP to respond with a pending callback.
Command Parameters: None
The response to this command can be any of the callback responses.

Name: noCallbacksID: 0x0007
Description: Indicates that there are currently no pending callbacks.
This frame is a response to the callback command.
Response Parameters: None

Name: setTokenID: 0x0009
Description: Sets a token (8 bytes of non-volatile storage) in the Simulated EEPROM of the NCP.
Command Parameters:
uint8_t tokenIdWhich token to set
uint8_t[8] tokenDataThe data to write to the token.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: getTokenID: 0x000A
Description: Retrieves a token (8 bytes of non-volatile storage) from the Simulated EEPROM of the NCP.
Command Parameters:
uint8_t tokenIdWhich token to read
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.
uint8_t[8] tokenDataThe contents of the token.

Name: getMfgTokenID: 0x000B
Description: Retrieves a manufacturing token from the Flash Information Area of the NCP (except for SL_ZIGBEE_EZSP_STACK_CAL_DATA which is managed by the stack).
Command Parameters:
sl_zigbee_ezsp_mfg_token_id_t tokenIdWhich manufacturing token to read.
Response Parameters:
uint8_t tokenDataLengthThe length of the tokenData parameter in bytes.
uint8_t[] tokenDataThe manufacturing token data.

Name: setMfgTokenID: 0x000C
Description: Sets a manufacturing token in the Customer Information Block (CIB) area of the NCP if that token currently unset (fully erased). Cannot be used with SL_ZIGBEE_EZSP_STACK_CAL_DATA, SL_ZIGBEE_EZSP_STACK_CAL_FILTER, SL_ZIGBEE_EZSP_MFG_ASH_CONFIG, or SL_ZIGBEE_EZSP_MFG_CBKE_DATA token.
Command Parameters:
sl_zigbee_ezsp_mfg_token_id_t tokenIdWhich manufacturing token to set.
uint8_t tokenDataLengthThe length of the tokenData parameter in bytes.
uint8_t[] tokenDataThe manufacturing token data.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: stackTokenChangedHandlerID: 0x000D
Description: A callback invoked to inform the application that a stack token has changed.
This frame is a response to the callback command.
Response Parameters:
uint16_t tokenAddressThe address of the stack token that has changed.

Name: getRandomNumberID: 0x0049
Description: Returns a pseudorandom number.
Command Parameters: None
Response Parameters:
sl_status_t statusAlways returns SL_STATUS_OK.
uint16_t valueA pseudorandom number.

Name: setTimerID: 0x000E
Description: Sets a timer on the NCP. There are 2 independent timers available for use by the Host. A timer can be cancelled by setting time to 0 or units to SL_ZIGBEE_EVENT_INACTIVE.
Command Parameters:
uint8_t timerIdWhich timer to set (0 or 1).
uint16_t timeThe delay before the timerHandler callback will be generated. Note that the timer clock is free running and is not synchronized with this command. This means that the actual delay will be between time and (time - 1). The maximum delay is 32767.
sl_zigbee_event_units_t unitsThe units for time.
bool repeatIf true, a timerHandler callback will be generated repeatedly. If false, only a single timerHandler callback will be generated.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: getTimerID: 0x004E
Description: Gets information about a timer. The Host can use this command to find out how much longer it will be before a previously set timer will generate a callback.
Command Parameters:
uint8_t timerIdWhich timer to get information about (0 or 1).
Response Parameters:
uint16_t timeThe delay before the timerHandler callback will be generated.
sl_zigbee_event_units_t unitsThe units for time.
bool repeatTrue if a timerHandler callback will be generated repeatedly. False if only a single timerHandler callback will be generated.

Name: timerHandlerID: 0x000F
Description: A callback from the timer.
This frame is a response to the callback command.
Response Parameters:
uint8_t timerIdWhich timer generated the callback (0 or 1).

Name: debugWriteID: 0x0012
Description: Sends a debug message from the Host to the Network Analyzer utility via the NCP.
Command Parameters:
bool binaryMessagetrue if the message should be interpreted as binary data, false if the message should be interpreted as ASCII text.
uint8_t messageLengthThe length of the messageContents parameter in bytes.
uint8_t[] messageContentsThe binary message.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: readAndClearCountersID: 0x0065
Description: Retrieves and clears Ember counters. See the sl_zigbee_counter_type_t enumeration for the counter types.
Command Parameters: None
Response Parameters:
uint16_t[SL_ZIGBEE_COUNTER_TYPE_COUNT] valuesA list of all counter values ordered according to the sl_zigbee_counter_type_t enumeration.

Name: readCountersID: 0x00F1
Description: Retrieves Ember counters. See the sl_zigbee_counter_type_t enumeration for the counter types.
Command Parameters: None
Response Parameters:
uint16_t[SL_ZIGBEE_COUNTER_TYPE_COUNT] valuesA list of all counter values ordered according to the sl_zigbee_counter_type_t enumeration.

Name: counterRolloverHandlerID: 0x00F2
Description: This call is fired when a counter exceeds its threshold
This frame is a response to the callback command.
Response Parameters:
sl_zigbee_counter_type_t typeType of Counter

Name: mux_invalid_rx_handlerID: 0x0062
Description: This call is fired when mux detects an invalid rx case, which would be different rx channels for different protocol contexts, when fast cahnnel switching is not enabled
This frame is a response to the callback command.
Response Parameters:
uint8_t new_rx_channel
uint8_t old_rx_channel

Name: delayTestID: 0x009D
Description: Used to test that UART flow control is working correctly.
Command Parameters:
uint16_t delayData will not be read from the host for this many milliseconds.
Response Parameters: None

Name: getLibraryStatusID: 0x0001
Description: This retrieves the status of the passed library ID to determine if it is compiled into the stack.
Command Parameters:
sl_zigbee_library_id_t libraryIdThe ID of the library being queried.
Response Parameters:
sl_zigbee_library_status_t statusThe status of the library being queried.

Name: getXncpInfoID: 0x0013
Description: Allows the HOST to know whether the NCP is running the XNCP library. If so, the response contains also the manufacturer ID and the version number of the XNCP application that is running on the NCP.
Command Parameters: None
Response Parameters:
sl_status_t statusSL_STATUS_OK if the NCP is running the XNCP library. SL_STATUS_INVALID_STATE otherwise.
uint16_t manufacturerIdThe manufactured ID the user has defined in the XNCP application.
uint16_t versionNumberThe version number of the XNCP application.

Name: customFrameID: 0x0047
Description: Provides the customer a custom EZSP frame. On the NCP, these frames are only handled if the XNCP library is included. On the NCP side these frames are handled in the sl_zigbee_xncp_incoming_custom_ezsp_message_cb() callback function.
Command Parameters:
uint8_t payloadLengthThe length of the custom frame payload (maximum 119 bytes).
uint8_t[] payloadThe payload of the custom frame.
Response Parameters:
sl_status_t statusThe status returned by the custom command.
uint8_t replyLengthThe length of the response.
uint8_t[] replyThe response.

Name: customFrameHandlerID: 0x0054
Description: A callback indicating a custom EZSP message has been received.
This frame is a response to the callback command.
Response Parameters:
uint8_t payloadLengthThe length of the custom frame payload.
uint8_t[] payloadThe payload of the custom frame.

Name: getEui64ID: 0x0026
Description: Returns the EUI64 ID of the local node.
Command Parameters: None
Response Parameters:
sl_802154_long_addr_t eui64The 64-bit ID.

Name: getNodeIdID: 0x0027
Description: Returns the 16-bit node ID of the local node.
Command Parameters: None
Response Parameters:
sl_802154_short_addr_t nodeIdThe 16-bit ID.

Name: getPhyInterfaceCountID: 0x00FC
Description: Returns number of phy interfaces present.
Command Parameters: None
Response Parameters:
uint8_t interfaceCountValue indicate how many phy interfaces present.

Name: getTrueRandomEntropySourceID: 0x004F
Description: Returns the entropy source used for true random number generation.
Command Parameters: None
Response Parameters:
sl_zigbee_entropy_source_t entropySourceValue indicates the used entropy source.

Name: setupDelayedJoinID: 0x003A
Description: Extend a joiner's timeout to wait for the network key on the joiner default key timeout is 3 sec, and only values greater equal to 3 sec are accepted.
Command Parameters:
uint8_t networkKeyTimeoutSNetwork key timeout
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: radioGetSchedulerPrioritiesID: 0x012A
Description: Get the current scheduler priorities for radio operations
Command Parameters: None
Response Parameters:
sl_802154_radio_priorities_t prioritiesThe current priorities.

Name: radioSetSchedulerPrioritiesID: 0x012B
Description: Set the current scheduler priorities for radio operations
Command Parameters:
sl_802154_radio_priorities_t prioritiesThe current priorities.
Response Parameters: None

Name: radioGetSchedulerSliptimeID: 0x012C
Description: Get the current multiprotocol sliptime
Command Parameters: None
Response Parameters:
uint32_t[1] slipTimeValue of the current slip time.

Name: radioSetSchedulerSliptimeID: 0x012D
Description: Set the current multiprotocol sliptime
Command Parameters:
uint32_t slipTimeValue of the current slip time.
Response Parameters: None

Name: counterRequiresPhyIndexID: 0x0132
Description: Check if a particular counter is one that could report from either a 2.4GHz or sub-GHz interface.
Command Parameters:
sl_zigbee_counter_type_t counterThe counter to be checked.
Response Parameters:
bool requiresWhether this counter requires a PHY index when operating on a dual-PHY system.

Name: counterRequiresDestinationNodeIdID: 0x0133
Description: Check if a particular counter can report on the destination node ID they have been triggered from.
Command Parameters:
sl_zigbee_counter_type_t counterThe counter to be checked.
Response Parameters:
bool requiresWhether this counter requires the destination node ID.

Networking Frames

Name: setManufacturerCodeID: 0x0015
Description: Sets the manufacturer code to the specified value. The manufacturer code is one of the fields of the node descriptor.
Command Parameters:
uint16_t codeThe manufacturer code for the local node.
Response Parameters:
sl_status_t status

Name: getManufacturerCodeID: 0x00CA
Description: Gets the manufacturer code to the specified value. The manufacturer code is one of the fields of the node descriptor.
Command Parameters: None
Response Parameters:
uint16_t codeThe manufacturer code for the local node.

Name: setPowerDescriptorID: 0x0016
Description: Sets the power descriptor to the specified value. The power descriptor is a dynamic value. Therefore, you should call this function whenever the value changes.
Command Parameters:
uint16_t descriptorThe new power descriptor for the local node.
Response Parameters:
sl_status_t status

Name: networkInitID: 0x0017
Description: Resume network operation after a reboot. The node retains its original type. This should be called on startup whether or not the node was previously part of a network. SL_STATUS_NOT_JOINED is returned if the node is not part of a network. This command accepts options to control the network initialization.
Command Parameters:
sl_zigbee_network_init_struct_t networkInitStructAn sl_zigbee_network_init_struct_t containing the options for initialization.
Response Parameters:
sl_status_t statusAn 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.

Name: networkStateID: 0x0018
Description: Returns a value indicating whether the node is joining, joined to, or leaving a network.
Command Parameters: None
Response Parameters:
sl_zigbee_network_status_t statusAn sl_zigbee_network_status_t value indicating the current join status.

Name: stackStatusHandlerID: 0x0019
Description: A callback invoked when the status of the stack changes. If the status parameter equals SL_STATUS_NETWORK_UP, then the getNetworkParameters command can be called to obtain the new network parameters. If any of the parameters are being stored in nonvolatile memory by the Host, the stored values should be updated.
This frame is a response to the callback command.
Response Parameters:
sl_status_t statusStack status

Name: startScanID: 0x001A
Description: This function will start a scan.
Command Parameters:
sl_zigbee_ezsp_network_scan_type_t scanTypeIndicates the type of scan to be performed. Possible values are: SL_ZIGBEE_EZSP_ENERGY_SCAN and SL_ZIGBEE_EZSP_ACTIVE_SCAN. For each type, the respective callback for reporting results is: energyScanResultHandler and networkFoundHandler. The energy scan and active scan report errors and completion via the scanCompleteHandler.
uint32_t channelMaskBits set as 1 indicate that this particular channel should be scanned. Bits set to 0 indicate that this particular channel should not be scanned. For example, a channelMask value of 0x00000001 would indicate that only channel 0 should be scanned. Valid channels range from 11 to 26 inclusive. This translates to a channel mask value of 0x07FFF800. As a convenience, a value of 0 is reinterpreted as the mask for the current channel.
uint8_t durationSets the exponent of the number of scan periods, where a scan period is 960 symbols. The scan will occur for ((2^duration) + 1) scan periods.
Response Parameters:
sl_status_t statusSL_STATUS_OK signals that the scan successfully started. Possible error responses and their meanings: SL_STATUS_MAC_SCANNING, we are already scanning; SL_STATUS_BAD_SCAN_DURATION, we have set a duration value that is not 0..14 inclusive; SL_STATUS_MAC_INCORRECT_SCAN_TYPE, we have requested an undefined scanning type; SL_STATUS_INVALID_CHANNEL_MASK, our channel mask did not specify any valid channels.

Name: energyScanResultHandlerID: 0x0048
Description: Reports the result of an energy scan for a single channel. The scan is not complete until the scanCompleteHandler callback is called.
This frame is a response to the callback command.
Response Parameters:
uint8_t channelThe 802.15.4 channel number that was scanned.
int8_t maxRssiValueThe maximum RSSI value found on the channel.

Name: networkFoundHandlerID: 0x001B
Description: Reports that a network was found as a result of a prior call to startScan. Gives the network parameters useful for deciding which network to join.
This frame is a response to the callback command.
Response Parameters:
sl_zigbee_zigbee_network_t networkFoundThe parameters associated with the network found.
uint8_t lastHopLqiLink quality of incoming packet from network.
int8_t lastHopRssiPower (in dBm) of incoming packet.

Name: scanCompleteHandlerID: 0x001C
Description: Returns the status of the current scan of type SL_ZIGBEE_EZSP_ENERGY_SCAN or SL_ZIGBEE_EZSP_ACTIVE_SCAN. SL_STATUS_OK signals that the scan has completed. Other error conditions signify a failure to scan on the channel specified.
This frame is a response to the callback command.
Response Parameters:
uint8_t channelThe channel on which the current error occurred. Undefined for the case of SL_STATUS_OK.
sl_status_t statusThe error condition that occurred on the current channel. Value will be SL_STATUS_OK when the scan has completed.

Name: unusedPanIdFoundHandlerID: 0x00D2
Description: This function returns an unused panID and channel pair found via the find unused panId scan procedure.
This frame is a response to the callback command.
Response Parameters:
sl_802154_pan_id_t panIdThe unused panID which has been found.
uint8_t channelThe channel that the unused panID was found on.

Name: findUnusedPanIdID: 0x00D3
Description: This function starts a series of scans which will return an available panId.
Command Parameters:
uint32_t channelMaskThe channels that will be scanned for available panIds.
uint8_t durationThe duration of the procedure.
Response Parameters:
sl_status_t statusThe error condition that occurred during the scan. Value will be SL_STATUS_OK if there are no errors.

Name: stopScanID: 0x001D
Description: Terminates a scan in progress.
Command Parameters: None
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: formNetworkID: 0x001E
Description: Forms a new network by becoming the coordinator.
Command Parameters:
sl_zigbee_network_parameters_t parametersSpecification of the new network.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: joinNetworkID: 0x001F
Description: Causes 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 the stackStatusHandler callback informs you that the stack is up.
Command Parameters:
sl_zigbee_node_type_t nodeTypeSpecification of the role that this node will have in the network. This role must not be SL_ZIGBEE_COORDINATOR. To be a coordinator, use the formNetwork command.
sl_zigbee_network_parameters_t parametersSpecification of the network with which the node should associate.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: joinNetworkDirectlyID: 0x003B
Description: Causes 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 the stackStatusHandler callback informs you that the stack is up. Unlike ::sli_zigbee_stack_join_network(), this function does not issue an active scan before joining. Instead, it 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. (For more information, see sli_zigbee_stack_get_stored_beacon.)
Command Parameters:
sl_zigbee_node_type_t localNodeTypeSpecifies the role that this node will have in the network. This role must not be SL_ZIGBEE_COORDINATOR. To be a coordinator, use the formNetwork command.
sl_zigbee_beacon_data_t beaconSpecifies the network with which the node should associate.
int8_t radioTxPowerThe radio transmit power to use, specified in dBm.
bool clearBeaconsAfterNetworkUpIf true, clear beacons in cache upon join success. If join fail, do nothing.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: leaveNetworkID: 0x0020
Description: Causes the stack to leave the current network. This generates a stackStatusHandler callback to indicate that the network is down. The radio will not be used until after sending a formNetwork or joinNetwork command.
Command Parameters:
sl_zigbee_leave_network_option_t optionsThis parameter gives options when leave network
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: findAndRejoinNetworkID: 0x0021
Description: The application may call this function when contact with the network has been lost. The most common usage 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.

The stack will call sl_zigbee_ezsp_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_ezsp_stack_status_handler callback indicates either the success or the failure of the attempt. The process takes approximately 150 milliseconds per channel to complete.

Command Parameters:
bool haveCurrentNetworkKeyThis parameter tells the stack whether to try to use the current network key. If it has the current network key it will perform a secure rejoin (encrypted). If this fails the device should try an unsecure rejoin. If the Trust Center allows the rejoin then the current Network Key will be sent encrypted using the device's Link Key.
uint32_t channelMaskA mask indicating the channels to be scanned. See sli_zigbee_stack_start_scan for format details. A value of 0 is reinterpreted as the mask for the current channel.
uint8_t reasonA sl_zigbee_rejoin_reason_t variable which could be passed in if there is actually a reason for rejoin, or could be left at 0xFF
uint8_t nodeTypeThe rejoin could be triggered with a different nodeType. This value could be set to 0 or SL_ZIGBEE_DEVICE_TYPE_UNCHANGED if not needed.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: permitJoiningID: 0x0022
Description: Tells the stack to allow other nodes to join the network with this node as their parent. Joining is initially disabled by default.
Command Parameters:
uint8_t durationA value of 0x00 disables joining. A value of 0xFF enables joining. Any other value enables joining for that number of seconds.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: childJoinHandlerID: 0x0023
Description: Indicates that a child has joined or left.
This frame is a response to the callback command.
Response Parameters:
uint8_t indexThe index of the child of interest.
bool joiningTrue if the child is joining. False the child is leaving.
sl_802154_short_addr_t childIdThe node ID of the child.
sl_802154_long_addr_t childEui64The EUI64 of the child.
sl_zigbee_node_type_t childTypeThe node type of the child.

Name: energyScanRequestID: 0x009C
Description: Sends a ZDO energy scan request. This request may only be sent by the current network manager and must be unicast, not broadcast. See ezsp-utils.h for related macros sli_zigbee_stack_set_network_manager_request() and sl_zigbee_change_channel_request().
Command Parameters:
sl_802154_short_addr_t targetThe network address of the node to perform the scan.
uint32_t scanChannelsA mask of the channels to be scanned
uint8_t scanDurationHow long to scan on each channel. Allowed values are 0..5, with the scan times as specified by 802.15.4 (0 = 31ms, 1 = 46ms, 2 = 77ms, 3 = 138ms, 4 = 261ms, 5 = 507ms).
uint16_t scanCountThe number of scans to be performed on each channel (1..8).
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: getNetworkParametersID: 0x0028
Description: Returns the current network parameters.
Command Parameters: None
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.
sl_zigbee_node_type_t nodeTypeAn sl_zigbee_node_type_t value indicating the current node type.
sl_zigbee_network_parameters_t parametersThe current network parameters.

Name: getRadioParametersID: 0x00FD
Description: Returns the current radio parameters based on phy index.
Command Parameters:
uint8_t phyIndexDesired index of phy interface for radio parameters.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.
sl_zigbee_multi_phy_radio_parameters_t parametersThe current radio parameters based on provided phy index.

Name: getParentChildParametersID: 0x0029
Description: Returns information about the children of the local node and the parent of the local node.
Command Parameters: None
Response Parameters:
uint8_t childCountThe number of children the node currently has.
sl_802154_long_addr_t parentEui64The parent's EUI64. The value is undefined for nodes without parents (coordinators and nodes that are not joined to a network).
sl_802154_short_addr_t parentNodeIdThe parent's node ID. The value is undefined for nodes without parents (coordinators and nodes that are not joined to a network).

Name: routerChildCountID: 0x013B
Description: Return the number of router children that the node currently has.
Command Parameters: None
Response Parameters:
uint8_t routerChildCountThe number of router children.

Name: maxChildCountID: 0x013C
Description: Return the maximum number of children for this node. The return value is undefined for nodes that are not joined to a network.
Command Parameters: None
Response Parameters:
uint8_t maxChildCountThe maximum number of children.

Name: maxRouterChildCountID: 0x013D
Description: Return the maximum number of router children for this node. The return value is undefined for nodes that are not joined to a network.
Command Parameters: None
Response Parameters:
uint8_t maxRouterChildCountThe maximum number of router children.

Name: getParentIncomingNwkFrameCounterID: 0x013E
Command Parameters: None
Response Parameters:
uint32_t parentIncomingNwkFrameCounter

Name: setParentIncomingNwkFrameCounterID: 0x013F
Command Parameters:
uint32_t value
Response Parameters:
sl_status_t status

Name: currentStackTasksID: 0x0145
Description: Return a bitmask indicating the stack's current tasks. The mask ::SL_ZIGBEE_HIGH_PRIORITY_TASKS defines which tasks are high priority. Devices should not sleep if any high priority tasks are active. Active tasks that are not high priority are waiting for messages to arrive from other devices. If there are active tasks, but no high priority ones, the device may sleep but should periodically wake up and call ::emberPollForData() in order to receive messages. Parents will hold messages for ::SL_ZIGBEE_INDIRECT_TRANSMISSION_TIMEOUT milliseconds before discarding them.
Command Parameters: None
Response Parameters:
uint16_t activeTasksA bitmask of the stack's active tasks.

Name: okToNapID: 0x0146
Description: Indicate whether the stack is currently in a state where there are no high-priority tasks, allowing the device to sleep. There may be tasks expecting incoming messages, in which case the device should periodically wake up and call ::emberPollForData() in order to receive messages. This function can only be called when the node type is ::SL_ZIGBEE_SLEEPY_END_DEVICE
Command Parameters: None
Response Parameters:
bool valueTrue if the application may sleep but the stack may be expecting incoming messages.

Name: parentTokenSetID: 0x0140
Description: Indicate whether the parent token has been set by association.
Command Parameters: None
Response Parameters:
bool indicatorTrue if the parent token has been set.

Name: okToHibernateID: 0x0141
Description: Indicate whether the stack currently has any tasks pending. If no tasks are pending, ::emberTick() does not need to be called until the next time a stack API function is called. This function can only be called when the node type is ::SL_ZIGBEE_SLEEPY_END_DEVICE.
Command Parameters: None
Response Parameters:
bool indicatorTrue if the application may sleep for as long as it wishes.

Name: okToLongPollID: 0x0142
Description: Indicate whether the stack is currently in a state that does not require the application to periodically poll.
Command Parameters: None
Response Parameters:
bool indicatorTrue if the device may poll less frequently.

Name: stackPowerDownID: 0x0143
Description: Calling this function will render all other stack functions except sli_zigbee_stack_stack_power_up() non-functional until the radio is powered back on.
Command Parameters: None
Response Parameters: None

Name: stackPowerUpID: 0x0144
Description: Initialize the radio. Typically called coming out of deep sleep. For non-sleepy devices, also turns the radio on and leaves it in RX mode.
Command Parameters: None
Response Parameters: None

Name: getChildDataID: 0x004A
Description: Returns information about a child of the local node.
Command Parameters:
uint8_t indexThe index of the child of interest in the child table. Possible indexes range from zero to SL_ZIGBEE_CHILD_TABLE_SIZE.
Response Parameters:
sl_status_t statusSL_STATUS_OK if there is a child at index. SL_STATUS_NOT_JOINED if there is no child at index.
sl_zigbee_child_data_t childDataThe data of the child.

Name: setChildDataID: 0x00AC
Description: Sets child data to the child table token.
Command Parameters:
uint8_t indexThe index of the child of interest in the child table. Possible indexes range from zero to (SL_ZIGBEE_CHILD_TABLE_SIZE - 1).
sl_zigbee_child_data_t childDataThe data of the child.
Response Parameters:
sl_status_t statusSL_STATUS_OK if the child data is set successfully at index. SL_STATUS_INVALID_INDEX if provided index is out of range.

Name: childIdID: 0x0106
Description: Convert a child index to a node ID
Command Parameters:
uint8_t childIndexThe index of the child of interest in the child table. Possible indexes range from zero to SL_ZIGBEE_CHILD_TABLE_SIZE.
Response Parameters:
sl_802154_short_addr_t childIdThe node ID of the child or SL_ZIGBEE_NULL_NODE_ID if there isn't a child at the childIndex specified

Name: childPowerID: 0x0134
Description: Return radio power value of the child from the given childIndex
Command Parameters:
uint8_t childIndexThe index of the child of interest in the child table. Possible indexes range from zero to SL_ZIGBEE_CHILD_TABLE_SIZE.
Response Parameters:
int8_t childPowerThe power of the child or maximum radio power, which is the power value provided by the user while forming/joining a network if there isn't a child at the childIndex specified

Name: setChildPowerID: 0x0135
Description: Set the radio power value for a given child index.
Command Parameters:
uint8_t childIndexThe index.
int8_t newPowerThe new power value.
Response Parameters: None

Name: childIndexID: 0x0107
Description: Convert a node ID to a child index
Command Parameters:
sl_802154_short_addr_t childIdThe node ID of the child
Response Parameters:
uint8_t childIndexThe child index or 0xFF if the node ID doesn't belong to a child

Name: getSourceRouteTableTotalSizeID: 0x00C3
Description: Returns the source route table total size.
Command Parameters: None
Response Parameters:
uint8_t sourceRouteTableTotalSizeTotal size of source route table.

Name: getSourceRouteTableFilledSizeID: 0x00C2
Description: Returns the number of filled entries in source route table.
Command Parameters: None
Response Parameters:
uint8_t sourceRouteTableFilledSizeThe number of filled entries in source route table.

Name: getSourceRouteTableEntryID: 0x00C1
Description: Returns information about a source route table entry
Command Parameters:
uint8_t indexThe index of the entry of interest in the source route table. Possible indexes range from zero to SOURCE_ROUTE_TABLE_FILLED_SIZE.
Response Parameters:
sl_status_t statusSL_STATUS_OK if there is source route entry at index. SL_STATUS_NOT_FOUND if there is no source route at index.
sl_802154_short_addr_t destinationThe node ID of the destination in that entry.
uint8_t closerIndexThe closer node index for this source route table entry

Name: getNeighborID: 0x0079
Description: Returns the neighbor table entry at the given index. The number of active neighbors can be obtained using the neighborCount command.
Command Parameters:
uint8_t indexThe index of the neighbor of interest. Neighbors are stored in ascending order by node id, with all unused entries at the end of the table.
Response Parameters:
sl_status_t statusSL_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_neighbor_table_entry_t valueThe contents of the neighbor table entry.

Name: getNeighborFrameCounterID: 0x003E
Description: Return sl_status_t depending on whether the frame counter of the node is found in the neighbor or child table. This function gets the last received frame counter as found in the Network Auxiliary header for the specified neighbor or child
Command Parameters:
sl_802154_long_addr_t eui64eui64 of the node
Response Parameters:
sl_status_t statusReturn SL_STATUS_NOT_FOUND if the node is not found in the neighbor or child table. Returns SL_STATUS_OK otherwise
uint32_t returnFrameCounterReturn the frame counter of the node from the neighbor or child table

Name: setNeighborFrameCounterID: 0x00AD
Description: Sets the frame counter for the neighbour or child.
Command Parameters:
sl_802154_long_addr_t eui64eui64 of the node
uint32_t frameCounterReturn the frame counter of the node from the neighbor or child table
Response Parameters:
sl_status_t statusReturn SL_STATUS_NOT_FOUND if the node is not found in the neighbor or child table. Returns SL_STATUS_OK otherwise

Name: setRoutingShortcutThresholdID: 0x00D0
Description: Sets the routing shortcut threshold to directly use a neighbor instead of performing routing.
Command Parameters:
uint8_t costThreshThe routing shortcut threshold to configure.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: getRoutingShortcutThresholdID: 0x00D1
Description: Gets the routing shortcut threshold used to differentiate between directly using a neighbor vs. performing routing.
Command Parameters: None
Response Parameters:
uint8_t routingShortcutThreshThe routing shortcut threshold

Name: neighborCountID: 0x007A
Description: Returns the number of active entries in the neighbor table.
Command Parameters: None
Response Parameters:
uint8_t valueThe number of active entries in the neighbor table.

Name: getRouteTableEntryID: 0x007B
Description: Returns the route table entry at the given index. The route table size can be obtained using the getConfigurationValue command.
Command Parameters:
uint8_t indexThe index of the route table entry of interest.
Response Parameters:
sl_status_t statusSL_STATUS_FAIL if the index is out of range or the device is an end device, and SL_STATUS_OK otherwise.
sl_zigbee_route_table_entry_t valueThe contents of the route table entry.

Name: setRadioPowerID: 0x0099
Description: Sets the radio output power 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. Note: Care should be taken when using this API on a running network, as it will directly impact the established link qualities neighboring nodes have with the node on which it is called. This can lead to disruption of existing routes and erratic network behavior.
Command Parameters:
int8_t powerDesired radio output power, in dBm.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating the success or failure of the command.

Name: setRadioChannelID: 0x009A
Description: Sets the channel to use for sending and receiving messages. For a list of available radio channels, see the technical specification for the RF communication module in your Developer Kit. Note: Care should be taken when using this API, as all devices on a network must use the same channel.
Command Parameters:
uint8_t channelDesired radio channel.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating the success or failure of the command.

Name: getRadioChannelID: 0x00FF
Description: Gets the channel in use for sending and receiving messages.
Command Parameters: None
Response Parameters:
uint8_t channelCurrent radio channel.

Name: setRadioIeee802154CcaModeID: 0x0095
Description: Set the configured 802.15.4 CCA mode in the radio.
Command Parameters:
uint8_t ccaModeA RAIL_IEEE802154_CcaMode_t value.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating the success or failure of the command.

Name: setConcentratorID: 0x0010
Description: Enable/disable concentrator support.
Command Parameters:
bool onIf this bool is true the concentrator support is enabled. Otherwise is disabled. If this bool is false all the other arguments are ignored.
uint16_t concentratorTypeMust be either SL_ZIGBEE_HIGH_RAM_CONCENTRATOR or SL_ZIGBEE_LOW_RAM_CONCENTRATOR. The former is used when the caller has enough memory to store source routes for the whole network. In that case, remote nodes stop sending route records once the concentrator has successfully received one. The latter is used when the concentrator has insufficient RAM to store all outbound source routes. In that case, route records are sent to the concentrator prior to every inbound APS unicast.
uint16_t minTimeThe minimum amount of time that must pass between MTORR broadcasts.
uint16_t maxTimeThe maximum amount of time that can pass between MTORR broadcasts.
uint8_t routeErrorThresholdThe number of route errors that will trigger a re-broadcast of the MTORR.
uint8_t deliveryFailureThresholdThe number of APS delivery failures that will trigger a re-broadcast of the MTORR.
uint8_t maxHopsThe maximum number of hops that the MTORR broadcast will be allowed to have. A value of 0 will be converted to the SL_ZIGBEE_MAX_HOPS value set by the stack.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: concentratorStartDiscoveryID: 0x014F
Description: Starts periodic many-to-one route discovery. Periodic discovery is started by default on bootup, but this function may be used if discovery has been stopped by a call to ::emberConcentratorStopDiscovery().
Command Parameters: None
Response Parameters: None

Name: concentratorStopDiscoveryID: 0x0150
Description: Stops periodic many-to-one route discovery.
Command Parameters: None
Response Parameters: None

Name: concentratorNoteRouteErrorID: 0x0151
Description: Notes when a route error has occurred.
Command Parameters:
sl_status_t status
sl_802154_short_addr_t nodeId
Response Parameters: None

Name: setBrokenRouteErrorCodeID: 0x0011
Description: Sets the error code that is sent back from a router with a broken route.
Command Parameters:
uint8_t errorCodeDesired error code.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating the success or failure of the command.

Name: multiPhyStartID: 0x00F8
Description: This causes to initialize the desired radio interface other than native and form a new network by becoming the coordinator with same panId as native radio network.
Command Parameters:
uint8_t phyIndexIndex of phy interface. The native phy index would be always zero hence valid phy index starts from one.
uint8_t pageDesired radio channel page.
uint8_t channelDesired radio channel.
int8_t powerDesired radio output power, in dBm.
sl_zigbee_multi_phy_nwk_config_t bitmaskNetwork configuration bitmask.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: multiPhyStopID: 0x00F9
Description: This causes to bring down the radio interface other than native.
Command Parameters:
uint8_t phyIndexIndex of phy interface. The native phy index would be always zero hence valid phy index starts from one.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: multiPhySetRadioPowerID: 0x00FA
Description: Sets the radio output power for desired phy interface 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. Note: Care should be taken when using this api on a running network, as it will directly impact the established link qualities neighboring nodes have with the node on which it is called. This can lead to disruption of existing routes and erratic network behavior.
Command Parameters:
uint8_t phyIndexIndex of phy interface. The native phy index would be always zero hence valid phy index starts from one.
int8_t powerDesired radio output power, in dBm.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating the success or failure of the command.

Name: sendLinkPowerDeltaRequestID: 0x00F7
Description: Send Link Power Delta Request from a child to its parent
Command Parameters: None
Response Parameters:
sl_status_t statusAn sl_status_t value indicating the success or failure of sending the request.

Name: multiPhySetRadioChannelID: 0x00FB
Description: Sets the channel for desired phy interface to use for sending and receiving messages. For a list of available radio pages and channels, see the technical specification for the RF communication module in your Developer Kit. Note: Care should be taken when using this API, as all devices on a network must use the same page and channel.
Command Parameters:
uint8_t phyIndexIndex of phy interface. The native phy index would be always zero hence valid phy index starts from one.
uint8_t pageDesired radio channel page.
uint8_t channelDesired radio channel.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating the success or failure of the command.

Name: getDutyCycleStateID: 0x0035
Description: Obtains the current duty cycle state.
Command Parameters: None
Response Parameters:
sl_status_t statusAn sl_status_t value indicating the success or failure of the command.
sl_zigbee_duty_cycle_state_t returnedStateThe current duty cycle state in effect.

Name: setDutyCycleLimitsInStackID: 0x0040
Description: Set the current duty cycle limits configuration. The Default limits set by stack if this call is not made.
Command Parameters:
sl_zigbee_duty_cycle_limits_t limitsThe duty cycle limits configuration to utilize.
Response Parameters:
sl_status_t statusSL_STATUS_OK if the duty cycle limit configurations set successfully, SL_STATUS_INVALID_PARAMETER if set illegal value such as setting only one of the limits to default or violates constraints Susp > Crit > Limi, SL_STATUS_INVALID_STATE if device is operating on 2.4Ghz

Name: getDutyCycleLimitsID: 0x004B
Description: Obtains the current duty cycle limits that were previously set by a call to sli_zigbee_stack_set_duty_cycle_limits_in_stack(), or the defaults set by the stack if no set call was made.
Command Parameters: None
Response Parameters:
sl_status_t statusAn sl_status_t value indicating the success or failure of the command.
sl_zigbee_duty_cycle_limits_t returnedLimitsReturn current duty cycle limits if returnedLimits is not NULL

Name: getCurrentDutyCycleID: 0x004C
Description: Returns the duty cycle of the stack's connected children that are being monitored, up to maxDevices. It indicates the amount of overall duty cycle they have consumed (up to the suspend limit). The first entry is always the local stack's nodeId, and thus the total aggregate duty cycle for the device. The passed pointer arrayOfDeviceDutyCycles MUST have space for maxDevices.
Command Parameters:
uint8_t maxDevicesNumber of devices to retrieve consumed duty cycle.
Response Parameters:
sl_status_t statusSL_STATUS_OK if the duty cycles were read successfully, SL_STATUS_INVALID_PARAMETER maxDevices is greater than SL_ZIGBEE_MAX_END_DEVICE_CHILDREN + 1.
uint8_t[134] arrayOfDeviceDutyCyclesConsumed duty cycles up to maxDevices. When the number of children that are being monitored is less than maxDevices, the sl_802154_short_addr_t element in the sl_zigbee_per_device_duty_cycle_t will be 0xFFFF.

Name: dutyCycleHandlerID: 0x004D
Description: Callback fires when the duty cycle state has changed
This frame is a response to the callback command.
Response Parameters:
uint8_t channelPageThe channel page whose duty cycle state has changed.
uint8_t channelThe channel number whose duty cycle state has changed.
sl_zigbee_duty_cycle_state_t stateThe current duty cycle state.
uint8_t totalDevicesThe total number of connected end devices that are being monitored for duty cycle.
sl_zigbee_per_device_duty_cycle_t arrayOfDeviceDutyCyclesConsumed duty cycles of end devices that are being monitored. The first entry always be the local stack's nodeId, and thus the total aggregate duty cycle for the device.

Name: setNumBeaconsToStoreID: 0x0037
Description: Configure the number of beacons to store when issuing active scans for networks.
Command Parameters:
uint8_t numBeaconsThe number of beacons to cache when scanning.
Response Parameters:
sl_status_t statusSL_STATUS_INVALID_PARAMETER if numBeacons is greater than SL_ZIGBEE_MAX_BEACONS_TO_STORE, otherwise SL_STATUS_OK

Name: getStoredBeaconID: 0x0004
Description: Fetches the specified beacon in the cache. Beacons are stored in cache after issuing an active scan.
Command Parameters:
uint8_t beacon_numberThe beacon index to fetch. Valid values range from 0 to sli_zigbee_stack_get_num_stored_beacons-1.
Response Parameters:
sl_status_t statusAn appropriate sl_status_t status code.
sl_zigbee_beacon_data_t beaconThe beacon to populate upon success.

Name: getNumStoredBeaconsID: 0x0008
Description: Returns the number of cached beacons that have been collected from a scan.
Command Parameters: None
Response Parameters:
uint8_t numBeaconsThe number of cached beacons that have been collected from a scan.

Name: clearStoredBeaconsID: 0x003C
Description: Clears all cached beacons that have been collected from a scan.
Command Parameters: None
Response Parameters:
sl_status_t status

Name: setLogicalAndRadioChannelID: 0x00B9
Description: This call sets the radio channel in the stack and propagates the information to the hardware.
Command Parameters:
uint8_t radioChannelThe radio channel to be set.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: sleepyToSleepyNetworkStartID: 0x0119
Description: Form a new sleepy-to-sleepy network. If the network is using security, the device must call sli_zigbee_stack_set_initial_security_state() first.
Command Parameters:
sl_zigbee_network_parameters_t parametersSpecification of the new network.
bool initiatorWhether this device is initiating or joining the network.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or a reason for failure.

Name: sendZigbeeLeaveID: 0x011A
Description: Send a Zigbee NWK Leave command to the destination.
Command Parameters:
sl_802154_pan_id_t destinationNode ID of the device being told to leave.
sl_zigbee_leave_request_flags_t flagsBitmask indicating additional considerations for the leave request.
Response Parameters:
sl_status_t statusStatus indicating success or a reason for failure. Call is invalid if destination is on network or is the local node.

Name: getPermitJoiningID: 0x011F
Description: Indicate the state of permit joining in MAC.
Command Parameters: None
Response Parameters:
bool joiningPermittedWhether the current network permits joining.

Name: getExtendedPanIdID: 0x0127
Description: Get the 8-byte extended PAN ID of this node.
Command Parameters: None
Response Parameters:
uint8_t[8] extendedPanIdExtended PAN ID of this node. Valid only if it is currently on a network.

Name: getCurrentNetworkID: 0x014E
Description: Get the current network.
Command Parameters: None
Response Parameters:
uint8_t indexReturn the current network index.

Name: setInitialNeighborOutgoingCostID: 0x0122
Description: Set initial outgoing link cost for neighbor.
Command Parameters:
uint8_t costThe new default cost. Valid values are 0, 1, 3, 5, and 7.
Response Parameters:
sl_status_t statusWhether or not initial cost was successfully set.

Name: getInitialNeighborOutgoingCostID: 0x0123
Description: Get initial outgoing link cost for neighbor.
Command Parameters: None
Response Parameters:
uint8_t costThe default cost associated with new neighbor's outgoing links.

Name: resetRejoiningNeighborsFrameCounterID: 0x0124
Description: Indicate whether a rejoining neighbor should have its incoming frame counter reset.
Command Parameters:
bool resetWhether or not a neighbor's incoming FC should be reset upon rejoining (true or false).
Response Parameters: None

Name: isResetRejoiningNeighborsFrameCounterEnabledID: 0x0125
Description: Check whether a rejoining neighbor will have its incoming frame counter reset based on the currently set policy.
Command Parameters: None
Response Parameters:
bool getsResetWhether or not a rejoining neighbor's incoming FC gets reset (true or false).

Binding Frames

Name: clearBindingTableID: 0x002A
Description: Deletes all binding table entries.
Command Parameters: None
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: setBindingID: 0x002B
Description: Sets an entry in the binding table.
Command Parameters:
uint8_t indexThe index of a binding table entry.
sl_zigbee_binding_table_entry_t valueThe contents of the binding entry.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: getBindingID: 0x002C
Description: Gets an entry from the binding table.
Command Parameters:
uint8_t indexThe index of a binding table entry.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.
sl_zigbee_binding_table_entry_t valueThe contents of the binding entry.

Name: deleteBindingID: 0x002D
Description: Deletes a binding table entry.
Command Parameters:
uint8_t indexThe index of a binding table entry.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: bindingIsActiveID: 0x002E
Description: Indicates whether any messages are currently being sent using this binding table entry. Note that this command does not indicate whether a binding is clear. To determine whether a binding is clear, check whether the type field of the sl_zigbee_binding_table_entry_t has the value SL_ZIGBEE_UNUSED_BINDING.
Command Parameters:
uint8_t indexThe index of a binding table entry.
Response Parameters:
bool activeTrue if the binding table entry is active, false otherwise.

Name: getBindingRemoteNodeIdID: 0x002F
Description: Returns the node ID for the binding's destination, if the ID is known. If a message is sent using the binding and the destination's ID is not known, the stack will discover the ID by broadcasting a ZDO address request. The application can avoid the need for this discovery by using setBindingRemoteNodeId when it knows the correct ID via some other means. The destination's node ID is forgotten when the binding is changed, when the local node reboots or, much more rarely, when the destination node changes its ID in response to an ID conflict.
Command Parameters:
uint8_t indexThe index of a binding table entry.
Response Parameters:
sl_802154_short_addr_t nodeIdThe short ID of the destination node or SL_ZIGBEE_NULL_NODE_ID if no destination is known.

Name: setBindingRemoteNodeIdID: 0x0030
Description: Set the node ID for the binding's destination. See getBindingRemoteNodeId for a description.
Command Parameters:
uint8_t indexThe index of a binding table entry.
sl_802154_short_addr_t nodeIdThe short ID of the destination node.
Response Parameters: None

Name: remoteSetBindingHandlerID: 0x0031
Description: The NCP used the external binding modification policy to decide how to handle a remote set binding request. The Host cannot change the current decision, but it can change the policy for future decisions using the setPolicy command.
This frame is a response to the callback command.
Response Parameters:
sl_zigbee_binding_table_entry_t entryThe requested binding.
uint8_t indexThe index at which the binding was added.
sl_status_t policyDecisionSL_STATUS_OK if the binding was added to the table and any other status if not.

Name: remoteDeleteBindingHandlerID: 0x0032
Description: The NCP used the external binding modification policy to decide how to handle a remote delete binding request. The Host cannot change the current decision, but it can change the policy for future decisions using the setPolicy command.
This frame is a response to the callback command.
Response Parameters:
uint8_t indexThe index of the binding whose deletion was requested.
sl_status_t policyDecisionSL_STATUS_OK if the binding was removed from the table and any other status if not.

Messaging Frames

Name: maximumPayloadLengthID: 0x0033
Description: Returns the maximum size of the payload. The size depends on the security level in use.
Command Parameters: None
Response Parameters:
uint8_t apsLengthThe maximum APS payload length.

Name: sendUnicastID: 0x0034
Description: Sends a unicast message as per the ZigBee specification. The message will arrive at its destination only if there is a known route to the destination node. Setting the ENABLE_ROUTE_DISCOVERY option will cause a route to be discovered if none is known. Setting the FORCE_ROUTE_DISCOVERY option will force route discovery. Routes to end-device children of the local node are always known. Setting the APS_RETRY option will cause the message to be retransmitted until either a matching acknowledgement is received or three transmissions have been made. Note: Using the FORCE_ROUTE_DISCOVERY option will cause the first transmission to be consumed by a route request as part of discovery, so the application payload of this packet will not reach its destination on the first attempt. If you want the packet to reach its destination, the APS_RETRY option must be set so that another attempt is made to transmit the message with its application payload after the route has been constructed. Note: When sending fragmented messages, the stack will only assign a new APS sequence number for the first fragment of the message (i.e., SL_ZIGBEE_APS_OPTION_FRAGMENT is set and the low-order byte of the groupId field in the APS frame is zero). For all subsequent fragments of the same message, the application must set the sequence number field in the APS frame to the sequence number assigned by the stack to the first fragment.
Command Parameters:
sl_zigbee_outgoing_message_type_t typeSpecifies the outgoing message type. Must be one of SL_ZIGBEE_OUTGOING_DIRECT, SL_ZIGBEE_OUTGOING_VIA_ADDRESS_TABLE, or SL_ZIGBEE_OUTGOING_VIA_BINDING.
sl_802154_short_addr_t indexOrDestinationDepending on the type of addressing used, this is either the sl_802154_short_addr_t of the destination, an index into the address table, or an index into the binding table.
sl_zigbee_aps_frame_t apsFrameThe APS frame which is to be added to the message.
uint16_t messageTagA value chosen by the Host. This value is used in the sl_zigbee_ezsp_message_sent_handler response to refer to this message.
uint8_t messageLengthThe length of the messageContents parameter in bytes.
uint8_t[] messageContentsContent of the message.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.
uint8_t sequenceThe sequence number that will be used when this message is transmitted.

Name: sendBroadcastID: 0x0036
Description: Sends a broadcast message as per the ZigBee specification.
Command Parameters:
sl_802154_short_addr_t aliasThe aliased source from which we send the broadcast. This must be SL_ZIGBEE_NULL_NODE_ID if we do not need an aliased source
sl_802154_short_addr_t destinationThe destination to which to send the broadcast. This must be one of the three ZigBee broadcast addresses.
uint8_t nwkSequenceThe alias nwk sequence number. this won't be used if there is no aliased source.
sl_zigbee_aps_frame_t apsFrameThe APS frame for the message.
uint8_t radiusThe message will be delivered to all nodes within radius hops of the sender. A radius of zero is converted to SL_ZIGBEE_MAX_HOPS.
uint16_t messageTagA value chosen by the Host. This value is used in the sl_zigbee_ezsp_message_sent_handler response to refer to this message.
uint8_t messageLengthThe length of the messageContents parameter in bytes.
uint8_t[] messageContentsThe broadcast message.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.
uint8_t apsSequenceThe APS sequence number that will be used when this message is transmitted.

Name: proxyNextBroadcastFromLongID: 0x0066
Description: Sends proxied broadcast message for another node in conjunction with sl_zigbee_proxy_broadcast where a long source is also specified in the NWK frame control.
Command Parameters:
uint8_t[8] euiSourceThe long source from which to send the broadcast
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: sendMulticastID: 0x0038
Description: Sends a multicast message to all endpoints that share a specific multicast ID and are within a specified number of hops of the sender.
Command Parameters:
sl_zigbee_aps_frame_t apsFrameThe APS frame for the message. The multicast will be sent to the groupId in this frame.
uint8_t hopsThe message will be delivered to all nodes within this number of hops of the sender. A value of zero is converted to SL_ZIGBEE_MAX_HOPS.
uint16_t broadcastAddrThe number of hops that the message will be forwarded by devices that are not members of the group. A value of 7 or greater is treated as infinite.
uint16_t aliasThe alias source address
uint8_t nwkSequencethe alias sequence number
uint16_t messageTagA value chosen by the Host. This value is used in the sl_zigbee_ezsp_message_sent_handler response to refer to this message.
uint8_t messageLengthThe length of the messageContents parameter in bytes.
uint8_t[] messageContentsThe multicast message.
Response Parameters:
sl_status_t statusAn sl_status_t value. For any result other than SL_STATUS_OK, the message will not be sent. SL_STATUS_OK - The message has been submitted for transmission. SL_STATUS_INVALID_INDEX - The bindingTableIndex refers to a non-multicast binding. SL_STATUS_NETWORK_DOWN - The node is not part of a network. SL_STATUS_MESSAGE_TOO_LONG - The message is too large to fit in a MAC layer frame. SL_STATUS_ALLOCATION_FAILED - The free packet buffer pool is empty. SL_STATUS_BUSY - Insufficient resources available in Network or MAC layers to send message.
uint8_t sequenceThe sequence number that will be used when this message is transmitted.

Name: sendReplyID: 0x0039
Description: Sends a reply to a received unicast message. The incomingMessageHandler callback for the unicast being replied to supplies the values for all the parameters except the reply itself.
Command Parameters:
sl_802154_short_addr_t senderValue supplied by incoming unicast.
sl_zigbee_aps_frame_t apsFrameValue supplied by incoming unicast.
uint8_t messageLengthThe length of the messageContents parameter in bytes.
uint8_t[] messageContentsThe reply message.
Response Parameters:
sl_status_t statusAn sl_status_t value. SL_STATUS_INVALID_STATE - The SL_ZIGBEE_EZSP_UNICAST_REPLIES_POLICY is set to SL_ZIGBEE_EZSP_HOST_WILL_NOT_SUPPLY_REPLY. This means the NCP will automatically send an empty reply. The Host must change the policy to SL_ZIGBEE_EZSP_HOST_WILL_SUPPLY_REPLY before it can supply the reply. There is one exception to this rule: In the case of responses to message fragments, the host must call sendReply when a message fragment is received. In this case, the policy set on the NCP does not matter. The NCP expects a sendReply call from the Host for message fragments regardless of the current policy settings. SL_STATUS_ALLOCATION_FAILED - Not enough memory was available to send the reply. SL_STATUS_BUSY - Either no route or insufficient resources available. SL_STATUS_OK - The reply was successfully queued for transmission.

Name: messageSentHandlerID: 0x003F
Description: A callback indicating the stack has completed sending a message.
This frame is a response to the callback command.
Response Parameters:
sl_status_t statusAn sl_status_t value of SL_STATUS_OK if an ACK was received from the destination or SL_STATUS_ZIGBEE_DELIVERY_FAILED if no ACK was received.
sl_zigbee_outgoing_message_type_t typeThe type of message sent.
uint16_t indexOrDestinationThe destination to which the message was sent, for direct unicasts, or the address table or binding index for other unicasts. The value is unspecified for multicasts and broadcasts.
sl_zigbee_aps_frame_t apsFrameThe APS frame for the message.
uint16_t messageTagThe value supplied by the Host in the sl_zigbee_ezsp_send_unicast, sl_zigbee_ezsp_send_broadcast or sl_zigbee_ezsp_send_multicast command.
uint8_t messageLengthThe length of the messageContents parameter in bytes.
uint8_t[] messageContentsThe unicast message supplied by the Host. The message contents are only included here if the decision for the messageContentsInCallback policy is messageTagAndContentsInCallback.

Name: sendManyToOneRouteRequestID: 0x0041
Description: Sends a route request packet that creates routes from every node in the network back to this node. This function should be called by an application that wishes to communicate with many nodes, for example, a gateway, central monitor, or controller. A device using this function was referred to as an 'aggregator' in EmberZNet 2.x and earlier, and is referred to as a 'concentrator' in the ZigBee specification and EmberZNet 3.

This function enables large scale networks, because the other devices do not have to individually perform bandwidth-intensive route discoveries. Instead, when a remote node sends an APS unicast to a concentrator, its network layer automatically delivers a special route record packet first, which lists the network ids of all the intermediate relays. The concentrator can then use source routing to send outbound APS unicasts. (A source routed message is one in which the entire route is listed in the network layer header.) This allows the concentrator to communicate with thousands of devices without requiring large route tables on neighboring nodes.

This function is only available in ZigBee Pro (stack profile 2), and cannot be called on end devices. Any router can be a concentrator (not just the coordinator), and there can be multiple concentrators on a network.

Note that a concentrator does not automatically obtain routes to all network nodes after calling this function. Remote applications must first initiate an inbound APS unicast.

Many-to-one routes are not repaired automatically. Instead, the concentrator application must call this function to rediscover the routes as necessary, for example, upon failure of a retried APS message. The reason for this is that there is no scalable one-size-fits-all route repair strategy. A common and recommended strategy is for the concentrator application to refresh the routes by calling this function periodically.

Command Parameters:
uint16_t concentratorTypeMust be either SL_ZIGBEE_HIGH_RAM_CONCENTRATOR or SL_ZIGBEE_LOW_RAM_CONCENTRATOR. The former is used when the caller has enough memory to store source routes for the whole network. In that case, remote nodes stop sending route records once the concentrator has successfully received one. The latter is used when the concentrator has insufficient RAM to store all outbound source routes. In that case, route records are sent to the concentrator prior to every inbound APS unicast.
uint8_t radiusThe maximum number of hops the route request will be relayed. A radius of zero is converted to SL_ZIGBEE_MAX_HOPS
Response Parameters:
sl_status_t statusSL_STATUS_OK if the route request was successfully submitted to the transmit queue, and SL_STATUS_FAIL otherwise.

Name: pollForDataID: 0x0042
Description: Periodically request any pending data from our parent. Setting interval to 0 or units to SL_ZIGBEE_EVENT_INACTIVE will generate a single poll.
Command Parameters:
uint16_t intervalThe time between polls. Note that the timer clock is free running and is not synchronized with this command. This means that the time will be between interval and (interval - 1). The maximum interval is 32767.
sl_zigbee_event_units_t unitsThe units for interval.
uint8_t failureLimitThe number of poll failures that will be tolerated before a pollCompleteHandler callback is generated. A value of zero will result in a callback for every poll. Any status value apart from SL_STATUS_OK and SL_STATUS_MAC_NO_DATA is counted as a failure.
Response Parameters:
sl_status_t statusThe result of sending the first poll.

Name: pollCompleteHandlerID: 0x0043
Description: Indicates the result of a data poll to the parent of the local node.
This frame is a response to the callback command.
Response Parameters:
sl_status_t statusAn sl_status_t value: SL_STATUS_OK - Data was received in response to the poll. SL_STATUS_MAC_NO_DATA - No data was pending. SL_STATUS_ZIGBEE_DELIVERY_FAILED - The poll message could not be sent. SL_STATUS_MAC_NO_ACK_RECEIVED - The poll message was sent but not acknowledged by the parent.

Name: setMessageFlagID: 0x0136
Description: Set a flag to indicate that a message is pending for a child. The next time that the child polls, it will be informed that it has a pending message. The message is sent from emberPollHandler, which is called when the child requests data.
Command Parameters:
sl_802154_short_addr_t childIdThe ID of the child that just polled for data.
Response Parameters:
sl_status_t statusSL_STATUS_OK - The next time that the child polls, it will be informed that it has pending data. SL_STATUS_NOT_JOINED - The child identified by childId is not our child.

Name: clearMessageFlagID: 0x0137
Description: Clear a flag to indicate that there are no more messages for a child. The next time the child polls, it will be informed that it does not have any pending messages.
Command Parameters:
sl_802154_short_addr_t childIdThe ID of the child that no longer has pending messages.
Response Parameters:
sl_status_t statusSL_STATUS_OK - The next time that the child polls, it will be informed that it does not have any pending messages. SL_STATUS_NOT_JOINED - The child identified by childId is not our child.

Name: pollHandlerID: 0x0044
Description: Indicates that the local node received a data poll from a child.
This frame is a response to the callback command.
Response Parameters:
sl_802154_short_addr_t childIdThe node ID of the child that is requesting data.
bool transmitExpectedTrue if transmit is expected, false otherwise.

Name: addChildID: 0x0138
Description: Add a child to the child/neighbor table only on SoC, allowing direct manipulation of these tables by the application. This can affect the network functionality, and needs to be used wisely. If used appropriately, the application can maintain more than the maximum of children provided by the stack.
Command Parameters:
sl_802154_short_addr_t shortIdThe preferred short ID of the node.
sl_802154_long_addr_t longIdThe long ID of the node.
sl_zigbee_node_type_t nodeTypeThe nodetype e.g., SL_ZIGBEE_ROUTER defining, if this would be added to the child table or neighbor table.
Response Parameters:
sl_status_t statusSL_STATUS_OK - This node has been successfully added. SL_STATUS_FAIL - The child was not added to the child/neighbor table.

Name: removeChildID: 0x0139
Description: Remove a node from child/neighbor table only on SoC, allowing direct manipulation of these tables by the application. This can affect the network functionality, and needs to be used wisely.
Command Parameters:
sl_802154_long_addr_t childEui64The long ID of the node.
Response Parameters:
sl_status_t statusSL_STATUS_OK - This node has been successfully removed. SL_STATUS_FAIL - The node was not found in either of the child or neighbor tables.

Name: removeNeighborID: 0x013A
Description: Remove a neighbor from neighbor table only on SoC, allowing direct manipulation of neighbor table by the application. This can affect the network functionality, and needs to be used wisely.
Command Parameters:
sl_802154_short_addr_t shortIdThe short ID of the neighbor.
sl_802154_long_addr_t longIdThe long ID of the neighbor.
Response Parameters: None

Name: incomingMessageHandlerID: 0x0045
Description: A callback indicating a message has been received.
This frame is a response to the callback command.
Response Parameters:
sl_zigbee_incoming_message_type_t typeThe type of the incoming message. One of the following: SL_ZIGBEE_INCOMING_UNICAST, SL_ZIGBEE_INCOMING_UNICAST_REPLY, SL_ZIGBEE_INCOMING_MULTICAST, SL_ZIGBEE_INCOMING_MULTICAST_LOOPBACK, SL_ZIGBEE_INCOMING_BROADCAST, SL_ZIGBEE_INCOMING_BROADCAST_LOOPBACK
sl_zigbee_aps_frame_t apsFrameThe APS frame from the incoming message.
sl_zigbee_rx_packet_info_t packetInfoMiscellanous message information.
uint8_t messageLengthThe length of the message parameter in bytes.
uint8_t[] messageThe incoming message.

Name: setSourceRouteDiscoveryModeID: 0x005A
Description: Sets source route discovery(MTORR) mode to on, off, reschedule
Command Parameters:
uint8_t modeSource route discovery mode: off:0, on:1, reschedule:2
Response Parameters:
uint32_t remainingTimeRemaining time(ms) until next MTORR broadcast if the mode is on, MAX_INT32U_VALUE if the mode is off

Name: incomingManyToOneRouteRequestHandlerID: 0x007D
Description: A callback indicating that a many-to-one route to the concentrator with the given short and long id is available for use.
This frame is a response to the callback command.
Response Parameters:
sl_802154_short_addr_t sourceThe short id of the concentrator.
sl_802154_long_addr_t longIdThe EUI64 of the concentrator.
uint8_t costThe path cost to the concentrator. The cost may decrease as additional route request packets for this discovery arrive, but the callback is made only once.

Name: incomingRouteErrorHandlerID: 0x0080
Description: A callback invoked when a route error message is received. The error indicates that a problem routing to or from the target node was encountered.
This frame is a response to the callback command.
Response Parameters:
sl_status_t statusSL_STATUS_ZIGBEE_SOURCE_ROUTE_FAILURE or SL_STATUS_ZIGBEE_MANY_TO_ONE_ROUTE_FAILURE.
sl_802154_short_addr_t targetThe short id of the remote node.

Name: incomingNetworkStatusHandlerID: 0x00C4
Description: A callback invoked when a network status/route error message is received. The error indicates that there was a problem sending/receiving messages from the target node
This frame is a response to the callback command.
Response Parameters:
uint8_t errorCodeOne byte over-the-air error code from network status message
sl_802154_short_addr_t targetThe short ID of the remote node

Name: incomingRouteRecordHandlerID: 0x0059
Description: Reports the arrival of a route record command frame.
This frame is a response to the callback command.
Response Parameters:
sl_802154_short_addr_t sourceThe source of the route record.
sl_802154_long_addr_t sourceEuiThe EUI64 of the source.
uint8_t lastHopLqiThe link quality from the node that last relayed the route record.
int8_t lastHopRssiThe energy level (in units of dBm) observed during the reception.
uint8_t relayCountThe number of relays in relayList.
uint8_t[] relayListThe route record. Each relay in the list is an uint16_t node ID. The list is passed as uint8_t * to avoid alignment problems.

Name: setSourceRouteID: 0x00AE
Description: Supply a source route for the next outgoing message.
Command Parameters:
sl_802154_short_addr_t destinationThe destination of the source route.
uint8_t relayCountThe number of relays in relayList.
uint16_t[] relayListThe source route.
Response Parameters:
sl_status_t statusSL_STATUS_OK if the source route was successfully stored, and SL_STATUS_ALLOCATION_FAILED otherwise.

Name: unicastCurrentNetworkKeyID: 0x0050
Description: Send the network key to a destination.
Command Parameters:
sl_802154_short_addr_t targetShortThe destination node of the key.
sl_802154_long_addr_t targetLongThe long address of the destination node.
sl_802154_short_addr_t parentShortIdThe parent node of the destination node.
Response Parameters:
sl_status_t statusSL_STATUS_OK if send was successful

Name: addressTableEntryIsActiveID: 0x005B
Description: Indicates whether any messages are currently being sent using this address table entry. Note that this function does not indicate whether the address table entry is unused. To determine whether an address table entry is unused, check the remote node ID. The remote node ID will have the value SL_ZIGBEE_TABLE_ENTRY_UNUSED_NODE_ID when the address table entry is not in use.
Command Parameters:
uint8_t addressTableIndexThe index of an address table entry.
Response Parameters:
bool activeTrue if the address table entry is active, false otherwise.

Name: setAddressTableInfoID: 0x005C
Description: Sets the EUI64 and short ID of an address table entry. Usually the application will not need to set the short ID in the address table. Once the remote EUI64 is set the stack is capable of figuring out the short ID on its own. However, in cases where the application does set the short ID, the application must set the remote EUI64 prior to setting the short ID. This function will also check other address table entries, the child table and the neighbor table to see if the node ID for the given EUI64 is already known. If known then this function will set node ID. If not known it will set the node ID to SL_ZIGBEE_UNKNOWN_NODE_ID.
Command Parameters:
uint8_t addressTableIndexThe index of an address table entry.
sl_802154_long_addr_t eui64The EUI64 to use for the address table entry.
sl_802154_short_addr_t idThe short ID corresponding to the remote node whose EUI64 is stored in the address table at the given index or SL_ZIGBEE_TABLE_ENTRY_UNUSED_NODE_ID which indicates that the entry stored in the address table at the given index is not in use.
Response Parameters:
sl_status_t statusSL_STATUS_OK if the information was successfully set, and SL_STATUS_ZIGBEE_ADDRESS_TABLE_ENTRY_IS_ACTIVE otherwise.

Name: getAddressTableInfoID: 0x005E
Description: Gets the EUI64 and short ID of an address table entry.
Command Parameters:
uint8_t addressTableIndexThe index of an address table entry.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.
sl_802154_short_addr_t nodeIdOne of the following: The short ID corresponding to the remote node whose EUI64 is stored in the address table at the given index. SL_ZIGBEE_UNKNOWN_NODE_ID - Indicates that the EUI64 stored in the address table at the given index is valid but the short ID is currently unknown. SL_ZIGBEE_DISCOVERY_ACTIVE_NODE_ID - Indicates that the EUI64 stored in the address table at the given location is valid and network address discovery is underway. SL_ZIGBEE_TABLE_ENTRY_UNUSED_NODE_ID - Indicates that the entry stored in the address table at the given index is not in use.
sl_802154_long_addr_t eui64The EUI64 of the address table entry is copied to this location.

Name: setExtendedTimeoutID: 0x007E
Description: Tells the stack whether or not the normal interval between retransmissions of a retried unicast message should be increased by SL_ZIGBEE_INDIRECT_TRANSMISSION_TIMEOUT. The interval needs to be increased when sending to a sleepy node so that the message is not retransmitted until the destination has had time to wake up and poll its parent. The stack will automatically extend the timeout: - For our own sleepy children. - When an address response is received from a parent on behalf of its child. - When an indirect transaction expiry route error is received. - When an end device announcement is received from a sleepy node.
Command Parameters:
sl_802154_long_addr_t remoteEui64The address of the node for which the timeout is to be set.
bool extendedTimeouttrue if the retry interval should be increased by SL_ZIGBEE_INDIRECT_TRANSMISSION_TIMEOUT. false if the normal retry interval should be used.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure

Name: getExtendedTimeoutID: 0x007F
Description: Indicates whether or not the stack will extend the normal interval between retransmissions of a retried unicast message by SL_ZIGBEE_INDIRECT_TRANSMISSION_TIMEOUT.
Command Parameters:
sl_802154_long_addr_t remoteEui64The address of the node for which the timeout is to be returned.
Response Parameters:
sl_status_t statusSL_STATUS_OK if the retry interval will be increased by SL_ZIGBEE_INDIRECT_TRANSMISSION_TIMEOUT and SL_STATUS_FAIL if the normal retry interval will be used.

Name: replaceAddressTableEntryID: 0x0082
Description: Replaces the EUI64, short ID and extended timeout setting of an address table entry. The previous EUI64, short ID and extended timeout setting are returned.
Command Parameters:
uint8_t addressTableIndexThe index of the address table entry that will be modified.
sl_802154_long_addr_t newEui64The EUI64 to be written to the address table entry.
sl_802154_short_addr_t newIdOne of the following: The short ID corresponding to the new EUI64. SL_ZIGBEE_UNKNOWN_NODE_ID if the new EUI64 is valid but the short ID is unknown and should be discovered by the stack. SL_ZIGBEE_TABLE_ENTRY_UNUSED_NODE_ID if the address table entry is now unused.
bool newExtendedTimeouttrue if the retry interval should be increased by SL_ZIGBEE_INDIRECT_TRANSMISSION_TIMEOUT. false if the normal retry interval should be used.
Response Parameters:
sl_status_t statusSL_STATUS_OK if the EUI64, short ID and extended timeout setting were successfully modified, and SL_STATUS_ZIGBEE_ADDRESS_TABLE_ENTRY_IS_ACTIVE otherwise.
sl_802154_long_addr_t oldEui64The EUI64 of the address table entry before it was modified.
sl_802154_short_addr_t oldIdOne of the following: The short ID corresponding to the EUI64 before it was modified. SL_ZIGBEE_UNKNOWN_NODE_ID if the short ID was unknown. SL_ZIGBEE_DISCOVERY_ACTIVE_NODE_ID if discovery of the short ID was underway. SL_ZIGBEE_TABLE_ENTRY_UNUSED_NODE_ID if the address table entry was unused.
bool oldExtendedTimeouttrue if the retry interval was being increased by SL_ZIGBEE_INDIRECT_TRANSMISSION_TIMEOUT. false if the normal retry interval was being used.

Name: lookupNodeIdByEui64ID: 0x0060
Description: Returns the node ID that corresponds to the specified EUI64. The node ID is found by searching through all stack tables for the specified EUI64.
Command Parameters:
sl_802154_long_addr_t eui64The EUI64 of the node to look up.
Response Parameters:
sl_status_t statusSL_STATUS_OK if the short ID was found, SL_STATUS_FAIL if the short ID is not known.
sl_802154_short_addr_t nodeIdThe short ID of the node or SL_ZIGBEE_NULL_NODE_ID if the short ID is not known.

Name: lookupEui64ByNodeIdID: 0x0061
Description: Returns the EUI64 that corresponds to the specified node ID. The EUI64 is found by searching through all stack tables for the specified node ID.
Command Parameters:
sl_802154_short_addr_t nodeIdThe short ID of the node to look up.
Response Parameters:
sl_status_t statusSL_STATUS_OK if the EUI64 was found, SL_STATUS_FAIL if the EUI64 is not known.
sl_802154_long_addr_t eui64The EUI64 of the node.

Name: getMulticastTableEntryID: 0x0063
Description: Gets an entry from the multicast table.
Command Parameters:
uint8_t indexThe index of a multicast table entry.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.
sl_zigbee_multicast_table_entry_t valueThe contents of the multicast entry.

Name: setMulticastTableEntryID: 0x0064
Description: Sets an entry in the multicast table.
Command Parameters:
uint8_t indexThe index of a multicast table entry
sl_zigbee_multicast_table_entry_t valueThe contents of the multicast entry.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: idConflictHandlerID: 0x007C
Description: A callback invoked by the EmberZNet stack when an id conflict is discovered, that is, two different nodes in the network were found to be using the same short id. The stack automatically removes the conflicting short id from its internal tables (address, binding, route, neighbor, and child tables). The application should discontinue any other use of the id.
This frame is a response to the callback command.
Response Parameters:
sl_802154_short_addr_t idThe short id for which a conflict was detected

Name: writeNodeDataID: 0x00FE
Description: Write the current node Id, PAN ID, or Node type to the tokens
Command Parameters:
bool eraseErase the node type or not
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: sendRawMessageID: 0x0051
Description: Transmits the given message without modification. The MAC header is assumed to be configured in the message at the time this function is called.
Command Parameters:
uint8_t messageLengthThe length of the messageContents parameter in bytes.
uint8_t[] messageContentsThe raw message.
uint8_t prioritytransmit priority.
bool useCcaShould we enable CCA or not.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: macPassthroughMessageHandlerID: 0x0097
Description: A callback invoked by the EmberZNet stack when a MAC passthrough message is received.
This frame is a response to the callback command.
Response Parameters:
sl_zigbee_mac_passthrough_type_t messageTypeThe type of MAC passthrough message received.
sl_zigbee_rx_packet_info_t packetInfoInformation about the incoming packet.
uint8_t messageLengthThe length of the messageContents parameter in bytes.
uint8_t[] messageContentsThe raw message that was received.

Name: macFilterMatchMessageHandlerID: 0x0046
Description: A callback invoked by the EmberZNet stack when a raw MAC message that has matched one of the application's configured MAC filters.
This frame is a response to the callback command.
Response Parameters:
sl_zigbee_mac_filter_match_data_t filterValueMatchThe value of the filter that was matched.
sl_zigbee_mac_passthrough_type_t legacyPassthroughTypeThe type of MAC passthrough message received.
sl_zigbee_rx_packet_info_t packetInfoInformation about the incoming packet.
uint8_t messageLengthThe length of the messageContents parameter in bytes.
uint8_t[] messageContentsThe raw message that was received.

Name: rawTransmitCompleteHandlerID: 0x0098
Description: A callback invoked by the EmberZNet stack when the MAC has finished transmitting a raw message.
This frame is a response to the callback command.
Response Parameters:
uint8_t messageLengthLength of the message that was transmitted.
uint8_t[] messageContentsThe message that was transmitted.
sl_status_t statusSL_STATUS_OK if the transmission was successful, or SL_STATUS_ZIGBEE_DELIVERY_FAILED if not

Name: setMacPollFailureWaitTimeID: 0x00F4
Description: This function is useful to sleepy end devices. This function will set the retry interval (in milliseconds) for mac data poll. This interval is the time in milliseconds the device waits before retrying a data poll when a MAC level data poll fails for any reason.
Command Parameters:
uint32_t waitBeforeRetryIntervalMsTime in milliseconds the device waits before retrying a data poll when a MAC level data poll fails for any reason.
Response Parameters: None

Name: getMaxMacRetriesID: 0x006A
Description: Returns the maximum number of no-ack retries that will be attempted
Command Parameters: None
Response Parameters:
uint8_t retriesMax MAC retries

Name: setBeaconClassificationParamsID: 0x00EF
Description: Sets the priority masks and related variables for choosing the best beacon.
Command Parameters: None
Response Parameters:
sl_status_t statusThe attempt to set the pramaters returns SL_STATUS_OK
sl_zigbee_beacon_classification_params_t paramGets the beacon prioritization related variable

Name: getBeaconClassificationParamsID: 0x00F3
Description: Gets the priority masks and related variables for choosing the best beacon.
Command Parameters: None
Response Parameters:
sl_status_t statusThe attempt to get the pramaters returns SL_STATUS_OK
sl_zigbee_beacon_classification_params_t paramGets the beacon prioritization related variable

Name: pendingAckedMessagesID: 0x0121
Description: Indicate whether there are pending messages in the APS retry queue.
Command Parameters: None
Response Parameters:
bool pending_messagesTrue if there is a pending message for this network in the APS retry queue, false if not.

Name: rescheduleLinkStatusMsgID: 0x011B
Description: Reschedule sending link status message, with first one being sent immediately.
Command Parameters: None
Response Parameters:
sl_status_t status

Name: setNwkUpdateIdID: 0x011D
Description: Set the network update ID to the desired value. Must be called before joining or forming the network.
Command Parameters:
uint8_t nwkUpdateIdDesired value of the network update ID.
bool set_when_on_networkSet to true in case change should also apply when on network.
Response Parameters:
sl_status_t statusStatus of set operation for the network update ID.

Security Frames

Name: setInitialSecurityStateID: 0x0068
Description: Sets the security state that will be used by the device when it forms or joins the network. This call should not be used when restoring saved network state via networkInit as this will result in a loss of security data and will cause communication problems when the device re-enters the network.
Command Parameters:
sl_zigbee_initial_security_state_t stateThe security configuration to be set.
Response Parameters:
sl_status_t successThe success or failure code of the operation.

Name: getCurrentSecurityStateID: 0x0069
Description: Gets the current security state that is being used by a device that is joined in the network.
Command Parameters: None
Response Parameters:
sl_status_t statusThe success or failure code of the operation.
sl_zigbee_current_security_state_t stateThe security configuration in use by the stack.

Name: secManExportKeyID: 0x0114
Description: Exports a key from security manager based on passed context.
Command Parameters:
sl_zigbee_sec_man_context_t contextMetadata to identify the requested key.
Response Parameters:
sl_status_t statusThe success or failure code of the operation.
sl_zigbee_sec_man_key_t keyData to store the exported key in.

Name: secManImportKeyID: 0x0115
Description: Imports a key into security manager based on passed context.
Command Parameters:
sl_zigbee_sec_man_context_t contextMetadata to identify where the imported key should be stored.
sl_zigbee_sec_man_key_t keyThe key to be imported.
Response Parameters:
sl_status_t statusThe success or failure code of the operation.

Name: switchNetworkKeyHandlerID: 0x006E
Description: A callback to inform the application that the Network Key has been updated and the node has been switched over to use the new key. The actual key being used is not passed up, but the sequence number is.
This frame is a response to the callback command.
Response Parameters:
uint8_t sequenceNumberThe sequence number of the new network key.

Name: findKeyTableEntryID: 0x0075
Description: This function searches through the Key Table and tries to find the entry that matches the passed search criteria.
Command Parameters:
sl_802154_long_addr_t addressThe address to search for. Alternatively, all zeros may be passed in to search for the first empty entry.
bool linkKeyThis indicates whether to search for an entry that contains a link key or a master key. true means to search for an entry with a Link Key.
Response Parameters:
uint8_t indexThis indicates the index of the entry that matches the search criteria. A value of 0xFF is returned if not matching entry is found.

Name: sendTrustCenterLinkKeyID: 0x0067
Description: This function sends an APS TransportKey command containing the current trust center link key. The node to which the command is sent is specified via the short and long address arguments.
Command Parameters:
sl_802154_short_addr_t destinationNodeIdThe short address of the node to which this command will be sent
sl_802154_long_addr_t destinationEui64The long address of the node to which this command will be sent
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success of failure of the operation

Name: eraseKeyTableEntryID: 0x0076
Description: This function erases the data in the key table entry at the specified index. If the index is invalid, false is returned.
Command Parameters:
uint8_t indexThis indicates the index of entry to erase.
Response Parameters:
sl_status_t statusThe success or failure of the operation.

Name: clearKeyTableID: 0x00B1
Description: This function clears the key table of the current network.
Command Parameters: None
Response Parameters:
sl_status_t statusThe success or failure of the operation.

Name: requestLinkKeyID: 0x0014
Description: A function to request a Link Key from the Trust Center with another device on the Network (which could be the Trust Center). A Link Key with the Trust Center is possible but the requesting device cannot be the Trust Center. Link Keys are optional in ZigBee Standard Security and thus the stack cannot know whether the other device supports them. If SL_ZIGBEE_REQUEST_KEY_TIMEOUT is non-zero on the Trust Center and the partner device is not the Trust Center, both devices must request keys with their partner device within the time period. The Trust Center only supports one outstanding key request at a time and therefore will ignore other requests. If the timeout is zero then the Trust Center will immediately respond and not wait for the second request. The Trust Center will always immediately respond to requests for a Link Key with it. Sleepy devices should poll at a higher rate until a response is received or the request times out. The success or failure of the request is returned via sl_zigbee_ezsp_zigbee_key_establishment_handler(...)
Command Parameters:
sl_802154_long_addr_t partnerThis is the IEEE address of the partner device that will share the link key.
Response Parameters:
sl_status_t statusThe success or failure of sending the request. This is not the final result of the attempt. sl_zigbee_ezsp_zigbee_key_establishment_handler(...) will return that.

Name: updateTcLinkKeyID: 0x006C
Description: Requests a new link key from the Trust Center. This function starts by sending a Node Descriptor request to the Trust Center to verify its R21+ stack version compliance. A Request Key message will then be sent, followed by a Verify Key Confirm message.
Command Parameters:
uint8_t maxAttemptsThe maximum number of attempts a node should make when sending the Node Descriptor, Request Key, and Verify Key Confirm messages. The number of attempts resets for each message type sent (e.g., if maxAttempts is 3, up to 3 Node Descriptors are sent, up to 3 Request Keys, and up to 3 Verify Key Confirm messages are sent).
Response Parameters:
sl_status_t statusThe success or failure of sending the request. If the Node Descriptor is successfully transmitted, sl_zigbee_ezsp_zigbee_key_establishment_handler(...) will be called at a later time with a final status result.

Name: zigbeeKeyEstablishmentHandlerID: 0x009B
Description: This is a callback that indicates the success or failure of an attempt to establish a key with a partner device.
This frame is a response to the callback command.
Response Parameters:
sl_802154_long_addr_t partnerThis is the IEEE address of the partner that the device successfully established a key with. This value is all zeros on a failure.
sl_zigbee_key_status_t statusThis is the status indicating what was established or why the key establishment failed.

Name: clearTransientLinkKeysID: 0x006B
Description: Clear all of the transient link keys from RAM.
Command Parameters: None
Response Parameters: None

Name: secManGetNetworkKeyInfoID: 0x0116
Description: Retrieve information about the current and alternate network key, excluding their contents.
Command Parameters: None
Response Parameters:
sl_status_t statusSuccess or failure of retrieving network key info.
sl_zigbee_sec_man_network_key_info_t network_key_infoInformation about current and alternate network keys.

Name: secManGetApsKeyInfoID: 0x010C
Description: Retrieve metadata about an APS link key. Does not retrieve contents.
Command Parameters:
sl_zigbee_sec_man_context_t contextContext used to input information about key.
Response Parameters:
sl_status_t statusStatus of metadata retrieval operation.
sl_zigbee_sec_man_aps_key_metadata_t key_dataMetadata about the referenced key.

Name: secManImportLinkKeyID: 0x010E
Description: Import an application link key into the key table.
Command Parameters:
uint8_t indexIndex where this key is to be imported to.
sl_802154_long_addr_t addressEUI64 this key is associated with.
sl_zigbee_sec_man_key_t plaintext_keyThe key data to be imported.
Response Parameters:
sl_status_t statusStatus of key import operation.

Name: secManExportLinkKeyByIndexID: 0x010F
Description: Export the link key at given index from the key table.
Command Parameters:
uint8_t indexIndex of key to export.
Response Parameters:
sl_status_t statusStatus of key export operation.
sl_zigbee_sec_man_context_t contextContext referencing the exported key. Contains information like the EUI64 address it is associated with.
sl_zigbee_sec_man_key_t plaintext_keyThe exported key.
sl_zigbee_sec_man_aps_key_metadata_t key_dataMetadata about the key.

Name: secManExportLinkKeyByEuiID: 0x010D
Description: Export the link key associated with the given EUI from the key table.
Command Parameters:
sl_802154_long_addr_t euiEUI64 associated with the key to export.
Response Parameters:
sl_status_t statusStatus of key export operation.
sl_zigbee_sec_man_context_t contextContext referring to the exported key, containing the table index that this key is located in.
sl_zigbee_sec_man_key_t plaintext_keyThe exported key.
sl_zigbee_sec_man_aps_key_metadata_t key_dataMetadata about the key.

Name: secManCheckKeyContextID: 0x0110
Description: Check whether a key context can be used to load a valid key.
Command Parameters:
sl_zigbee_sec_man_context_t contextContext struct to check the validity of.
Response Parameters:
sl_status_t statusValidity of the checked context.

Name: secManImportTransientKeyID: 0x0111
Description: Import a transient link key.
Command Parameters:
sl_802154_long_addr_t eui64EUI64 associated with this transient key.
sl_zigbee_sec_man_key_t plaintext_keyThe key to import.
Response Parameters:
sl_status_t statusStatus of key import operation.

Name: secManExportTransientKeyByIndexID: 0x0112
Description: Export a transient link key from a given table index.
Command Parameters:
uint8_t indexIndex to export from.
Response Parameters:
sl_status_t statusStatus of key export operation.
sl_zigbee_sec_man_context_t contextContext struct for export operation.
sl_zigbee_sec_man_key_t plaintext_keyThe exported key.
sl_zigbee_sec_man_aps_key_metadata_t key_dataMetadata about the key.

Name: secManExportTransientKeyByEuiID: 0x0113
Description: Export a transient link key associated with a given EUI64
Command Parameters:
sl_802154_long_addr_t euiIndex to export from.
Response Parameters:
sl_status_t statusStatus of key export operation.
sl_zigbee_sec_man_context_t contextContext struct for export operation.
sl_zigbee_sec_man_key_t plaintext_keyThe exported key.
sl_zigbee_sec_man_aps_key_metadata_t key_dataMetadata about the key.

Name: setIncomingTcLinkKeyFrameCounterID: 0x0128
Description: Set the incoming TC link key frame counter to desired value.
Command Parameters:
uint32_t frameCounterValue to set the frame counter to.
Response Parameters: None

Name: apsCryptMessageID: 0x0129
Description: Encrypt/decrypt a message in-place using APS.
Command Parameters:
bool encryptEncrypt (true) or decrypt (false) the message.
uint8_t length_combined_argLength of the array containing message, needs to be long enough to include the auxiliary header and MIC.
uint8_t[] messageThe message to be en/de-crypted.
uint8_t apsHeaderEndIndexIndex just past the APS frame.
sl_802154_long_addr_t remoteEui64IEEE address of the device this message is associated with.
Response Parameters:
sl_status_t statusStatus of the encryption/decryption call.

Trust Center Frames

Name: trustCenterPostJoinHandlerID: 0x0024
Description: The NCP uses the trust center behavior policy to decide whether to allow a new node to join the network (part of the trust center pre-join handler). The Host cannot change the current decision in this post-join callback, but it can change the policy for future decisions using the setPolicy command.
This frame is a response to the callback command.
Response Parameters:
sl_802154_short_addr_t newNodeIdThe Node Id of the node whose status changed
sl_802154_long_addr_t newNodeEui64The EUI64 of the node whose status changed.
sl_zigbee_device_update_t statusThe status of the node: Secure Join/Rejoin, Unsecure Join/Rejoin, Device left.
sl_zigbee_join_decision_t policyDecisionAn sl_zigbee_join_decision_t reflecting the decision made.
sl_802154_short_addr_t parentOfNewNodeIdThe parent of the node whose status has changed.

Name: broadcastNextNetworkKeyID: 0x0073
Description: This function broadcasts a new encryption key, but does not tell the nodes in the network to start using it. To tell nodes to switch to the new key, use sl_zigbee_send_network_key_switch(). This is only valid for the Trust Center/Coordinator. It is up to the application to determine how quickly to send the Switch Key after sending the alternate encryption key.
Command Parameters:
sl_zigbee_key_data_t keyAn optional pointer to a 16-byte encryption key (SL_ZIGBEE_ENCRYPTION_KEY_SIZE). An all zero key may be passed in, which will cause the stack to randomly generate a new key.
Response Parameters:
sl_status_t statussl_status_t value that indicates the success or failure of the command.

Name: broadcastNetworkKeySwitchID: 0x0074
Description: This function broadcasts a switch key message to tell all nodes to change to the sequence number of the previously sent Alternate Encryption Key.
Command Parameters: None
Response Parameters:
sl_status_t statussl_status_t value that indicates the success or failure of the command.

Name: aesMmoHashID: 0x006F
Description: This routine processes the passed chunk of data and updates the hash context based on it. If the 'finalize' parameter is not set, then the length of the data passed in must be a multiple of 16. If the 'finalize' parameter is set then the length can be any value up 1-16, and the final hash value will be calculated.
Command Parameters:
sl_zigbee_aes_mmo_hash_context_t contextThe hash context to update.
bool finalizeThis indicates whether the final hash value should be calculated
uint8_t lengthThe length of the data to hash.
uint8_t[] dataThe data to hash.
Response Parameters:
sl_status_t statusThe result of the operation
sl_zigbee_aes_mmo_hash_context_t returnContextThe updated hash context.

Name: removeDeviceID: 0x00A8
Description: This command sends an APS remove device using APS encryption to the destination indicating either to remove itself from the network, or one of its children.
Command Parameters:
sl_802154_short_addr_t destShortThe node ID of the device that will receive the message
sl_802154_long_addr_t destLongThe long address (EUI64) of the device that will receive the message.
sl_802154_long_addr_t targetLongThe long address (EUI64) of the device to be removed.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success, or the reason for failure

Name: unicastNwkKeyUpdateID: 0x00A9
Description: This command will send a unicast transport key message with a new NWK key to the specified device. APS encryption using the device's existing link key will be used.
Command Parameters:
sl_802154_short_addr_t destShortThe node ID of the device that will receive the message
sl_802154_long_addr_t destLongThe long address (EUI64) of the device that will receive the message.
sl_zigbee_key_data_t keyThe NWK key to send to the new device.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success, or the reason for failure

Certificate Based Key Exchange (CBKE) Frames

Name: generateCbkeKeysID: 0x00A4
Description: This call starts the generation of the ECC Ephemeral Public/Private key pair. When complete it stores the private key. The results are returned via sl_zigbee_ezsp_generate_cbke_keys_handler().
Command Parameters: None
Response Parameters:
sl_status_t status

Name: generateCbkeKeysHandlerID: 0x009E
Description: A callback by the Crypto Engine indicating that a new ephemeral public/private key pair has been generated. The public/private key pair is stored on the NCP, but only the associated public key is returned to the host. The node's associated certificate is also returned.
This frame is a response to the callback command.
Response Parameters:
sl_status_t statusThe result of the CBKE operation.
sl_zigbee_public_key_data_t ephemeralPublicKeyThe generated ephemeral public key.

Name: calculateSmacsID: 0x009F
Description: Calculates the SMAC verification keys for both the initiator and responder roles of CBKE using the passed parameters and the stored public/private key pair previously generated with ezspGenerateKeysRetrieveCert(). It also stores the unverified link key data in temporary storage on the NCP until the key establishment is complete.
Command Parameters:
bool amInitiatorThe role of this device in the Key Establishment protocol.
sl_zigbee_certificate_data_t partnerCertificateThe key establishment partner's implicit certificate.
sl_zigbee_public_key_data_t partnerEphemeralPublicKeyThe key establishment partner's ephemeral public key
Response Parameters:
sl_status_t status

Name: calculateSmacsHandlerID: 0x00A0
Description: A callback to indicate that the NCP has finished calculating the Secure Message Authentication Codes (SMAC) for both the initiator and responder. The associated link key is kept in temporary storage until the host tells the NCP to store or discard the key via sli_zigbee_stack_clear_temporary_data_maybe_store_link_key().
This frame is a response to the callback command.
Response Parameters:
sl_status_t statusThe Result of the CBKE operation.
sl_zigbee_smac_data_t initiatorSmacThe calculated value of the initiator's SMAC
sl_zigbee_smac_data_t responderSmacThe calculated value of the responder's SMAC

Name: generateCbkeKeys283k1ID: 0x00E8
Description: This call starts the generation of the ECC 283k1 curve Ephemeral Public/Private key pair. When complete it stores the private key. The results are returned via sl_zigbee_ezsp_generate_cbke_keys_283k1_handler().
Command Parameters: None
Response Parameters:
sl_status_t status

Name: generateCbkeKeys283k1HandlerID: 0x00E9
Description: A callback by the Crypto Engine indicating that a new 283k1 ephemeral public/private key pair has been generated. The public/private key pair is stored on the NCP, but only the associated public key is returned to the host. The node's associated certificate is also returned.
This frame is a response to the callback command.
Response Parameters:
sl_status_t statusThe result of the CBKE operation.
sl_zigbee_public_key_283k1_data_t ephemeralPublicKeyThe generated ephemeral public key.

Name: calculateSmacs283k1ID: 0x00EA
Description: Calculates the SMAC verification keys for both the initiator and responder roles of CBKE for the 283k1 ECC curve using the passed parameters and the stored public/private key pair previously generated with sl_zigbee_ezsp_generate_keys_retrieve_cert_283k1(). It also stores the unverified link key data in temporary storage on the NCP until the key establishment is complete.
Command Parameters:
bool amInitiatorThe role of this device in the Key Establishment protocol.
sl_zigbee_certificate_283k1_data_t partnerCertificateThe key establishment partner's implicit certificate.
sl_zigbee_public_key_283k1_data_t partnerEphemeralPublicKeyThe key establishment partner's ephemeral public key
Response Parameters:
sl_status_t status

Name: calculateSmacs283k1HandlerID: 0x00EB
Description: A callback to indicate that the NCP has finished calculating the Secure Message Authentication Codes (SMAC) for both the initiator and responder for the CBKE 283k1 Library. The associated link key is kept in temporary storage until the host tells the NCP to store or discard the key via sli_zigbee_stack_clear_temporary_data_maybe_store_link_key().
This frame is a response to the callback command.
Response Parameters:
sl_status_t statusThe Result of the CBKE operation.
sl_zigbee_smac_data_t initiatorSmacThe calculated value of the initiator's SMAC
sl_zigbee_smac_data_t responderSmacThe calculated value of the responder's SMAC

Name: clearTemporaryDataMaybeStoreLinkKeyID: 0x00A1
Description: Clears the temporary data associated with CBKE and the key establishment, most notably the ephemeral public/private key pair. If storeLinKey is true it moves the unverified link key stored in temporary storage into the link key table. Otherwise it discards the key.
Command Parameters:
bool storeLinkKeyA bool indicating whether to store (true) or discard (false) the unverified link key derived when sl_zigbee_ezsp_calculate_smacs() was previously called.
Response Parameters:
sl_status_t status

Name: clearTemporaryDataMaybeStoreLinkKey283k1ID: 0x00EE
Description: Clears the temporary data associated with CBKE and the key establishment, most notably the ephemeral public/private key pair. If storeLinKey is true it moves the unverified link key stored in temporary storage into the link key table. Otherwise it discards the key.
Command Parameters:
bool storeLinkKeyA bool indicating whether to store (true) or discard (false) the unverified link key derived when sl_zigbee_ezsp_calculate_smacs() was previously called.
Response Parameters:
sl_status_t status

Name: getCertificateID: 0x00A5
Description: Retrieves the certificate installed on the NCP.
Command Parameters: None
Response Parameters:
sl_status_t status
sl_zigbee_certificate_data_t localCertThe locally installed certificate.

Name: getCertificate283k1ID: 0x00EC
Description: Retrieves the 283k certificate installed on the NCP.
Command Parameters: None
Response Parameters:
sl_status_t status
sl_zigbee_certificate_283k1_data_t localCertThe locally installed certificate.

Name: dsaSignID: 0x00A6
Description: LEGACY FUNCTION: This functionality has been replaced by a single bit in the sl_zigbee_aps_frame_t, SL_ZIGBEE_APS_OPTION_DSA_SIGN. Devices wishing to send signed messages should use that as it requires fewer function calls and message buffering. The dsaSignHandler response is still called when SL_ZIGBEE_APS_OPTION_DSA_SIGN is used. However, this function is still supported. This function begins the process of signing the passed message contained within the messageContents array. If no other ECC operation is going on, it will immediately return with SL_STATUS_IN_PROGRESS to indicate the start of ECC operation. It will delay a period of time to let APS retries take place, but then it will shut down the radio and consume the CPU processing until the signing is complete. This may take up to 1 second. The signed message will be returned in the dsaSignHandler response. Note that the last byte of the messageContents passed to this function has special significance. As the typical use case for DSA signing is to sign the ZCL payload of a DRLC Report Event Status message in SE 1.0, there is often both a signed portion (ZCL payload) and an unsigned portion (ZCL header). The last byte in the content of messageToSign is therefore used as a special indicator to signify how many bytes of leading data in the array should be excluded from consideration during the signing process. If the signature needs to cover the entire array (all bytes except last one), the caller should ensure that the last byte of messageContents is 0x00. When the signature operation is complete, this final byte will be replaced by the signature type indicator (0x01 for ECDSA signatures), and the actual signature will be appended to the original contents after this byte.
Command Parameters:
uint8_t messageLengthThe length of the messageContents parameter in bytes.
uint8_t[] messageContentsThe message contents for which to create a signature. Per above notes, this may include a leading portion of data not included in the signature, in which case the last byte of this array should be set to the index of the first byte to be considered for signing. Otherwise, the last byte of messageContents should be 0x00 to indicate that a signature should occur across the entire contents.
Response Parameters:
sl_status_t statusSL_STATUS_IN_PROGRESS if the stack has queued up the operation for execution. SL_STATUS_INVALID_STATE if the operation can't be performed in this context, possibly because another ECC operation is pending.

Name: dsaSignHandlerID: 0x00A7
Description: The handler that returns the results of the signing operation. On success, the signature will be appended to the original message (including the signature type indicator that replaced the startIndex field for the signing) and both are returned via this callback.
This frame is a response to the callback command.
Response Parameters:
sl_status_t statusThe result of the DSA signing operation.
uint8_t messageLengthThe length of the messageContents parameter in bytes.
uint8_t[] messageContentsThe message and attached which includes the original message and the appended signature.

Name: dsaVerifyID: 0x00A3
Description: Verify that signature of the associated message digest was signed by the private key of the associated certificate.
Command Parameters:
sl_zigbee_message_digest_t digestThe AES-MMO message digest of the signed data. If dsaSign command was used to generate the signature for this data, the final byte (replaced by signature type of 0x01) in the messageContents array passed to dsaSign is included in the hash context used for the digest calculation.
sl_zigbee_certificate_data_t signerCertificateThe certificate of the signer. Note that the signer's certificate and the verifier's certificate must both be issued by the same Certificate Authority, so they should share the same CA Public Key.
sl_zigbee_signature_data_t receivedSigThe signature of the signed data.
Response Parameters:
sl_status_t status

Name: dsaVerifyHandlerID: 0x0078
Description: This callback is executed by the stack when the DSA verification has completed and has a result. If the result is SL_STATUS_OK, the signature is valid. If the result is SL_STATUS_ZIGBEE_SIGNATURE_VERIFY_FAILURE then the signature is invalid. If the result is anything else then the signature verify operation failed and the validity is unknown.
This frame is a response to the callback command.
Response Parameters:
sl_status_t statusThe result of the DSA verification operation.

Name: dsaVerify283k1ID: 0x00B0
Description: Verify that signature of the associated message digest was signed by the private key of the associated certificate.
Command Parameters:
sl_zigbee_message_digest_t digestThe AES-MMO message digest of the signed data. If dsaSign command was used to generate the signature for this data, the final byte (replaced by signature type of 0x01) in the messageContents array passed to dsaSign is included in the hash context used for the digest calculation.
sl_zigbee_certificate_283k1_data_t signerCertificateThe certificate of the signer. Note that the signer's certificate and the verifier's certificate must both be issued by the same Certificate Authority, so they should share the same CA Public Key.
sl_zigbee_signature_283k1_data_t receivedSigThe signature of the signed data.
Response Parameters:
sl_status_t status

Name: setPreinstalledCbkeDataID: 0x00A2
Description: Sets the device's CA public key, local certificate, and static private key on the NCP associated with this node.
Command Parameters:
sl_zigbee_public_key_data_t caPublicThe Certificate Authority's public key.
sl_zigbee_certificate_data_t myCertThe node's new certificate signed by the CA.
sl_zigbee_private_key_data_t myKeyThe node's new static private key.
Response Parameters:
sl_status_t status

Name: savePreinstalledCbkeData283k1ID: 0x00ED
Description: Sets the device's 283k1 curve CA public key, local certificate, and static private key on the NCP associated with this node.
Command Parameters: None
Response Parameters:
sl_status_t status

Mfglib Frames

Name: mfglibInternalStartID: 0x0083
Description: Activate use of mfglib test routines and enables the radio receiver to report packets it receives to the mfgLibRxHandler() callback. These packets will not be passed up with a CRC failure. All other mfglib functions will return an error until the mfglibInternalStart() has been called
Command Parameters:
bool rxCallbacktrue to generate a mfglibRxHandler callback when a packet is received.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: mfglibInternalEndID: 0x0084
Description: Deactivate use of mfglib test routines; restores the hardware to the state it was in prior to mfglibInternalStart() and stops receiving packets started by mfglibInternalStart() at the same time.
Command Parameters: None
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: mfglibInternalStartToneID: 0x0085
Description: Starts transmitting an unmodulated tone on the currently set channel and power level. Upon successful return, the tone will be transmitting. To stop transmitting tone, application must call mfglibInternalStopTone(), allowing it the flexibility to determine its own criteria for tone duration (time, event, etc.)
Command Parameters: None
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: mfglibInternalStopToneID: 0x0086
Description: Stops transmitting tone started by mfglibInternalStartTone().
Command Parameters: None
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: mfglibInternalStartStreamID: 0x0087
Description: Starts transmitting a random stream of characters. This is so that the radio modulation can be measured.
Command Parameters: None
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: mfglibInternalStopStreamID: 0x0088
Description: Stops transmitting a random stream of characters started by mfglibInternalStartStream().
Command Parameters: None
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: mfglibInternalSendPacketID: 0x0089
Description: Sends a single packet consisting of the following bytes: packetLength, packetContents[0], ... , packetContents[packetLength - 3], CRC[0], CRC[1]. The total number of bytes sent is packetLength + 1. The radio replaces the last two bytes of packetContents[] with the 16-bit CRC for the packet.
Command Parameters:
uint8_t packetLengthThe length of the packetContents parameter in bytes. Must be greater than 3 and less than 123.
uint8_t[] packetContentsThe packet to send. The last two bytes will be replaced with the 16-bit CRC.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: mfglibInternalSetChannelID: 0x008A
Description: Sets the radio channel. Calibration occurs if this is the first time the channel has been used.
Command Parameters:
uint8_t channelThe channel to switch to. Valid values are 11 to 26.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: mfglibInternalGetChannelID: 0x008B
Description: Returns the current radio channel, as previously set via mfglibInternalSetChannel().
Command Parameters: None
Response Parameters:
uint8_t channelThe current channel.

Name: mfglibInternalSetPowerID: 0x008C
Description: First select the transmit power mode, and then include a method for selecting the radio transmit power. The valid power settings depend upon the specific radio in use. Ember radios have discrete power settings, and then requested power is rounded to a valid power setting; the actual power output is available to the caller via mfglibInternalGetPower().
Command Parameters:
uint16_t txPowerModePower mode. Refer to txPowerModes in stack/include/sl_zigbee_types.h for possible values.
int8_t powerPower in units of dBm. Refer to radio data sheet for valid range.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: mfglibInternalGetPowerID: 0x008D
Description: Returns the current radio power setting, as previously set via mfglibInternalSetPower().
Command Parameters: None
Response Parameters:
int8_t powerPower in units of dBm. Refer to radio data sheet for valid range.

Name: mfglibRxHandlerID: 0x008E
Description: A callback indicating a packet with a valid CRC has been received.
This frame is a response to the callback command.
Response Parameters:
uint8_t linkQualityThe link quality observed during the reception
int8_t rssiThe energy level (in units of dBm) observed during the reception.
uint8_t packetLengthThe length of the packetContents parameter in bytes. Will be greater than 3 and less than 123.
uint8_t[] packetContentsThe received packet (last 2 bytes are not FCS / CRC and may be discarded)

Bootloader Frames

Name: launchStandaloneBootloaderID: 0x008F
Description: Quits the current application and launches the standalone bootloader (if installed) The function returns an error if the standalone bootloader is not present
Command Parameters:
bool enabledIf true, launch the standalone bootloader. If false, do nothing.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: sendBootloadMessageID: 0x0090
Description: Transmits the given bootload message to a neighboring node using a specific 802.15.4 header that allows the EmberZNet stack as well as the bootloader to recognize the message, but will not interfere with other ZigBee stacks.
Command Parameters:
bool broadcastIf true, the destination address and pan id are both set to the broadcast address.
sl_802154_long_addr_t destEui64The EUI64 of the target node. Ignored if the broadcast field is set to true.
uint8_t messageLengthThe length of the messageContents parameter in bytes.
uint8_t[] messageContentsThe multicast message.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: getStandaloneBootloaderVersionPlatMicroPhyID: 0x0091
Description: Detects if the standalone bootloader is installed, and if so returns the installed version. If not return 0xffff. A returned version of 0x1234 would indicate version 1.2 build 34. Also return the node's version of PLAT, MICRO and PHY.
Command Parameters: None
Response Parameters:
uint16_t bootloader_versionBOOTLOADER_INVALID_VERSION if the standalone bootloader is not present, or the version of the installed standalone bootloader.
uint8_t nodePlatThe value of PLAT on the node
uint8_t nodeMicroThe value of MICRO on the node
uint8_t nodePhyThe value of PHY on the node

Name: incomingBootloadMessageHandlerID: 0x0092
Description: A callback invoked by the EmberZNet stack when a bootload message is received.
This frame is a response to the callback command.
Response Parameters:
sl_802154_long_addr_t longIdThe EUI64 of the sending node.
sl_zigbee_rx_packet_info_t packetInfoInformation about the incoming packet.
uint8_t messageLengthThe length of the messageContents parameter in bytes.
uint8_t[] messageContentsThe bootload message that was sent.

Name: bootloadTransmitCompleteHandlerID: 0x0093
Description: A callback invoked by the EmberZNet stack when the MAC has finished transmitting a bootload message.
This frame is a response to the callback command.
Response Parameters:
sl_status_t statusAn sl_status_t value of SL_STATUS_OK if an ACK was received from the destination or SL_STATUS_ZIGBEE_DELIVERY_FAILED if no ACK was received.
uint8_t messageLengthThe length of the messageContents parameter in bytes.
uint8_t[] messageContentsThe message that was sent.

Name: aesEncryptID: 0x0094
Description: Perform AES encryption on plaintext using key.
Command Parameters:
uint8_t[16] plaintext16 bytes of plaintext.
uint8_t[16] keyThe 16-byte encryption key to use.
Response Parameters:
uint8_t[16] ciphertext16 bytes of ciphertext.

Name: incomingMfgTestMessageHandlerID: 0x0147
Description: A callback to be implemented on the Golden Node to process acknowledgements. If you supply a custom version of this handler, you must define SL_ZIGBEE_APPLICATION_HAS_INCOMING_MFG_TEST_MESSAGE_HANDLER in your application's CONFIGURATION_HEADER
This frame is a response to the callback command.
Response Parameters:
uint8_t messageTypeThe type of the incoming message. Currently, the only possibility is MFG_TEST_TYPE_ACK.
uint8_t dataLengthThe length of the incoming message.
uint8_t[1] dataA pointer to the data received in the current message.

Name: mfgTestSetPacketModeID: 0x0148
Description: A function used on the Golden Node to switch between normal network operation (for testing) and manufacturing configuration. Like emberSleep(), it may not be possible to execute this command due to pending network activity. For the transition from normal network operation to manufacturing configuration, it is customary to loop, calling this function alternately with emberTick() until the mode change succeeds.
Command Parameters:
bool beginConfigurationDetermines the new mode of operation. true causes the node to enter manufacturing configuration. false causes the node to return to normal network operation.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or failure of the command.

Name: mfgTestSendRebootCommandID: 0x0149
Description: A function used during manufacturing configuration on the Golden Node to send the DUT a reboot command. The usual practice is to execute this command at the end of manufacturing configuration, to place the DUT into normal network operation for testing. This function executes only during manufacturing configuration mode and returns an error otherwise. If successful, the DUT acknowledges the reboot command within 20 milliseconds and then reboots.
Command Parameters: None
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or failure of the command.

Name: mfgTestSendEui64ID: 0x014A
Description: A function used during manufacturing configuration on the Golden Node to set the DUT's 8-byte EUI ID. This function executes only during manufacturing configuration mode and returns an error otherwise. If successful, the DUT acknowledges the new EUI ID within 150 milliseconds.
Command Parameters:
sl_802154_long_addr_t newIdThe 8-byte EUID for the DUT.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or failure of the command.

Name: mfgTestSendManufacturingStringID: 0x014B
Description: A function used during manufacturing configuration on the Golden Node to set the DUT's 16-byte configuration string. This function executes only during manufacturing configuration mode and will return an error otherwise. If successful, the DUT will acknowledge the new string within 150 milliseconds.
Command Parameters:
sl_zigbee_manufacturing_string_t newStringThe 16-byte manufacturing string.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or failure of the command.

Name: mfgTestSendRadioParametersID: 0x014C
Description: A function used during manufacturing configuration on the Golden Node to set the DUT's radio parameters. This function executes only during manufacturing configuration mode and returns an error otherwise. If successful, the DUT acknowledges the new parameters within 25 milliseconds.
Command Parameters:
uint8_t supportedBandsSets the radio band for the DUT. See ember-common.h for possible values.
int8_t crystalOffsetSets the CC1020 crystal offset. This parameter has no effect on the EM2420, and it may safely be set to 0 for this RFIC.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or failure of the command.

Name: mfgTestSendCommandID: 0x014D
Description: A function used in each of the manufacturing configuration API calls. Most implementations will not need to call this function directly. See mfg-test.c for more detail. This function executes only during manufacturing configuration mode and returns an error otherwise.
Command Parameters:
uint8_t[1] commandA pointer to the outgoing command string.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or failure of the command.

ZLL Frames

Name: zllNetworkOpsID: 0x00B2
Description: A consolidation of ZLL network operations with similar signatures; specifically, forming and joining networks or touch-linking.
Command Parameters:
sl_zigbee_zll_network_t networkInfoInformation about the network.
sl_zigbee_ezsp_zll_network_operation_t opOperation indicator.
int8_t radioTxPowerRadio transmission power.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: zllSetInitialSecurityStateID: 0x00B3
Description: This call will cause the device to setup the security information used in its network. It must be called prior to forming, starting, or joining a network.
Command Parameters:
sl_zigbee_key_data_t networkKeyZLL Network key.
sl_zigbee_zll_initial_security_state_t securityStateInitial security state of the network.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: zllSetSecurityStateWithoutKeyID: 0x00CF
Description: This call will update ZLL security token information. Unlike sli_zigbee_stack_zll_set_initial_security_state, this can be called while a network is already established.
Command Parameters:
sl_zigbee_zll_initial_security_state_t securityStateSecurity state of the network.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: zllStartScanID: 0x00B4
Description: This call will initiate a ZLL network scan on all the specified channels.
Command Parameters:
uint32_t channelMaskThe range of channels to scan.
int8_t radioPowerForScanThe radio output power used for the scan requests.
sl_zigbee_node_type_t nodeTypeThe node type of the local device.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: zllSetRxOnWhenIdleID: 0x00B5
Description: This call will change the mode of the radio so that the receiver is on for a specified amount of time when the device is idle.
Command Parameters:
uint32_t durationMsThe duration in milliseconds to leave the radio on.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: zllNetworkFoundHandlerID: 0x00B6
Description: This call is fired when a ZLL network scan finds a ZLL network.
This frame is a response to the callback command.
Response Parameters:
sl_zigbee_zll_network_t networkInfoInformation about the network.
bool isDeviceInfoNullUsed to interpret deviceInfo field.
sl_zigbee_zll_device_info_record_t deviceInfoDevice specific information.
sl_zigbee_rx_packet_info_t packetInfoInformation about the incoming packet received from this network.

Name: zllScanCompleteHandlerID: 0x00B7
Description: This call is fired when a ZLL network scan is complete.
This frame is a response to the callback command.
Response Parameters:
sl_status_t statusStatus of the operation.

Name: zllAddressAssignmentHandlerID: 0x00B8
Description: This call is fired when network and group addresses are assigned to a remote mode in a network start or network join request.
This frame is a response to the callback command.
Response Parameters:
sl_zigbee_zll_address_assignment_t addressInfoAddress assignment information.
sl_zigbee_rx_packet_info_t packetInfoInformation about the incoming packet.

Name: zllTouchLinkTargetHandlerID: 0x00BB
Description: This call is fired when the device is a target of a touch link.
This frame is a response to the callback command.
Response Parameters:
sl_zigbee_zll_network_t networkInfoInformation about the network.

Name: zllGetTokensID: 0x00BC
Description: Get the ZLL tokens.
Command Parameters: None
Response Parameters:
sl_zigbee_tok_type_stack_zll_data_t dataData token return value.
sl_zigbee_tok_type_stack_zll_security_t securitySecurity token return value.

Name: zllSetDataTokenID: 0x00BD
Description: Set the ZLL data token.
Command Parameters:
sl_zigbee_tok_type_stack_zll_data_t dataData token to be set.
Response Parameters: None

Name: zllSetNonZllNetworkID: 0x00BF
Description: Set the ZLL data token bitmask to reflect the ZLL network state.
Command Parameters: None
Response Parameters: None

Name: isZllNetworkID: 0x00BE
Description: Is this a ZLL network?
Command Parameters: None
Response Parameters:
bool isZllNetworkZLL network?

Name: zllSetRadioIdleModeID: 0x00D4
Description: This call sets the radio's default idle power mode.
Command Parameters:
sl_zigbee_radio_power_mode_t modeThe power mode to be set.
Response Parameters: None

Name: zllGetRadioIdleModeID: 0x00BA
Description: This call gets the radio's default idle power mode.
Command Parameters: None
Response Parameters:
uint8_t radioIdleModeThe current power mode.

Name: setZllNodeTypeID: 0x00D5
Description: This call sets the default node type for a factory new ZLL device.
Command Parameters:
sl_zigbee_node_type_t nodeTypeThe node type to be set.
Response Parameters: None

Name: setZllAdditionalStateID: 0x00D6
Description: This call sets additional capability bits in the ZLL state.
Command Parameters:
uint16_t stateA mask with the bits to be set or cleared.
Response Parameters: None

Name: zllOperationInProgressID: 0x00D7
Description: Is there a ZLL (Touchlink) operation in progress?
Command Parameters: None
Response Parameters:
bool zllOperationInProgressZLL operation in progress?

Name: zllRxOnWhenIdleGetActiveID: 0x00D8
Description: Is the ZLL radio on when idle mode is active?
Command Parameters: None
Response Parameters:
bool zllRxOnWhenIdleGetActiveZLL radio on when idle mode is active?

Name: zllScanningCompleteID: 0x00F6
Description: Informs the ZLL API that application scanning is complete
Command Parameters: None
Response Parameters: None

Name: getZllPrimaryChannelMaskID: 0x00D9
Description: Get the primary ZLL (touchlink) channel mask.
Command Parameters: None
Response Parameters:
uint32_t zllPrimaryChannelMaskThe primary ZLL channel mask

Name: getZllSecondaryChannelMaskID: 0x00DA
Description: Get the secondary ZLL (touchlink) channel mask.
Command Parameters: None
Response Parameters:
uint32_t zllSecondaryChannelMaskThe secondary ZLL channel mask

Name: setZllPrimaryChannelMaskID: 0x00DB
Description: Set the primary ZLL (touchlink) channel mask
Command Parameters:
uint32_t zllPrimaryChannelMaskThe primary ZLL channel mask
Response Parameters: None

Name: setZllSecondaryChannelMaskID: 0x00DC
Description: Set the secondary ZLL (touchlink) channel mask.
Command Parameters:
uint32_t zllSecondaryChannelMaskThe secondary ZLL channel mask
Response Parameters: None

Name: zllClearTokensID: 0x0025
Description: Clear ZLL stack tokens.
Command Parameters: None
Response Parameters: None

Green Power Frames

Name: gpProxyTableProcessGpPairingID: 0x00C9
Description: Update the GP Proxy table based on a GP pairing.
Command Parameters:
uint32_t optionsThe options field of the GP Pairing command.
sl_zigbee_gp_address_t addrThe target GPD.
uint8_t commModeThe communication mode of the GP Sink.
uint16_t sinkNetworkAddressThe network address of the GP Sink.
uint16_t sinkGroupIdThe group ID of the GP Sink.
uint16_t assignedAliasThe alias assigned to the GPD.
uint8_t[8] sinkIeeeAddressThe IEEE address of the GP Sink.
sl_zigbee_key_data_t gpdKeyThe key to use for the target GPD.
uint32_t gpdSecurityFrameCounterThe GPD security frame counter.
uint8_t forwardingRadiusThe forwarding radius.
Response Parameters:
bool gpPairingAddedWhether a GP Pairing has been created or not.

Name: dGpSendID: 0x00C6
Description: Adds/removes an entry from the GP Tx Queue.
Command Parameters:
bool actionThe action to perform on the GP TX queue (true to add, false to remove).
bool useCcaWhether to use ClearChannelAssessment when transmitting the GPDF.
sl_zigbee_gp_address_t addrThe Address of the destination GPD.
uint8_t gpdCommandIdThe GPD command ID to send.
uint8_t gpdAsduLengthThe length of the GP command payload.
uint8_t[] gpdAsduThe GP command payload.
uint8_t gpepHandleThe handle to refer to the GPDF.
uint16_t gpTxQueueEntryLifetimeMsHow long to keep the GPDF in the TX Queue.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: dGpSentHandlerID: 0x00C7
Description: A callback to the GP endpoint to indicate the result of the GPDF transmission.
This frame is a response to the callback command.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.
uint8_t gpepHandleThe handle of the GPDF.

Name: gpepIncomingMessageHandlerID: 0x00C5
Description: A callback invoked by the ZigBee GP stack when a GPDF is received.
This frame is a response to the callback command.
Response Parameters:
sl_zigbee_gp_params_t paramGP parameters list represented as a macro for GP endpoint incoming message handler and callbacks prototypes.

Name: gpProxyTableGetEntryID: 0x00C8
Description: Retrieves the proxy table entry stored at the passed index.
Command Parameters:
uint8_t proxyIndexThe index of the requested proxy table entry.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.
sl_zigbee_gp_proxy_table_entry_t entryAn sl_zigbee_gp_proxy_table_entry_t struct containing a copy of the requested proxy entry.

Name: gpProxyTableLookupID: 0x00C0
Description: Finds the index of the passed address in the gp table.
Command Parameters:
sl_zigbee_gp_address_t addrThe address to search for
Response Parameters:
uint8_t indexThe index, or 0xFF for not found

Name: gpProxyTableRemoveEntryID: 0x005D
Description: Removes the proxy table entry stored at the passed index.
Command Parameters:
uint8_t proxyIndexThe index of the requested proxy table entry.
Response Parameters: None

Name: gpClearProxyTableID: 0x005F
Description: Clear the entire proxy table
Command Parameters: None
Response Parameters: None

Name: gpSinkTableGetEntryID: 0x00DD
Description: Retrieves the sink table entry stored at the passed index.
Command Parameters:
uint8_t sinkIndexThe index of the requested sink table entry.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.
sl_zigbee_gp_sink_table_entry_t entryAn sl_zigbee_gp_sink_table_entry_t struct containing a copy of the requested sink entry.

Name: gpSinkTableLookupID: 0x00DE
Description: Finds the index of the passed address in the gp table.
Command Parameters:
sl_zigbee_gp_address_t addrThe address to search for.
Response Parameters:
uint8_t indexThe index, or 0xFF for not found

Name: gpSinkTableSetEntryID: 0x00DF
Description: Retrieves the sink table entry stored at the passed index.
Command Parameters:
uint8_t sinkIndexThe index of the requested sink table entry.
sl_zigbee_gp_sink_table_entry_t entryAn sl_zigbee_gp_sink_table_entry_t struct containing a copy of the sink entry to be updated.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: gpSinkTableRemoveEntryID: 0x00E0
Description: Removes the sink table entry stored at the passed index.
Command Parameters:
uint8_t sinkIndexThe index of the requested sink table entry.
Response Parameters: None

Name: gpSinkTableFindOrAllocateEntryID: 0x00E1
Description: Finds or allocates a sink entry
Command Parameters:
sl_zigbee_gp_address_t addrAn sl_zigbee_gp_address_t struct containing a copy of the gpd address to be found.
Response Parameters:
uint8_t indexAn index of found or allocated sink or 0xFF if failed.

Name: gpSinkTableClearAllID: 0x00E2
Description: Clear the entire sink table
Command Parameters: None
Response Parameters: None

Name: gpSinkTableInitID: 0x0070
Description: Iniitializes Sink Table
Command Parameters: None
Response Parameters: None

Name: gpSinkTableSetSecurityFrameCounterID: 0x00F5
Description: Sets security framecounter in the sink table
Command Parameters:
uint8_t indexIndex to the Sink table
uint32_t sfcSecurity Frame Counter
Response Parameters: None

Name: gpSinkCommissionID: 0x010A
Description: Puts the GPS in commissioning mode.
Command Parameters:
uint8_t optionscommissioning options
uint16_t gpmAddrForSecuritygpm address for security.
uint16_t gpmAddrForPairinggpm address for pairing.
uint8_t sinkEndpointsink endpoint.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: gpTranslationTableClearID: 0x010B
Description: Clears all entries within the translation table.
Command Parameters: None
Response Parameters: None

Name: gpSinkTableGetNumberOfActiveEntriesID: 0x0118
Description: Return number of active entries in sink table.
Command Parameters: None
Response Parameters:
uint8_t number_of_entriesNumber of active entries in sink table.

Token Interface Frames

Name: getTokenCountID: 0x0100
Description: Gets the total number of tokens.
Command Parameters: None
Response Parameters:
uint32_t countTotal number of tokens.

Name: getTokenInfoID: 0x0101
Description: Gets the token information for a single token at provided index
Command Parameters:
uint8_t indexIndex of the token in the token table for which information is needed.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.
sl_zigbee_token_info_t tokenInfoToken information.

Name: getTokenDataID: 0x0102
Description: Gets the token data for a single token with provided key
Command Parameters:
uint32_t tokenKey of the token in the token table for which data is needed.
uint32_t indexIndex in case of the indexed token.
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.
sl_zigbee_token_data_t tokenDataToken Data

Name: setTokenDataID: 0x0103
Description: Sets the token data for a single token with provided key
Command Parameters:
uint32_t tokenKey of the token in the token table for which data is to be set.
uint32_t indexIndex in case of the indexed token.
sl_zigbee_token_data_t tokenDataToken Data
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: resetNodeID: 0x0104
Description: Reset the node by calling halReboot.
Command Parameters: None
Response Parameters: None

Name: gpSecurityTestVectorsID: 0x0117
Description: Run GP security test vectors.
Command Parameters: None
Response Parameters:
sl_status_t statusAn sl_status_t value indicating success or the reason for failure.

Name: tokenFactoryResetID: 0x0077
Description: Factory reset all configured zigbee tokens
Command Parameters:
bool excludeOutgoingFCExclude network and APS outgoing frame counter tokens.
bool excludeBootCounterExclude stack boot counter token.
Response Parameters: None

Alphabetical List of Frames

NameID
addChild0x0138
addEndpoint0x0002
addressTableEntryIsActive0x005B
aesEncrypt0x0094
aesMmoHash0x006F
apsCryptMessage0x0129
bindingIsActive0x002E
bootloadTransmitCompleteHandler0x0093
broadcastNetworkKeySwitch0x0074
broadcastNextNetworkKey0x0073
calculateSmacs0x009F
calculateSmacs283k10x00EA
calculateSmacs283k1Handler0x00EB
calculateSmacsHandler0x00A0
callback0x0006
childId0x0106
childIndex0x0107
childJoinHandler0x0023
childPower0x0134
clearBindingTable0x002A
clearKeyTable0x00B1
clearMessageFlag0x0137
clearStoredBeacons0x003C
clearTemporaryDataMaybeStoreLinkKey0x00A1
clearTemporaryDataMaybeStoreLinkKey283k10x00EE
clearTransientLinkKeys0x006B
concentratorNoteRouteError0x0151
concentratorStartDiscovery0x014F
concentratorStopDiscovery0x0150
counterRequiresDestinationNodeId0x0133
counterRequiresPhyIndex0x0132
counterRolloverHandler0x00F2
currentStackTasks0x0145
customFrame0x0047
customFrameHandler0x0054
dGpSend0x00C6
dGpSentHandler0x00C7
debugWrite0x0012
delayTest0x009D
deleteBinding0x002D
dsaSign0x00A6
dsaSignHandler0x00A7
dsaVerify0x00A3
dsaVerify283k10x00B0
dsaVerifyHandler0x0078
dutyCycleHandler0x004D
echo0x0081
energyScanRequest0x009C
energyScanResultHandler0x0048
eraseKeyTableEntry0x0076
findAndRejoinNetwork0x0021
findKeyTableEntry0x0075
findUnusedPanId0x00D3
formNetwork0x001E
generateCbkeKeys0x00A4
generateCbkeKeys283k10x00E8
generateCbkeKeys283k1Handler0x00E9
generateCbkeKeysHandler0x009E
getAddressTableInfo0x005E
getBeaconClassificationParams0x00F3
getBinding0x002C
getBindingRemoteNodeId0x002F
getCertificate0x00A5
getCertificate283k10x00EC
getChildData0x004A
getConfigurationValue0x0052
getCurrentDutyCycle0x004C
getCurrentNetwork0x014E
getCurrentSecurityState0x0069
getDutyCycleLimits0x004B
getDutyCycleState0x0035
getEndpoint0x012E
getEndpointCluster0x0131
getEndpointCount0x012F
getEndpointDescription0x0130
getEui640x0026
getExtendedPanId0x0127
getExtendedTimeout0x007F
getExtendedValue0x0003
getInitialNeighborOutgoingCost0x0123
getLibraryStatus0x0001
getManufacturerCode0x00CA
getMaxMacRetries0x006A
getMfgToken0x000B
getMulticastTableEntry0x0063
getNeighbor0x0079
getNeighborFrameCounter0x003E
getNetworkParameters0x0028
getNodeId0x0027
getNumStoredBeacons0x0008
getParentChildParameters0x0029
getParentIncomingNwkFrameCounter0x013E
getPermitJoining0x011F
getPhyInterfaceCount0x00FC
getPolicy0x0056
getRadioChannel0x00FF
getRadioParameters0x00FD
getRandomNumber0x0049
getRouteTableEntry0x007B
getRoutingShortcutThreshold0x00D1
getSourceRouteTableEntry0x00C1
getSourceRouteTableFilledSize0x00C2
getSourceRouteTableTotalSize0x00C3
getStandaloneBootloaderVersionPlatMicroPhy0x0091
getStoredBeacon0x0004
getTimer0x004E
getToken0x000A
getTokenCount0x0100
getTokenData0x0102
getTokenInfo0x0101
getTrueRandomEntropySource0x004F
getValue0x00AA
getXncpInfo0x0013
getZllPrimaryChannelMask0x00D9
getZllSecondaryChannelMask0x00DA
gpClearProxyTable0x005F
gpProxyTableGetEntry0x00C8
gpProxyTableLookup0x00C0
gpProxyTableProcessGpPairing0x00C9
gpProxyTableRemoveEntry0x005D
gpSecurityTestVectors0x0117
gpSinkCommission0x010A
gpSinkTableClearAll0x00E2
gpSinkTableFindOrAllocateEntry0x00E1
gpSinkTableGetEntry0x00DD
gpSinkTableGetNumberOfActiveEntries0x0118
gpSinkTableInit0x0070
gpSinkTableLookup0x00DE
gpSinkTableRemoveEntry0x00E0
gpSinkTableSetEntry0x00DF
gpSinkTableSetSecurityFrameCounter0x00F5
gpTranslationTableClear0x010B
gpepIncomingMessageHandler0x00C5
idConflictHandler0x007C
incomingBootloadMessageHandler0x0092
incomingManyToOneRouteRequestHandler0x007D
incomingMessageHandler0x0045
incomingMfgTestMessageHandler0x0147
incomingNetworkStatusHandler0x00C4
incomingRouteErrorHandler0x0080
incomingRouteRecordHandler0x0059
invalidCommand0x0058
isResetRejoiningNeighborsFrameCounterEnabled0x0125
isZllNetwork0x00BE
joinNetwork0x001F
joinNetworkDirectly0x003B
launchStandaloneBootloader0x008F
leaveNetwork0x0020
lookupEui64ByNodeId0x0061
lookupNodeIdByEui640x0060
macFilterMatchMessageHandler0x0046
macPassthroughMessageHandler0x0097
maxChildCount0x013C
maxRouterChildCount0x013D
maximumPayloadLength0x0033
messageSentHandler0x003F
mfgTestSendCommand0x014D
mfgTestSendEui640x014A
mfgTestSendManufacturingString0x014B
mfgTestSendRadioParameters0x014C
mfgTestSendRebootCommand0x0149
mfgTestSetPacketMode0x0148
mfglibInternalEnd0x0084
mfglibInternalGetChannel0x008B
mfglibInternalGetPower0x008D
mfglibInternalSendPacket0x0089
mfglibInternalSetChannel0x008A
mfglibInternalSetPower0x008C
mfglibInternalStart0x0083
mfglibInternalStartStream0x0087
mfglibInternalStartTone0x0085
mfglibInternalStopStream0x0088
mfglibInternalStopTone0x0086
mfglibRxHandler0x008E
multiPhySetRadioChannel0x00FB
multiPhySetRadioPower0x00FA
multiPhyStart0x00F8
multiPhyStop0x00F9
mux_invalid_rx_handler0x0062
neighborCount0x007A
networkFoundHandler0x001B
networkInit0x0017
networkState0x0018
noCallbacks0x0007
nop0x0005
okToHibernate0x0141
okToLongPoll0x0142
okToNap0x0146
parentTokenSet0x0140
pendingAckedMessages0x0121
permitJoining0x0022
pollCompleteHandler0x0043
pollForData0x0042
pollHandler0x0044
proxyNextBroadcastFromLong0x0066
radioGetSchedulerPriorities0x012A
radioGetSchedulerSliptime0x012C
radioSetSchedulerPriorities0x012B
radioSetSchedulerSliptime0x012D
rawTransmitCompleteHandler0x0098
readAndClearCounters0x0065
readAttribute0x0108
readCounters0x00F1
remoteDeleteBindingHandler0x0032
remoteSetBindingHandler0x0031
removeChild0x0139
removeDevice0x00A8
removeNeighbor0x013A
replaceAddressTableEntry0x0082
requestLinkKey0x0014
rescheduleLinkStatusMsg0x011B
resetNode0x0104
resetRejoiningNeighborsFrameCounter0x0124
routerChildCount0x013B
savePreinstalledCbkeData283k10x00ED
scanCompleteHandler0x001C
secManCheckKeyContext0x0110
secManExportKey0x0114
secManExportLinkKeyByEui0x010D
secManExportLinkKeyByIndex0x010F
secManExportTransientKeyByEui0x0113
secManExportTransientKeyByIndex0x0112
secManGetApsKeyInfo0x010C
secManGetNetworkKeyInfo0x0116
secManImportKey0x0115
secManImportLinkKey0x010E
secManImportTransientKey0x0111
sendBootloadMessage0x0090
sendBroadcast0x0036
sendLinkPowerDeltaRequest0x00F7
sendManyToOneRouteRequest0x0041
sendMulticast0x0038
sendPanIdUpdate0x0057
sendRawMessage0x0051
sendReply0x0039
sendTrustCenterLinkKey0x0067
sendUnicast0x0034
sendZigbeeLeave0x011A
setAddressTableInfo0x005C
setBeaconClassificationParams0x00EF
setBinding0x002B
setBindingRemoteNodeId0x0030
setBrokenRouteErrorCode0x0011
setChildData0x00AC
setChildPower0x0135
setConcentrator0x0010
setConfigurationValue0x0053
setDutyCycleLimitsInStack0x0040
setExtendedTimeout0x007E
setIncomingTcLinkKeyFrameCounter0x0128
setInitialNeighborOutgoingCost0x0122
setInitialSecurityState0x0068
setLogicalAndRadioChannel0x00B9
setMacPollFailureWaitTime0x00F4
setManufacturerCode0x0015
setMessageFlag0x0136
setMfgToken0x000C
setMulticastTableEntry0x0064
setNeighborFrameCounter0x00AD
setNumBeaconsToStore0x0037
setNwkUpdateId0x011D
setParentIncomingNwkFrameCounter0x013F
setPassiveAckConfig0x0105
setPendingNetworkUpdatePanId0x011E
setPolicy0x0055
setPowerDescriptor0x0016
setPreinstalledCbkeData0x00A2
setRadioChannel0x009A
setRadioIeee802154CcaMode0x0095
setRadioPower0x0099
setRoutingShortcutThreshold0x00D0
setSourceRoute0x00AE
setSourceRouteDiscoveryMode0x005A
setTimer0x000E
setToken0x0009
setTokenData0x0103
setValue0x00AB
setZllAdditionalState0x00D6
setZllNodeType0x00D5
setZllPrimaryChannelMask0x00DB
setZllSecondaryChannelMask0x00DC
setupDelayedJoin0x003A
sleepyToSleepyNetworkStart0x0119
stackPowerDown0x0143
stackPowerUp0x0144
stackStatusHandler0x0019
stackTokenChangedHandler0x000D
startScan0x001A
stopScan0x001D
switchNetworkKeyHandler0x006E
timerHandler0x000F
tokenFactoryReset0x0077
trustCenterPostJoinHandler0x0024
unicastCurrentNetworkKey0x0050
unicastNwkKeyUpdate0x00A9
unusedPanIdFoundHandler0x00D2
updateTcLinkKey0x006C
version0x0000
writeAttribute0x0109
writeNodeData0x00FE
zigbeeKeyEstablishmentHandler0x009B
zllAddressAssignmentHandler0x00B8
zllClearTokens0x0025
zllGetRadioIdleMode0x00BA
zllGetTokens0x00BC
zllNetworkFoundHandler0x00B6
zllNetworkOps0x00B2
zllOperationInProgress0x00D7
zllRxOnWhenIdleGetActive0x00D8
zllScanCompleteHandler0x00B7
zllScanningComplete0x00F6
zllSetDataToken0x00BD
zllSetInitialSecurityState0x00B3
zllSetNonZllNetwork0x00BF
zllSetRadioIdleMode0x00D4
zllSetRxOnWhenIdle0x00B5
zllSetSecurityStateWithoutKey0x00CF
zllStartScan0x00B4
zllTouchLinkTargetHandler0x00BB

Numeric List of Frames

IDName
0x0000version
0x0001getLibraryStatus
0x0002addEndpoint
0x0003getExtendedValue
0x0004getStoredBeacon
0x0005nop
0x0006callback
0x0007noCallbacks
0x0008getNumStoredBeacons
0x0009setToken
0x000AgetToken
0x000BgetMfgToken
0x000CsetMfgToken
0x000DstackTokenChangedHandler
0x000EsetTimer
0x000FtimerHandler
0x0010setConcentrator
0x0011setBrokenRouteErrorCode
0x0012debugWrite
0x0013getXncpInfo
0x0014requestLinkKey
0x0015setManufacturerCode
0x0016setPowerDescriptor
0x0017networkInit
0x0018networkState
0x0019stackStatusHandler
0x001AstartScan
0x001BnetworkFoundHandler
0x001CscanCompleteHandler
0x001DstopScan
0x001EformNetwork
0x001FjoinNetwork
0x0020leaveNetwork
0x0021findAndRejoinNetwork
0x0022permitJoining
0x0023childJoinHandler
0x0024trustCenterPostJoinHandler
0x0025zllClearTokens
0x0026getEui64
0x0027getNodeId
0x0028getNetworkParameters
0x0029getParentChildParameters
0x002AclearBindingTable
0x002BsetBinding
0x002CgetBinding
0x002DdeleteBinding
0x002EbindingIsActive
0x002FgetBindingRemoteNodeId
0x0030setBindingRemoteNodeId
0x0031remoteSetBindingHandler
0x0032remoteDeleteBindingHandler
0x0033maximumPayloadLength
0x0034sendUnicast
0x0035getDutyCycleState
0x0036sendBroadcast
0x0037setNumBeaconsToStore
0x0038sendMulticast
0x0039sendReply
0x003AsetupDelayedJoin
0x003BjoinNetworkDirectly
0x003CclearStoredBeacons
0x003D-- unassigned --
0x003EgetNeighborFrameCounter
0x003FmessageSentHandler
0x0040setDutyCycleLimitsInStack
0x0041sendManyToOneRouteRequest
0x0042pollForData
0x0043pollCompleteHandler
0x0044pollHandler
0x0045incomingMessageHandler
0x0046macFilterMatchMessageHandler
0x0047customFrame
0x0048energyScanResultHandler
0x0049getRandomNumber
0x004AgetChildData
0x004BgetDutyCycleLimits
0x004CgetCurrentDutyCycle
0x004DdutyCycleHandler
0x004EgetTimer
0x004FgetTrueRandomEntropySource
0x0050unicastCurrentNetworkKey
0x0051sendRawMessage
0x0052getConfigurationValue
0x0053setConfigurationValue
0x0054customFrameHandler
0x0055setPolicy
0x0056getPolicy
0x0057sendPanIdUpdate
0x0058invalidCommand
0x0059incomingRouteRecordHandler
0x005AsetSourceRouteDiscoveryMode
0x005BaddressTableEntryIsActive
0x005CsetAddressTableInfo
0x005DgpProxyTableRemoveEntry
0x005EgetAddressTableInfo
0x005FgpClearProxyTable
0x0060lookupNodeIdByEui64
0x0061lookupEui64ByNodeId
0x0062mux_invalid_rx_handler
0x0063getMulticastTableEntry
0x0064setMulticastTableEntry
0x0065readAndClearCounters
0x0066proxyNextBroadcastFromLong
0x0067sendTrustCenterLinkKey
0x0068setInitialSecurityState
0x0069getCurrentSecurityState
0x006AgetMaxMacRetries
0x006BclearTransientLinkKeys
0x006CupdateTcLinkKey
0x006D-- unassigned --
0x006EswitchNetworkKeyHandler
0x006FaesMmoHash
0x0070gpSinkTableInit
0x0071-- unassigned --
0x0072-- unassigned --
0x0073broadcastNextNetworkKey
0x0074broadcastNetworkKeySwitch
0x0075findKeyTableEntry
0x0076eraseKeyTableEntry
0x0077tokenFactoryReset
0x0078dsaVerifyHandler
0x0079getNeighbor
0x007AneighborCount
0x007BgetRouteTableEntry
0x007CidConflictHandler
0x007DincomingManyToOneRouteRequestHandler
0x007EsetExtendedTimeout
0x007FgetExtendedTimeout
0x0080incomingRouteErrorHandler
0x0081echo
0x0082replaceAddressTableEntry
0x0083mfglibInternalStart
0x0084mfglibInternalEnd
0x0085mfglibInternalStartTone
0x0086mfglibInternalStopTone
0x0087mfglibInternalStartStream
0x0088mfglibInternalStopStream
0x0089mfglibInternalSendPacket
0x008AmfglibInternalSetChannel
0x008BmfglibInternalGetChannel
0x008CmfglibInternalSetPower
0x008DmfglibInternalGetPower
0x008EmfglibRxHandler
0x008FlaunchStandaloneBootloader
0x0090sendBootloadMessage
0x0091getStandaloneBootloaderVersionPlatMicroPhy
0x0092incomingBootloadMessageHandler
0x0093bootloadTransmitCompleteHandler
0x0094aesEncrypt
0x0095setRadioIeee802154CcaMode
0x0096-- unassigned --
0x0097macPassthroughMessageHandler
0x0098rawTransmitCompleteHandler
0x0099setRadioPower
0x009AsetRadioChannel
0x009BzigbeeKeyEstablishmentHandler
0x009CenergyScanRequest
0x009DdelayTest
0x009EgenerateCbkeKeysHandler
0x009FcalculateSmacs
0x00A0calculateSmacsHandler
0x00A1clearTemporaryDataMaybeStoreLinkKey
0x00A2setPreinstalledCbkeData
0x00A3dsaVerify
0x00A4generateCbkeKeys
0x00A5getCertificate
0x00A6dsaSign
0x00A7dsaSignHandler
0x00A8removeDevice
0x00A9unicastNwkKeyUpdate
0x00AAgetValue
0x00ABsetValue
0x00ACsetChildData
0x00ADsetNeighborFrameCounter
0x00AEsetSourceRoute
0x00AF-- unassigned --
0x00B0dsaVerify283k1
0x00B1clearKeyTable
0x00B2zllNetworkOps
0x00B3zllSetInitialSecurityState
0x00B4zllStartScan
0x00B5zllSetRxOnWhenIdle
0x00B6zllNetworkFoundHandler
0x00B7zllScanCompleteHandler
0x00B8zllAddressAssignmentHandler
0x00B9setLogicalAndRadioChannel
0x00BAzllGetRadioIdleMode
0x00BBzllTouchLinkTargetHandler
0x00BCzllGetTokens
0x00BDzllSetDataToken
0x00BEisZllNetwork
0x00BFzllSetNonZllNetwork
0x00C0gpProxyTableLookup
0x00C1getSourceRouteTableEntry
0x00C2getSourceRouteTableFilledSize
0x00C3getSourceRouteTableTotalSize
0x00C4incomingNetworkStatusHandler
0x00C5gpepIncomingMessageHandler
0x00C6dGpSend
0x00C7dGpSentHandler
0x00C8gpProxyTableGetEntry
0x00C9gpProxyTableProcessGpPairing
0x00CAgetManufacturerCode
0x00CB-- unassigned --
0x00CC-- unassigned --
0x00CD-- unassigned --
0x00CE-- unassigned --
0x00CFzllSetSecurityStateWithoutKey
0x00D0setRoutingShortcutThreshold
0x00D1getRoutingShortcutThreshold
0x00D2unusedPanIdFoundHandler
0x00D3findUnusedPanId
0x00D4zllSetRadioIdleMode
0x00D5setZllNodeType
0x00D6setZllAdditionalState
0x00D7zllOperationInProgress
0x00D8zllRxOnWhenIdleGetActive
0x00D9getZllPrimaryChannelMask
0x00DAgetZllSecondaryChannelMask
0x00DBsetZllPrimaryChannelMask
0x00DCsetZllSecondaryChannelMask
0x00DDgpSinkTableGetEntry
0x00DEgpSinkTableLookup
0x00DFgpSinkTableSetEntry
0x00E0gpSinkTableRemoveEntry
0x00E1gpSinkTableFindOrAllocateEntry
0x00E2gpSinkTableClearAll
0x00E3-- unassigned --
0x00E4-- unassigned --
0x00E5-- unassigned --
0x00E6-- unassigned --
0x00E7-- unassigned --
0x00E8generateCbkeKeys283k1
0x00E9generateCbkeKeys283k1Handler
0x00EAcalculateSmacs283k1
0x00EBcalculateSmacs283k1Handler
0x00ECgetCertificate283k1
0x00EDsavePreinstalledCbkeData283k1
0x00EEclearTemporaryDataMaybeStoreLinkKey283k1
0x00EFsetBeaconClassificationParams
0x00F0-- unassigned --
0x00F1readCounters
0x00F2counterRolloverHandler
0x00F3getBeaconClassificationParams
0x00F4setMacPollFailureWaitTime
0x00F5gpSinkTableSetSecurityFrameCounter
0x00F6zllScanningComplete
0x00F7sendLinkPowerDeltaRequest
0x00F8multiPhyStart
0x00F9multiPhyStop
0x00FAmultiPhySetRadioPower
0x00FBmultiPhySetRadioChannel
0x00FCgetPhyInterfaceCount
0x00FDgetRadioParameters
0x00FEwriteNodeData
0x00FFgetRadioChannel
0x0100getTokenCount
0x0101getTokenInfo
0x0102getTokenData
0x0103setTokenData
0x0104resetNode
0x0105setPassiveAckConfig
0x0106childId
0x0107childIndex
0x0108readAttribute
0x0109writeAttribute
0x010AgpSinkCommission
0x010BgpTranslationTableClear
0x010CsecManGetApsKeyInfo
0x010DsecManExportLinkKeyByEui
0x010EsecManImportLinkKey
0x010FsecManExportLinkKeyByIndex
0x0110secManCheckKeyContext
0x0111secManImportTransientKey
0x0112secManExportTransientKeyByIndex
0x0113secManExportTransientKeyByEui
0x0114secManExportKey
0x0115secManImportKey
0x0116secManGetNetworkKeyInfo
0x0117gpSecurityTestVectors
0x0118gpSinkTableGetNumberOfActiveEntries
0x0119sleepyToSleepyNetworkStart
0x011AsendZigbeeLeave
0x011BrescheduleLinkStatusMsg
0x011C-- unassigned --
0x011DsetNwkUpdateId
0x011EsetPendingNetworkUpdatePanId
0x011FgetPermitJoining
0x0120-- unassigned --
0x0121pendingAckedMessages
0x0122setInitialNeighborOutgoingCost
0x0123getInitialNeighborOutgoingCost
0x0124resetRejoiningNeighborsFrameCounter
0x0125isResetRejoiningNeighborsFrameCounterEnabled
0x0126-- unassigned --
0x0127getExtendedPanId
0x0128setIncomingTcLinkKeyFrameCounter
0x0129apsCryptMessage
0x012AradioGetSchedulerPriorities
0x012BradioSetSchedulerPriorities
0x012CradioGetSchedulerSliptime
0x012DradioSetSchedulerSliptime
0x012EgetEndpoint
0x012FgetEndpointCount
0x0130getEndpointDescription
0x0131getEndpointCluster
0x0132counterRequiresPhyIndex
0x0133counterRequiresDestinationNodeId
0x0134childPower
0x0135setChildPower
0x0136setMessageFlag
0x0137clearMessageFlag
0x0138addChild
0x0139removeChild
0x013AremoveNeighbor
0x013BrouterChildCount
0x013CmaxChildCount
0x013DmaxRouterChildCount
0x013EgetParentIncomingNwkFrameCounter
0x013FsetParentIncomingNwkFrameCounter
0x0140parentTokenSet
0x0141okToHibernate
0x0142okToLongPoll
0x0143stackPowerDown
0x0144stackPowerUp
0x0145currentStackTasks
0x0146okToNap
0x0147incomingMfgTestMessageHandler
0x0148mfgTestSetPacketMode
0x0149mfgTestSendRebootCommand
0x014AmfgTestSendEui64
0x014BmfgTestSendManufacturingString
0x014CmfgTestSendRadioParameters
0x014DmfgTestSendCommand
0x014EgetCurrentNetwork
0x014FconcentratorStartDiscovery
0x0150concentratorStopDiscovery
0x0151concentratorNoteRouteError