Modules#
EmberBeaconClassificationParams
Ember Common Data Types#
See ember-types.h for source code.
Miscellaneous Ember Types#
Type of Ember software version.
EmberReleaseTypeStruct Data that relates release type to the correct string.
EmberReleaseTypeStruct Data that relates release type to the correct string.
EmberReleaseTypeStruct Data that relates release type to the correct string.
EmberReleaseTypeStruct 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.
EmberReleaseTypeStruct 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.
Return type for Ember functions.
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 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.
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.
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 to emberAssumedTrustCenterConcentratorType.
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 emberCounterHandler().
txPowerModes for emberSetTxPowerMode and mfglibSetPower#
The application should call emberSetTxPowerMode() 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 emberSetTxPowerMode() with the txPowerMode parameter set to this value to enable boost power mode.
The application should call emberSetTxPowerMode() with the txPowerMode parameter set to this value to enable the alternate transmitter output.
The application should call emberSetTxPowerMode() with the txPowerMode parameter set to this value to enable both boost mode and the alternate transmitter output.
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 EmberKeyStruct.
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.
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 EmberKeyData structure.
This function allows access to the actual certificate data bytes of the EmberCertificateData structure.
This function allows access to the actual public key data bytes of the EmberPublicKeyData structure.
This function allows access to the actual private key data bytes of the EmberPrivateKeyData structure.
This function allows access to the actual SMAC (Secured Message Authentication Code) data of the EmberSmacData structure.
This function allows access to the actual ECDSA signature data of the EmberSignatureData structure.
This function allows access to the actual certificate data bytes of the Ember283k1CertificateData structure.
This function allows access to the actual public key data bytes of the Ember283k1PublicKeyData structure.
This function allows access to the actual private key data bytes of the Ember283k1PrivateKeyData structure.
This function allows access to the actual ECDSA signature data of the Ember283k1SignatureData 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 EmberInitialSecurityBitmask 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 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 emberSetMfgSecurityConfig() API will return EMBER_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.
Network and IEEE Address Request/Response#
Defines for ZigBee device profile cluster IDs follow. These include descriptions of the formats of the messages.Note that each message starts with a 1-byte transaction sequence number. This sequence number is used to match a response command frame to the request frame that it is replying to. The application shall maintain a 1-byte counter that is copied into this field and incremented by one for each command sent. When a value of 0xff is reached, the next command shall re-start the counter with a value of 0x00.Network request: <transaction sequence number: 1> <EUI64:8> <type:1> <start index:1>IEEE request: <transaction sequence number: 1> <node ID:2> <type:1> <start index:1> <type> = 0x00 single address response, ignore the start index = 0x01 extended response -> sends kid's IDs as wellResponse: <transaction sequence number: 1> <status:1> <EUI64:8> <node ID:2> <ID count:1> <start index:1> <child ID:2>*
Node Descriptor Request/Response#
Request: <transaction sequence number: 1> <node ID:2> Response: <transaction sequence number: 1> <status:1> <node ID:2>// <node descriptor: 13>//// Node Descriptor field is divided into subfields of bitmasks as follows:// (Note: All lengths below are given in bits rather than bytes.)// Logical Type: 3// Complex Descriptor Available: 1// User Descriptor Available: 1// (reserved/unused): 3// APS Flags: 3// Frequency Band: 5// MAC capability flags: 8// Manufacturer Code: 16// Maximum buffer size: 8// Maximum incoming transfer size: 16// Server mask: 16// Maximum outgoing transfer size: 16// Descriptor Capability Flags: 8// See ZigBee document 053474, Section 2.3.2.3 for more details.
Power Descriptor Request / Response#
Request: <transaction sequence number: 1> <node ID:2> Response: <transaction sequence number: 1> <status:1> <node ID:2> <current power mode, available power sources:1> <current power source, current power source level:1>// See ZigBee document 053474, Section 2.3.2.4 for more details.
Simple Descriptor Request / Response#
Request: <transaction sequence number: 1> <node ID:2> <endpoint:1>Response: <transaction sequence number: 1> <status:1> <node ID:2> <length:1> <endpoint:1> <app profile ID:2> <app device ID:2> <app device version, app flags:1> <input cluster count:1> <input cluster:2>* <output cluster count:1> <output cluster:2>*
Active Endpoints Request / Response#
Request: <transaction sequence number: 1> <node ID:2>Response: <transaction sequence number: 1> <status:1> <node ID:2> <endpoint count:1> <endpoint:1>*
Match Descriptors Request / Response#
Request: <transaction sequence number: 1> <node ID:2> <app profile ID:2> <input cluster count:1> <input cluster:2>* <output cluster count:1> <output cluster:2>*Response: <transaction sequence number: 1> <status:1> <node ID:2> <endpoint count:1> <endpoint:1>*
Discovery Cache Request / Response#
Request: <transaction sequence number: 1> <source node ID:2> <source EUI64:8>Response: <transaction sequence number: 1> <status (== EMBER_ZDP_SUCCESS):1>
End Device Announce and End Device Announce Response#
Request: <transaction sequence number: 1> <node ID:2> <EUI64:8> <capabilities:1>No response is sent.
System Server Discovery Request / Response#
This is broadcast and only servers which have matching services respond. The response contains the request services that the recipient provides.Request: <transaction sequence number: 1> <server mask:2>Response: <transaction sequence number: 1> <status (== EMBER_ZDP_SUCCESS):1> <server mask:2>
Parent Announce and Parent Announce Response#
This is broadcast and only servers which have matching children respond. The response contains the list of children that the recipient now holds.Request: <transaction sequence number: 1> <number of children:1> <child EUI64:8> <child Age:4>*Response: <transaction sequence number: 1> <number of children:1> <child EUI64:8> <child Age:4>*
ZDO server mask bits#
These are used in server discovery requests and responses.
Find Node Cache Request / Response#
This is broadcast and only discovery servers which have the information for the device of interest, or the device of interest itself, respond. The requesting device can then direct any service discovery requests to the responder.Request: <transaction sequence number: 1> <device of interest ID:2> <d-of-i EUI64:8>Response: <transaction sequence number: 1> <responder ID:2> <device of interest ID:2> <d-of-i EUI64:8>
End Device Bind Request / Response#
Request: <transaction sequence number: 1> <node ID:2> <EUI64:8> <endpoint:1> <app profile ID:2> <input cluster count:1> <input cluster:2>* <output cluster count:1> <output cluster:2>*Response: <transaction sequence number: 1> <status:1>
Binding types and Request / Response#
Bind and unbind have the same formats. There are two possible formats, depending on whether the destination is a group address or a device address. Device addresses include an endpoint, groups don't.Request: <transaction sequence number: 1> <source EUI64:8> <source endpoint:1> <cluster ID:2> <destination address:3 or 10>Destination address: <0x01:1> <destination group:2>Or: <0x03:1> <destination EUI64:8> <destination endpoint:1>Response: <transaction sequence number: 1> <status:1>
LQI Table Request / Response#
Request: <transaction sequence number: 1> <start index:1>Response: <transaction sequence number: 1> <status:1> <neighbor table entries:1> <start index:1> <entry count:1> <entry:22>* <entry> = <extended PAN ID:8> <EUI64:8> <node ID:2> <device type, RX on when idle, relationship:1> <permit joining:1> <depth:1> <LQI:1>The device-type byte has the following fields: Name Mask Valuesdevice type 0x03 0x00 coordinator 0x01 router 0x02 end device 0x03 unknownrx mode 0x0C 0x00 off when idle 0x04 on when idle 0x08 unknownrelationship 0x70 0x00 parent 0x10 child 0x20 sibling 0x30 other 0x40 previous childreserved 0x10The permit-joining byte has the following fields Name Mask Valuespermit joining 0x03 0x00 not accepting join requests 0x01 accepting join requests 0x02 unknownreserved 0xFC
Routing Table Request / Response#
Request: <transaction sequence number: 1> <start index:1>Response: <transaction sequence number: 1> <status:1> <routing table entries:1> <start index:1> <entry count:1> <entry:5>* <entry> = <destination address:2> <status:1> <next hop:2>The status byte has the following fields: Name Mask Valuesstatus 0x07 0x00 active 0x01 discovery underway 0x02 discovery failed 0x03 inactive 0x04 validation underwayflags 0x38 0x08 memory constrained 0x10 many-to-one 0x20 route record requiredreserved 0xC0
Binding Table Request / Response#
Request: <transaction sequence number: 1> <start index:1>Response: <transaction sequence number: 1> <status:1> <binding table entries:1> <start index:1> <entry count:1> <entry:14/21>* <entry> = <source EUI64:8> <source endpoint:1> <cluster ID:2> <dest addr mode:1> <dest:2/8> <dest endpoint:0/1>If Dest. Address Mode = 0x03, then the Long Dest. Address will be used and Dest. endpoint will be included. If Dest. Address Mode = 0x01, then the Short Dest. Address will be used and there will be no Dest. endpoint.
Leave Request / Response#
Request: <transaction sequence number: 1> <EUI64:8> <flags:1> The flag bits are: 0x40 remove children 0x80 rejoinResponse: <transaction sequence number: 1> <status:1>
Permit Joining Request / Response#
Request: <transaction sequence number: 1> <duration:1> <permit authentication:1>Response: <transaction sequence number: 1> <status:1>
Network Update Request / Response#
Request: <transaction sequence number: 1> <scan channels:4> <duration:1> <count:0/1> <manager:0/2> If the duration is in 0x00 ... 0x05, 'count' is present but not 'manager'. Perform 'count' scans of the given duration on the given channels. If duration is 0xFE, 'channels' should have a single channel and 'count' and 'manager' are not present. Switch to the indicated channel. If duration is 0xFF, 'count' is not present. Set the active channels and the network manager ID to the values given. Unicast requests always get a response, which is INVALID_REQUEST if the duration is not a legal value.Response: <transaction sequence number: 1> <status:1> <scanned channels:4> <transmissions:2> <failures:2> <energy count:1> <energy:1>*
Unsupported#
Not mandatory and not supported.
ZDO configuration flags.#
Control which ZDO requests are passed to the application. These are normally controlled via the following configuration definitions:EMBER_APPLICATION_RECEIVES_SUPPORTED_ZDO_REQUESTS EMBER_APPLICATION_HANDLES_UNSUPPORTED_ZDO_REQUESTS EMBER_APPLICATION_HANDLES_ENDPOINT_ZDO_REQUESTS EMBER_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 the maximum number of counters that are specified as reporting either on 2.4 GHz or Sub-GHz.
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.
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.
Macros#
Returns true if nodeId (short address) is a broadcast address.
Miscellaneous Ember Types Documentation#
EmberVersionType#
EmberVersionType
Type of Ember software version.
Enumerator | |
---|---|
EMBER_VERSION_TYPE_PRE_RELEASE | |
EMBER_VERSION_TYPE_ALPHA_1 | |
EMBER_VERSION_TYPE_ALPHA_2 | |
EMBER_VERSION_TYPE_ALPHA_3 | |
EMBER_VERSION_TYPE_BETA_1 | |
EMBER_VERSION_TYPE_BETA_2 | |
EMBER_VERSION_TYPE_BETA_3 | |
EMBER_VERSION_TYPE_GA |
53
of file stack/include/ember-types.h
EmberStackProfile#
EmberStackProfile
EmberReleaseTypeStruct Data that relates release type to the correct string.
Enumerator | |
---|---|
EMBER_STACK_PROFILE_NONE | |
EMBER_STACK_PROFILE_ZIGBEE_PRO |
447
of file stack/include/ember-types.h
EmberSecurityLevel#
EmberSecurityLevel
EmberReleaseTypeStruct Data that relates release type to the correct string.
Enumerator | |
---|---|
EMBER_SECURITY_LEVEL_NONE | |
EMBER_SECURITY_LEVEL_Z3 |
458
of file stack/include/ember-types.h
EmberLeaveRequestFlags#
EmberLeaveRequestFlags
EmberReleaseTypeStruct Data that relates release type to the correct string.
Enumerator | |
---|---|
EMBER_ZIGBEE_LEAVE_AND_REJOIN | |
EMBER_ZIGBEE_LEAVE_WITHOUT_REJOIN |
469
of file stack/include/ember-types.h
EmberLeaveReason#
EmberLeaveReason
EmberReleaseTypeStruct Data that relates release type to the correct string.
Enumerator | |
---|---|
EMBER_LEAVE_REASON_NONE | |
EMBER_LEAVE_DUE_TO_NWK_LEAVE_MESSAGE | |
EMBER_LEAVE_DUE_TO_APS_REMOVE_MESSAGE | |
EMBER_LEAVE_DUE_TO_ZDO_LEAVE_MESSAGE | |
EMBER_LEAVE_DUE_TO_ZLL_TOUCHLINK | |
EMBER_LEAVE_DUE_TO_APP_EVENT_1 |
489
of file stack/include/ember-types.h
EmberMulticastId#
typedef uint16_t EmberMulticastId
16-bit ZigBee network address.
16-bit ZigBee multicast group identifier.
224
of file stack/include/ember-types.h
EmberDutyCycleHectoPct#
typedef uint16_t EmberDutyCycleHectoPct
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%).
237
of file stack/include/ember-types.h
emberVersion#
const EmberVersion emberVersion
A structure containing the version information.
115
of file stack/include/ember-types.h
EMBER_RELEASE_TYPE_TO_STRING_STRUCT_DATA#
#define EMBER_RELEASE_TYPE_TO_STRING_STRUCT_DATAValue:
EmberReleaseTypeStruct Data that relates release type to the correct string.
89
of file stack/include/ember-types.h
EUI64_SIZE#
#define EUI64_SIZEValue:
8
Size of EUI64 (an IEEE address) in bytes (8).
120
of file stack/include/ember-types.h
EXTENDED_PAN_ID_SIZE#
#define EXTENDED_PAN_ID_SIZEValue:
8
Size of an extended PAN identifier in bytes (8).
125
of file stack/include/ember-types.h
EMBER_ENCRYPTION_KEY_SIZE#
#define EMBER_ENCRYPTION_KEY_SIZEValue:
16
Size of an encryption key in bytes (16).
130
of file stack/include/ember-types.h
EMBER_CERTIFICATE_SIZE#
#define EMBER_CERTIFICATE_SIZEValue:
48
Size of Implicit Certificates used for Certificate-based Key Exchange(CBKE).
136
of file stack/include/ember-types.h
EMBER_PUBLIC_KEY_SIZE#
#define EMBER_PUBLIC_KEY_SIZEValue:
22
Size of Public Keys used in Elliptical Cryptography ECMQV algorithms.
141
of file stack/include/ember-types.h
EMBER_PRIVATE_KEY_SIZE#
#define EMBER_PRIVATE_KEY_SIZEValue:
21
Size of Private Keys used in Elliptical Cryptography ECMQV algorithms.
146
of file stack/include/ember-types.h
EMBER_SMAC_SIZE#
#define EMBER_SMAC_SIZEValue:
16
Size of the SMAC used in Elliptical Cryptography ECMQV algorithms.
151
of file stack/include/ember-types.h
EMBER_SIGNATURE_SIZE#
#define EMBER_SIGNATURE_SIZEValue:
42
Size of the DSA signature used in Elliptical Cryptography Digital Signature Algorithms.
157
of file stack/include/ember-types.h
EMBER_AES_HASH_BLOCK_SIZE#
#define EMBER_AES_HASH_BLOCK_SIZEValue:
16
The size of AES-128 MMO hash is 16-bytes. This is defined in the core. ZigBee specification.
162
of file stack/include/ember-types.h
EMBER_CERTIFICATE_283K1_SIZE#
#define EMBER_CERTIFICATE_283K1_SIZEValue:
74
Size of Implicit Certificates used for Certificate Based Key Exchange using the ECC283K1 curve in bytes.
168
of file stack/include/ember-types.h
EMBER_PUBLIC_KEY_283K1_SIZE#
#define EMBER_PUBLIC_KEY_283K1_SIZEValue:
37
Size of Public Keys used in SECT283k1 Elliptical Cryptography ECMQV algorithms.
173
of file stack/include/ember-types.h
EMBER_PRIVATE_KEY_283K1_SIZE#
#define EMBER_PRIVATE_KEY_283K1_SIZEValue:
36
Size of Private Keys used SECT283k1 in Elliptical Cryptography ECMQV algorithms.
178
of file stack/include/ember-types.h
EMBER_SIGNATURE_283K1_SIZE#
#define EMBER_SIGNATURE_283K1_SIZEValue:
72
Size of the DSA signature used in SECT283k1 Elliptical Cryptography Digital Signature Algorithms.
184
of file stack/include/ember-types.h
__EMBERSTATUS_TYPE__#
#define __EMBERSTATUS_TYPE__
Return type for Ember functions.
190
of file stack/include/ember-types.h
NULL_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.
216
of file stack/include/ember-types.h
EMBER_MAX_802_15_4_CHANNEL_NUMBER#
#define EMBER_MAX_802_15_4_CHANNEL_NUMBERValue:
26
The maximum 802.15.4 channel number is 26.
242
of file stack/include/ember-types.h
EMBER_MIN_802_15_4_CHANNEL_NUMBER#
#define EMBER_MIN_802_15_4_CHANNEL_NUMBERValue:
11
The minimum 2.4GHz 802.15.4 channel number is 11.
247
of file stack/include/ember-types.h
EMBER_MIN_SUBGHZ_CHANNEL_NUMBER#
#define EMBER_MIN_SUBGHZ_CHANNEL_NUMBERValue:
0
The minimum SubGhz channel number is 0.
252
of file stack/include/ember-types.h
EMBER_ACTIVE_SCAN_DURATION#
#define EMBER_ACTIVE_SCAN_DURATIONValue:
3
ZigBee protocol specifies that active scans have a duration of 3 (138 msec). See documentation for emberStartScan in include/network-formation.h for more info on duration values.
259
of file stack/include/ember-types.h
EMBER_SUB_GHZ_SCAN_DURATION#
#define EMBER_SUB_GHZ_SCAN_DURATIONValue:
5
The SubGhz scan duration is 5.
264
of file stack/include/ember-types.h
EMBER_NUM_802_15_4_CHANNELS#
#define EMBER_NUM_802_15_4_CHANNELSValue:
(EMBER_MAX_802_15_4_CHANNEL_NUMBER - EMBER_MIN_802_15_4_CHANNEL_NUMBER + 1)
There are sixteen 802.15.4 channels.
269
of file stack/include/ember-types.h
EMBER_ALL_802_15_4_CHANNELS_MASK#
#define EMBER_ALL_802_15_4_CHANNELS_MASKValue:
0x07FFF800UL
A bitmask to scan all 2.4 GHz 802.15.4 channels.
275
of file stack/include/ember-types.h
EMBER_MAX_CHANNELS_PER_PAGE#
#define EMBER_MAX_CHANNELS_PER_PAGEValue:
27
The maximum channels per page are 27 page bits 31...27, channel bits 26...0.
281
of file stack/include/ember-types.h
EMBER_ALL_SUBGHZ_CHANNELS_MASK_FOR_PAGES_28_30_31#
#define EMBER_ALL_SUBGHZ_CHANNELS_MASK_FOR_PAGES_28_30_31Value:
0x07FFFFFFUL
Sub-GHz channel bitmasks for pages 28, 30, 31.
286
of file stack/include/ember-types.h
EMBER_MAX_SUBGHZ_CHANNEL_NUMBER_ON_PAGES_28_30_31#
#define EMBER_MAX_SUBGHZ_CHANNEL_NUMBER_ON_PAGES_28_30_31Value:
26
The maximum SubGhz channel number on pages 28, 30, 31 is 26.
291
of file stack/include/ember-types.h
EMBER_ALL_SUBGHZ_CHANNELS_MASK_FOR_PAGES_29#
#define EMBER_ALL_SUBGHZ_CHANNELS_MASK_FOR_PAGES_29Value:
0x1FF
SubGhz channel bitmasks for page 29.
295
of file stack/include/ember-types.h
EMBER_MAX_SUBGHZ_CHANNEL_NUMBER_ON_PAGE_29#
#define EMBER_MAX_SUBGHZ_CHANNEL_NUMBER_ON_PAGE_29Value:
8
The maximum SubGhz channel number on page 29 is 8.
300
of file stack/include/ember-types.h
EMBER_MIN_SUGBHZ_PAGE_NUMBER#
#define EMBER_MIN_SUGBHZ_PAGE_NUMBERValue:
28
The minimum SubGhz page number is 28.
305
of file stack/include/ember-types.h
EMBER_MAX_SUGBHZ_PAGE_NUMBER#
#define EMBER_MAX_SUGBHZ_PAGE_NUMBERValue:
31
The maximum SubGhz page number is 31.
310
of file stack/include/ember-types.h
EMBER_ALL_CHANNEL_PAGE_MASK#
#define EMBER_ALL_CHANNEL_PAGE_MASKValue:
0xF8000000UL
A bitmask for the channel page within a channel mask.
315
of file stack/include/ember-types.h
EMBER_PAGE_CHANNEL_MASK_FROM_CHANNEL_MASK#
#define EMBER_PAGE_CHANNEL_MASK_FROM_CHANNEL_MASKValue:
A page-channel mask for a given page and channel mask.
320
of file stack/include/ember-types.h
EMBER_PAGE_CHANNEL_MASK_FROM_CHANNEL_NUMBER#
#define EMBER_PAGE_CHANNEL_MASK_FROM_CHANNEL_NUMBERValue:
(page, channel)
A page-channel mask for a given page and channel.
327
of file stack/include/ember-types.h
EMBER_ZIGBEE_COORDINATOR_ADDRESS#
#define EMBER_ZIGBEE_COORDINATOR_ADDRESSValue:
0x0000u
The network ID of the coordinator in a ZigBee network is 0x0000.
333
of file stack/include/ember-types.h
EMBER_NULL_NODE_ID#
#define EMBER_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.
339
of file stack/include/ember-types.h
EMBER_NO_CHANNEL_PAGE_IN_USE#
#define EMBER_NO_CHANNEL_PAGE_IN_USEValue:
0
The channel page value used to indicate just the 2.4GHz channels.
344
of file stack/include/ember-types.h
EMBER_NULL_EUI64#
#define EMBER_NULL_EUI64Value:
{ 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF }
A distinguished EUI64 that is commonly used to indicate an invalid EUI64.
349
of file stack/include/ember-types.h
EMBER_NULL_BINDING#
#define EMBER_NULL_BINDINGValue:
0xFFu
A distinguished binding index used to indicate the absence of a binding.
355
of file stack/include/ember-types.h
EMBER_TABLE_ENTRY_UNUSED_NODE_ID#
#define EMBER_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.
366
of file stack/include/ember-types.h
EMBER_MULTICAST_NODE_ID#
#define EMBER_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.
374
of file stack/include/ember-types.h
EMBER_UNKNOWN_NODE_ID#
#define EMBER_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.
383
of file stack/include/ember-types.h
EMBER_DISCOVERY_ACTIVE_NODE_ID#
#define EMBER_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.
392
of file stack/include/ember-types.h
EMBER_NULL_ADDRESS_TABLE_INDEX#
#define EMBER_NULL_ADDRESS_TABLE_INDEXValue:
0xFFu
A distinguished address table index used to indicate the absence of an address table entry.
398
of file stack/include/ember-types.h
EMBER_ZDO_ENDPOINT#
#define EMBER_ZDO_ENDPOINTValue:
0u
The endpoint where the ZigBee Device Object (ZDO) resides.
403
of file stack/include/ember-types.h
EMBER_BROADCAST_ENDPOINT#
#define EMBER_BROADCAST_ENDPOINTValue:
0xFFu
The broadcast endpoint, as defined in the ZigBee spec.
408
of file stack/include/ember-types.h
EMBER_ZDO_PROFILE_ID#
#define EMBER_ZDO_PROFILE_IDValue:
0x0000u
The profile ID used by the ZigBee Device Object (ZDO).
413
of file stack/include/ember-types.h
EMBER_WILDCARD_PROFILE_ID#
#define EMBER_WILDCARD_PROFILE_IDValue:
0xFFFFu
The profile ID used to address all the public profiles.
418
of file stack/include/ember-types.h
EMBER_MAXIMUM_STANDARD_PROFILE_ID#
#define EMBER_MAXIMUM_STANDARD_PROFILE_IDValue:
0x7FFFu
The maximum value for a profile ID in the standard profile range.
423
of file stack/include/ember-types.h
EMBER_BROADCAST_TABLE_TIMEOUT_QS#
#define EMBER_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.
429
of file stack/include/ember-types.h
EMBER_MANUFACTURER_ID#
#define EMBER_MANUFACTURER_IDValue:
0x1002u
Ember's Manufacturer ID.
434
of file stack/include/ember-types.h
EMBER_NULL_NETWORK_INDEX#
#define EMBER_NULL_NETWORK_INDEXValue:
0xFFu
An invalid network index.
439
of file stack/include/ember-types.h
EMBER_DC_LIMIT_USE_DEFAULT#
#define EMBER_DC_LIMIT_USE_DEFAULTValue:
0
Use Ember's default duty cycle limit configurations.
444
of file stack/include/ember-types.h
ZigBee Broadcast Addresses Documentation#
EMBER_BROADCAST_ADDRESS#
#define EMBER_BROADCAST_ADDRESSValue:
0xFFFCu
Broadcast to all routers.
519
of file stack/include/ember-types.h
EMBER_RX_ON_WHEN_IDLE_BROADCAST_ADDRESS#
#define EMBER_RX_ON_WHEN_IDLE_BROADCAST_ADDRESSValue:
0xFFFDu
Broadcast to all non-sleepy devices.
521
of file stack/include/ember-types.h
EMBER_SLEEPY_BROADCAST_ADDRESS#
#define EMBER_SLEEPY_BROADCAST_ADDRESSValue:
0xFFFFu
Broadcast to all devices, including sleepy end devices.
523
of file stack/include/ember-types.h
Ember Concentrator Types Documentation#
EmberAssumeTrustCenterConcentratorType#
EmberAssumeTrustCenterConcentratorType
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 to emberAssumedTrustCenterConcentratorType.
Enumerator | |
---|---|
EMBER_ASSUME_TRUST_CENTER_IS_NOT_A_CONCENTRATOR | |
EMBER_ASSUME_TRUST_CENTER_IS_LOW_RAM_CONCENTRATOR | |
EMBER_ASSUME_TRUST_CENTER_IS_HIGH_RAM_CONCENTRATOR |
1018
of file stack/include/ember-types.h
EmberJoinDecision#
EmberJoinDecision
The decision made by the Trust Center when a node attempts to join.
Enumerator | |
---|---|
EMBER_USE_PRECONFIGURED_KEY | |
EMBER_SEND_KEY_IN_THE_CLEAR | |
EMBER_DENY_JOIN | |
EMBER_NO_ACTION | |
EMBER_ALLOW_REJOINS_ONLY |
1036
of file stack/include/ember-types.h
EmberDeviceUpdate#
EmberDeviceUpdate
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 | |
---|---|
EMBER_STANDARD_SECURITY_SECURED_REJOIN | |
EMBER_STANDARD_SECURITY_UNSECURED_JOIN | |
EMBER_DEVICE_LEFT | |
EMBER_STANDARD_SECURITY_UNSECURED_REJOIN |
1071
of file stack/include/ember-types.h
EmberRejoinReason#
EmberRejoinReason
Notes the last rejoin reason.
Enumerator | |
---|---|
EMBER_REJOIN_REASON_NONE | |
EMBER_REJOIN_DUE_TO_NWK_KEY_UPDATE | |
EMBER_REJOIN_DUE_TO_LEAVE_MESSAGE | |
EMBER_REJOIN_DUE_TO_NO_PARENT | |
EMBER_REJOIN_DUE_TO_ZLL_TOUCHLINK | |
EMBER_REJOIN_DUE_TO_END_DEVICE_REBOOT | |
EMBER_REJOIN_DUE_TO_APP_EVENT_5 | |
EMBER_REJOIN_DUE_TO_APP_EVENT_4 | |
EMBER_REJOIN_DUE_TO_APP_EVENT_3 | |
EMBER_REJOIN_DUE_TO_APP_EVENT_2 | |
EMBER_REJOIN_DUE_TO_APP_EVENT_1 |
1096
of file stack/include/ember-types.h
EmberClusterListId#
EmberClusterListId
Defines the lists of clusters that must be provided for each endpoint.
Enumerator | |
---|---|
EMBER_INPUT_CLUSTER_LIST | |
EMBER_OUTPUT_CLUSTER_LIST |
1127
of file stack/include/ember-types.h
EmberEventUnits#
EmberEventUnits
Either marks an event as inactive or specifies the units for the event execution time.
Enumerator | |
---|---|
EMBER_EVENT_INACTIVE | |
EMBER_EVENT_MS_TIME | |
EMBER_EVENT_QS_TIME | |
EMBER_EVENT_MINUTE_TIME | |
EMBER_EVENT_ZERO_DELAY |
1144
of file stack/include/ember-types.h
EmberJoinMethod#
EmberJoinMethod
The type of method used for joining.
Enumerator | |
---|---|
EMBER_USE_MAC_ASSOCIATION | |
EMBER_USE_NWK_REJOIN | |
EMBER_USE_NWK_REJOIN_HAVE_NWK_KEY | |
EMBER_USE_CONFIGURED_NWK_STATE |
1168
of file stack/include/ember-types.h
EmberCounterType#
EmberCounterType
Defines the events reported to the application by the emberCounterHandler().
Enumerator | |
---|---|
EMBER_COUNTER_MAC_RX_BROADCAST | |
EMBER_COUNTER_MAC_TX_BROADCAST | |
EMBER_COUNTER_MAC_RX_UNICAST | |
EMBER_COUNTER_MAC_TX_UNICAST_SUCCESS | |
EMBER_COUNTER_MAC_TX_UNICAST_RETRY | |
EMBER_COUNTER_MAC_TX_UNICAST_FAILED | |
EMBER_COUNTER_APS_DATA_RX_BROADCAST | |
EMBER_COUNTER_APS_DATA_TX_BROADCAST | |
EMBER_COUNTER_APS_DATA_RX_UNICAST | |
EMBER_COUNTER_APS_DATA_TX_UNICAST_SUCCESS | |
EMBER_COUNTER_APS_DATA_TX_UNICAST_RETRY | |
EMBER_COUNTER_APS_DATA_TX_UNICAST_FAILED | |
EMBER_COUNTER_ROUTE_DISCOVERY_INITIATED | |
EMBER_COUNTER_NEIGHBOR_ADDED | |
EMBER_COUNTER_NEIGHBOR_REMOVED | |
EMBER_COUNTER_NEIGHBOR_STALE | |
EMBER_COUNTER_JOIN_INDICATION | |
EMBER_COUNTER_CHILD_REMOVED | |
EMBER_COUNTER_ASH_OVERFLOW_ERROR | |
EMBER_COUNTER_ASH_FRAMING_ERROR | |
EMBER_COUNTER_ASH_OVERRUN_ERROR | |
EMBER_COUNTER_NWK_FRAME_COUNTER_FAILURE | |
EMBER_COUNTER_APS_FRAME_COUNTER_FAILURE | |
EMBER_COUNTER_ASH_XOFF | |
EMBER_COUNTER_APS_LINK_KEY_NOT_AUTHORIZED | |
EMBER_COUNTER_NWK_DECRYPTION_FAILURE | |
EMBER_COUNTER_APS_DECRYPTION_FAILURE | |
EMBER_COUNTER_ALLOCATE_PACKET_BUFFER_FAILURE | |
EMBER_COUNTER_RELAYED_UNICAST | |
EMBER_COUNTER_PHY_TO_MAC_QUEUE_LIMIT_REACHED | |
EMBER_COUNTER_PACKET_VALIDATE_LIBRARY_DROPPED_COUNT | |
EMBER_COUNTER_TYPE_NWK_RETRY_OVERFLOW | |
EMBER_COUNTER_PHY_CCA_FAIL_COUNT | |
EMBER_COUNTER_BROADCAST_TABLE_FULL | |
EMBER_COUNTER_PTA_LO_PRI_REQUESTED | |
EMBER_COUNTER_PTA_HI_PRI_REQUESTED | |
EMBER_COUNTER_PTA_LO_PRI_DENIED | |
EMBER_COUNTER_PTA_HI_PRI_DENIED | |
EMBER_COUNTER_PTA_LO_PRI_TX_ABORTED | |
EMBER_COUNTER_PTA_HI_PRI_TX_ABORTED | |
EMBER_COUNTER_ADDRESS_CONFLICT_SENT | |
EMBER_COUNTER_TYPE_COUNT |
1409
of file stack/include/ember-types.h
EmberTaskId#
typedef uint8_t EmberTaskId
brief An identifier for a task.
1649
of file stack/include/ember-types.h
EMBER_LOW_RAM_CONCENTRATOR#
#define EMBER_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.
998
of file stack/include/ember-types.h
EMBER_HIGH_RAM_CONCENTRATOR#
#define EMBER_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.
1003
of file stack/include/ember-types.h
EMBER_JOIN_DECISION_STRINGS#
#define EMBER_JOIN_DECISION_STRINGSValue:
@ brief Defines the CLI enumerations for the EmberJoinDecision enum.
1057
of file stack/include/ember-types.h
EMBER_DEVICE_UPDATE_STRINGS#
#define EMBER_DEVICE_UPDATE_STRINGSValue:
@ brief Defines the CLI enumerations for the EmberDeviceUpdate enum.
1086
of file stack/include/ember-types.h
emberInitializeNetworkParameters#
#define emberInitializeNetworkParametersValue:
(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.
1247
of file stack/include/ember-types.h
EMBER_COUNTER_STRINGS#
#define EMBER_COUNTER_STRINGS
@ brief Defines the CLI enumerations for the EmberCounterType enum.
1593
of file stack/include/ember-types.h
txPowerModes for emberSetTxPowerMode and mfglibSetPower Documentation#
EMBER_TX_POWER_MODE_DEFAULT#
#define EMBER_TX_POWER_MODE_DEFAULTValue:
0x0000
The application should call emberSetTxPowerMode() 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.
1707
of file stack/include/ember-types.h
EMBER_TX_POWER_MODE_BOOST#
#define EMBER_TX_POWER_MODE_BOOSTValue:
0x0001
The application should call emberSetTxPowerMode() with the txPowerMode parameter set to this value to enable boost power mode.
1711
of file stack/include/ember-types.h
EMBER_TX_POWER_MODE_ALTERNATE#
#define EMBER_TX_POWER_MODE_ALTERNATEValue:
0x0002
The application should call emberSetTxPowerMode() with the txPowerMode parameter set to this value to enable the alternate transmitter output.
1716
of file stack/include/ember-types.h
EMBER_TX_POWER_MODE_BOOST_AND_ALTERNATE#
#define EMBER_TX_POWER_MODE_BOOST_AND_ALTERNATEValue:
The application should call emberSetTxPowerMode() with the txPowerMode parameter set to this value to enable both boost mode and the alternate transmitter output.
1721
of file stack/include/ember-types.h
Counters Request Definitions Documentation#
EmberInitialSecurityBitmask#
EmberInitialSecurityBitmask
This is the Initial Security Bitmask that controls the use of various security features.
Enumerator | |
---|---|
EMBER_DISTRIBUTED_TRUST_CENTER_MODE | |
EMBER_TRUST_CENTER_GLOBAL_LINK_KEY | |
EMBER_PRECONFIGURED_NETWORK_KEY_MODE | |
EMBER_HAVE_TRUST_CENTER_EUI64 | |
EMBER_TRUST_CENTER_USES_HASHED_LINK_KEY | |
EMBER_HAVE_PRECONFIGURED_KEY | |
EMBER_HAVE_NETWORK_KEY | |
EMBER_GET_LINK_KEY_WHEN_JOINING | |
EMBER_REQUIRE_ENCRYPTED_KEY | |
EMBER_NO_FRAME_COUNTER_RESET | |
EMBER_GET_PRECONFIGURED_KEY_FROM_INSTALL_CODE |
1877
of file stack/include/ember-types.h
EmberExtendedSecurityBitmask#
EmberExtendedSecurityBitmask
This is the Extended Security Bitmask that controls the use of various extended security features.
Enumerator | |
---|---|
EMBER_SECURE_NETWORK_KEY_ROTATION | |
EMBER_JOINER_GLOBAL_LINK_KEY | |
EMBER_EXT_NO_FRAME_COUNTER_RESET | |
EMBER_NWK_LEAVE_WITHOUT_REJOIN_NOT_ALLOWED | |
EMBER_NWK_LEAVE_REQUEST_NOT_ALLOWED |
1969
of file stack/include/ember-types.h
EmberCurrentSecurityBitmask#
EmberCurrentSecurityBitmask
This is the Current Security Bitmask that details the use of various security features.
Enumerator | |
---|---|
EMBER_STANDARD_SECURITY_MODE_ | |
EMBER_DISTRIBUTED_TRUST_CENTER_MODE_ | |
EMBER_TRUST_CENTER_GLOBAL_LINK_KEY_ | |
EMBER_HAVE_TRUST_CENTER_LINK_KEY | |
EMBER_TRUST_CENTER_USES_HASHED_LINK_KEY_ |
2083
of file stack/include/ember-types.h
EmberKeyStructBitmask#
EmberKeyStructBitmask
This bitmask describes the presence of fields within the EmberKeyStruct.
Enumerator | |
---|---|
EMBER_KEY_HAS_SEQUENCE_NUMBER | |
EMBER_KEY_HAS_OUTGOING_FRAME_COUNTER | |
EMBER_KEY_HAS_INCOMING_FRAME_COUNTER | |
EMBER_KEY_HAS_PARTNER_EUI64 | |
EMBER_KEY_IS_AUTHORIZED | |
EMBER_KEY_PARTNER_IS_SLEEPY | |
EMBER_UNCONFIRMED_TRANSIENT_KEY |
2133
of file stack/include/ember-types.h
EmberKeyType#
EmberKeyType
This denotes the type of security key.
Enumerator | |
---|---|
EMBER_TRUST_CENTER_LINK_KEY | |
EMBER_CURRENT_NETWORK_KEY | |
EMBER_NEXT_NETWORK_KEY | |
EMBER_APPLICATION_LINK_KEY |
2179
of file stack/include/ember-types.h
EmberKeyStatus#
EmberKeyStatus
This denotes the status of an attempt to establish a key with another device.
Enumerator | |
---|---|
EMBER_KEY_STATUS_NONE | |
EMBER_APP_LINK_KEY_ESTABLISHED | |
EMBER_TRUST_CENTER_LINK_KEY_ESTABLISHED | |
EMBER_KEY_ESTABLISHMENT_TIMEOUT | |
EMBER_KEY_TABLE_FULL | |
EMBER_TC_RESPONDED_TO_KEY_REQUEST | |
EMBER_TC_APP_KEY_SENT_TO_REQUESTER | |
EMBER_TC_RESPONSE_TO_KEY_REQUEST_FAILED | |
EMBER_TC_REQUEST_KEY_TYPE_NOT_SUPPORTED | |
EMBER_TC_NO_LINK_KEY_FOR_REQUESTER | |
EMBER_TC_REQUESTER_EUI64_UNKNOWN | |
EMBER_TC_RECEIVED_FIRST_APP_KEY_REQUEST | |
EMBER_TC_TIMEOUT_WAITING_FOR_SECOND_APP_KEY_REQUEST | |
EMBER_TC_NON_MATCHING_APP_KEY_REQUEST_RECEIVED | |
EMBER_TC_FAILED_TO_SEND_APP_KEYS | |
EMBER_TC_FAILED_TO_STORE_APP_KEY_REQUEST | |
EMBER_TC_REJECTED_APP_KEY_REQUEST | |
EMBER_TC_FAILED_TO_GENERATE_NEW_KEY | |
EMBER_TC_FAILED_TO_SEND_TC_KEY | |
EMBER_TRUST_CENTER_IS_PRE_R21 | |
EMBER_TC_REQUESTER_VERIFY_KEY_TIMEOUT | |
EMBER_TC_REQUESTER_VERIFY_KEY_FAILURE | |
EMBER_TC_REQUESTER_VERIFY_KEY_SUCCESS | |
EMBER_VERIFY_LINK_KEY_FAILURE | |
EMBER_VERIFY_LINK_KEY_SUCCESS |
2225
of file stack/include/ember-types.h
EmberTcLinkKeyRequestPolicy#
EmberTcLinkKeyRequestPolicy
This enumeration determines whether or not a Trust Center answers trust center link key requests.
Enumerator | |
---|---|
EMBER_DENY_TC_LINK_KEY_REQUESTS | |
EMBER_ALLOW_TC_LINK_KEY_REQUEST_AND_SEND_CURRENT_KEY | |
EMBER_ALLOW_TC_LINK_KEY_REQUEST_AND_GENERATE_NEW_KEY |
2277
of file stack/include/ember-types.h
EmberAppLinkKeyRequestPolicy#
EmberAppLinkKeyRequestPolicy
This enumeration determines whether or not a Trust Center answers app link key requests.
Enumerator | |
---|---|
EMBER_DENY_APP_LINK_KEY_REQUESTS | |
EMBER_ALLOW_APP_LINK_KEY_REQUEST |
2297
of file stack/include/ember-types.h
EmberKeySettings#
EmberKeySettings
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 | |
---|---|
EMBER_KEY_PERMISSIONS_NONE | |
EMBER_KEY_PERMISSIONS_READING_ALLOWED | |
EMBER_KEY_PERMISSIONS_HASHING_ALLOWED |
2427
of file stack/include/ember-types.h
EmberMacPassthroughType#
EmberMacPassthroughType
The types of MAC passthrough messages that an application may receive. This is a bitmask.
Enumerator | |
---|---|
EMBER_MAC_PASSTHROUGH_NONE | |
EMBER_MAC_PASSTHROUGH_SE_INTERPAN | |
EMBER_MAC_PASSTHROUGH_EMBERNET | |
EMBER_MAC_PASSTHROUGH_EMBERNET_SOURCE | |
EMBER_MAC_PASSTHROUGH_APPLICATION | |
EMBER_MAC_PASSTHROUGH_CUSTOM |
2526
of file stack/include/ember-types.h
emberKeyContents#
uint8_t* emberKeyContents (EmberKeyData *key)
This function allows access to the actual key data bytes of the EmberKeyData structure.
N/A | key | A pointer to an EmberKeyData structure. |
Returns
uint8_t* Returns a pointer to the first byte of the Key data.
2315
of file stack/include/ember-types.h
emberCertificateContents#
uint8_t* emberCertificateContents (EmberCertificateData *cert)
This function allows access to the actual certificate data bytes of the EmberCertificateData structure.
N/A | cert | A pointer to an EmberCertificateData structure. |
Returns
uint8_t* Returns a pointer to the first byte of the certificate data.
2328
of file stack/include/ember-types.h
emberPublicKeyContents#
uint8_t* emberPublicKeyContents (EmberPublicKeyData *key)
This function allows access to the actual public key data bytes of the EmberPublicKeyData structure.
N/A | key | A pointer to an EmberPublicKeyData structure. |
Returns
uint8_t* Returns a pointer to the first byte of the public key data.
2341
of file stack/include/ember-types.h
emberPrivateKeyContents#
uint8_t* emberPrivateKeyContents (EmberPrivateKeyData *key)
This function allows access to the actual private key data bytes of the EmberPrivateKeyData structure.
N/A | key | A pointer to an EmberPrivateKeyData structure. |
Returns
uint8_t* Returns a pointer to the first byte of the private key data.
2354
of file stack/include/ember-types.h
emberSmacContents#
uint8_t* emberSmacContents (EmberSmacData *key)
This function allows access to the actual SMAC (Secured Message Authentication Code) data of the EmberSmacData structure.
N/A | key |
2364
of file stack/include/ember-types.h
emberSignatureContents#
uint8_t* emberSignatureContents (EmberSignatureData *sig)
This function allows access to the actual ECDSA signature data of the EmberSignatureData structure.
N/A | sig |
2373
of file stack/include/ember-types.h
emberCertificate283k1Contents#
uint8_t* emberCertificate283k1Contents (EmberCertificate283k1Data *cert)
This function allows access to the actual certificate data bytes of the Ember283k1CertificateData structure.
N/A | cert | A pointer to an ::Ember283k1CertificateData structure. |
Returns
uint8_t* Returns a pointer to the first byte of the certificate data.
2386
of file stack/include/ember-types.h
emberPublicKey283k1Contents#
uint8_t* emberPublicKey283k1Contents (EmberPublicKey283k1Data *key)
This function allows access to the actual public key data bytes of the Ember283k1PublicKeyData structure.
N/A | key | A pointer to an Ember283k1PublicKeyData structure. |
Returns
uint8_t* Returns a pointer to the first byte of the public key data.
2399
of file stack/include/ember-types.h
emberPrivateKey283k1Contents#
uint8_t* emberPrivateKey283k1Contents (EmberPrivateKey283k1Data *key)
This function allows access to the actual private key data bytes of the Ember283k1PrivateKeyData structure.
N/A | key | A pointer to an Ember283k1PrivateKeyData structure. |
Returns
uint8_t* Returns a pointer to the first byte of the private key data.
2412
of file stack/include/ember-types.h
ember283k1SignatureContents#
uint8_t* ember283k1SignatureContents (Ember283k1SignatureData *sig)
This function allows access to the actual ECDSA signature data of the Ember283k1SignatureData structure.
N/A | sig |
2421
of file stack/include/ember-types.h
EMBER_PRIVATE_PROFILE_ID#
#define EMBER_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.
1745
of file stack/include/ember-types.h
EMBER_PRIVATE_PROFILE_ID_START#
#define EMBER_PRIVATE_PROFILE_ID_STARTValue:
0xC00Du
Ember's first private profile ID.
1750
of file stack/include/ember-types.h
EMBER_PRIVATE_PROFILE_ID_END#
#define EMBER_PRIVATE_PROFILE_ID_ENDValue:
0xC016u
Ember's last private profile ID.
1755
of file stack/include/ember-types.h
EMBER_REPORT_COUNTERS_REQUEST#
#define EMBER_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.
1760
of file stack/include/ember-types.h
EMBER_REPORT_COUNTERS_RESPONSE#
#define EMBER_REPORT_COUNTERS_RESPONSEValue:
0x8003u
The cluster ID used to respond to an EMBER_REPORT_COUNTERS_REQUEST.
1763
of file stack/include/ember-types.h
EMBER_REPORT_AND_CLEAR_COUNTERS_REQUEST#
#define EMBER_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.
1769
of file stack/include/ember-types.h
EMBER_REPORT_AND_CLEAR_COUNTERS_RESPONSE#
#define EMBER_REPORT_AND_CLEAR_COUNTERS_RESPONSEValue:
0x8004u
The cluster ID used to respond to an EMBER_REPORT_AND_CLEAR_COUNTERS_REQUEST.
1772
of file stack/include/ember-types.h
EMBER_OTA_CERTIFICATE_UPGRADE_CLUSTER#
#define EMBER_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.
1778
of file stack/include/ember-types.h
EMBER_STANDARD_SECURITY_MODE#
#define EMBER_STANDARD_SECURITY_MODEValue:
0x0000
This is an EmberInitialSecurityBitmask 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.
1866
of file stack/include/ember-types.h
EMBER_TRUST_CENTER_NODE_ID#
#define EMBER_TRUST_CENTER_NODE_IDValue:
0x0000u
The short address of the trust center. This address never changes dynamically.
1871
of file stack/include/ember-types.h
EMBER_NO_TRUST_CENTER_MODE#
#define EMBER_NO_TRUST_CENTER_MODEValue:
EMBER_DISTRIBUTED_TRUST_CENTER_MODE
This is the legacy name for the Distributed Trust Center Mode.
2024
of file stack/include/ember-types.h
EMBER_GLOBAL_LINK_KEY#
#define EMBER_GLOBAL_LINK_KEYValue:
EMBER_TRUST_CENTER_GLOBAL_LINK_KEY
This is the legacy name for the Trust Center Global Link Key.
2028
of file stack/include/ember-types.h
EMBER_MFG_SECURITY_CONFIG_MAGIC_NUMBER#
#define EMBER_MFG_SECURITY_CONFIG_MAGIC_NUMBERValue:
0xCABAD11FUL
This magic number prevents accidentally changing the key settings. The emberSetMfgSecurityConfig() API will return EMBER_INVALID_CALL unless it is passed in.
2449
of file stack/include/ember-types.h
ZDO response status. Documentation#
EmberZdoStatus#
EmberZdoStatus
Enumerator | |
---|---|
EMBER_ZDP_SUCCESS | |
EMBER_ZDP_INVALID_REQUEST_TYPE | |
EMBER_ZDP_DEVICE_NOT_FOUND | |
EMBER_ZDP_INVALID_ENDPOINT | |
EMBER_ZDP_NOT_ACTIVE | |
EMBER_ZDP_NOT_SUPPORTED | |
EMBER_ZDP_TIMEOUT | |
EMBER_ZDP_NO_MATCH | |
EMBER_ZDP_NO_ENTRY | |
EMBER_ZDP_NO_DESCRIPTOR | |
EMBER_ZDP_INSUFFICIENT_SPACE | |
EMBER_ZDP_NOT_PERMITTED | |
EMBER_ZDP_TABLE_FULL | |
EMBER_ZDP_NOT_AUTHORIZED | |
EMBER_ZDP_DEVICE_BINDING_TABLE_FULL | |
EMBER_ZDP_INVALID_INDEX | |
EMBER_NWK_ALREADY_PRESENT | |
EMBER_NWK_TABLE_FULL | |
EMBER_NWK_UNKNOWN_DEVICE |
2572
of file stack/include/ember-types.h
Network and IEEE Address Request/Response Documentation#
NETWORK_ADDRESS_REQUEST#
#define NETWORK_ADDRESS_REQUESTValue:
0x0000u
2630
of file stack/include/ember-types.h
NETWORK_ADDRESS_RESPONSE#
#define NETWORK_ADDRESS_RESPONSEValue:
0x8000u
2631
of file stack/include/ember-types.h
IEEE_ADDRESS_REQUEST#
#define IEEE_ADDRESS_REQUESTValue:
0x0001u
2632
of file stack/include/ember-types.h
IEEE_ADDRESS_RESPONSE#
#define IEEE_ADDRESS_RESPONSEValue:
0x8001u
2633
of file stack/include/ember-types.h
Node Descriptor Request/Response Documentation#
NODE_DESCRIPTOR_REQUEST#
#define NODE_DESCRIPTOR_REQUESTValue:
0x0002u
2661
of file stack/include/ember-types.h
NODE_DESCRIPTOR_RESPONSE#
#define NODE_DESCRIPTOR_RESPONSEValue:
0x8002u
2662
of file stack/include/ember-types.h
Power Descriptor Request / Response Documentation#
POWER_DESCRIPTOR_REQUEST#
#define POWER_DESCRIPTOR_REQUESTValue:
0x0003u
2675
of file stack/include/ember-types.h
POWER_DESCRIPTOR_RESPONSE#
#define POWER_DESCRIPTOR_RESPONSEValue:
0x8003u
2676
of file stack/include/ember-types.h
Simple Descriptor Request / Response Documentation#
SIMPLE_DESCRIPTOR_REQUEST#
#define SIMPLE_DESCRIPTOR_REQUESTValue:
0x0004u
2692
of file stack/include/ember-types.h
SIMPLE_DESCRIPTOR_RESPONSE#
#define SIMPLE_DESCRIPTOR_RESPONSEValue:
0x8004u
2693
of file stack/include/ember-types.h
Active Endpoints Request / Response Documentation#
ACTIVE_ENDPOINTS_REQUEST#
#define ACTIVE_ENDPOINTS_REQUESTValue:
0x0005u
2704
of file stack/include/ember-types.h
ACTIVE_ENDPOINTS_RESPONSE#
#define ACTIVE_ENDPOINTS_RESPONSEValue:
0x8005u
2705
of file stack/include/ember-types.h
Match Descriptors Request / Response Documentation#
MATCH_DESCRIPTORS_REQUEST#
#define MATCH_DESCRIPTORS_REQUESTValue:
0x0006u
2719
of file stack/include/ember-types.h
MATCH_DESCRIPTORS_RESPONSE#
#define MATCH_DESCRIPTORS_RESPONSEValue:
0x8006u
2720
of file stack/include/ember-types.h
Discovery Cache Request / Response Documentation#
DISCOVERY_CACHE_REQUEST#
#define DISCOVERY_CACHE_REQUESTValue:
0x0012u
2732
of file stack/include/ember-types.h
DISCOVERY_CACHE_RESPONSE#
#define DISCOVERY_CACHE_RESPONSEValue:
0x8012u
2733
of file stack/include/ember-types.h
End Device Announce and End Device Announce Response Documentation#
END_DEVICE_ANNOUNCE#
#define END_DEVICE_ANNOUNCEValue:
0x0013u
2744
of file stack/include/ember-types.h
END_DEVICE_ANNOUNCE_RESPONSE#
#define END_DEVICE_ANNOUNCE_RESPONSEValue:
0x8013u
2745
of file stack/include/ember-types.h
System Server Discovery Request / Response Documentation#
SYSTEM_SERVER_DISCOVERY_REQUEST#
#define SYSTEM_SERVER_DISCOVERY_REQUESTValue:
0x0015u
2759
of file stack/include/ember-types.h
SYSTEM_SERVER_DISCOVERY_RESPONSE#
#define SYSTEM_SERVER_DISCOVERY_RESPONSEValue:
0x8015u
2760
of file stack/include/ember-types.h
Parent Announce and Parent Announce Response Documentation#
PARENT_ANNOUNCE#
#define PARENT_ANNOUNCEValue:
0x001Fu
2775
of file stack/include/ember-types.h
PARENT_ANNOUNCE_RESPONSE#
#define PARENT_ANNOUNCE_RESPONSEValue:
0x801Fu
2776
of file stack/include/ember-types.h
ZDO server mask bits Documentation#
EmberZdoServerMask#
EmberZdoServerMask
Enumerator | |
---|---|
EMBER_ZDP_PRIMARY_TRUST_CENTER | |
EMBER_ZDP_SECONDARY_TRUST_CENTER | |
EMBER_ZDP_PRIMARY_BINDING_TABLE_CACHE | |
EMBER_ZDP_SECONDARY_BINDING_TABLE_CACHE | |
EMBER_ZDP_PRIMARY_DISCOVERY_CACHE | |
EMBER_ZDP_SECONDARY_DISCOVERY_CACHE | |
EMBER_ZDP_NETWORK_MANAGER |
2784
of file stack/include/ember-types.h
Find Node Cache Request / Response Documentation#
FIND_NODE_CACHE_REQUEST#
#define FIND_NODE_CACHE_REQUESTValue:
0x001Cu
2813
of file stack/include/ember-types.h
FIND_NODE_CACHE_RESPONSE#
#define FIND_NODE_CACHE_RESPONSEValue:
0x801Cu
2814
of file stack/include/ember-types.h
End Device Bind Request / Response Documentation#
END_DEVICE_BIND_REQUEST#
#define END_DEVICE_BIND_REQUESTValue:
0x0020u
2827
of file stack/include/ember-types.h
END_DEVICE_BIND_RESPONSE#
#define END_DEVICE_BIND_RESPONSEValue:
0x8020u
2828
of file stack/include/ember-types.h
Binding types and Request / Response Documentation#
UNICAST_BINDING#
#define UNICAST_BINDINGValue:
0x03u
2848
of file stack/include/ember-types.h
UNICAST_MANY_TO_ONE_BINDING#
#define UNICAST_MANY_TO_ONE_BINDINGValue:
0x83u
2849
of file stack/include/ember-types.h
MULTICAST_BINDING#
#define MULTICAST_BINDINGValue:
0x01u
2850
of file stack/include/ember-types.h
BIND_REQUEST#
#define BIND_REQUESTValue:
0x0021u
2852
of file stack/include/ember-types.h
BIND_RESPONSE#
#define BIND_RESPONSEValue:
0x8021u
2853
of file stack/include/ember-types.h
UNBIND_REQUEST#
#define UNBIND_REQUESTValue:
0x0022u
2854
of file stack/include/ember-types.h
UNBIND_RESPONSE#
#define UNBIND_RESPONSEValue:
0x8022u
2855
of file stack/include/ember-types.h
LQI Table Request / Response Documentation#
LQI_TABLE_REQUEST#
#define LQI_TABLE_REQUESTValue:
0x0031u
2905
of file stack/include/ember-types.h
LQI_TABLE_RESPONSE#
#define LQI_TABLE_RESPONSEValue:
0x8031u
2906
of file stack/include/ember-types.h
Routing Table Request / Response Documentation#
ROUTING_TABLE_REQUEST#
#define ROUTING_TABLE_REQUESTValue:
0x0032u
2941
of file stack/include/ember-types.h
ROUTING_TABLE_RESPONSE#
#define ROUTING_TABLE_RESPONSEValue:
0x8032u
2942
of file stack/include/ember-types.h
Binding Table Request / Response Documentation#
BINDING_TABLE_REQUEST#
#define BINDING_TABLE_REQUESTValue:
0x0033u
2963
of file stack/include/ember-types.h
BINDING_TABLE_RESPONSE#
#define BINDING_TABLE_RESPONSEValue:
0x8033u
2964
of file stack/include/ember-types.h
Leave Request / Response Documentation#
LEAVE_REQUEST#
#define LEAVE_REQUESTValue:
0x0034u
2977
of file stack/include/ember-types.h
LEAVE_RESPONSE#
#define LEAVE_RESPONSEValue:
0x8034u
2978
of file stack/include/ember-types.h
LEAVE_REQUEST_REMOVE_CHILDREN_FLAG#
#define LEAVE_REQUEST_REMOVE_CHILDREN_FLAGValue:
0x40u
2980
of file stack/include/ember-types.h
LEAVE_REQUEST_REJOIN_FLAG#
#define LEAVE_REQUEST_REJOIN_FLAGValue:
0x80u
2981
of file stack/include/ember-types.h
Permit Joining Request / Response Documentation#
PERMIT_JOINING_REQUEST#
#define PERMIT_JOINING_REQUESTValue:
0x0036u
2992
of file stack/include/ember-types.h
PERMIT_JOINING_RESPONSE#
#define PERMIT_JOINING_RESPONSEValue:
0x8036u
2993
of file stack/include/ember-types.h
Network Update Request / Response Documentation#
NWK_UPDATE_REQUEST#
#define NWK_UPDATE_REQUESTValue:
0x0038u
3021
of file stack/include/ember-types.h
NWK_UPDATE_RESPONSE#
#define NWK_UPDATE_RESPONSEValue:
0x8038u
3022
of file stack/include/ember-types.h
NWK_UPDATE_ENHANCED_REQUEST#
#define NWK_UPDATE_ENHANCED_REQUESTValue:
0x0039u
3024
of file stack/include/ember-types.h
NWK_UPDATE_ENHANCED_RESPONSE#
#define NWK_UPDATE_ENHANCED_RESPONSEValue:
0x8039u
3025
of file stack/include/ember-types.h
NWK_UPDATE_IEEE_JOINING_LIST_REQUEST#
#define NWK_UPDATE_IEEE_JOINING_LIST_REQUESTValue:
0x003Au
3027
of file stack/include/ember-types.h
NWK_UPDATE_IEEE_JOINING_LIST_REPONSE#
#define NWK_UPDATE_IEEE_JOINING_LIST_REPONSEValue:
0x803Au
3028
of file stack/include/ember-types.h
NWK_UNSOLICITED_ENHANCED_UPDATE_NOTIFY#
#define NWK_UNSOLICITED_ENHANCED_UPDATE_NOTIFYValue:
0x803Bu
3030
of file stack/include/ember-types.h
Unsupported Documentation#
COMPLEX_DESCRIPTOR_REQUEST#
#define COMPLEX_DESCRIPTOR_REQUESTValue:
0x0010u
3037
of file stack/include/ember-types.h
COMPLEX_DESCRIPTOR_RESPONSE#
#define COMPLEX_DESCRIPTOR_RESPONSEValue:
0x8010u
3038
of file stack/include/ember-types.h
USER_DESCRIPTOR_REQUEST#
#define USER_DESCRIPTOR_REQUESTValue:
0x0011u
3039
of file stack/include/ember-types.h
USER_DESCRIPTOR_RESPONSE#
#define USER_DESCRIPTOR_RESPONSEValue:
0x8011u
3040
of file stack/include/ember-types.h
DISCOVERY_REGISTER_REQUEST#
#define DISCOVERY_REGISTER_REQUESTValue:
0x0012u
3041
of file stack/include/ember-types.h
DISCOVERY_REGISTER_RESPONSE#
#define DISCOVERY_REGISTER_RESPONSEValue:
0x8012u
3042
of file stack/include/ember-types.h
USER_DESCRIPTOR_SET#
#define USER_DESCRIPTOR_SETValue:
0x0014u
3043
of file stack/include/ember-types.h
USER_DESCRIPTOR_CONFIRM#
#define USER_DESCRIPTOR_CONFIRMValue:
0x8014u
3044
of file stack/include/ember-types.h
NETWORK_DISCOVERY_REQUEST#
#define NETWORK_DISCOVERY_REQUESTValue:
0x0030u
3045
of file stack/include/ember-types.h
NETWORK_DISCOVERY_RESPONSE#
#define NETWORK_DISCOVERY_RESPONSEValue:
0x8030u
3046
of file stack/include/ember-types.h
DIRECT_JOIN_REQUEST#
#define DIRECT_JOIN_REQUESTValue:
0x0035u
3047
of file stack/include/ember-types.h
DIRECT_JOIN_RESPONSE#
#define DIRECT_JOIN_RESPONSEValue:
0x8035u
3048
of file stack/include/ember-types.h
CLUSTER_ID_RESPONSE_MINIMUM#
#define CLUSTER_ID_RESPONSE_MINIMUMValue:
0x8000u
3050
of file stack/include/ember-types.h
ZDO configuration flags. Documentation#
EmberZdoConfigurationFlags#
EmberZdoConfigurationFlags
Defines the maximum number of counters that are specified as reporting either on 2.4 GHz or Sub-GHz.
Enumerator | |
---|---|
EMBER_APP_RECEIVES_SUPPORTED_ZDO_REQUESTS | |
EMBER_APP_HANDLES_UNSUPPORTED_ZDO_REQUESTS | |
EMBER_APP_HANDLES_ZDO_ENDPOINT_REQUESTS | |
EMBER_APP_HANDLES_ZDO_BINDING_REQUESTS |
3066
of file stack/include/ember-types.h
EmberMultiPhyNwkConfig#
EmberMultiPhyNwkConfig
Defines the maximum number of counters that are specified as reporting either on 2.4 GHz or Sub-GHz.
Enumerator | |
---|---|
EMBER_MULTI_PHY_ROUTERS_ALLOWED | |
EMBER_MULTI_PHY_BROADCASTS_ENABLED | |
EMBER_MULTI_PHY_DISABLED |
3094
of file stack/include/ember-types.h
@0#
@0
Defines the maximum number of counters that are specified as reporting either on 2.4 GHz or Sub-GHz.
Enumerator | |
---|---|
PRIORITIZE_BEACONS_BASED_ON_PARENT_CLASSIFICATION | |
PRIORITIZE_BEACONS_BASED_ON_TC_CONNECTVITY | |
TC_CONNECTIVITY | |
LONG_UPTIME | |
BAD_PARENT_CONNECTIVITY | |
EMBER_OUTGOING_MESSAGES | |
EMBER_INCOMING_MESSAGES | |
EMBER_RADIO_IS_ON | |
EMBER_TRANSPORT_ACTIVE | |
EMBER_APS_LAYER_ACTIVE | |
EMBER_ASSOCIATING | |
EMBER_ZLL_TOUCH_LINKING | |
EMBER_NETWORK_TIMEOUT_REQUEST | |
EMBER_SEND_ORPHAN_NOTIFICATION | |
EMBER_MAC_DATA_POLL_SUPER_RETRY |
3137
of file stack/include/ember-types.h
EmberEntropySource#
EmberEntropySource
Defines the entropy source used by the stack.
Enumerator | |
---|---|
EMBER_ENTROPY_SOURCE_ERROR | |
EMBER_ENTROPY_SOURCE_RADIO | |
EMBER_ENTROPY_SOURCE_MBEDTLS_TRNG | |
EMBER_ENTROPY_SOURCE_MBEDTLS |
3154
of file stack/include/ember-types.h
@1#
@1
Defines the maximum number of counters that are specified as reporting either on 2.4 GHz or Sub-GHz.
Enumerator | |
---|---|
EMBER_POLL_TIMEOUT_10_SECONDS | |
EMBER_POLL_TIMEOUT_2_MINUTES | |
EMBER_POLL_TIMEOUT_4_MINUTES | |
EMBER_POLL_TIMEOUT_8_MINUTES | |
EMBER_POLL_TIMEOUT_16_MINUTES | |
EMBER_POLL_TIMEOUT_32_MINUTES | |
EMBER_POLL_TIMEOUT_64_MINUTES | |
EMBER_POLL_TIMEOUT_128_MINUTES | |
EMBER_POLL_TIMEOUT_256_MINUTES | |
EMBER_POLL_TIMEOUT_512_MINUTES | |
EMBER_POLL_TIMEOUT_1024_MINUTES | |
EMBER_POLL_TIMEOUT_2048_MINUTES | |
EMBER_POLL_TIMEOUT_4096_MINUTES | |
EMBER_POLL_TIMEOUT_8192_MINUTES | |
EMBER_POLL_TIMEOUT_16384_MINUTES |
3166
of file stack/include/ember-types.h
EmberTcApsEncryptMode#
EmberTcApsEncryptMode
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 | |
TC_APS_ENCRYPT_ENABLE | |
TC_APS_ENCRYPT_DISABLE |
3190
of file stack/include/ember-types.h
EmberRadioPowerMode#
typedef uint8_t EmberRadioPowerMode
Radio power mode.
3130
of file stack/include/ember-types.h
WEAK_TEST#
#define WEAK_TEST
Defines the maximum number of counters that are specified as reporting either on 2.4 GHz or Sub-GHz.
3090
of file stack/include/ember-types.h
EMBER_MAX_MAC_ONLY_COUNTERS#
#define EMBER_MAX_MAC_ONLY_COUNTERSValue:
33u
Defines the maximum number of counters that are specified as reporting either on 2.4 GHz or Sub-GHz.
3109
of file stack/include/ember-types.h
EMBER_MAX_NUM_PHYS#
#define EMBER_MAX_NUM_PHYSValue:
2u
Defines the maximum number of PHYs supported.
3115
of file stack/include/ember-types.h
PHY_INDEX_NATIVE#
#define PHY_INDEX_NATIVEValue:
0u
PHY index for 2.4 GHz radio interface, valid for simultaneous multi radio network.
3120
of file stack/include/ember-types.h
PHY_INDEX_PRO2PLUS#
#define PHY_INDEX_PRO2PLUSValue:
1u
PHY index for Sub-GHz radio interface, valid for simultaneous multi radio network.
3125
of file stack/include/ember-types.h
Enumeration Documentation#
EmberNodeType#
EmberNodeType
Defines the possible types of nodes and the roles that a node might play in a network.
Enumerator | |
---|---|
EMBER_UNKNOWN_DEVICE | |
EMBER_COORDINATOR | |
EMBER_ROUTER | |
EMBER_END_DEVICE | |
EMBER_SLEEPY_END_DEVICE | |
EMBER_WIREFREE_INITIATOR_DEVICE | |
EMBER_WIREFREE_TARGET_DEVICE |
545
of file stack/include/ember-types.h
EmberEndDeviceConfiguration#
EmberEndDeviceConfiguration
The configuration advertised by the end device to the parent when joining/rejoining.
Enumerator | |
---|---|
EMBER_END_DEVICE_CONFIG_NONE | |
EMBER_END_DEVICE_CONFIG_PERSIST_DATA_ON_PARENT |
573
of file stack/include/ember-types.h
EmberNetworkInitBitmask#
EmberNetworkInitBitmask
Defines the options that should be used when initializing the node's network configuration.
Enumerator | |
---|---|
EMBER_NETWORK_INIT_NO_OPTIONS | |
EMBER_NETWORK_INIT_PARENT_INFO_IN_TOKEN | |
EMBER_NETWORK_INIT_END_DEVICE_REJOIN_ON_REBOOT |
600
of file stack/include/ember-types.h
EmberApsRejoinMode#
EmberApsRejoinMode
Options to allow/disallow rejoins using the default link key.
Enumerator | |
---|---|
NO_REJOIN | |
REJOIN_ANY_LINK_KEY | |
REJOIN_NON_DEFAULT_LINK_KEY |
669
of file stack/include/ember-types.h
EmberApsOption#
EmberApsOption
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 | |
---|---|
EMBER_APS_OPTION_NONE | |
EMBER_APS_OPTION_DSA_SIGN | |
EMBER_APS_OPTION_ENCRYPTION | |
EMBER_APS_OPTION_RETRY | |
EMBER_APS_OPTION_ENABLE_ROUTE_DISCOVERY | |
EMBER_APS_OPTION_FORCE_ROUTE_DISCOVERY | |
EMBER_APS_OPTION_SOURCE_EUI64 | |
EMBER_APS_OPTION_DESTINATION_EUI64 | |
EMBER_APS_OPTION_ENABLE_ADDRESS_DISCOVERY | |
EMBER_APS_OPTION_POLL_RESPONSE | |
EMBER_APS_OPTION_ZDO_RESPONSE_REQUIRED | |
EMBER_APS_OPTION_FRAGMENT |
687
of file stack/include/ember-types.h
EmberIncomingMessageType#
EmberIncomingMessageType
Defines the possible incoming message types.
Enumerator | |
---|---|
EMBER_INCOMING_UNICAST | |
EMBER_INCOMING_UNICAST_REPLY | |
EMBER_INCOMING_MULTICAST | |
EMBER_INCOMING_MULTICAST_LOOPBACK | |
EMBER_INCOMING_BROADCAST | |
EMBER_INCOMING_BROADCAST_LOOPBACK |
758
of file stack/include/ember-types.h
EmberOutgoingMessageType#
EmberOutgoingMessageType
Defines the possible outgoing message types.
Enumerator | |
---|---|
EMBER_OUTGOING_DIRECT | |
EMBER_OUTGOING_VIA_ADDRESS_TABLE | |
EMBER_OUTGOING_VIA_BINDING | |
EMBER_OUTGOING_MULTICAST | |
EMBER_OUTGOING_MULTICAST_WITH_ALIAS | |
EMBER_OUTGOING_BROADCAST_WITH_ALIAS | |
EMBER_OUTGOING_BROADCAST |
782
of file stack/include/ember-types.h
EmberZigbeeCommandType#
EmberZigbeeCommandType
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 | |
---|---|
EMBER_ZIGBEE_COMMAND_TYPE_RAW_MAC | |
EMBER_ZIGBEE_COMMAND_TYPE_MAC_COMMAND | |
EMBER_ZIGBEE_COMMAND_TYPE_NWK | |
EMBER_ZIGBEE_COMMAND_TYPE_APS | |
EMBER_ZIGBEE_COMMAND_TYPE_ZDO | |
EMBER_ZIGBEE_COMMAND_TYPE_ZCL | |
EMBER_ZIGBEE_COMMAND_TYPE_BEACON |
816
of file stack/include/ember-types.h
EmberPacketAction#
EmberPacketAction
indication of the action taken on a packet
Enumerator | |
---|---|
EMBER_DROP_PACKET | |
EMBER_ACCEPT_PACKET | |
EMBER_MANGLE_PACKET | |
EMBER_ACCEPT_PACKET_OVERRIDE_SECURITY | |
EMBER_ACCEPT_PACKET_SKIP_NWK_CRYPTO |
840
of file stack/include/ember-types.h
EmberZigbeePacketType#
EmberZigbeePacketType
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 | |
---|---|
EMBER_ZIGBEE_PACKET_TYPE_RAW_MAC | |
EMBER_ZIGBEE_PACKET_TYPE_MAC_COMMAND | |
EMBER_ZIGBEE_PACKET_TYPE_NWK_DATA | |
EMBER_ZIGBEE_PACKET_TYPE_NWK_COMMAND | |
EMBER_ZIGBEE_PACKET_TYPE_APS_DATA | |
EMBER_ZIGBEE_PACKET_TYPE_APS_COMMAND | |
EMBER_ZIGBEE_PACKET_TYPE_ZDO | |
EMBER_ZIGBEE_PACKET_TYPE_ZCL | |
EMBER_ZIGBEE_PACKET_TYPE_BEACON | |
EMBER_ZIGBEE_PACKET_TYPE_INTERPAN | |
EMBER_ZIGBEE_PACKET_TYPE_NWK_DATA_PRE_DECRYPTION | |
EMBER_ZIGBEE_PACKET_TYPE_NWK_COMMAND_PRE_DECRYPTION |
869
of file stack/include/ember-types.h
EmberNetworkStatus#
EmberNetworkStatus
Defines the possible join states for a node.
Enumerator | |
---|---|
EMBER_NO_NETWORK | |
EMBER_JOINING_NETWORK | |
EMBER_JOINED_NETWORK | |
EMBER_JOINED_NETWORK_NO_PARENT | |
EMBER_JOINED_NETWORK_WF_INITIATOR | |
EMBER_JOINED_NETWORK_WF_TARGET | |
EMBER_LEAVING_NETWORK |
905
of file stack/include/ember-types.h
EmberNetworkScanType#
EmberNetworkScanType
Type for a network scan.
Enumerator | |
---|---|
EMBER_ENERGY_SCAN | |
EMBER_ACTIVE_SCAN | |
EMBER_START_RADIO_OFF_SCAN | |
EMBER_STACK_GP_CHANNEL_DELIVERY_SCAN | |
EMBER_ACTIVE_SCAN_ROUTER | |
EMBER_LAST_SCAN_TYPE |
942
of file stack/include/ember-types.h
EmberBindingType#
EmberBindingType
Defines binding types.
Enumerator | |
---|---|
EMBER_UNUSED_BINDING | |
EMBER_UNICAST_BINDING | |
EMBER_MANY_TO_ONE_BINDING | |
EMBER_MULTICAST_BINDING |
970
of file stack/include/ember-types.h
EmberKeepAliveMode#
EmberKeepAliveMode
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.
EMBER_KEEP_ALIVE_SUPPORT_UNKNOWN which is initialized at end-device boot time, means parent's keep alive mechanism is unknown to end-device.
EMBER_MAC_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.
EMBER_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.
EMBER_KEEP_ALIVE_SUPPORT_ALL basically maps to EMBER_MAC_DATA_POLL_KEEP_ALIVE as the preferred approach between the two.
Enumerator | |
---|---|
EMBER_KEEP_ALIVE_SUPPORT_UNKNOWN | |
EMBER_MAC_DATA_POLL_KEEP_ALIVE | |
EMBER_END_DEVICE_TIMEOUT_KEEP_ALIVE | |
EMBER_KEEP_ALIVE_SUPPORT_ALL |
3225
of file stack/include/ember-types.h
EmberSourceRouteDiscoveryMode#
EmberSourceRouteDiscoveryMode
Types of source route discovery modes used by the concentrator.
EMBER_SOURCE_ROUTE_DISCOVERY_OFF no source route discovery is scheduled EMBER_SOURCE_ROUTE_DISCOVERY_ON source routes discovery is scheduled, and it is triggered periodically EMBER_SOURCE_ROUTE_DISCOVERY_RESCHEDULE source routes discoveries are re-scheduled to be sent once immediately and then triggered periodically
Enumerator | |
---|---|
EMBER_SOURCE_ROUTE_DISCOVERY_OFF | |
EMBER_SOURCE_ROUTE_DISCOVERY_ON | |
EMBER_SOURCE_ROUTE_DISCOVERY_RESCHEDULE |
3246
of file stack/include/ember-types.h
EmberTransmitPriority#
EmberTransmitPriority
Packet transmit priorities in terms of getting into the MAC queue.
EMBER_MAC_TRANSMIT_PRIORITY_HIGH High priority headers go on the front of the queue. EMBER_MAC_TRANSMIT_PRIORITY_NORMAL Normal priority headers go on the back of the queue. EMBER_MAC_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 | |
---|---|
EMBER_MAC_TRANSMIT_PRIORITY_HIGH | |
EMBER_MAC_TRANSMIT_PRIORITY_NORMAL | |
EMBER_MAC_TRANSMIT_PRIORITY_SCAN_OKAY |
3276
of file stack/include/ember-types.h
sl_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_DONT_SEND | |
ROUTE_RECORD_POLICY_NO_ACK_REQUIRED |
3295
of file stack/include/ember-types.h
Macro Definition Documentation#
EMBER_MIN_BROADCAST_ADDRESS#
#define EMBER_MIN_BROADCAST_ADDRESSValue:
0xFFF8u
532
of file stack/include/ember-types.h
emberIsZigbeeBroadcastAddress#
#define emberIsZigbeeBroadcastAddressValue:
(address)
Returns true if nodeId (short address) is a broadcast address.
537
of file stack/include/ember-types.h