Ember Common Data Types#
See sl_zigbee_types.h for source code.
Modules#
sl_zigbee_release_type_struct_t
sl_zigbee_network_init_struct_t
sl_zigbee_network_parameters_t
sl_zigbee_multi_phy_radio_parameters_t
sl_zigbee_binding_table_entry_t
sl_zigbee_neighbor_table_entry_t
sl_zigbee_multicast_table_entry_t
sl_zigbee_multiprotocol_priorities_t
sl_zigbee_extra_counters_info_t
sl_zigbee_aes_mmo_hash_context_t
sl_zigbee_certificate_283k1_data_t
sl_zigbee_public_key_283k1_data_t
sl_zigbee_private_key_283k1_data_t
sl_zigbee_signature_283k1_data_t
sl_zigbee_initial_security_state_t
sl_zigbee_current_security_state_t
sl_zigbee_transient_key_data_t
sl_zigbee_mfg_security_struct_t
sl_zigbee_per_device_duty_cycle_t
sl_zigbee_mac_filter_match_struct_t
sl_zigbee_source_route_table_entry_t
sl_zigbee_beacon_classification_params_t
Miscellaneous Ember Types#
Type of Ember software version.
Use in case zigbee leave network with options.
sl_zigbee_release_type_struct_t Data that relates release type to the correct string.
sl_zigbee_release_type_struct_t Data that relates release type to the correct string.
sl_zigbee_release_type_struct_t Data that relates release type to the correct string.
sl_zigbee_release_type_struct_t Data that relates release type to the correct string.
16-bit ZigBee network address.
802.15.4 PAN ID.
A structure containing the version information.
sl_zigbee_release_type_struct_t Data that relates release type to the correct string.
Size of EUI64 (an IEEE address) in bytes (8).
Size of an extended PAN identifier in bytes (8).
Size of an encryption key in bytes (16).
Size of Implicit Certificates used for Certificate-based Key Exchange(CBKE).
Size of Public Keys used in Elliptical Cryptography ECMQV algorithms.
Size of Private Keys used in Elliptical Cryptography ECMQV algorithms.
Size of the SMAC used in Elliptical Cryptography ECMQV algorithms.
Size of the DSA signature used in Elliptical Cryptography Digital Signature Algorithms.
The size of AES-128 MMO hash is 16-bytes. This is defined in the core. ZigBee specification.
Size of Implicit Certificates used for Certificate Based Key Exchange using the ECC283K1 curve in bytes.
Size of Public Keys used in SECT283k1 Elliptical Cryptography ECMQV algorithms.
Size of Private Keys used SECT283k1 in Elliptical Cryptography ECMQV algorithms.
Size of the DSA signature used in SECT283k1 Elliptical Cryptography Digital Signature Algorithms.
EUI 64-bit ID (an IEEE address).
The maximum 802.15.4 channel number is 26.
The minimum 2.4GHz 802.15.4 channel number is 11.
The minimum SubGhz channel number is 0.
The SubGhz scan duration is 5.
There are sixteen 802.15.4 channels.
A bitmask to scan all 2.4 GHz 802.15.4 channels.
The maximum channels per page are 27 page bits 31...27, channel bits 26...0.
Sub-GHz channel bitmasks for pages 28, 30, 31.
The maximum SubGhz channel number on pages 28, 30, 31 is 26.
SubGhz channel bitmasks for page 29.
The maximum SubGhz channel number on page 29 is 8.
The minimum SubGhz page number is 28.
The maximum SubGhz page number is 31.
A bitmask for the channel page within a channel mask.
A page-channel mask for a given page and channel mask.
A page-channel mask for a given page and channel.
The network ID of the coordinator in a ZigBee network is 0x0000.
A distinguished network ID that will never be assigned to any node. It is used to indicate the absence of a node ID.
The channel page value used to indicate just the 2.4GHz channels.
A distinguished EUI64 that is commonly used to indicate an invalid EUI64.
A distinguished binding index used to indicate the absence of a binding.
A distinguished network ID that will never be assigned to any node.
A distinguished network ID that will never be assigned to any node. This value is returned when getting the remote node ID from the binding table and the given binding table index refers to a multicast binding entry.
A distinguished network ID that will never be assigned to any node. This value is used when getting the remote node ID from the address or binding tables. It indicates that the address or binding table entry is currently in use but the node ID corresponding to the EUI64 in the table is currently unknown.
A distinguished network ID that will never be assigned to any node. This value is used when getting the remote node ID from the address or binding tables. It indicates that the address or binding table entry is currently in use and network address discovery is underway.
A distinguished address table index used to indicate the absence of an address table entry.
The endpoint where the ZigBee Device Object (ZDO) resides.
The broadcast endpoint, as defined in the ZigBee spec.
The GP endpoint, as defined in the ZigBee spec.
The profile ID used by the ZigBee Device Object (ZDO).
The profile ID used to address all the public profiles.
The maximum value for a profile ID in the standard profile range.
The broadcast table entry timeout, which specifies, in quarter seconds, how long an entry persists in the local device's broadcast table.
Ember's Manufacturer ID.
An invalid network index.
Use Ember's default duty cycle limit configurations.
Ember Concentrator Types#
To 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 assumed concentrator type can be changed by setting appropriate value in sl_zigbee_set_assumed_trust_center_concentrator_type().
The decision made by the Trust Center when a node attempts to join.
The Status of the Update Device message sent to the Trust Center. The device may have joined or rejoined insecurely, rejoined securely, or left. MAC Security has been deprecated and therefore there is no secure join.
Notes the last rejoin reason.
Defines the lists of clusters that must be provided for each endpoint.
Either marks an event as inactive or specifies the units for the event execution time.
The type of method used for joining.
Defines the events reported to the application by the ::sl_zigbee_counters_handler(). Usage of the destinationNodeId or data fields found in the sl_zigbee_counter_info_t or sl_zigbee_extra_counters_info_t structs is denoted for counter types that use them. (See comments accompanying enum definitions in this source file for details.)
Counters Request Definitions#
This is the Initial Security Bitmask that controls the use of various security features.
This is the Extended Security Bitmask that controls the use of various extended security features.
This is the Current Security Bitmask that details the use of various security features.
This bitmask describes the presence of fields within the sl_zigbee_key_struct_t.
This denotes the type of security key.
This denotes the status of an attempt to establish a key with another device.
This enumeration determines whether or not a Trust Center answers trust center link key requests.
This enumeration determines whether or not a Trust Center answers app link key requests.
This is a ZigBee application profile ID that has been assigned to Ember Corporation.
Duty cycle states.
The types of MAC passthrough messages that an application may receive. This is a bitmask.
This function allows access to the actual key data bytes of the sl_zigbee_key_data_t structure.
Get access to the actual certificate data bytes of the sl_zigbee_certificate_data_t structure.
Get access to the actual public key data bytes of the sl_zigbee_public_key_data_t structure.
Get access to the actual private key data bytes of the sl_zigbee_private_key_data_t structure.
Get access to the actual SMAC (Secured Message Authentication Code) data of the sl_zigbee_smac_data_t structure.
Get access to the actual ECDSA signature data of the sl_zigbee_signature_data_t structure.
Get access to the actual certificate data bytes of the sl_zigbee_283k1_certificate_data_t structure.
Get access to the actual public key data bytes of the sl_zigbee_283k1_public_key_data_t structure.
Get access to the actual private key data bytes of the sl_zigbee_283k1_private_key_data_t structure.
Get access to the actual ECDSA signature data of the sl_zigbee_signature_283k1_data_t structure.
This is a ZigBee application profile ID that has been assigned to Ember Corporation.
Ember's first private profile ID.
Ember's last private profile ID.
This is an sl_zigbee_initial_security_bitmask_t value but it does not actually set anything. It is the default mode used by the ZigBee Pro stack. It is defined here so that no legacy code is broken by referencing it.
The short address of the trust center. This address never changes dynamically.
This denotes that the device can require a resync of the APS frame counter.
This is the legacy name for the Distributed Trust Center Mode.
This is the legacy name for the Trust Center Global Link Key.
This magic number prevents accidentally changing the key settings. The sl_zigbee_set_mfg_security_config() API will return SL_ZIGBEE_INVALID_CALL unless it is passed in.
ZDO response status.#
Most responses to ZDO commands contain a status byte. The meaning of this byte is defined by the ZigBee Device Profile.
ZDO server mask bits#
These are used in server discovery requests and responses.
ZDO configuration flags.#
Control which ZDO requests are passed to the application. These are normally controlled via the following configuration definitions:SL_ZIGBEE_APPLICATION_RECEIVES_SUPPORTED_ZDO_REQUESTS SL_ZIGBEE_APPLICATION_HANDLES_UNSUPPORTED_ZDO_REQUESTS SL_ZIGBEE_APPLICATION_HANDLES_ENDPOINT_ZDO_REQUESTS SL_ZIGBEE_APPLICATION_HANDLES_BINDING_ZDO_REQUESTSSee ember-configuration.h for more information.
Defines the maximum number of counters that are specified as reporting either on 2.4 GHz or Sub-GHz.
Defines the maximum number of counters that are specified as reporting either on 2.4 GHz or Sub-GHz.
Defines beacon classification flags.
Defines the entropy source used by the stack.
Defines the maximum number of counters that are specified as reporting either on 2.4 GHz or Sub-GHz.
Defines the trust center APS encryption mode when sending a newer (alternate) network key to a device. The value settings below do not take effect when sending the initial network key during joining or rejoining.
Radio power mode.
Defines the maximum number of counters that are specified as reporting either on 2.4 GHz or Sub-GHz.
Defines the maximum number of counters that are specified as reporting either on 2.4 GHz or Sub-GHz.
Defines the maximum number of PHYs supported.
PHY index for 2.4 GHz radio interface, valid for simultaneous multi radio network.
PHY index for Sub-GHz radio interface, valid for simultaneous multi radio network.
ZigBee Broadcast Addresses#
ZigBee specifies three different broadcast addresses that reach different collections of nodes. Broadcasts are normally sent only to routers. Broadcasts can also be forwarded to end devices, either all of them or only those that do not sleep. Broadcasting to end devices is both significantly more resource-intensive and significantly less reliable than broadcasting to routers.
txPowerModes for sl_802154_set_tx_power_mode and mfglibSetPower#
The application should call sl_802154_set_tx_power_mode() with the txPowerMode parameter set to this value to disable all power mode options, resulting in normal power mode and bi-directional RF transmitter output.
The application should call sl_802154_set_tx_power_mode() with the txPowerMode parameter set to this value to enable boost power mode.
The application should call sl_802154_set_tx_power_mode() with the txPowerMode parameter set to this value to enable the alternate transmitter output.
The application should call sl_802154_set_tx_power_mode() with the txPowerMode parameter set to this value to enable both boost mode and the alternate transmitter output.
Enumerations#
Defines the possible types of nodes and the roles that a node might play in a network.
The configuration advertised by the end device to the parent when joining/rejoining.
Defines the options that should be used when initializing the node's network configuration.
Options to allow/disallow rejoins using the default link key.
Options to use when sending a message.
Defines the possible incoming message types.
Defines the possible outgoing message types.
A type of command received by the stack.
indication of the action taken on a packet
A type of packet received by the stack.
Defines the possible join states for a node.
Type for a network scan.
Defines binding types.
Type of Ember keep alive method defining the keep alive message type that a parent accepts to prevent child aging. This is configured in a parent router and communicated and stored in an end-device.
Types of source route discovery modes used by the concentrator.
Packet transmit priorities in terms of getting into the MAC queue.
Policies for sending a route record to the concentrator.
Passive ack config enum.
Typedefs#
represents a single entry in the APS duplicate rejection table
Macros#
Returns true if nodeId (short address) is a broadcast address.
Miscellaneous Ember Types Documentation#
sl_zigbee_version_type_t#
sl_zigbee_version_type_t
Type of Ember software version.
| Enumerator | |
|---|---|
| SL_ZIGBEE_VERSION_TYPE_PRE_RELEASE | |
| SL_ZIGBEE_VERSION_TYPE_ALPHA_1 | |
| SL_ZIGBEE_VERSION_TYPE_ALPHA_2 | |
| SL_ZIGBEE_VERSION_TYPE_ALPHA_3 | |
| SL_ZIGBEE_VERSION_TYPE_BETA_1 | |
| SL_ZIGBEE_VERSION_TYPE_BETA_2 | |
| SL_ZIGBEE_VERSION_TYPE_BETA_3 | |
| SL_ZIGBEE_VERSION_TYPE_GA | |
54 of file stack/include/sl_zigbee_types.hsl_zigbee_leave_network_option_t#
sl_zigbee_leave_network_option_t
Use in case zigbee leave network with options.
| Enumerator | |
|---|---|
| SL_ZIGBEE_LEAVE_NWK_WITH_NO_OPTION | Leave with no option. |
| SL_ZIGBEE_LEAVE_NWK_WITH_OPTION_REJOIN | Leave with option rejoin. |
| SL_ZIGBEE_LEAVE_NWK_IS_REQUESTED | Leave is requested. |
462 of file stack/include/sl_zigbee_types.hsl_zigbee_stack_profile_t#
sl_zigbee_stack_profile_t
sl_zigbee_release_type_struct_t Data that relates release type to the correct string.
| Enumerator | |
|---|---|
| SL_ZIGBEE_STACK_PROFILE_NONE | |
| SL_ZIGBEE_STACK_PROFILE_ZIGBEE_PRO | |
477 of file stack/include/sl_zigbee_types.hsl_zigbee_security_level_t#
sl_zigbee_security_level_t
sl_zigbee_release_type_struct_t Data that relates release type to the correct string.
| Enumerator | |
|---|---|
| SL_ZIGBEE_SECURITY_LEVEL_NONE | |
| SL_ZIGBEE_SECURITY_LEVEL_Z3 | |
488 of file stack/include/sl_zigbee_types.hsl_zigbee_leave_request_flags_t#
sl_zigbee_leave_request_flags_t
sl_zigbee_release_type_struct_t Data that relates release type to the correct string.
| Enumerator | |
|---|---|
| SL_ZIGBEE_ZIGBEE_LEAVE_AND_REJOIN | Leave and rejoin. |
| SL_ZIGBEE_ZIGBEE_LEAVE_WITHOUT_REJOIN | Leave. |
499 of file stack/include/sl_zigbee_types.hsl_zigbee_leave_reason_t#
sl_zigbee_leave_reason_t
sl_zigbee_release_type_struct_t Data that relates release type to the correct string.
| Enumerator | |
|---|---|
| SL_ZIGBEE_LEAVE_REASON_NONE | |
| SL_ZIGBEE_LEAVE_DUE_TO_NWK_LEAVE_MESSAGE | |
| SL_ZIGBEE_LEAVE_DUE_TO_APS_REMOVE_MESSAGE | |
| SL_ZIGBEE_LEAVE_DUE_TO_ZDO_LEAVE_MESSAGE | |
| SL_ZIGBEE_LEAVE_DUE_TO_ZLL_TOUCHLINK | |
| SL_ZIGBEE_LEAVE_DUE_TO_APP_EVENT_1 | |
519 of file stack/include/sl_zigbee_types.hsl_zigbee_multicast_id_t#
typedef uint16_t sl_zigbee_multicast_id_t
16-bit ZigBee network address.
16-bit ZigBee multicast group identifier.
231 of file stack/include/sl_zigbee_types.hsl_zigbee_duty_cycle_hecto_pct_t#
typedef uint16_t sl_zigbee_duty_cycle_hecto_pct_t
802.15.4 PAN ID.
The 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%).
244 of file stack/include/sl_zigbee_types.hsl_zigbee_version#
const sl_zigbee_version_t sl_zigbee_version
A structure containing the version information.
116 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_RELEASE_TYPE_TO_STRING_STRUCT_DATA#
#define SL_ZIGBEE_RELEASE_TYPE_TO_STRING_STRUCT_DATAValue:
sl_zigbee_release_type_struct_t Data that relates release type to the correct string.
90 of file stack/include/sl_zigbee_types.hEUI64_SIZE#
#define EUI64_SIZEValue:
8
Size of EUI64 (an IEEE address) in bytes (8).
138 of file stack/include/sl_zigbee_types.hEXTENDED_PAN_ID_SIZE#
#define EXTENDED_PAN_ID_SIZEValue:
8
Size of an extended PAN identifier in bytes (8).
143 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_ENCRYPTION_KEY_SIZE#
#define SL_ZIGBEE_ENCRYPTION_KEY_SIZEValue:
16
Size of an encryption key in bytes (16).
148 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_CERTIFICATE_SIZE#
#define SL_ZIGBEE_CERTIFICATE_SIZEValue:
48
Size of Implicit Certificates used for Certificate-based Key Exchange(CBKE).
154 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_PUBLIC_KEY_SIZE#
#define SL_ZIGBEE_PUBLIC_KEY_SIZEValue:
22
Size of Public Keys used in Elliptical Cryptography ECMQV algorithms.
159 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_PRIVATE_KEY_SIZE#
#define SL_ZIGBEE_PRIVATE_KEY_SIZEValue:
21
Size of Private Keys used in Elliptical Cryptography ECMQV algorithms.
164 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_SMAC_SIZE#
#define SL_ZIGBEE_SMAC_SIZEValue:
16
Size of the SMAC used in Elliptical Cryptography ECMQV algorithms.
169 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_SIGNATURE_SIZE#
#define SL_ZIGBEE_SIGNATURE_SIZEValue:
42
Size of the DSA signature used in Elliptical Cryptography Digital Signature Algorithms.
175 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_AES_HASH_BLOCK_SIZE#
#define SL_ZIGBEE_AES_HASH_BLOCK_SIZEValue:
16
The size of AES-128 MMO hash is 16-bytes. This is defined in the core. ZigBee specification.
180 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_CERTIFICATE_283K1_SIZE#
#define SL_ZIGBEE_CERTIFICATE_283K1_SIZEValue:
74
Size of Implicit Certificates used for Certificate Based Key Exchange using the ECC283K1 curve in bytes.
186 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_PUBLIC_KEY_283K1_SIZE#
#define SL_ZIGBEE_PUBLIC_KEY_283K1_SIZEValue:
37
Size of Public Keys used in SECT283k1 Elliptical Cryptography ECMQV algorithms.
191 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_PRIVATE_KEY_283K1_SIZE#
#define SL_ZIGBEE_PRIVATE_KEY_283K1_SIZEValue:
36
Size of Private Keys used SECT283k1 in Elliptical Cryptography ECMQV algorithms.
196 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_SIGNATURE_283K1_SIZE#
#define SL_ZIGBEE_SIGNATURE_283K1_SIZEValue:
72
Size of the DSA signature used in SECT283k1 Elliptical Cryptography Digital Signature Algorithms.
202 of file stack/include/sl_zigbee_types.hNULL_BUFFER#
#define NULL_BUFFERValue:
0x0000u
EUI 64-bit ID (an IEEE address).
Incoming and outgoing messages are stored in buffers. These buffers are allocated and freed as needed.
Buffers are 32 bytes in length and can be linked together to hold longer messages.
See packet-buffer.h for APIs related to stack and linked buffers.
223 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_MAX_802_15_4_CHANNEL_NUMBER#
#define SL_ZIGBEE_MAX_802_15_4_CHANNEL_NUMBERValue:
26
The maximum 802.15.4 channel number is 26.
249 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_MIN_802_15_4_CHANNEL_NUMBER#
#define SL_ZIGBEE_MIN_802_15_4_CHANNEL_NUMBERValue:
11
The minimum 2.4GHz 802.15.4 channel number is 11.
254 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_MIN_SUBGHZ_CHANNEL_NUMBER#
#define SL_ZIGBEE_MIN_SUBGHZ_CHANNEL_NUMBERValue:
0
The minimum SubGhz channel number is 0.
259 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_ACTIVE_SCAN_DURATION#
#define SL_ZIGBEE_ACTIVE_SCAN_DURATIONValue:
3
ZigBee protocol specifies that active scans have a duration of 3 (138 msec). See documentation for sl_zigbee_start_scan in include/network-formation.h for more info on duration values.
266 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_SUB_GHZ_SCAN_DURATION#
#define SL_ZIGBEE_SUB_GHZ_SCAN_DURATIONValue:
5
The SubGhz scan duration is 5.
271 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_NUM_802_15_4_CHANNELS#
#define SL_ZIGBEE_NUM_802_15_4_CHANNELSValue:
(SL_ZIGBEE_MAX_802_15_4_CHANNEL_NUMBER - SL_ZIGBEE_MIN_802_15_4_CHANNEL_NUMBER + 1)
There are sixteen 802.15.4 channels.
276 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_ALL_802_15_4_CHANNELS_MASK#
#define SL_ZIGBEE_ALL_802_15_4_CHANNELS_MASKValue:
0x07FFF800UL
A bitmask to scan all 2.4 GHz 802.15.4 channels.
282 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_MAX_CHANNELS_PER_PAGE#
#define SL_ZIGBEE_MAX_CHANNELS_PER_PAGEValue:
27
The maximum channels per page are 27 page bits 31...27, channel bits 26...0.
288 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_ALL_SUBGHZ_CHANNELS_MASK_FOR_PAGES_28_30_31#
#define SL_ZIGBEE_ALL_SUBGHZ_CHANNELS_MASK_FOR_PAGES_28_30_31Value:
0x07FFFFFFUL
Sub-GHz channel bitmasks for pages 28, 30, 31.
293 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_MAX_SUBGHZ_CHANNEL_NUMBER_ON_PAGES_28_30_31#
#define SL_ZIGBEE_MAX_SUBGHZ_CHANNEL_NUMBER_ON_PAGES_28_30_31Value:
26
The maximum SubGhz channel number on pages 28, 30, 31 is 26.
298 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_ALL_SUBGHZ_CHANNELS_MASK_FOR_PAGES_29#
#define SL_ZIGBEE_ALL_SUBGHZ_CHANNELS_MASK_FOR_PAGES_29Value:
0x1FF
SubGhz channel bitmasks for page 29.
302 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_MAX_SUBGHZ_CHANNEL_NUMBER_ON_PAGE_29#
#define SL_ZIGBEE_MAX_SUBGHZ_CHANNEL_NUMBER_ON_PAGE_29Value:
8
The maximum SubGhz channel number on page 29 is 8.
307 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_MIN_SUGBHZ_PAGE_NUMBER#
#define SL_ZIGBEE_MIN_SUGBHZ_PAGE_NUMBERValue:
28
The minimum SubGhz page number is 28.
312 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_MAX_SUGBHZ_PAGE_NUMBER#
#define SL_ZIGBEE_MAX_SUGBHZ_PAGE_NUMBERValue:
31
The maximum SubGhz page number is 31.
317 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_ALL_CHANNEL_PAGE_MASK#
#define SL_ZIGBEE_ALL_CHANNEL_PAGE_MASKValue:
0xF8000000UL
A bitmask for the channel page within a channel mask.
322 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_PAGE_CHANNEL_MASK_FROM_CHANNEL_MASK#
#define SL_ZIGBEE_PAGE_CHANNEL_MASK_FROM_CHANNEL_MASKValue:
A page-channel mask for a given page and channel mask.
327 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_PAGE_CHANNEL_MASK_FROM_CHANNEL_NUMBER#
#define SL_ZIGBEE_PAGE_CHANNEL_MASK_FROM_CHANNEL_NUMBERValue:
(page, channel)
A page-channel mask for a given page and channel.
334 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_ZIGBEE_COORDINATOR_ADDRESS#
#define SL_ZIGBEE_ZIGBEE_COORDINATOR_ADDRESSValue:
0x0000u
The network ID of the coordinator in a ZigBee network is 0x0000.
340 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_NULL_NODE_ID#
#define SL_ZIGBEE_NULL_NODE_IDValue:
0xFFFFu
A distinguished network ID that will never be assigned to any node. It is used to indicate the absence of a node ID.
346 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_NO_CHANNEL_PAGE_IN_USE#
#define SL_ZIGBEE_NO_CHANNEL_PAGE_IN_USEValue:
0
The channel page value used to indicate just the 2.4GHz channels.
351 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_NULL_EUI64#
#define SL_ZIGBEE_NULL_EUI64Value:
{ 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF }A distinguished EUI64 that is commonly used to indicate an invalid EUI64.
356 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_NULL_BINDING#
#define SL_ZIGBEE_NULL_BINDINGValue:
0xFFu
A distinguished binding index used to indicate the absence of a binding.
362 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_TABLE_ENTRY_UNUSED_NODE_ID#
#define SL_ZIGBEE_TABLE_ENTRY_UNUSED_NODE_IDValue:
0xFFFFu
A distinguished network ID that will never be assigned to any node.
This value is used when setting or getting the remote node ID in the address table or getting the remote node ID from the binding table. It indicates that the address or binding table entry is not in use.
373 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_MULTICAST_NODE_ID#
#define SL_ZIGBEE_MULTICAST_NODE_IDValue:
0xFFFEu
A distinguished network ID that will never be assigned to any node. This value is returned when getting the remote node ID from the binding table and the given binding table index refers to a multicast binding entry.
381 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_UNKNOWN_NODE_ID#
#define SL_ZIGBEE_UNKNOWN_NODE_IDValue:
0xFFFDu
A distinguished network ID that will never be assigned to any node. This value is used when getting the remote node ID from the address or binding tables. It indicates that the address or binding table entry is currently in use but the node ID corresponding to the EUI64 in the table is currently unknown.
390 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_DISCOVERY_ACTIVE_NODE_ID#
#define SL_ZIGBEE_DISCOVERY_ACTIVE_NODE_IDValue:
0xFFFCu
A distinguished network ID that will never be assigned to any node. This value is used when getting the remote node ID from the address or binding tables. It indicates that the address or binding table entry is currently in use and network address discovery is underway.
399 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_NULL_ADDRESS_TABLE_INDEX#
#define SL_ZIGBEE_NULL_ADDRESS_TABLE_INDEXValue:
0xFFu
A distinguished address table index used to indicate the absence of an address table entry.
405 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_ZDO_ENDPOINT#
#define SL_ZIGBEE_ZDO_ENDPOINTValue:
0u
The endpoint where the ZigBee Device Object (ZDO) resides.
410 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_BROADCAST_ENDPOINT#
#define SL_ZIGBEE_BROADCAST_ENDPOINTValue:
0xFFu
The broadcast endpoint, as defined in the ZigBee spec.
415 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_GP_ENDPOINT#
#define SL_ZIGBEE_GP_ENDPOINTValue:
0xF2u
The GP endpoint, as defined in the ZigBee spec.
420 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_ZDO_PROFILE_ID#
#define SL_ZIGBEE_ZDO_PROFILE_IDValue:
0x0000u
The profile ID used by the ZigBee Device Object (ZDO).
425 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_WILDCARD_PROFILE_ID#
#define SL_ZIGBEE_WILDCARD_PROFILE_IDValue:
0xFFFFu
The profile ID used to address all the public profiles.
430 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_MAXIMUM_STANDARD_PROFILE_ID#
#define SL_ZIGBEE_MAXIMUM_STANDARD_PROFILE_IDValue:
0x7FFFu
The maximum value for a profile ID in the standard profile range.
435 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_BROADCAST_TABLE_TIMEOUT_QS#
#define SL_ZIGBEE_BROADCAST_TABLE_TIMEOUT_QSValue:
(20 * 4)
The broadcast table entry timeout, which specifies, in quarter seconds, how long an entry persists in the local device's broadcast table.
441 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_MANUFACTURER_ID#
#define SL_ZIGBEE_MANUFACTURER_IDValue:
0x1002u
Ember's Manufacturer ID.
446 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_NULL_NETWORK_INDEX#
#define SL_ZIGBEE_NULL_NETWORK_INDEXValue:
0xFFu
An invalid network index.
451 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_DC_LIMIT_USE_DEFAULT#
#define SL_ZIGBEE_DC_LIMIT_USE_DEFAULTValue:
0
Use Ember's default duty cycle limit configurations.
456 of file stack/include/sl_zigbee_types.hEmber Concentrator Types Documentation#
sl_zigbee_assume_trust_center_concentrator_type_t#
sl_zigbee_assume_trust_center_concentrator_type_t
To 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 assumed concentrator type can be changed by setting appropriate value in sl_zigbee_set_assumed_trust_center_concentrator_type().
| Enumerator | |
|---|---|
| SL_ZIGBEE_ASSUME_TRUST_CENTER_IS_NOT_A_CONCENTRATOR | To assume trust center is not a concentrator. |
| SL_ZIGBEE_ASSUME_TRUST_CENTER_IS_LOW_RAM_CONCENTRATOR | To assume trust center is a low RAM concentrator. |
| SL_ZIGBEE_ASSUME_TRUST_CENTER_IS_HIGH_RAM_CONCENTRATOR | To assume trust center is a high RAM concentrator. |
1043 of file stack/include/sl_zigbee_types.hsl_zigbee_join_decision_t#
sl_zigbee_join_decision_t
The decision made by the Trust Center when a node attempts to join.
| Enumerator | |
|---|---|
| SL_ZIGBEE_USE_PRECONFIGURED_KEY | Allow the node to join. The node has the key. |
| SL_ZIGBEE_SEND_KEY_IN_THE_CLEAR | Allow the node to join. Send the key to the node. |
| SL_ZIGBEE_DENY_JOIN | Deny join. |
| SL_ZIGBEE_NO_ACTION | Take no action. |
| SL_ZIGBEE_ALLOW_REJOINS_ONLY | Allow rejoins only. |
1061 of file stack/include/sl_zigbee_types.hsl_zigbee_device_update_t#
sl_zigbee_device_update_t
The Status of the Update Device message sent to the Trust Center. The device may have joined or rejoined insecurely, rejoined securely, or left. MAC Security has been deprecated and therefore there is no secure join.
| Enumerator | |
|---|---|
| SL_ZIGBEE_STANDARD_SECURITY_SECURED_REJOIN | |
| SL_ZIGBEE_STANDARD_SECURITY_UNSECURED_JOIN | |
| SL_ZIGBEE_DEVICE_LEFT | |
| SL_ZIGBEE_STANDARD_SECURITY_UNSECURED_REJOIN | |
1097 of file stack/include/sl_zigbee_types.hsl_zigbee_rejoin_reason_t#
sl_zigbee_rejoin_reason_t
Notes the last rejoin reason.
| Enumerator | |
|---|---|
| SL_ZIGBEE_REJOIN_REASON_NONE | |
| SL_ZIGBEE_REJOIN_DUE_TO_NWK_KEY_UPDATE | |
| SL_ZIGBEE_REJOIN_DUE_TO_LEAVE_MESSAGE | |
| SL_ZIGBEE_REJOIN_DUE_TO_NO_PARENT | |
| SL_ZIGBEE_REJOIN_DUE_TO_ZLL_TOUCHLINK | |
| SL_ZIGBEE_REJOIN_DUE_TO_END_DEVICE_REBOOT | |
| SL_ZIGBEE_REJOIN_DUE_TO_APP_EVENT_5 | |
| SL_ZIGBEE_REJOIN_DUE_TO_APP_EVENT_4 | |
| SL_ZIGBEE_REJOIN_DUE_TO_APP_EVENT_3 | |
| SL_ZIGBEE_REJOIN_DUE_TO_APP_EVENT_2 | |
| SL_ZIGBEE_REJOIN_DUE_TO_APP_EVENT_1 | |
1122 of file stack/include/sl_zigbee_types.hsl_zigbee_cluster_list_id_t#
sl_zigbee_cluster_list_id_t
Defines the lists of clusters that must be provided for each endpoint.
| Enumerator | |
|---|---|
| SL_ZIGBEE_INPUT_CLUSTER_LIST | Input clusters the endpoint will accept. |
| SL_ZIGBEE_OUTPUT_CLUSTER_LIST | Output clusters the endpoint can send. |
1153 of file stack/include/sl_zigbee_types.hsl_zigbee_event_units_t#
sl_zigbee_event_units_t
Either marks an event as inactive or specifies the units for the event execution time.
| Enumerator | |
|---|---|
| SL_ZIGBEE_EVENT_INACTIVE | The event is not scheduled to run. |
| SL_ZIGBEE_EVENT_MS_TIME | The execution time is in approximate milliseconds. |
| SL_ZIGBEE_EVENT_QS_TIME | The execution time is in 'binary' quarter seconds (256 approximate milliseconds each). |
| SL_ZIGBEE_EVENT_MINUTE_TIME | The execution time is in 'binary' minutes (65536 approximate milliseconds each). |
| SL_ZIGBEE_EVENT_ZERO_DELAY | The event is scheduled to run at the earliest opportunity. |
1170 of file stack/include/sl_zigbee_types.hsl_zigbee_join_method_t#
sl_zigbee_join_method_t
The type of method used for joining.
| Enumerator | |
|---|---|
| SL_ZIGBEE_USE_MAC_ASSOCIATION | Devices normally 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_REJOIN | For networks where the "permit joining" flag is never turned on, devices 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_KEY | |
| SL_ZIGBEE_USE_CONFIGURED_NWK_STATE | For 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_USE_NWK_COMMISSIONING_JOIN | This enumeration causes an unencrypted Network Commissioning Request to be sent out with joinType set to initial join. The trust center may respond by establishing a new dynamic link key and then sending the network key. Network Commissioning Requests should only be sent to parents that support processing of the command. |
| SL_ZIGBEE_USE_NWK_COMMISSIONING_REJOIN | This enumeration causes an unencrypted Network Commissioning Request to be sent out with joinType set to rejoin. The trust center may respond by establishing a new dynamic link key and then sending the network key. Network Commissioning Requests should only be sent to parents that support processing of the command. |
| SL_ZIGBEE_USE_NWK_COMMISSIONING_REJOIN_HAVE_NWK_KEY | This enumeration causes an encrypted Network Commissioning Request to be sent out with joinType set to rejoin. This enumeration is used by devices that already have the network key and wish to recover connection to a parent or the network in general. Network Commissioning Requests should only be sent to parents that support processing of the command. |
1194 of file stack/include/sl_zigbee_types.hsl_zigbee_counter_type_t#
sl_zigbee_counter_type_t
Defines the events reported to the application by the ::sl_zigbee_counters_handler(). Usage of the destinationNodeId or data fields found in the sl_zigbee_counter_info_t or sl_zigbee_extra_counters_info_t structs is denoted for counter types that use them. (See comments accompanying enum definitions in this source file for details.)
| Enumerator | |
|---|---|
| SL_ZIGBEE_COUNTER_MAC_RX_BROADCAST | The MAC received a broadcast Data frame, Command frame, or Beacon destinationNodeId: BROADCAST_ADDRESS or Data frames or sender node ID for Beacon frames data: not used |
| SL_ZIGBEE_COUNTER_MAC_TX_BROADCAST | The MAC transmitted a broadcast Data frame, Command frame or Beacon. destinationNodeId: BROADCAST_ADDRESS data: not used |
| SL_ZIGBEE_COUNTER_MAC_RX_UNICAST | The MAC received a unicast Data or Command frame destinationNodeId: MAC layer source or SL_ZIGBEE_UNKNOWN_NODE_ID if no 16-bit source node ID is present in the frame data: not used |
| SL_ZIGBEE_COUNTER_MAC_TX_UNICAST_SUCCESS | The MAC successfully transmitted a unicast Data or Command frame Note: Only frames with a 16-bit destination node ID are counted. destinationNodeId: MAC layer destination address data: not used |
| SL_ZIGBEE_COUNTER_MAC_TX_UNICAST_RETRY | The MAC retried a unicast Data or Command frame after initial Tx attempt. Note: CSMA-related failures are tracked separately via SL_ZIGBEE_COUNTER_PHY_CCA_FAIL_COUNT. destinationNodeId: MAC layer destination or SL_ZIGBEE_UNKNOWN_NODE_ID if no 16-bit destination node ID is present in the frame data: number of retries (after initial Tx attempt) accumulated so far for this packet. (Should always be >0.) |
| SL_ZIGBEE_COUNTER_MAC_TX_UNICAST_FAILED | The MAC unsuccessfully transmitted a unicast Data or Command frame. Note: Only frames with a 16-bit destination node ID are counted. destinationNodeId: MAC layer destination address data: not used |
| SL_ZIGBEE_COUNTER_APS_DATA_RX_BROADCAST | The APS layer received a data broadcast. destinationNodeId: sender's node ID data: not used |
| SL_ZIGBEE_COUNTER_APS_DATA_TX_BROADCAST | The APS layer transmitted a data broadcast. |
| SL_ZIGBEE_COUNTER_APS_DATA_RX_UNICAST | The APS layer received a data unicast. destinationNodeId: sender's node ID data: not used |
| SL_ZIGBEE_COUNTER_APS_DATA_TX_UNICAST_SUCCESS | The APS layer successfully transmitted a data unicast. destinationNodeId: NWK destination address data: number of APS retries (>=0) consumed for this unicast. |
| SL_ZIGBEE_COUNTER_APS_DATA_TX_UNICAST_RETRY | The APS layer retried a unicast Data frame. This is a placeholder and is not used by the |
| SL_ZIGBEE_COUNTER_APS_DATA_TX_UNICAST_FAILED | |
| SL_ZIGBEE_COUNTER_ROUTE_DISCOVERY_INITIATED | The network layer successfully submitted a new route discovery to the MAC. |
| SL_ZIGBEE_COUNTER_NEIGHBOR_ADDED | An entry was added to the neighbor table. |
| SL_ZIGBEE_COUNTER_NEIGHBOR_REMOVED | An entry was removed from the neighbor table. |
| SL_ZIGBEE_COUNTER_NEIGHBOR_STALE | A neighbor table entry became stale because it had not been heard from. |
| SL_ZIGBEE_COUNTER_JOIN_INDICATION | A node joined or rejoined to the network via this node. destinationNodeId: node ID of child data: not used |
| SL_ZIGBEE_COUNTER_CHILD_REMOVED | An entry was removed from the child table. destinationNodeId: node ID of child data: not used |
| SL_ZIGBEE_COUNTER_ASH_OVERFLOW_ERROR | EZSP-UART only. An overflow error occurred in the UART. |
| SL_ZIGBEE_COUNTER_ASH_FRAMING_ERROR | EZSP-UART only. A framing error occurred in the UART. |
| SL_ZIGBEE_COUNTER_ASH_OVERRUN_ERROR | EZSP-UART only. An overrun error occurred in the UART. |
| SL_ZIGBEE_COUNTER_NWK_FRAME_COUNTER_FAILURE | A 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_FAILURE | A message was dropped at the APS layer because the APS frame counter was not higher than the last message seen from that source. destinationNodeId: node ID of MAC source that relayed the message data: not used |
| SL_ZIGBEE_COUNTER_ASH_XOFF | EZSP-UART only. An XOFF was transmitted by the UART. |
| SL_ZIGBEE_COUNTER_APS_LINK_KEY_NOT_AUTHORIZED | An encrypted message was dropped by the APS layer because the sender's key has not been authenticated. As a result, the key is not authorized for use in APS data messages. destinationNodeId: SL_ZIGBEE_NULL_NODE_ID data: APS key table index related to the sender |
| SL_ZIGBEE_COUNTER_NWK_DECRYPTION_FAILURE | A NWK encrypted message was received but dropped because decryption failed. destinationNodeId: sender of the dropped packet data: not used |
| SL_ZIGBEE_COUNTER_APS_DECRYPTION_FAILURE | An APS encrypted message was received but dropped because decryption failed. destinationNodeId: sender of the dropped packet data: not used |
| SL_ZIGBEE_COUNTER_ALLOCATE_PACKET_BUFFER_FAILURE | The number of failures 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_UNICAST | The number of relayed unicast packets. destinationId: NWK layer destination address of relayed packet data: not used |
| SL_ZIGBEE_COUNTER_PHY_TO_MAC_QUEUE_LIMIT_REACHED | The number of times a packet was dropped due to reaching the preset PHY-to-MAC queue limit (sli_mac_phy_to_mac_queue_length). The limit will determine how many messages are accepted by the PHY between calls to sl_zigbee_tick(). After that limit is reached, packets will be dropped. The counter records the number of dropped packets. NOTE: For each call to sl_zigbee_counters_handler() there may be more than 1 packet that was dropped due to the limit reached. The actual number of packets dropped will be returned in the 'data' parameter passed to that function. destinationNodeId: not used data: number of dropped packets represented by this counter event phyIndex: present |
| SL_ZIGBEE_COUNTER_PACKET_VALIDATE_LIBRARY_DROPPED_COUNT | The number of times a packet was dropped due to the packet-validate library checking a packet and rejecting it due to length or other formatting problems. destinationNodeId: not used data: type of validation condition that failed |
| SL_ZIGBEE_COUNTER_TYPE_NWK_RETRY_OVERFLOW | The number of times the NWK retry queue is full and a new message failed to be added. destinationNodeId; not used data: NWK retry queue size that has been exceeded |
| SL_ZIGBEE_COUNTER_PHY_CCA_FAIL_COUNT | The number of times the PHY layer was unable to transmit due to a failed CCA (Clear Channel Assessment) attempt. See also: SL_ZIGBEE_COUNTER_MAC_TX_UNICAST_RETRY. destinationNodeId: MAC layer destination or SL_ZIGBEE_UNKNOWN_NODE_ID if no 16-bit destination node ID is present in the frame data: not used |
| SL_ZIGBEE_COUNTER_BROADCAST_TABLE_FULL | The number of times a NWK broadcast was dropped because the broadcast table was full. |
| SL_ZIGBEE_COUNTER_PTA_LO_PRI_REQUESTED | The number of times a low-priority packet traffic arbitration request has been made. |
| SL_ZIGBEE_COUNTER_PTA_HI_PRI_REQUESTED | The number of times a high-priority packet traffic arbitration request has been made. |
| SL_ZIGBEE_COUNTER_PTA_LO_PRI_DENIED | The number of times a low-priority packet traffic arbitration request has been denied. |
| SL_ZIGBEE_COUNTER_PTA_HI_PRI_DENIED | The number of times a high-priority packet traffic arbitration request has been denied. |
| SL_ZIGBEE_COUNTER_PTA_LO_PRI_TX_ABORTED | The number of times a low-priority packet traffic arbitration transmission has been aborted. |
| SL_ZIGBEE_COUNTER_PTA_HI_PRI_TX_ABORTED | The number of times a high-priority packet traffic arbitration transmission has been aborted. |
| SL_ZIGBEE_COUNTER_ADDRESS_CONFLICT_SENT | The number of times an address conflict has caused node_id change, and an address conflict error is sent |
| SL_ZIGBEE_COUNTER_TYPE_COUNT | A placeholder giving the number of Ember counter types. |
1463 of file stack/include/sl_zigbee_types.hsl_zigbee_task_id_t#
typedef uint8_t sl_zigbee_task_id_t
brief An identifier for a task.
1775 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_LOW_RAM_CONCENTRATOR#
#define SL_ZIGBEE_LOW_RAM_CONCENTRATORValue:
0xFFF8u
A 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.
1023 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_HIGH_RAM_CONCENTRATOR#
#define SL_ZIGBEE_HIGH_RAM_CONCENTRATORValue:
0xFFF9u
A 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.
1028 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_JOIN_DECISION_STRINGS#
#define SL_ZIGBEE_JOIN_DECISION_STRINGSValue:
@ brief Defines the CLI enumerations for the sl_zigbee_join_decision_t enum.
1082 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_DEVICE_UPDATE_STRINGS#
#define SL_ZIGBEE_DEVICE_UPDATE_STRINGSValue:
@ brief Defines the CLI enumerations for the sl_zigbee_device_update_t enum.
1112 of file stack/include/sl_zigbee_types.hsl_zigbee_initialize_network_parameters#
#define sl_zigbee_initialize_network_parametersValue:
(parameters)
A 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.
1298 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_COUNTER_STRINGS#
#define SL_ZIGBEE_COUNTER_STRINGS
@ brief Defines the CLI enumerations for the sl_zigbee_counter_type_t enum.
1719 of file stack/include/sl_zigbee_types.hCounters Request Definitions Documentation#
sl_zigbee_initial_security_bitmask_t#
sl_zigbee_initial_security_bitmask_t
This is the Initial Security Bitmask that controls the use of various security features.
| Enumerator | |
|---|---|
| SL_ZIGBEE_DISTRIBUTED_TRUST_CENTER_MODE | 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_KEY | Enables a Global Link Key for the Trust Center. All nodes will share the same Trust Center Link Key. |
| SL_ZIGBEE_PRECONFIGURED_NETWORK_KEY_MODE | 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_HAVE_TRUST_CENTER_EUI64 | This 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 that 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_TRUST_CENTER_USES_HASHED_LINK_KEY | This denotes that the sl_zigbee_initial_security_state_t::preconfiguredKey is not the actual Link Key but a Root Key known only to the Trust Center. It is hashed with the IEEE Address of the destination device 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_KEY | This denotes that the sl_zigbee_initial_security_state_t::preconfiguredKey element has valid data that should be used to configure the initial security state. |
| SL_ZIGBEE_HAVE_NETWORK_KEY | This denotes that the sl_zigbee_initial_security_state_t::networkKey element has valid data that should be used to configure the initial security state. |
| SL_ZIGBEE_GET_LINK_KEY_WHEN_JOINING | This denotes to a joining node that it should attempt to acquire a Trust Center Link Key during joining. This is necessary if the device does not have a pre-configured key, or wants to obtain a new one (since it may be using a well-known key during joining). |
| SL_ZIGBEE_REQUIRE_ENCRYPTED_KEY | This 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 using a pre-configured key. |
| SL_ZIGBEE_NO_FRAME_COUNTER_RESET | This denotes whether the device should NOT reset its outgoing frame counters (both NWK and APS) when sl_zigbee_set_initial_security_state() is called. Normally it is advised to reset the frame counter before joining a new network. However, when a device is joining to the same network again (but not using ::emberRejoinNetwork()), it should keep the NWK and APS frame counters stored in its tokens. NOTE: The application is allowed to dynamically change the behavior via SL_ZIGBEE_EXT_NO_FRAME_COUNTER_RESET field. |
| SL_ZIGBEE_GET_PRECONFIGURED_KEY_FROM_INSTALL_CODE | This denotes that the device should obtain its pre-configured key from an installation code stored in the manufacturing token. The token contains a value that will be hashed to obtain the actual pre-configured key. If that token is not valid, the call to sl_zigbee_set_initial_security_state() will fail. |
2003 of file stack/include/sl_zigbee_types.hsl_zigbee_extended_security_bitmask_t#
sl_zigbee_extended_security_bitmask_t
This is the Extended Security Bitmask that controls the use of various extended security features.
| Enumerator | |
|---|---|
| SL_ZIGBEE_SECURE_NETWORK_KEY_ROTATION | This denotes that the network key update can only happen if the network key update request is unicast and encrypted i.e. broadcast network key update requests will not be processed if bit 1 is set |
| SL_ZIGBEE_JOINER_GLOBAL_LINK_KEY | This denotes whether a joiner node (router or end-device) uses a Global Link Key or a Unique Link Key. |
| SL_ZIGBEE_EXT_NO_FRAME_COUNTER_RESET | This denotes whether the device's outgoing frame counter is allowed to be reset during forming or joining. If the flag is set, the outgoing frame counter is not allowed to be reset. If the flag is not set, the frame counter is allowed to be reset. |
| SL_ZIGBEE_NWK_LEAVE_WITHOUT_REJOIN_NOT_ALLOWED | This denotes whether a device should discard or accept network leave without rejoin commands. |
| SL_ZIGBEE_NWK_LEAVE_REQUEST_NOT_ALLOWED | This denotes whether a router node should discard or accept network Leave Commands. |
2095 of file stack/include/sl_zigbee_types.hsl_zigbee_current_security_bitmask_t#
sl_zigbee_current_security_bitmask_t
This is the Current Security Bitmask that details the use of various security features.
| Enumerator | |
|---|---|
| SL_ZIGBEE_STANDARD_SECURITY_MODE_ | This denotes that the device is running in a network with ZigBee Standard Security. |
| SL_ZIGBEE_DISTRIBUTED_TRUST_CENTER_MODE_ | This denotes that the device is running in a network without a centralized Trust Center. |
| SL_ZIGBEE_TRUST_CENTER_GLOBAL_LINK_KEY_ | This 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_KEY | This denotes that the node has a Trust Center Link Key. |
| SL_ZIGBEE_TRUST_CENTER_USES_HASHED_LINK_KEY_ | This denotes that the Trust Center is using a Hashed Link Key. |
2223 of file stack/include/sl_zigbee_types.hsl_zigbee_key_struct_bitmask_t#
sl_zigbee_key_struct_bitmask_t
This bitmask describes the presence of fields within the sl_zigbee_key_struct_t.
| Enumerator | |
|---|---|
| SL_ZIGBEE_KEY_HAS_SEQUENCE_NUMBER | This indicates that the key has a sequence number associated with it. (i.e., a Network Key). |
| SL_ZIGBEE_KEY_HAS_OUTGOING_FRAME_COUNTER | This indicates that the key has an outgoing frame counter and the corresponding value within the sl_zigbee_key_struct_t has been populated. |
| SL_ZIGBEE_KEY_HAS_INCOMING_FRAME_COUNTER | This indicates that the key has an incoming frame counter and the corresponding value within the sl_zigbee_key_struct_t has been populated. |
| SL_ZIGBEE_KEY_HAS_PARTNER_EUI64 | This indicates that the key has an associated Partner EUI64 address and the corresponding value within the sl_zigbee_key_struct_t has been populated. |
| SL_ZIGBEE_KEY_IS_AUTHORIZED | This indicates the key is authorized for use in APS data messages. If the key is not authorized for use in APS data messages it has not yet gone through a key agreement protocol, such as CBKE (i.e., ECC). |
| SL_ZIGBEE_KEY_PARTNER_IS_SLEEPY | This indicates that the partner associated with the link is a sleepy end device. This bit is set automatically if the local device hears a device announce from the partner indicating it is not an 'RX on when idle' device. |
| SL_ZIGBEE_UNCONFIRMED_TRANSIENT_KEY | This indicates that the transient key which is being added is unconfirmed. This bit is set when we add a transient key while the sl_zigbee_tc_link_key_request_policy_t is SL_ZIGBEE_ALLOW_TC_LINK_KEY_REQUEST_AND_GENERATE_NEW_KEY |
| SL_ZIGBEE_KEY_HAS_PSA_ID | This indicates that the actual key data is stored in PSA, and the respective PSA ID is recorded in the psa_id field. |
| SL_ZIGBEE_KEY_HAS_KEY_DATA | This indicates that the keyData field has valid data. On certain parts and depending on the security configuration, keys may live in secure storage and are not exportable. In such cases, keyData will not house the actual key contents. |
| SL_ZIGBEE_KEY_IS_AUTHENTICATION_TOKEN | This indicates that the key represents a Device Authentication Token and is not an encryption key. The Authentication token is persisted for the lifetime of the device on the network and used to validate and update the device connection. It is only removed when the device leaves or is decommissioned from the network |
| SL_ZIGBEE_DLK_DERIVED_KEY | This indicates that the key has been derived by the Dynamic Link Key feature. |
| SL_ZIGBEE_KEY_FC_SYNC_SUPPORTED | This indicates that the device this key is being used to communicate with supports the APS frame counter synchronization procedure. |
2273 of file stack/include/sl_zigbee_types.hsl_zigbee_key_type_t#
sl_zigbee_key_type_t
This denotes the type of security key.
| Enumerator | |
|---|---|
| SL_ZIGBEE_TRUST_CENTER_LINK_KEY | This denotes that the key is a Trust Center Link Key. |
| SL_ZIGBEE_CURRENT_NETWORK_KEY | This denotes that the key is the Current Network Key. |
| SL_ZIGBEE_NEXT_NETWORK_KEY | This denotes that the key is the Next Network Key. |
| SL_ZIGBEE_APPLICATION_LINK_KEY | This denotes that the key is an Application Link Key. |
2345 of file stack/include/sl_zigbee_types.hsl_zigbee_key_status_t#
sl_zigbee_key_status_t
This denotes the status of an attempt to establish a key with another device.
| Enumerator | |
|---|---|
| SL_ZIGBEE_KEY_STATUS_NONE | |
| SL_ZIGBEE_APP_LINK_KEY_ESTABLISHED | |
| SL_ZIGBEE_TRUST_CENTER_LINK_KEY_ESTABLISHED | |
| SL_ZIGBEE_KEY_ESTABLISHMENT_TIMEOUT | |
| SL_ZIGBEE_KEY_TABLE_FULL | |
| SL_ZIGBEE_TC_RESPONDED_TO_KEY_REQUEST | |
| SL_ZIGBEE_TC_APP_KEY_SENT_TO_REQUESTER | |
| SL_ZIGBEE_TC_RESPONSE_TO_KEY_REQUEST_FAILED | |
| SL_ZIGBEE_TC_REQUEST_KEY_TYPE_NOT_SUPPORTED | |
| SL_ZIGBEE_TC_NO_LINK_KEY_FOR_REQUESTER | |
| SL_ZIGBEE_TC_REQUESTER_EUI64_UNKNOWN | |
| SL_ZIGBEE_TC_RECEIVED_FIRST_APP_KEY_REQUEST | |
| SL_ZIGBEE_TC_TIMEOUT_WAITING_FOR_SECOND_APP_KEY_REQUEST | |
| SL_ZIGBEE_TC_NON_MATCHING_APP_KEY_REQUEST_RECEIVED | |
| SL_ZIGBEE_TC_FAILED_TO_SEND_APP_KEYS | |
| SL_ZIGBEE_TC_FAILED_TO_STORE_APP_KEY_REQUEST | |
| SL_ZIGBEE_TC_REJECTED_APP_KEY_REQUEST | |
| SL_ZIGBEE_TC_FAILED_TO_GENERATE_NEW_KEY | |
| SL_ZIGBEE_TC_FAILED_TO_SEND_TC_KEY | |
| SL_ZIGBEE_TRUST_CENTER_IS_PRE_R21 | |
| SL_ZIGBEE_TC_REQUESTER_VERIFY_KEY_TIMEOUT | |
| SL_ZIGBEE_TC_REQUESTER_VERIFY_KEY_FAILURE | |
| SL_ZIGBEE_TC_REQUESTER_VERIFY_KEY_SUCCESS | |
| SL_ZIGBEE_VERIFY_LINK_KEY_FAILURE | |
| SL_ZIGBEE_VERIFY_LINK_KEY_SUCCESS | |
2397 of file stack/include/sl_zigbee_types.hsl_zigbee_tc_link_key_request_policy_t#
sl_zigbee_tc_link_key_request_policy_t
This enumeration determines whether or not a Trust Center answers trust center link key requests.
| Enumerator | |
|---|---|
| SL_ZIGBEE_DENY_TC_LINK_KEY_REQUESTS | |
| SL_ZIGBEE_ALLOW_TC_LINK_KEY_REQUEST_AND_SEND_CURRENT_KEY | |
| SL_ZIGBEE_ALLOW_TC_LINK_KEY_REQUEST_AND_GENERATE_NEW_KEY | |
2449 of file stack/include/sl_zigbee_types.hsl_zigbee_app_link_key_request_policy_t#
sl_zigbee_app_link_key_request_policy_t
This enumeration determines whether or not a Trust Center answers app link key requests.
| Enumerator | |
|---|---|
| SL_ZIGBEE_DENY_APP_LINK_KEY_REQUESTS | |
| SL_ZIGBEE_ALLOW_APP_LINK_KEY_REQUEST | |
2469 of file stack/include/sl_zigbee_types.hsl_zigbee_key_settings_t#
sl_zigbee_key_settings_t
This is a ZigBee application profile ID that has been assigned to Ember Corporation.
It is used to send for sending messages that have a specific, non-standard, interaction with the Ember stack. Its only current use is for stack counters requests.
| Enumerator | |
|---|---|
| SL_ZIGBEE_KEY_PERMISSIONS_NONE | |
| SL_ZIGBEE_KEY_PERMISSIONS_READING_ALLOWED | |
| SL_ZIGBEE_KEY_PERMISSIONS_HASHING_ALLOWED | |
2599 of file stack/include/sl_zigbee_types.hsl_zigbee_duty_cycle_state_t#
sl_zigbee_duty_cycle_state_t
Duty cycle states.
Applications have no control over the state but the callback exposes state changes to the application.
| Enumerator | |
|---|---|
| SL_ZIGBEE_DUTY_CYCLE_TRACKING_OFF | No duty cycle tracking or metrics are taking place. |
| SL_ZIGBEE_DUTY_CYCLE_LBT_NORMAL | Duty Cycle is tracked and has not exceeded any thresholds. |
| SL_ZIGBEE_DUTY_CYCLE_LBT_LIMITED_THRESHOLD_REACHED | The limited threshold of the total duty cycle allotment was exceeded. |
| SL_ZIGBEE_DUTY_CYCLE_LBT_CRITICAL_THRESHOLD_REACHED | The critical threshold of the total duty cycle allotment was exceeded. |
| SL_ZIGBEE_DUTY_CYCLE_LBT_SUSPEND_LIMIT_REACHED | The suspend limit was reached and all outbound transmissions are blocked. |
2645 of file stack/include/sl_zigbee_types.hsl_zigbee_mac_passthrough_type_t#
sl_zigbee_mac_passthrough_type_t
The types of MAC passthrough messages that an application may receive. This is a bitmask.
| Enumerator | |
|---|---|
| SL_802154_PASSTHROUGH_NONE | No MAC passthrough messages. |
| SL_802154_PASSTHROUGH_SE_INTERPAN | SE InterPAN messages. |
| SL_802154_PASSTHROUGH_EMBERNET | EmberNet and first generation (v1) standalone bootloader messages. |
| SL_802154_PASSTHROUGH_EMBERNET_SOURCE | EmberNet messages filtered by their source address. |
| SL_802154_PASSTHROUGH_APPLICATION | Application-specific passthrough messages. |
| SL_802154_PASSTHROUGH_CUSTOM | Custom inter-pan filter. |
2698 of file stack/include/sl_zigbee_types.hsl_zigbee_key_contents#
uint8_t * sl_zigbee_key_contents (sl_zigbee_key_data_t * key)
This function allows access to the actual key data bytes of the sl_zigbee_key_data_t structure.
| N/A | key | A pointer to an sl_zigbee_key_data_t structure. |
Returns
uint8_t* Returns a pointer to the first byte of the Key data.
2487 of file stack/include/sl_zigbee_types.hsl_zigbee_certificate_contents#
uint8_t * sl_zigbee_certificate_contents (sl_zigbee_certificate_data_t * cert)
Get access to the actual certificate data bytes of the sl_zigbee_certificate_data_t structure.
| N/A | cert | A pointer to an sl_zigbee_certificate_data_t structure. |
Returns
uint8_t* Returns a pointer to the first byte of the certificate data.
2500 of file stack/include/sl_zigbee_types.hsl_zigbee_public_key_contents#
uint8_t * sl_zigbee_public_key_contents (sl_zigbee_public_key_data_t * key)
Get access to the actual public key data bytes of the sl_zigbee_public_key_data_t structure.
| N/A | key | A pointer to an sl_zigbee_public_key_data_t structure. |
Returns
uint8_t* Returns a pointer to the first byte of the public key data.
2513 of file stack/include/sl_zigbee_types.hsl_zigbee_private_key_contents#
uint8_t * sl_zigbee_private_key_contents (sl_zigbee_private_key_data_t * key)
Get access to the actual private key data bytes of the sl_zigbee_private_key_data_t structure.
| N/A | key | A pointer to an sl_zigbee_private_key_data_t structure. |
Returns
uint8_t* Returns a pointer to the first byte of the private key data.
2526 of file stack/include/sl_zigbee_types.hsl_zigbee_smac_contents#
uint8_t * sl_zigbee_smac_contents (sl_zigbee_smac_data_t * key)
Get access to the actual SMAC (Secured Message Authentication Code) data of the sl_zigbee_smac_data_t structure.
| N/A | key |
2536 of file stack/include/sl_zigbee_types.hsl_zigbee_signature_contents#
uint8_t * sl_zigbee_signature_contents (sl_zigbee_signature_data_t * sig)
Get access to the actual ECDSA signature data of the sl_zigbee_signature_data_t structure.
| N/A | sig |
2545 of file stack/include/sl_zigbee_types.hsl_zigbee_certificate_283k1_contents#
uint8_t * sl_zigbee_certificate_283k1_contents (sl_zigbee_certificate_283k1_data_t * cert)
Get access to the actual certificate data bytes of the sl_zigbee_283k1_certificate_data_t structure.
| N/A | cert | A pointer to an ::sl_zigbee_283k1_certificate_data_t structure. |
Returns
uint8_t* Returns a pointer to the first byte of the certificate data.
2558 of file stack/include/sl_zigbee_types.hsl_zigbee_public_key_283k1_contents#
uint8_t * sl_zigbee_public_key_283k1_contents (sl_zigbee_public_key_283k1_data_t * key)
Get access to the actual public key data bytes of the sl_zigbee_283k1_public_key_data_t structure.
| N/A | key | A pointer to an sl_zigbee_283k1_public_key_data_t structure. |
Returns
uint8_t* Returns a pointer to the first byte of the public key data.
2571 of file stack/include/sl_zigbee_types.hsl_zigbee_private_key_283k1_contents#
uint8_t * sl_zigbee_private_key_283k1_contents (sl_zigbee_private_key_283k1_data_t * key)
Get access to the actual private key data bytes of the sl_zigbee_283k1_private_key_data_t structure.
| N/A | key | A pointer to an sl_zigbee_283k1_private_key_data_t structure. |
Returns
uint8_t* Returns a pointer to the first byte of the private key data.
2584 of file stack/include/sl_zigbee_types.hember283k1SignatureContents#
uint8_t * ember283k1SignatureContents (sl_zigbee_signature_283k1_data_t * sig)
Get access to the actual ECDSA signature data of the sl_zigbee_signature_283k1_data_t structure.
| N/A | sig |
2593 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_PRIVATE_PROFILE_ID#
#define SL_ZIGBEE_PRIVATE_PROFILE_IDValue:
0xC00Eu
This is a ZigBee application profile ID that has been assigned to Ember Corporation.
It is used to send for sending messages that have a specific, non-standard, interaction with the Ember stack. Its only current use is for stack counters requests.
1871 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_PRIVATE_PROFILE_ID_START#
#define SL_ZIGBEE_PRIVATE_PROFILE_ID_STARTValue:
0xC00Du
Ember's first private profile ID.
1876 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_PRIVATE_PROFILE_ID_END#
#define SL_ZIGBEE_PRIVATE_PROFILE_ID_ENDValue:
0xC016u
Ember's last private profile ID.
1881 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_REPORT_COUNTERS_REQUEST#
#define SL_ZIGBEE_REPORT_COUNTERS_REQUESTValue:
0x0003u
The cluster ID used to request that a node respond with a report of its Ember stack counters. See app/util/counters/counters-ota.h.
1886 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_REPORT_COUNTERS_RESPONSE#
#define SL_ZIGBEE_REPORT_COUNTERS_RESPONSEValue:
0x8003u
The cluster ID used to respond to an SL_ZIGBEE_REPORT_COUNTERS_REQUEST.
1889 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_REPORT_AND_CLEAR_COUNTERS_REQUEST#
#define SL_ZIGBEE_REPORT_AND_CLEAR_COUNTERS_REQUESTValue:
0x0004u
The cluster ID used to request that a node respond with a report of its Ember stack counters. The node will also reset its clusters to zero after a successful response. See app/util/counters/counters-ota.h.
1895 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_REPORT_AND_CLEAR_COUNTERS_RESPONSE#
#define SL_ZIGBEE_REPORT_AND_CLEAR_COUNTERS_RESPONSEValue:
0x8004u
The cluster ID used to respond to an SL_ZIGBEE_REPORT_AND_CLEAR_COUNTERS_REQUEST.
1898 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_OTA_CERTIFICATE_UPGRADE_CLUSTER#
#define SL_ZIGBEE_OTA_CERTIFICATE_UPGRADE_CLUSTERValue:
0x0005u
The cluster ID used to send and receive over the air certificate messages. This is used to field upgrade devices with Smart Energy Certificates and other security data.
1904 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_STANDARD_SECURITY_MODE#
#define SL_ZIGBEE_STANDARD_SECURITY_MODEValue:
0x0000
This is an sl_zigbee_initial_security_bitmask_t value but it does not actually set anything. It is the default mode used by the ZigBee Pro stack. It is defined here so that no legacy code is broken by referencing it.
1992 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_TRUST_CENTER_NODE_ID#
#define SL_ZIGBEE_TRUST_CENTER_NODE_IDValue:
0x0000u
The short address of the trust center. This address never changes dynamically.
1997 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_TC_SUPPORTS_FC_SYNC#
#define SL_ZIGBEE_TC_SUPPORTS_FC_SYNCValue:
0x00800000UL
This denotes that the device can require a resync of the APS frame counter.
2157 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_NO_TRUST_CENTER_MODE#
#define SL_ZIGBEE_NO_TRUST_CENTER_MODEValue:
SL_ZIGBEE_DISTRIBUTED_TRUST_CENTER_MODE
This is the legacy name for the Distributed Trust Center Mode.
2161 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_GLOBAL_LINK_KEY#
#define SL_ZIGBEE_GLOBAL_LINK_KEYValue:
SL_ZIGBEE_TRUST_CENTER_GLOBAL_LINK_KEY
This is the legacy name for the Trust Center Global Link Key.
2165 of file stack/include/sl_zigbee_types.hSL_LEGACY_SECURITY_CONFIG_MAGIC_NUMBER#
#define SL_LEGACY_SECURITY_CONFIG_MAGIC_NUMBERValue:
0xCABAD11FUL
This magic number prevents accidentally changing the key settings. The sl_zigbee_set_mfg_security_config() API will return SL_ZIGBEE_INVALID_CALL unless it is passed in.
2621 of file stack/include/sl_zigbee_types.hZDO response status. Documentation#
sl_zigbee_zdo_status_t#
sl_zigbee_zdo_status_t
| Enumerator | |
|---|---|
| SL_ZIGBEE_ZDP_SUCCESS | |
| SL_ZIGBEE_ZDP_INVALID_REQUEST_TYPE | |
| SL_ZIGBEE_ZDP_DEVICE_NOT_FOUND | |
| SL_ZIGBEE_ZDP_INVALID_ENDPOINT | |
| SL_ZIGBEE_ZDP_NOT_ACTIVE | |
| SL_ZIGBEE_ZDP_NOT_SUPPORTED | |
| SL_ZIGBEE_ZDP_TIMEOUT | |
| SL_ZIGBEE_ZDP_NO_MATCH | |
| SL_ZIGBEE_ZDP_NO_ENTRY | |
| SL_ZIGBEE_ZDP_NO_DESCRIPTOR | |
| SL_ZIGBEE_ZDP_INSUFFICIENT_SPACE | |
| SL_ZIGBEE_ZDP_NOT_PERMITTED | |
| SL_ZIGBEE_ZDP_TABLE_FULL | |
| SL_ZIGBEE_ZDP_NOT_AUTHORIZED | |
| SL_ZIGBEE_ZDP_DEVICE_BINDING_TABLE_FULL | |
| SL_ZIGBEE_ZDP_INVALID_INDEX | |
| SL_ZIGBEE_ZDP_FRAME_TOO_LARGE | |
| SL_ZIGBEE_ZDP_BAD_KEY_NEGOTIATION_METHOD | |
| SL_ZIGBEE_ZDP_TEMPORARY_FAILURE | |
| SL_ZIGBEE_APS_SECURITY_FAIL | |
| SL_ZIGBEE_NWK_ALREADY_PRESENT | |
| SL_ZIGBEE_NWK_TABLE_FULL | |
| SL_ZIGBEE_NWK_UNKNOWN_DEVICE | |
| SL_ZIGBEE_NWK_MISSING_TLV | |
| SL_ZIGBEE_NWK_INVALID_TLV | |
2744 of file stack/include/sl_zigbee_types.hZDO server mask bits Documentation#
sl_zigbee_zdo_server_mask_t#
sl_zigbee_zdo_server_mask_t
| Enumerator | |
|---|---|
| SL_ZIGBEE_ZDP_PRIMARY_TRUST_CENTER | |
| SL_ZIGBEE_ZDP_SECONDARY_TRUST_CENTER | |
| SL_ZIGBEE_ZDP_PRIMARY_BINDING_TABLE_CACHE | |
| SL_ZIGBEE_ZDP_SECONDARY_BINDING_TABLE_CACHE | |
| SL_ZIGBEE_ZDP_PRIMARY_DISCOVERY_CACHE | |
| SL_ZIGBEE_ZDP_SECONDARY_DISCOVERY_CACHE | DEPRECATED |
| SL_ZIGBEE_ZDP_NETWORK_MANAGER | DEPRECATED |
2789 of file stack/include/sl_zigbee_types.hZDO configuration flags. Documentation#
sl_zigbee_zdo_configuration_flags_t#
sl_zigbee_zdo_configuration_flags_t
Defines the maximum number of counters that are specified as reporting either on 2.4 GHz or Sub-GHz.
| Enumerator | |
|---|---|
| SL_ZIGBEE_APP_RECEIVES_SUPPORTED_ZDO_REQUESTS | |
| SL_ZIGBEE_APP_HANDLES_UNSUPPORTED_ZDO_REQUESTS | |
| SL_ZIGBEE_APP_HANDLES_ZDO_ENDPOINT_REQUESTS | |
| SL_ZIGBEE_APP_HANDLES_ZDO_BINDING_REQUESTS | |
2818 of file stack/include/sl_zigbee_types.hsl_zigbee_multi_phy_nwk_config_t#
sl_zigbee_multi_phy_nwk_config_t
Defines the maximum number of counters that are specified as reporting either on 2.4 GHz or Sub-GHz.
| Enumerator | |
|---|---|
| SL_ZIGBEE_MULTI_PHY_ROUTERS_ALLOWED | |
| SL_ZIGBEE_MULTI_PHY_BROADCASTS_ENABLED | |
| SL_ZIGBEE_MULTI_PHY_DISABLED | |
2846 of file stack/include/sl_zigbee_types.hsl_zigbee_beacon_classification_flags_t#
sl_zigbee_beacon_classification_flags_t
Defines beacon classification flags.
| Enumerator | |
|---|---|
| PRIORITIZE_BEACONS_BASED_ON_PARENT_CLASSIFICATION | |
| PRIORITIZE_BEACONS_BASED_ON_TC_CONNECTVITY | |
| TC_CONNECTIVITY | |
| LONG_UPTIME | |
| BAD_PARENT_CONNECTIVITY | |
| PREFERRED_PARENT | |
2893 of file stack/include/sl_zigbee_types.hsl_zigbee_entropy_source_t#
sl_zigbee_entropy_source_t
Defines the entropy source used by the stack.
| Enumerator | |
|---|---|
| SL_ZIGBEE_ENTROPY_SOURCE_ERROR | |
| SL_ZIGBEE_ENTROPY_SOURCE_RADIO | |
| SL_ZIGBEE_ENTROPY_SOURCE_MBEDTLS_TRNG | |
| SL_ZIGBEE_ENTROPY_SOURCE_MBEDTLS | |
2916 of file stack/include/sl_zigbee_types.h@0#
@0
Defines the maximum number of counters that are specified as reporting either on 2.4 GHz or Sub-GHz.
| Enumerator | |
|---|---|
| SL_ZIGBEE_POLL_TIMEOUT_10_SECONDS | |
| SL_ZIGBEE_POLL_TIMEOUT_2_MINUTES | |
| SL_ZIGBEE_POLL_TIMEOUT_4_MINUTES | |
| SL_ZIGBEE_POLL_TIMEOUT_8_MINUTES | |
| SL_ZIGBEE_POLL_TIMEOUT_16_MINUTES | |
| SL_ZIGBEE_POLL_TIMEOUT_32_MINUTES | |
| SL_ZIGBEE_POLL_TIMEOUT_64_MINUTES | |
| SL_ZIGBEE_POLL_TIMEOUT_128_MINUTES | |
| SL_ZIGBEE_POLL_TIMEOUT_256_MINUTES | |
| SL_ZIGBEE_POLL_TIMEOUT_512_MINUTES | |
| SL_ZIGBEE_POLL_TIMEOUT_1024_MINUTES | |
| SL_ZIGBEE_POLL_TIMEOUT_2048_MINUTES | |
| SL_ZIGBEE_POLL_TIMEOUT_4096_MINUTES | |
| SL_ZIGBEE_POLL_TIMEOUT_8192_MINUTES | |
| SL_ZIGBEE_POLL_TIMEOUT_16384_MINUTES | |
2928 of file stack/include/sl_zigbee_types.hsl_zigbee_tc_aps_encrypt_mode_t#
sl_zigbee_tc_aps_encrypt_mode_t
Defines the trust center APS encryption mode when sending a newer (alternate) network key to a device. The value settings below do not take effect when sending the initial network key during joining or rejoining.
| Enumerator | |
|---|---|
| TC_APS_ENCRYPT_DEFAULT | Default: don't encrypt broadcasts, encrypt unicasts |
| TC_APS_ENCRYPT_ENABLE | Encrypt both broadcasts and unicasts |
| TC_APS_ENCRYPT_DISABLE | Do not encrypt broadcasts and unicasts |
2952 of file stack/include/sl_zigbee_types.hsl_zigbee_radio_power_mode_t#
typedef uint8_t sl_zigbee_radio_power_mode_t
Radio power mode.
2882 of file stack/include/sl_zigbee_types.hWEAK_TEST#
#define WEAK_TEST
Defines the maximum number of counters that are specified as reporting either on 2.4 GHz or Sub-GHz.
2842 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_MAX_MAC_ONLY_COUNTERS#
#define SL_ZIGBEE_MAX_MAC_ONLY_COUNTERSValue:
33u
Defines the maximum number of counters that are specified as reporting either on 2.4 GHz or Sub-GHz.
2861 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_MAX_NUM_PHYS#
#define SL_ZIGBEE_MAX_NUM_PHYSValue:
2u
Defines the maximum number of PHYs supported.
2867 of file stack/include/sl_zigbee_types.hPHY_INDEX_NATIVE#
#define PHY_INDEX_NATIVEValue:
0u
PHY index for 2.4 GHz radio interface, valid for simultaneous multi radio network.
2872 of file stack/include/sl_zigbee_types.hPHY_INDEX_PRO2PLUS#
#define PHY_INDEX_PRO2PLUSValue:
1u
PHY index for Sub-GHz radio interface, valid for simultaneous multi radio network.
2877 of file stack/include/sl_zigbee_types.hZigBee Broadcast Addresses Documentation#
SL_ZIGBEE_BROADCAST_ADDRESS#
#define SL_ZIGBEE_BROADCAST_ADDRESSValue:
0xFFFCu
Broadcast to all routers.
549 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_RX_ON_WHEN_IDLE_BROADCAST_ADDRESS#
#define SL_ZIGBEE_RX_ON_WHEN_IDLE_BROADCAST_ADDRESSValue:
0xFFFDu
Broadcast to all non-sleepy devices.
551 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_SLEEPY_BROADCAST_ADDRESS#
#define SL_ZIGBEE_SLEEPY_BROADCAST_ADDRESSValue:
0xFFFFu
Broadcast to all devices, including sleepy end devices.
553 of file stack/include/sl_zigbee_types.htxPowerModes for sl_802154_set_tx_power_mode and mfglibSetPower Documentation#
SL_ZIGBEE_TX_POWER_MODE_DEFAULT#
#define SL_ZIGBEE_TX_POWER_MODE_DEFAULTValue:
0x0000
The application should call sl_802154_set_tx_power_mode() with the txPowerMode parameter set to this value to disable all power mode options, resulting in normal power mode and bi-directional RF transmitter output.
1833 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_TX_POWER_MODE_BOOST#
#define SL_ZIGBEE_TX_POWER_MODE_BOOSTValue:
0x0001
The application should call sl_802154_set_tx_power_mode() with the txPowerMode parameter set to this value to enable boost power mode.
1837 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_TX_POWER_MODE_ALTERNATE#
#define SL_ZIGBEE_TX_POWER_MODE_ALTERNATEValue:
0x0002
The application should call sl_802154_set_tx_power_mode() with the txPowerMode parameter set to this value to enable the alternate transmitter output.
1842 of file stack/include/sl_zigbee_types.hSL_ZIGBEE_TX_POWER_MODE_BOOST_AND_ALTERNATE#
#define SL_ZIGBEE_TX_POWER_MODE_BOOST_AND_ALTERNATEValue:
The application should call sl_802154_set_tx_power_mode() with the txPowerMode parameter set to this value to enable both boost mode and the alternate transmitter output.
1847 of file stack/include/sl_zigbee_types.hEnumeration Documentation#
sl_zigbee_node_type_t#
sl_zigbee_node_type_t
Defines the possible types of nodes and the roles that a node might play in a network.
| Enumerator | |
|---|---|
| SL_ZIGBEE_UNKNOWN_DEVICE | The device is not joined. |
| SL_ZIGBEE_DEVICE_TYPE_UNCHANGED | Device type has not changed since last join. |
| SL_ZIGBEE_COORDINATOR | Will relay messages and can act as a parent to other nodes. |
| SL_ZIGBEE_ROUTER | Will relay messages and can act as a parent to other nodes. |
| SL_ZIGBEE_END_DEVICE | Communicates only with its parent and will not relay messages. |
| SL_ZIGBEE_SLEEPY_END_DEVICE | An end device whose radio can be turned off to save power. The application must call sl_zigbee_poll_for_data() to receive messages. |
| SL_ZIGBEE_S2S_INITIATOR_DEVICE | Sleepy end device which transmits with wake up frames (CSL). |
| SL_ZIGBEE_S2S_TARGET_DEVICE | Sleepy end device which duty cycles the radio Rx (CSL). |
575 of file stack/include/sl_zigbee_types.hsl_zigbee_end_device_configuration_t#
sl_zigbee_end_device_configuration_t
The configuration advertised by the end device to the parent when joining/rejoining.
| Enumerator | |
|---|---|
| SL_ZIGBEE_END_DEVICE_CONFIG_NONE | |
| SL_ZIGBEE_END_DEVICE_CONFIG_PERSIST_DATA_ON_PARENT | |
605 of file stack/include/sl_zigbee_types.hsl_zigbee_network_init_bitmask_t#
sl_zigbee_network_init_bitmask_t
Defines the options that should be used when initializing the node's network configuration.
| Enumerator | |
|---|---|
| SL_ZIGBEE_NETWORK_INIT_NO_OPTIONS | |
| SL_ZIGBEE_NETWORK_INIT_PARENT_INFO_IN_TOKEN | The Parent Node ID and EUI64 are stored in a token. This prevents the need to perform an Orphan scan on startup. |
| SL_ZIGBEE_NETWORK_INIT_END_DEVICE_REJOIN_ON_REBOOT | Z3 compliant end devices on a network must send a rejoin request on reboot. |
632 of file stack/include/sl_zigbee_types.hsl_zigbee_aps_rejoin_mode_t#
sl_zigbee_aps_rejoin_mode_t
Options to allow/disallow rejoins using the default link key.
| Enumerator | |
|---|---|
| NO_REJOIN | |
| REJOIN_ANY_LINK_KEY | |
| REJOIN_NON_DEFAULT_LINK_KEY | |
696 of file stack/include/sl_zigbee_types.hsl_zigbee_aps_option_t#
sl_zigbee_aps_option_t
Options to use when sending a message.
The discover-route, APS-retry, and APS-indirect options may be used together. Poll response cannot be combined with any other options.
| Enumerator | |
|---|---|
| SL_ZIGBEE_APS_OPTION_NONE | No options. |
| SL_ZIGBEE_APS_OPTION_DSA_SIGN | This signs the application layer message body (APS Frame not included) and appends the ECDSA signature to the end of the message, which is needed by Smart Energy applications and requires the CBKE and ECC libraries. The sl_zigbee_dsa_sign_handler() function is called after DSA signing is complete but before the message has been sent by the APS layer. Note that when passing a buffer to the stack for DSA signing, the final byte in the buffer has a special significance as an indicator of how many leading bytes should be ignored for signature purposes. See the API documentation of sl_zigbee_dsa_sign() or the dsaSign EZSP command for more details about this requirement. |
| SL_ZIGBEE_APS_OPTION_ENCRYPTION | Send 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_RETRY | Resend the message using the APS retry mechanism. This option and the enable route discovery option must be enabled for an existing route to be repaired automatically. |
| SL_ZIGBEE_APS_OPTION_ENABLE_ROUTE_DISCOVERY | Send the message with the NWK 'enable route discovery' flag, which causes a route discovery to be initiated if no route to the destination is known. Note that in the mesh stack, this option and the APS retry option must be enabled an existing route to be repaired automatically. |
| SL_ZIGBEE_APS_OPTION_FORCE_ROUTE_DISCOVERY | Send the message with the NWK 'force route discovery' flag, which causes a route discovery to be initiated even if one is known. |
| SL_ZIGBEE_APS_OPTION_SOURCE_EUI64 | Include the source EUI64 in the network frame. |
| SL_ZIGBEE_APS_OPTION_DESTINATION_EUI64 | Include the destination EUI64 in the network frame. |
| SL_ZIGBEE_APS_OPTION_ENABLE_ADDRESS_DISCOVERY | Send a ZDO request to discover the node ID of the destination if it is not already known. |
| SL_ZIGBEE_APS_OPTION_POLL_RESPONSE | This message is being sent in response to a call to sl_zigbee_poll_handler(). It causes the message to be sent immediately instead of being queued up until the next poll from the (end device) destination. |
| SL_ZIGBEE_APS_OPTION_ZDO_RESPONSE_REQUIRED | This incoming message is a valid ZDO request and the application is responsible for sending a ZDO response. This flag is used only within sl_zigbee_incoming_message_handler() when EMBER_APPLICATION_RECEIVES_UNSUPPORTED_ZDO_REQUESTS is defined. |
| SL_ZIGBEE_APS_OPTION_FRAGMENT | This 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. |
714 of file stack/include/sl_zigbee_types.hsl_zigbee_incoming_message_type_t#
sl_zigbee_incoming_message_type_t
Defines the possible incoming message types.
| Enumerator | |
|---|---|
| SL_ZIGBEE_INCOMING_UNICAST | Unicast. |
| SL_ZIGBEE_INCOMING_UNICAST_REPLY | Unicast reply. |
| SL_ZIGBEE_INCOMING_MULTICAST | Multicast. |
| SL_ZIGBEE_INCOMING_MULTICAST_LOOPBACK | Multicast sent by the local device. |
| SL_ZIGBEE_INCOMING_BROADCAST | Broadcast. |
| SL_ZIGBEE_INCOMING_BROADCAST_LOOPBACK | Broadcast sent by the local device. |
785 of file stack/include/sl_zigbee_types.hsl_zigbee_outgoing_message_type_t#
sl_zigbee_outgoing_message_type_t
Defines the possible outgoing message types.
| Enumerator | |
|---|---|
| SL_ZIGBEE_OUTGOING_DIRECT | Unicast sent directly to an sl_802154_short_addr_t. |
| SL_ZIGBEE_OUTGOING_VIA_ADDRESS_TABLE | Unicast sent using an entry in the address table. |
| SL_ZIGBEE_OUTGOING_VIA_BINDING | Unicast sent using an entry in the binding table. |
| SL_ZIGBEE_OUTGOING_MULTICAST | Multicast message. This value is passed to sl_zigbee_message_sent_handler() only. It may not be passed to sl_zigbee_send_unicast(). |
| SL_ZIGBEE_OUTGOING_MULTICAST_WITH_ALIAS | An aliased multicast message. This value is passed to sl_zigbee_message_sent_handler() only. It may not be passed to sl_zigbee_send_unicast(). |
| SL_ZIGBEE_OUTGOING_BROADCAST_WITH_ALIAS | An aliased Broadcast message. This value is passed to sl_zigbee_message_sent_handler() only. It may not be passed to sl_zigbee_send_unicast(). |
| SL_ZIGBEE_OUTGOING_BROADCAST | A broadcast message. This value is passed to sl_zigbee_message_sent_handler() only. It may not be passed to sl_zigbee_send_unicast(). |
809 of file stack/include/sl_zigbee_types.hsl_zigbee_zigbee_command_type_t#
sl_zigbee_zigbee_command_type_t
A type of command received by the stack.
This enumeration indicates which protocol layer in the Ember stack an incoming command was meant for, or from which protocol layer an outgoing command is being sent.
| Enumerator | |
|---|---|
| SL_ZIGBEE_ZIGBEE_COMMAND_TYPE_RAW_MAC | Describes an 802.15.4 raw MAC message, unprocessed by the stack. |
| SL_ZIGBEE_ZIGBEE_COMMAND_TYPE_MAC_COMMAND | Describes an 802.15.4 MAC layer command. |
| SL_ZIGBEE_ZIGBEE_COMMAND_TYPE_NWK | Describes a ZigBee Network layer command. |
| SL_ZIGBEE_ZIGBEE_COMMAND_TYPE_APS | Describes a ZigBee Application Support layer command. |
| SL_ZIGBEE_ZIGBEE_COMMAND_TYPE_ZDO | Describes a ZigBee Device Object command. |
| SL_ZIGBEE_ZIGBEE_COMMAND_TYPE_ZCL | Describes a ZigBee Cluster Library command. |
| SL_ZIGBEE_ZIGBEE_COMMAND_TYPE_BEACON | Not a MAC command, but enumerated here for simplicity. |
843 of file stack/include/sl_zigbee_types.hsl_zigbee_packet_action_t#
sl_zigbee_packet_action_t
indication of the action taken on a packet
| Enumerator | |
|---|---|
| SL_ZIGBEE_DROP_PACKET | |
| SL_ZIGBEE_ACCEPT_PACKET | |
| SL_ZIGBEE_MANGLE_PACKET | |
| SL_ZIGBEE_ACCEPT_PACKET_OVERRIDE_SECURITY | This action allows unencrypted packets to pass through the stack. We only support this action in the network layer for now. WARNING: Using this packet handler action may have serious security implications |
| SL_ZIGBEE_ACCEPT_PACKET_SKIP_NWK_CRYPTO | This action allows unencrypted incoming packets to skip NWK decryption as well as outgoing packets to skip NWK encryption irrespective of the encryption flag in the NWK header. We only support this action in the network layer for now. |
867 of file stack/include/sl_zigbee_types.hsl_zigbee_zigbee_packet_type_t#
sl_zigbee_zigbee_packet_type_t
A type of packet received by the stack.
This enum provides a way to indicate which protocol layer in the Ember stack an incoming packet is meant for, or from which protocol layer an outgoing command is being sent from.
| Enumerator | |
|---|---|
| SL_ZIGBEE_ZIGBEE_PACKET_TYPE_RAW_MAC | Describes an 802.15.4 raw MAC message, unprocessed by the stack. |
| SL_ZIGBEE_ZIGBEE_PACKET_TYPE_MAC_COMMAND | Describes an 802.15.4 MAC layer command. |
| SL_ZIGBEE_ZIGBEE_PACKET_TYPE_NWK_DATA | Describes a ZigBee Network layer data message. |
| SL_ZIGBEE_ZIGBEE_PACKET_TYPE_NWK_COMMAND | Describes a ZigBee Network layer command. |
| SL_ZIGBEE_ZIGBEE_PACKET_TYPE_APS_DATA | Describes a ZigBee Application Support layer data message. |
| SL_ZIGBEE_ZIGBEE_PACKET_TYPE_APS_COMMAND | Describes a ZigBee Application Support layer command. |
| SL_ZIGBEE_ZIGBEE_PACKET_TYPE_ZDO | Describes a ZigBee Device Object command. |
| SL_ZIGBEE_ZIGBEE_PACKET_TYPE_ZCL | Describes a ZigBee Cluster Library command. |
| SL_ZIGBEE_ZIGBEE_PACKET_TYPE_BEACON | Distinguishing between raw MAC and beacons for simplicity |
| SL_ZIGBEE_ZIGBEE_PACKET_TYPE_INTERPAN | Describes a ZigBee Light Link message. |
| SL_ZIGBEE_ZIGBEE_PACKET_TYPE_NWK_DATA_PRE_DECRYPTION | Describes a ZigBee Network layer data message prior to (potential) decryption. |
| SL_ZIGBEE_ZIGBEE_PACKET_TYPE_NWK_COMMAND_PRE_DECRYPTION | Describes a ZigBee Network layer command prior to (potential) decryption. |
896 of file stack/include/sl_zigbee_types.hsl_zigbee_network_status_t#
sl_zigbee_network_status_t
Defines the possible join states for a node.
| Enumerator | |
|---|---|
| SL_ZIGBEE_NO_NETWORK | The node is not associated with a network in any way. |
| SL_ZIGBEE_JOINING_NETWORK | The node is currently attempting to join a network. |
| SL_ZIGBEE_JOINED_NETWORK | The node is joined to a network. |
| SL_ZIGBEE_JOINED_NETWORK_NO_PARENT | The node is an end device joined to a network but its parent is not responding. |
| SL_ZIGBEE_JOINED_NETWORK_S2S_INITIATOR | The node is a Sleepy-to-Sleepy initiator |
| SL_ZIGBEE_JOINED_NETWORK_S2S_TARGET | The node is a Sleepy-to-Sleepy target |
| SL_ZIGBEE_LEAVING_NETWORK | The node is in the process of leaving its current network. |
932 of file stack/include/sl_zigbee_types.hsl_zigbee_network_scan_type_t#
sl_zigbee_network_scan_type_t
Type for a network scan.
| Enumerator | |
|---|---|
| SL_ZIGBEE_ENERGY_SCAN | An energy scan scans each channel for its RSSI value. |
| SL_ZIGBEE_ACTIVE_SCAN | An active scan scans each channel for available networks. Use this scan type during network-steering to filter for beacons with available child capacity. The network found callback sl_zigbee_af_network_found_cb fires for all received beacons, while only beacons matching the capacity criteria and therefore viable for joining are cached |
| SL_ZIGBEE_START_RADIO_OFF_SCAN | A fake scan that is used to turn off the radio. |
| SL_ZIGBEE_STACK_GP_CHANNEL_DELIVERY_SCAN | A green power channel delivery scan. |
| SL_ZIGBEE_ACTIVE_SCAN_ROUTER | An active scan scans each channel for available networks. Use this scan type during network-steering to filter for and cache beacons with available router capacity - Note that this scan type temporarily sets nodeType to SL_ZIGBEE_ROUTER for the duration of the scan process. The network found callback sl_zigbee_af_network_found_cb fires for all received beacons, while only beacons matching the capacity criteria and therefore viable for joining are cached |
| SL_ZIGBEE_LAST_SCAN_TYPE | |
967 of file stack/include/sl_zigbee_types.hsl_zigbee_binding_type_t#
sl_zigbee_binding_type_t
Defines binding types.
| Enumerator | |
|---|---|
| SL_ZIGBEE_UNUSED_BINDING | A binding that is currently not in use. |
| SL_ZIGBEE_UNICAST_BINDING | A unicast binding whose 64-bit identifier is the destination EUI64. |
| SL_ZIGBEE_MANY_TO_ONE_BINDING | A unicast binding whose 64-bit identifier is the many-to-one destination EUI64. Route discovery should be disabled when sending unicasts via many-to-one bindings. |
| SL_ZIGBEE_MULTICAST_BINDING | A multicast binding whose 64-bit identifier is the group address. This binding can be used to send messages to the group and to receive messages sent to the group. |
995 of file stack/include/sl_zigbee_types.hsl_zigbee_keep_alive_mode_t#
sl_zigbee_keep_alive_mode_t
Type of Ember keep alive method defining the keep alive message type that a parent accepts to prevent child aging. This is configured in a parent router and communicated and stored in an end-device.
SL_ZIGBEE_KEEP_ALIVE_SUPPORT_UNKNOWN which is initialized at end-device boot time, means parent's keep alive mechanism is unknown to end-device.
SL_802154_DATA_POLL_KEEP_ALIVE means that the parent does not need explicit keep alive messages and will use incoming mac data polls as a sign that a child should not be aged out.
SL_ZIGBEE_END_DEVICE_TIMEOUT_KEEP_ALIVE means that the parent needs explicit keep alive messages (net work timeout requests) to keep the child in its child table.
SL_ZIGBEE_KEEP_ALIVE_SUPPORT_ALL basically maps to SL_802154_DATA_POLL_KEEP_ALIVE as the preferred approach between the two.
| Enumerator | |
|---|---|
| SL_ZIGBEE_KEEP_ALIVE_SUPPORT_UNKNOWN | |
| SL_802154_DATA_POLL_KEEP_ALIVE | |
| SL_ZIGBEE_END_DEVICE_TIMEOUT_KEEP_ALIVE | |
| SL_ZIGBEE_KEEP_ALIVE_SUPPORT_ALL | |
3013 of file stack/include/sl_zigbee_types.hsl_zigbee_source_route_discovery_mode_t#
sl_zigbee_source_route_discovery_mode_t
Types of source route discovery modes used by the concentrator.
SL_ZIGBEE_SOURCE_ROUTE_DISCOVERY_OFF no source route discovery is scheduled SL_ZIGBEE_SOURCE_ROUTE_DISCOVERY_ON source routes discovery is scheduled, and it is triggered periodically SL_ZIGBEE_SOURCE_ROUTE_DISCOVERY_RESCHEDULE source routes discoveries are re-scheduled to be sent once immediately and then triggered periodically
| Enumerator | |
|---|---|
| SL_ZIGBEE_SOURCE_ROUTE_DISCOVERY_OFF | off |
| SL_ZIGBEE_SOURCE_ROUTE_DISCOVERY_ON | on |
| SL_ZIGBEE_SOURCE_ROUTE_DISCOVERY_RESCHEDULE | reschedule |
3034 of file stack/include/sl_zigbee_types.hsl_zigbee_transmit_priority_t#
sl_zigbee_transmit_priority_t
Packet transmit priorities in terms of getting into the MAC queue.
SL_802154_TRANSMIT_PRIORITY_HIGH High priority headers go on the front of the queue. SL_802154_TRANSMIT_PRIORITY_NORMAL Normal priority headers go on the back of the queue. SL_802154_TRANSMIT_PRIORITY_SCAN_OKAY Normally, only beacon requests and orphan notifications can be sent during a scan. They are submitted with SCAN_OKAY and go on the front of the queue. Other packets could be submitted with this priority, but it is not recommended.
| Enumerator | |
|---|---|
| SL_802154_TRANSMIT_PRIORITY_HIGH | |
| SL_802154_TRANSMIT_PRIORITY_NORMAL | |
| SL_802154_TRANSMIT_PRIORITY_SCAN_OKAY | |
3059 of file stack/include/sl_zigbee_types.hsl_zigbee_route_record_policy_type_t#
sl_zigbee_route_record_policy_type_t
Policies for sending a route record to the concentrator.
When sending a unicast to a concentrator, the message may be preceded by a route record packet depending on the type of concentrator and the route record policy
| Enumerator | |
|---|---|
| ROUTE_RECORD_POLICY_ACK_BY_SOURCE_ROUTED_MESSAGE | ROUTE_RECORD_POLICY_ACK_BY_SOURCE_ROUTED_MESSAGE is the default policy A low RAM concentrator will be sent a route record ahead of any unicast A high RAM concentrator will be sent a route record ahead of any unicast until a source routed unicast is received from it. |
| ROUTE_RECORD_POLICY_DONT_SEND | ROUTE_RECORD_POLICY_DONT_SEND policy means that the local node never sends a route record message (Note: Non-compliant) |
| ROUTE_RECORD_POLICY_NO_ACK_REQUIRED | ROUTE_RECORD_POLICY_NO_ACK_REQUIRED A low RAM concentrator will be sent a route record ahead of any unicast A high RAM concentrator will be sent a route record ahead of any unicast (Note: Non-compliant) |
3078 of file stack/include/sl_zigbee_types.hsl_passive_ack_config_enum_t#
sl_passive_ack_config_enum_t
Passive ack config enum.
| Enumerator | |
|---|---|
| SL_PASSIVE_ACK_DEFAULT_CONFIG | |
| SL_PASSIVE_ACK_DISABLE | |
| SL_PASSIVE_ACK_THRESHOLD_WITH_REBROADCAST | |
| SL_PASSIVE_ACK_THRESHOLD_NO_REBROADCAST | |
| SL_PASSIVE_ACK_THRESHOLD_WITH_REBROADCAST_ALL_NODES | |
3104 of file stack/include/sl_zigbee_types.hTypedef Documentation#
sl_zigbee_aps_duplicate_msg_entry_t#
typedef struct aps_duplicate_msg_entry sl_zigbee_aps_duplicate_msg_entry_t
represents a single entry in the APS duplicate rejection table
3122 of file stack/include/sl_zigbee_types.hMacro Definition Documentation#
SL_ZIGBEE_MIN_BROADCAST_ADDRESS#
#define SL_ZIGBEE_MIN_BROADCAST_ADDRESSValue:
0xFFF8u
562 of file stack/include/sl_zigbee_types.hsl_zigbee_is_zigbee_broadcast_address#
#define sl_zigbee_is_zigbee_broadcast_addressValue:
(address)
Returns true if nodeId (short address) is a broadcast address.
567 of file stack/include/sl_zigbee_types.h