Modules#

EmberReleaseTypeStruct

EmberVersion

EmberZigbeeNetwork

EmberNetworkInitStruct

EmberBeaconSurvey

EmberBeaconData

EmberBeaconIterator

EmberNetworkParameters

EmberMultiPhyRadioParameters

EmberApsFrame

EmberChildData

EmberBindingTableEntry

EmberNeighborTableEntry

EmberRouteTableEntry

EmberMulticastTableEntry

EmberMultiprotocolPriorities

EmberCounterInfo

EmberExtraCounterInfo

EmberEventControl

EmberEventData

EmberTaskControl

EmberKeyData

EmberCertificateData

EmberPublicKeyData

EmberPrivateKeyData

EmberSmacData

EmberSignatureData

EmberMessageDigest

EmberAesMmoHashContext

EmberCertificate283k1Data

EmberPublicKey283k1Data

EmberPrivateKey283k1Data

EmberSignature283k1Data

EmberInitialSecurityState

EmberCurrentSecurityState

EmberTransientKeyData

EmberKeyStruct

EmberMfgSecurityStruct

EmberDutyCycleLimits

EmberPerDeviceDutyCycle

sl_nwk_packet_exchange_t

EmberMacFilterMatchStruct

SourceRouteTableEntry

EmberBeaconClassificationParams

EmberTagMapEntry

Ember Common Data Types#

See ember-types.h for source code.

Miscellaneous Ember Types#

enum
EMBER_VERSION_TYPE_PRE_RELEASE = 0x00
EMBER_VERSION_TYPE_ALPHA_1 = 0x11
EMBER_VERSION_TYPE_ALPHA_2 = 0x12
EMBER_VERSION_TYPE_ALPHA_3 = 0x13
EMBER_VERSION_TYPE_BETA_1 = 0x21
EMBER_VERSION_TYPE_BETA_2 = 0x22
EMBER_VERSION_TYPE_BETA_3 = 0x23
EMBER_VERSION_TYPE_GA = 0xAA
}

Type of Ember software version.

enum
EMBER_STACK_PROFILE_NONE = 0x00
EMBER_STACK_PROFILE_ZIGBEE_PRO = 0x02
}

EmberReleaseTypeStruct Data that relates release type to the correct string.

enum
EMBER_SECURITY_LEVEL_NONE = 0x00
EMBER_SECURITY_LEVEL_Z3 = 0x05
}

EmberReleaseTypeStruct Data that relates release type to the correct string.

enum
EMBER_ZIGBEE_LEAVE_AND_REJOIN = 0x80
EMBER_ZIGBEE_LEAVE_WITHOUT_REJOIN = 0x00
}

EmberReleaseTypeStruct Data that relates release type to the correct string.

enum
EMBER_LEAVE_REASON_NONE = 0
EMBER_LEAVE_DUE_TO_NWK_LEAVE_MESSAGE = 1
EMBER_LEAVE_DUE_TO_APS_REMOVE_MESSAGE = 2
EMBER_LEAVE_DUE_TO_ZDO_LEAVE_MESSAGE = 3
EMBER_LEAVE_DUE_TO_ZLL_TOUCHLINK = 4
EMBER_LEAVE_DUE_TO_APP_EVENT_1 = 0xFF
}

EmberReleaseTypeStruct Data that relates release type to the correct string.

typedef uint16_t

16-bit ZigBee network address.

typedef uint16_t

802.15.4 PAN ID.

A structure containing the version information.

#define
EMBER_RELEASE_TYPE_TO_STRING_STRUCT_DATA undefined

EmberReleaseTypeStruct Data that relates release type to the correct string.

#define
EUI64_SIZE 8

Size of EUI64 (an IEEE address) in bytes (8).

#define
EXTENDED_PAN_ID_SIZE 8

Size of an extended PAN identifier in bytes (8).

#define
EMBER_ENCRYPTION_KEY_SIZE 16

Size of an encryption key in bytes (16).

#define
EMBER_CERTIFICATE_SIZE 48

Size of Implicit Certificates used for Certificate-based Key Exchange(CBKE).

#define
EMBER_PUBLIC_KEY_SIZE 22

Size of Public Keys used in Elliptical Cryptography ECMQV algorithms.

#define
EMBER_PRIVATE_KEY_SIZE 21

Size of Private Keys used in Elliptical Cryptography ECMQV algorithms.

#define
EMBER_SMAC_SIZE 16

Size of the SMAC used in Elliptical Cryptography ECMQV algorithms.

#define
EMBER_SIGNATURE_SIZE 42

Size of the DSA signature used in Elliptical Cryptography Digital Signature Algorithms.

#define
EMBER_AES_HASH_BLOCK_SIZE 16

The size of AES-128 MMO hash is 16-bytes. This is defined in the core. ZigBee specification.

#define
EMBER_CERTIFICATE_283K1_SIZE 74

Size of Implicit Certificates used for Certificate Based Key Exchange using the ECC283K1 curve in bytes.

#define
EMBER_PUBLIC_KEY_283K1_SIZE 37

Size of Public Keys used in SECT283k1 Elliptical Cryptography ECMQV algorithms.

#define
EMBER_PRIVATE_KEY_283K1_SIZE 36

Size of Private Keys used SECT283k1 in Elliptical Cryptography ECMQV algorithms.

#define
EMBER_SIGNATURE_283K1_SIZE 72

Size of the DSA signature used in SECT283k1 Elliptical Cryptography Digital Signature Algorithms.

#define
__EMBERSTATUS_TYPE__

Return type for Ember functions.

#define
NULL_BUFFER 0x0000

EUI 64-bit ID (an IEEE address).

#define
EMBER_MAX_802_15_4_CHANNEL_NUMBER 26

The maximum 802.15.4 channel number is 26.

#define
EMBER_MIN_802_15_4_CHANNEL_NUMBER 11

The minimum 2.4GHz 802.15.4 channel number is 11.

#define
EMBER_MIN_SUBGHZ_CHANNEL_NUMBER 0

The minimum SubGhz channel number is 0.

#define
EMBER_ACTIVE_SCAN_DURATION 3
#define
EMBER_SUB_GHZ_SCAN_DURATION 5

The SubGhz scan duration is 5.

#define
EMBER_NUM_802_15_4_CHANNELS (EMBER_MAX_802_15_4_CHANNEL_NUMBER - EMBER_MIN_802_15_4_CHANNEL_NUMBER + 1)

There are sixteen 802.15.4 channels.

#define
EMBER_ALL_802_15_4_CHANNELS_MASK 0x07FFF800UL

A bitmask to scan all 2.4 GHz 802.15.4 channels.

#define
EMBER_MAX_CHANNELS_PER_PAGE 27

The maximum channels per page are 27 page bits 31...27, channel bits 26...0.

#define
EMBER_ALL_SUBGHZ_CHANNELS_MASK_FOR_PAGES_28_30_31 0x07FFFFFFUL

Sub-GHz channel bitmasks for pages 28, 30, 31.

#define
EMBER_MAX_SUBGHZ_CHANNEL_NUMBER_ON_PAGES_28_30_31 26

The maximum SubGhz channel number on pages 28, 30, 31 is 26.

#define
EMBER_ALL_SUBGHZ_CHANNELS_MASK_FOR_PAGES_29 0x1FF

SubGhz channel bitmasks for page 29.

#define
EMBER_MAX_SUBGHZ_CHANNEL_NUMBER_ON_PAGE_29 8

The maximum SubGhz channel number on page 29 is 8.

#define
EMBER_MIN_SUGBHZ_PAGE_NUMBER 28

The minimum SubGhz page number is 28.

#define
EMBER_MAX_SUGBHZ_PAGE_NUMBER 31

The maximum SubGhz page number is 31.

#define
EMBER_ALL_CHANNEL_PAGE_MASK 0xF8000000UL

A bitmask for the channel page within a channel mask.

#define
EMBER_PAGE_CHANNEL_MASK_FROM_CHANNEL_MASK (page, mask)

A page-channel mask for a given page and channel mask.

#define
EMBER_PAGE_CHANNEL_MASK_FROM_CHANNEL_NUMBER (page, channel)

A page-channel mask for a given page and channel.

#define
EMBER_ZIGBEE_COORDINATOR_ADDRESS 0x0000

The network ID of the coordinator in a ZigBee network is 0x0000.

#define
EMBER_NULL_NODE_ID 0xFFFF

A distinguished network ID that will never be assigned to any node. It is used to indicate the absence of a node ID.

#define
EMBER_NO_CHANNEL_PAGE_IN_USE 0

The channel page value used to indicate just the 2.4GHz channels.

#define
EMBER_NULL_EUI64 { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF }

A distinguished EUI64 that is commonly used to indicate an invalid EUI64.

#define
EMBER_NULL_BINDING 0xFF

A distinguished binding index used to indicate the absence of a binding.

#define
EMBER_TABLE_ENTRY_UNUSED_NODE_ID 0xFFFF

A distinguished network ID that will never be assigned to any node.

#define
EMBER_MULTICAST_NODE_ID 0xFFFE

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.

#define
EMBER_UNKNOWN_NODE_ID 0xFFFD

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.

#define
EMBER_DISCOVERY_ACTIVE_NODE_ID 0xFFFC

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.

#define
EMBER_NULL_ADDRESS_TABLE_INDEX 0xFF

A distinguished address table index used to indicate the absence of an address table entry.

#define
EMBER_ZDO_ENDPOINT 0

The endpoint where the ZigBee Device Object (ZDO) resides.

#define
EMBER_BROADCAST_ENDPOINT 0xFF

The broadcast endpoint, as defined in the ZigBee spec.

#define
EMBER_ZDO_PROFILE_ID 0x0000

The profile ID used by the ZigBee Device Object (ZDO).

#define
EMBER_WILDCARD_PROFILE_ID 0xFFFF

The profile ID used to address all the public profiles.

#define
EMBER_MAXIMUM_STANDARD_PROFILE_ID 0x7FFF

The maximum value for a profile ID in the standard profile range.

#define
EMBER_BROADCAST_TABLE_TIMEOUT_QS (20 * 4)

The broadcast table entry timeout, which specifies, in quarter seconds, how long an entry persists in the local device's broadcast table.

#define
EMBER_MANUFACTURER_ID 0x1002

Ember's Manufacturer ID.

#define
EMBER_NULL_NETWORK_INDEX 0xFF

An invalid network index.

#define
EMBER_DC_LIMIT_USE_DEFAULT 0

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.

#define
EMBER_BROADCAST_ADDRESS 0xFFFC
#define
EMBER_RX_ON_WHEN_IDLE_BROADCAST_ADDRESS 0xFFFD
#define
EMBER_SLEEPY_BROADCAST_ADDRESS 0xFFFF

Ember Concentrator Types#

enum
EMBER_ASSUME_TRUST_CENTER_IS_NOT_A_CONCENTRATOR = 0
EMBER_ASSUME_TRUST_CENTER_IS_LOW_RAM_CONCENTRATOR = 1
EMBER_ASSUME_TRUST_CENTER_IS_HIGH_RAM_CONCENTRATOR = 2
}

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.

enum
EMBER_USE_PRECONFIGURED_KEY = 0
EMBER_SEND_KEY_IN_THE_CLEAR
EMBER_DENY_JOIN
EMBER_NO_ACTION
}

The decision made by the Trust Center when a node attempts to join.

enum
EMBER_STANDARD_SECURITY_SECURED_REJOIN = 0
EMBER_STANDARD_SECURITY_UNSECURED_JOIN = 1
EMBER_DEVICE_LEFT = 2
EMBER_STANDARD_SECURITY_UNSECURED_REJOIN = 3
}

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.

enum
EMBER_REJOIN_REASON_NONE = 0
EMBER_REJOIN_DUE_TO_NWK_KEY_UPDATE = 1
EMBER_REJOIN_DUE_TO_LEAVE_MESSAGE = 2
EMBER_REJOIN_DUE_TO_NO_PARENT = 3
EMBER_REJOIN_DUE_TO_ZLL_TOUCHLINK = 4
EMBER_REJOIN_DUE_TO_END_DEVICE_REBOOT = 5
EMBER_REJOIN_DUE_TO_APP_EVENT_5 = 0xFB
EMBER_REJOIN_DUE_TO_APP_EVENT_4 = 0xFC
EMBER_REJOIN_DUE_TO_APP_EVENT_3 = 0xFD
EMBER_REJOIN_DUE_TO_APP_EVENT_2 = 0xFE
EMBER_REJOIN_DUE_TO_APP_EVENT_1 = 0xFF
}

Notes the last rejoin reason.

enum
EMBER_INPUT_CLUSTER_LIST = 0
EMBER_OUTPUT_CLUSTER_LIST = 1
}

Defines the lists of clusters that must be provided for each endpoint.

enum
EMBER_EVENT_INACTIVE = 0
EMBER_EVENT_MS_TIME
EMBER_EVENT_QS_TIME
EMBER_EVENT_MINUTE_TIME
EMBER_EVENT_ZERO_DELAY
}

Either marks an event as inactive or specifies the units for the event execution time.

enum
EMBER_USE_MAC_ASSOCIATION = 0
EMBER_USE_NWK_REJOIN = 1
EMBER_USE_NWK_REJOIN_HAVE_NWK_KEY = 2
EMBER_USE_CONFIGURED_NWK_STATE = 3
}

The type of method used for joining.

enum
EMBER_COUNTER_MAC_RX_BROADCAST = 0
EMBER_COUNTER_MAC_TX_BROADCAST = 1
EMBER_COUNTER_MAC_RX_UNICAST = 2
EMBER_COUNTER_MAC_TX_UNICAST_SUCCESS = 3
EMBER_COUNTER_MAC_TX_UNICAST_RETRY = 4
EMBER_COUNTER_MAC_TX_UNICAST_FAILED = 5
EMBER_COUNTER_APS_DATA_RX_BROADCAST = 6
EMBER_COUNTER_APS_DATA_TX_BROADCAST = 7
EMBER_COUNTER_APS_DATA_RX_UNICAST = 8
EMBER_COUNTER_APS_DATA_TX_UNICAST_SUCCESS = 9
EMBER_COUNTER_APS_DATA_TX_UNICAST_RETRY = 10
EMBER_COUNTER_APS_DATA_TX_UNICAST_FAILED = 11
EMBER_COUNTER_ROUTE_DISCOVERY_INITIATED = 12
EMBER_COUNTER_NEIGHBOR_ADDED = 13
EMBER_COUNTER_NEIGHBOR_REMOVED = 14
EMBER_COUNTER_NEIGHBOR_STALE = 15
EMBER_COUNTER_JOIN_INDICATION = 16
EMBER_COUNTER_CHILD_REMOVED = 17
EMBER_COUNTER_ASH_OVERFLOW_ERROR = 18
EMBER_COUNTER_ASH_FRAMING_ERROR = 19
EMBER_COUNTER_ASH_OVERRUN_ERROR = 20
EMBER_COUNTER_NWK_FRAME_COUNTER_FAILURE = 21
EMBER_COUNTER_APS_FRAME_COUNTER_FAILURE = 22
EMBER_COUNTER_ASH_XOFF = 23
EMBER_COUNTER_APS_LINK_KEY_NOT_AUTHORIZED = 24
EMBER_COUNTER_NWK_DECRYPTION_FAILURE = 25
EMBER_COUNTER_APS_DECRYPTION_FAILURE = 26
EMBER_COUNTER_ALLOCATE_PACKET_BUFFER_FAILURE = 27
EMBER_COUNTER_RELAYED_UNICAST = 28
EMBER_COUNTER_PHY_TO_MAC_QUEUE_LIMIT_REACHED = 29
EMBER_COUNTER_PACKET_VALIDATE_LIBRARY_DROPPED_COUNT = 30
EMBER_COUNTER_TYPE_NWK_RETRY_OVERFLOW = 31
EMBER_COUNTER_PHY_CCA_FAIL_COUNT = 32
EMBER_COUNTER_BROADCAST_TABLE_FULL = 33
EMBER_COUNTER_PTA_LO_PRI_REQUESTED = 34
EMBER_COUNTER_PTA_HI_PRI_REQUESTED = 35
EMBER_COUNTER_PTA_LO_PRI_DENIED = 36
EMBER_COUNTER_PTA_HI_PRI_DENIED = 37
EMBER_COUNTER_PTA_LO_PRI_TX_ABORTED = 38
EMBER_COUNTER_PTA_HI_PRI_TX_ABORTED = 39
EMBER_COUNTER_ADDRESS_CONFLICT_SENT = 40
EMBER_COUNTER_TYPE_COUNT = 41
}

Defines the events reported to the application by the emberCounterHandler().

typedef uint8_t
#define
EMBER_LOW_RAM_CONCENTRATOR 0xFFF8
#define
EMBER_HIGH_RAM_CONCENTRATOR 0xFFF9
#define
EMBER_JOIN_DECISION_STRINGS undefined
#define
EMBER_DEVICE_UPDATE_STRINGS undefined
#define
emberInitializeNetworkParameters (parameters)
#define
EMBER_COUNTER_STRINGS

txPowerModes for emberSetTxPowerMode and mfglibSetPower#

#define
EMBER_TX_POWER_MODE_DEFAULT 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.

#define
EMBER_TX_POWER_MODE_BOOST 0x0001

The application should call emberSetTxPowerMode() with the txPowerMode parameter set to this value to enable boost power mode.

#define
EMBER_TX_POWER_MODE_ALTERNATE 0x0002

The application should call emberSetTxPowerMode() with the txPowerMode parameter set to this value to enable the alternate transmitter output.

#define
EMBER_TX_POWER_MODE_BOOST_AND_ALTERNATE undefined

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#

enum
EMBER_DISTRIBUTED_TRUST_CENTER_MODE = 0x0002
EMBER_TRUST_CENTER_GLOBAL_LINK_KEY = 0x0004
EMBER_PRECONFIGURED_NETWORK_KEY_MODE = 0x0008
EMBER_HAVE_TRUST_CENTER_EUI64 = 0x0040
EMBER_TRUST_CENTER_USES_HASHED_LINK_KEY = 0x0084
EMBER_HAVE_PRECONFIGURED_KEY = 0x0100
EMBER_HAVE_NETWORK_KEY = 0x0200
EMBER_GET_LINK_KEY_WHEN_JOINING = 0x0400
EMBER_REQUIRE_ENCRYPTED_KEY = 0x0800
EMBER_NO_FRAME_COUNTER_RESET = 0x1000
EMBER_GET_PRECONFIGURED_KEY_FROM_INSTALL_CODE = 0x2000
}

This is the Initial Security Bitmask that controls the use of various security features.

enum
EMBER_SECURE_NETWORK_KEY_ROTATION = 0x0002
EMBER_JOINER_GLOBAL_LINK_KEY = 0x0010
EMBER_EXT_NO_FRAME_COUNTER_RESET = 0x0020
EMBER_NWK_LEAVE_WITHOUT_REJOIN_NOT_ALLOWED = 0x0040
EMBER_NWK_LEAVE_REQUEST_NOT_ALLOWED = 0x0100
}

This is the Extended Security Bitmask that controls the use of various extended security features.

enum
EMBER_STANDARD_SECURITY_MODE_ = 0x0000
EMBER_DISTRIBUTED_TRUST_CENTER_MODE_ = 0x0002
EMBER_TRUST_CENTER_GLOBAL_LINK_KEY_ = 0x0004
EMBER_HAVE_TRUST_CENTER_LINK_KEY = 0x0010
EMBER_TRUST_CENTER_USES_HASHED_LINK_KEY_ = 0x0084
}

This is the Current Security Bitmask that details the use of various security features.

enum
EMBER_KEY_HAS_SEQUENCE_NUMBER = 0x0001
EMBER_KEY_HAS_OUTGOING_FRAME_COUNTER = 0x0002
EMBER_KEY_HAS_INCOMING_FRAME_COUNTER = 0x0004
EMBER_KEY_HAS_PARTNER_EUI64 = 0x0008
EMBER_KEY_IS_AUTHORIZED = 0x0010
EMBER_KEY_PARTNER_IS_SLEEPY = 0x0020
EMBER_UNCONFIRMED_TRANSIENT_KEY = 0x0040
}

This bitmask describes the presence of fields within the EmberKeyStruct.

enum
EMBER_TRUST_CENTER_LINK_KEY = 1
EMBER_CURRENT_NETWORK_KEY = 3
EMBER_NEXT_NETWORK_KEY = 4
EMBER_APPLICATION_LINK_KEY = 5
}

This denotes the type of security key.

enum
EMBER_KEY_STATUS_NONE = 0x00
EMBER_APP_LINK_KEY_ESTABLISHED = 0x01
EMBER_TRUST_CENTER_LINK_KEY_ESTABLISHED = 0x03
EMBER_KEY_ESTABLISHMENT_TIMEOUT = 0x04
EMBER_KEY_TABLE_FULL = 0x05
EMBER_TC_RESPONDED_TO_KEY_REQUEST = 0x06
EMBER_TC_APP_KEY_SENT_TO_REQUESTER = 0x07
EMBER_TC_RESPONSE_TO_KEY_REQUEST_FAILED = 0x08
EMBER_TC_REQUEST_KEY_TYPE_NOT_SUPPORTED = 0x09
EMBER_TC_NO_LINK_KEY_FOR_REQUESTER = 0x0A
EMBER_TC_REQUESTER_EUI64_UNKNOWN = 0x0B
EMBER_TC_RECEIVED_FIRST_APP_KEY_REQUEST = 0x0C
EMBER_TC_TIMEOUT_WAITING_FOR_SECOND_APP_KEY_REQUEST = 0x0D
EMBER_TC_NON_MATCHING_APP_KEY_REQUEST_RECEIVED = 0x0E
EMBER_TC_FAILED_TO_SEND_APP_KEYS = 0x0F
EMBER_TC_FAILED_TO_STORE_APP_KEY_REQUEST = 0x10
EMBER_TC_REJECTED_APP_KEY_REQUEST = 0x11
EMBER_TC_FAILED_TO_GENERATE_NEW_KEY = 0x12
EMBER_TC_FAILED_TO_SEND_TC_KEY = 0x13
EMBER_TRUST_CENTER_IS_PRE_R21 = 0x1E
EMBER_TC_REQUESTER_VERIFY_KEY_TIMEOUT = 0x32
EMBER_TC_REQUESTER_VERIFY_KEY_FAILURE = 0x33
EMBER_TC_REQUESTER_VERIFY_KEY_SUCCESS = 0x34
EMBER_VERIFY_LINK_KEY_FAILURE = 0x64
EMBER_VERIFY_LINK_KEY_SUCCESS = 0x65
}

This denotes the status of an attempt to establish a key with another device.

enum
EMBER_DENY_TC_LINK_KEY_REQUESTS = 0x00
EMBER_ALLOW_TC_LINK_KEY_REQUEST_AND_SEND_CURRENT_KEY = 0x01
EMBER_ALLOW_TC_LINK_KEY_REQUEST_AND_GENERATE_NEW_KEY = 0x02
}

This enumeration determines whether or not a Trust Center answers trust center link key requests.

enum
EMBER_DENY_APP_LINK_KEY_REQUESTS = 0x00
EMBER_ALLOW_APP_LINK_KEY_REQUEST = 0x01
}

This enumeration determines whether or not a Trust Center answers app link key requests.

enum
EMBER_KEY_PERMISSIONS_NONE = 0x0000
EMBER_KEY_PERMISSIONS_READING_ALLOWED = 0x0001
EMBER_KEY_PERMISSIONS_HASHING_ALLOWED = 0x0002
}

This is a ZigBee application profile ID that has been assigned to Ember Corporation.

enum
EMBER_MAC_PASSTHROUGH_NONE = 0x00
EMBER_MAC_PASSTHROUGH_SE_INTERPAN = 0x01
EMBER_MAC_PASSTHROUGH_EMBERNET = 0x02
EMBER_MAC_PASSTHROUGH_EMBERNET_SOURCE = 0x04
EMBER_MAC_PASSTHROUGH_APPLICATION = 0x08
EMBER_MAC_PASSTHROUGH_CUSTOM = 0x10
}

The types of MAC passthrough messages that an application may receive. This is a bitmask.

typedef uint8_t

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

uint8_t *
emberKeyContents(EmberKeyData *key)

This function allows access to the actual key data bytes of the EmberKeyData structure.

uint8_t *
emberCertificateContents(EmberCertificateData *cert)

This function allows access to the actual certificate data bytes of the EmberCertificateData structure.

uint8_t *
emberPublicKeyContents(EmberPublicKeyData *key)

This function allows access to the actual public key data bytes of the EmberPublicKeyData structure.

uint8_t *
emberPrivateKeyContents(EmberPrivateKeyData *key)

This function allows access to the actual private key data bytes of the EmberPrivateKeyData structure.

uint8_t *
emberSmacContents(EmberSmacData *key)

This function allows access to the actual SMAC (Secured Message Authentication Code) data of the EmberSmacData structure.

uint8_t *
emberSignatureContents(EmberSignatureData *sig)

This function allows access to the actual ECDSA signature data of the EmberSignatureData structure.

uint8_t *
emberCertificate283k1Contents(EmberCertificate283k1Data *cert)

This function allows access to the actual certificate data bytes of the Ember283k1CertificateData structure.

uint8_t *
emberPublicKey283k1Contents(EmberPublicKey283k1Data *key)

This function allows access to the actual public key data bytes of the Ember283k1PublicKeyData structure.

uint8_t *
emberPrivateKey283k1Contents(EmberPrivateKey283k1Data *key)

This function allows access to the actual private key data bytes of the Ember283k1PrivateKeyData structure.

uint8_t *
ember283k1SignatureContents(Ember283k1SignatureData *sig)

This function allows access to the actual ECDSA signature data of the Ember283k1SignatureData structure.

#define
EMBER_PRIVATE_PROFILE_ID 0xC00E

This is a ZigBee application profile ID that has been assigned to Ember Corporation.

#define
EMBER_PRIVATE_PROFILE_ID_START 0xC00D

Ember's first private profile ID.

#define
EMBER_PRIVATE_PROFILE_ID_END 0xC016

Ember's last private profile ID.

#define
EMBER_REPORT_COUNTERS_REQUEST 0x0003
#define
EMBER_REPORT_COUNTERS_RESPONSE 0x8003
#define
EMBER_REPORT_AND_CLEAR_COUNTERS_REQUEST 0x0004
#define
EMBER_REPORT_AND_CLEAR_COUNTERS_RESPONSE 0x8004
#define
EMBER_OTA_CERTIFICATE_UPGRADE_CLUSTER 0x0005
#define
EMBER_STANDARD_SECURITY_MODE 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.

#define
EMBER_TRUST_CENTER_NODE_ID 0x0000

The short address of the trust center. This address never changes dynamically.

#define
EMBER_NO_TRUST_CENTER_MODE EMBER_DISTRIBUTED_TRUST_CENTER_MODE

This is the legacy name for the Distributed Trust Center Mode.

#define
EMBER_GLOBAL_LINK_KEY EMBER_TRUST_CENTER_GLOBAL_LINK_KEY

This is the legacy name for the Trust Center Global Link Key.

#define
EMBER_MFG_SECURITY_CONFIG_MAGIC_NUMBER 0xCABAD11FUL

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.

enum
EMBER_ZDP_SUCCESS = 0x00
EMBER_ZDP_INVALID_REQUEST_TYPE = 0x80
EMBER_ZDP_DEVICE_NOT_FOUND = 0x81
EMBER_ZDP_INVALID_ENDPOINT = 0x82
EMBER_ZDP_NOT_ACTIVE = 0x83
EMBER_ZDP_NOT_SUPPORTED = 0x84
EMBER_ZDP_TIMEOUT = 0x85
EMBER_ZDP_NO_MATCH = 0x86
EMBER_ZDP_NO_ENTRY = 0x88
EMBER_ZDP_NO_DESCRIPTOR = 0x89
EMBER_ZDP_INSUFFICIENT_SPACE = 0x8a
EMBER_ZDP_NOT_PERMITTED = 0x8b
EMBER_ZDP_TABLE_FULL = 0x8c
EMBER_ZDP_NOT_AUTHORIZED = 0x8d
EMBER_ZDP_DEVICE_BINDING_TABLE_FULL = 0x8e
EMBER_ZDP_INVALID_INDEX = 0x8f
EMBER_NWK_ALREADY_PRESENT = 0xC5
EMBER_NWK_TABLE_FULL = 0xC7
EMBER_NWK_UNKNOWN_DEVICE = 0xC8
}

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>*

#define
NETWORK_ADDRESS_REQUEST 0x0000
#define
NETWORK_ADDRESS_RESPONSE 0x8000
#define
IEEE_ADDRESS_REQUEST 0x0001
#define
IEEE_ADDRESS_RESPONSE 0x8001

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.

#define
NODE_DESCRIPTOR_REQUEST 0x0002
#define
NODE_DESCRIPTOR_RESPONSE 0x8002

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.

#define
POWER_DESCRIPTOR_REQUEST 0x0003
#define
POWER_DESCRIPTOR_RESPONSE 0x8003

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>*

#define
SIMPLE_DESCRIPTOR_REQUEST 0x0004
#define
SIMPLE_DESCRIPTOR_RESPONSE 0x8004

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>*

#define
ACTIVE_ENDPOINTS_REQUEST 0x0005
#define
ACTIVE_ENDPOINTS_RESPONSE 0x8005

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>*

#define
MATCH_DESCRIPTORS_REQUEST 0x0006
#define
MATCH_DESCRIPTORS_RESPONSE 0x8006

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>

#define
DISCOVERY_CACHE_REQUEST 0x0012
#define
DISCOVERY_CACHE_RESPONSE 0x8012

End Device Announce and End Device Announce Response#

Request: <transaction sequence number: 1> <node ID:2> <EUI64:8> <capabilities:1>No response is sent.

#define
END_DEVICE_ANNOUNCE 0x0013
#define
END_DEVICE_ANNOUNCE_RESPONSE 0x8013

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>

#define
SYSTEM_SERVER_DISCOVERY_REQUEST 0x0015
#define
SYSTEM_SERVER_DISCOVERY_RESPONSE 0x8015

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>*

#define
PARENT_ANNOUNCE 0x001F
#define
PARENT_ANNOUNCE_RESPONSE 0x801F

ZDO server mask bits#

These are used in server discovery requests and responses.

enum
EMBER_ZDP_PRIMARY_TRUST_CENTER = 0x0001
EMBER_ZDP_SECONDARY_TRUST_CENTER = 0x0002
EMBER_ZDP_PRIMARY_BINDING_TABLE_CACHE = 0x0004
EMBER_ZDP_SECONDARY_BINDING_TABLE_CACHE = 0x0008
EMBER_ZDP_PRIMARY_DISCOVERY_CACHE = 0x0010
EMBER_ZDP_SECONDARY_DISCOVERY_CACHE = 0x0020
EMBER_ZDP_NETWORK_MANAGER = 0x0040
}

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>

#define
FIND_NODE_CACHE_REQUEST 0x001C
#define
FIND_NODE_CACHE_RESPONSE 0x801C

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>

#define
END_DEVICE_BIND_REQUEST 0x0020
#define
END_DEVICE_BIND_RESPONSE 0x8020

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>

#define
UNICAST_BINDING 0x03
#define
UNICAST_MANY_TO_ONE_BINDING 0x83
#define
MULTICAST_BINDING 0x01
#define
BIND_REQUEST 0x0021
#define
BIND_RESPONSE 0x8021
#define
UNBIND_REQUEST 0x0022
#define
UNBIND_RESPONSE 0x8022

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

#define
LQI_TABLE_REQUEST 0x0031
#define
LQI_TABLE_RESPONSE 0x8031

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

#define
ROUTING_TABLE_REQUEST 0x0032
#define
ROUTING_TABLE_RESPONSE 0x8032

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.

#define
BINDING_TABLE_REQUEST 0x0033
#define
BINDING_TABLE_RESPONSE 0x8033

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>

#define
LEAVE_REQUEST 0x0034
#define
LEAVE_RESPONSE 0x8034
#define
LEAVE_REQUEST_REMOVE_CHILDREN_FLAG 0x40
#define
LEAVE_REQUEST_REJOIN_FLAG 0x80

Permit Joining Request / Response#

Request: <transaction sequence number: 1> <duration:1> <permit authentication:1>Response: <transaction sequence number: 1> <status:1>

#define
PERMIT_JOINING_REQUEST 0x0036
#define
PERMIT_JOINING_RESPONSE 0x8036

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>*

#define
NWK_UPDATE_REQUEST 0x0038
#define
NWK_UPDATE_RESPONSE 0x8038
#define
NWK_UPDATE_ENHANCED_REQUEST 0x0039
#define
NWK_UPDATE_ENHANCED_RESPONSE 0x8039
#define
NWK_UPDATE_IEEE_JOINING_LIST_REQUEST 0x003A
#define
NWK_UPDATE_IEEE_JOINING_LIST_REPONSE 0x803A
#define
NWK_UNSOLICITED_ENHANCED_UPDATE_NOTIFY 0x803B

Unsupported#

Not mandatory and not supported.

#define
COMPLEX_DESCRIPTOR_REQUEST 0x0010
#define
COMPLEX_DESCRIPTOR_RESPONSE 0x8010
#define
USER_DESCRIPTOR_REQUEST 0x0011
#define
USER_DESCRIPTOR_RESPONSE 0x8011
#define
DISCOVERY_REGISTER_REQUEST 0x0012
#define
DISCOVERY_REGISTER_RESPONSE 0x8012
#define
USER_DESCRIPTOR_SET 0x0014
#define
USER_DESCRIPTOR_CONFIRM 0x8014
#define
NETWORK_DISCOVERY_REQUEST 0x0030
#define
NETWORK_DISCOVERY_RESPONSE 0x8030
#define
DIRECT_JOIN_REQUEST 0x0035
#define
DIRECT_JOIN_RESPONSE 0x8035
#define
CLUSTER_ID_RESPONSE_MINIMUM 0x8000

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.

enum
EMBER_APP_RECEIVES_SUPPORTED_ZDO_REQUESTS = 0x01
EMBER_APP_HANDLES_UNSUPPORTED_ZDO_REQUESTS = 0x02
EMBER_APP_HANDLES_ZDO_ENDPOINT_REQUESTS = 0x04
EMBER_APP_HANDLES_ZDO_BINDING_REQUESTS = 0x08
}

Defines the maximum number of counters that are specified as reporting either on 2.4 GHz or Sub-GHz.

enum
EMBER_MULTI_PHY_ROUTERS_ALLOWED = 0x01
EMBER_MULTI_PHY_BROADCASTS_ENABLED = 0x02
EMBER_MULTI_PHY_DISABLED = 0x80
}

Defines the maximum number of counters that are specified as reporting either on 2.4 GHz or Sub-GHz.

enum
@0 {
PRIORITIZE_BEACONS_BASED_ON_PARENT_CLASSIFICATION = 0x0001
PRIORITIZE_BEACONS_BASED_ON_TC_CONNECTVITY = 0x0002
TC_CONNECTIVITY = 0x0010
LONG_UPTIME = 0x0020
BAD_PARENT_CONNECTIVITY = 0x0040
EMBER_OUTGOING_MESSAGES = 0x0001
EMBER_INCOMING_MESSAGES = 0x0002
EMBER_RADIO_IS_ON = 0x0004
EMBER_TRANSPORT_ACTIVE = 0x0008
EMBER_APS_LAYER_ACTIVE = 0x0010
EMBER_ASSOCIATING = 0x0020
EMBER_ZLL_TOUCH_LINKING = 0x0040
EMBER_NETWORK_TIMEOUT_REQUEST = 0x0200
EMBER_SEND_ORPHAN_NOTIFICATION = 0x0400
EMBER_MAC_DATA_POLL_SUPER_RETRY = 0x0800
INITIAL = 0x0000
SCAN_FOR_TOUCH_LINK = 0x0001
SCAN_FOR_DEVICE_INFORMATION = 0x0002
SCAN_FOR_IDENTIFY = 0x0004
SCAN_FOR_RESET = 0x0008
TARGET_NETWORK_FOUND = 0x0010
ABORTING_TOUCH_LINK = 0x0020
SCAN_COMPLETE = 0x0040
TOUCH_LINK_TARGET = 0x0080
FORMING_NETWORK = 0x0100
RESETTING_TO_FACTORY_NEW = 0x0200
ADC_REF_INT = 42U
TOKEN_COUNT
COMM_SERIAL = 0x01
COMM_RADIO = 0x02
}

Defines the maximum number of counters that are specified as reporting either on 2.4 GHz or Sub-GHz.

enum
EMBER_ENTROPY_SOURCE_ERROR = 0x00
EMBER_ENTROPY_SOURCE_RADIO = 0x01
EMBER_ENTROPY_SOURCE_MBEDTLS_TRNG = 0x02
EMBER_ENTROPY_SOURCE_MBEDTLS = 0x03
}

Defines the entropy source used by the stack.

enum
@1 {
EMBER_POLL_TIMEOUT_10_SECONDS = 0
EMBER_POLL_TIMEOUT_2_MINUTES = 1
EMBER_POLL_TIMEOUT_4_MINUTES = 2
EMBER_POLL_TIMEOUT_8_MINUTES = 3
EMBER_POLL_TIMEOUT_16_MINUTES = 4
EMBER_POLL_TIMEOUT_32_MINUTES = 5
EMBER_POLL_TIMEOUT_64_MINUTES = 6
EMBER_POLL_TIMEOUT_128_MINUTES = 7
EMBER_POLL_TIMEOUT_256_MINUTES = 8
EMBER_POLL_TIMEOUT_512_MINUTES = 9
EMBER_POLL_TIMEOUT_1024_MINUTES = 10
EMBER_POLL_TIMEOUT_2048_MINUTES = 11
EMBER_POLL_TIMEOUT_4096_MINUTES = 12
EMBER_POLL_TIMEOUT_8192_MINUTES = 13
EMBER_POLL_TIMEOUT_16384_MINUTES = 14
EMBER_RADIO_POWER_MODE_RX_ON
EMBER_RADIO_POWER_MODE_OFF
ADC_SAMPLE_CLOCKS_32 = 0x0
ADC_SAMPLE_CLOCKS_64 = 0x1
ADC_SAMPLE_CLOCKS_128 = 0x2
ADC_SAMPLE_CLOCKS_256 = 0x3
ADC_SAMPLE_CLOCKS_512 = 0x4
ADC_SAMPLE_CLOCKS_1024 = 0x5
ADC_SAMPLE_CLOCKS_2048 = 0x6
ADC_SAMPLE_CLOCKS_4096 = 0x7
}

Defines the maximum number of counters that are specified as reporting either on 2.4 GHz or Sub-GHz.

enum
EMBER_KEEP_ALIVE_SUPPORT_UNKNOWN = 0x00
EMBER_MAC_DATA_POLL_KEEP_ALIVE = 0x01
EMBER_END_DEVICE_TIMEOUT_KEEP_ALIVE = 0x02
EMBER_KEEP_ALIVE_SUPPORT_ALL = 0x03
}

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.

enum
EMBER_SOURCE_ROUTE_DISCOVERY_OFF = 0x00
EMBER_SOURCE_ROUTE_DISCOVERY_ON = 0x01
EMBER_SOURCE_ROUTE_DISCOVERY_RESCHEDULE = 0x02
}

types of source route discovery modes used by the concentrator.

enum
EMBER_MAC_TRANSMIT_PRIORITY_HIGH
EMBER_MAC_TRANSMIT_PRIORITY_NORMAL
EMBER_MAC_TRANSMIT_PRIORITY_SCAN_OKAY
}

Packet transmit priorities in terms of getting into the MAC queue.

enum
ROUTE_RECORD_POLICY_ACK_BY_SOURCE_ROUTED_MESSAGE = 0
ROUTE_RECORD_POLICY_DONT_SEND = 1
ROUTE_RECORD_POLICY_NO_ACK_REQUIRED = 2
}

Policies for sending a route record to the concentrator.

typedef uint8_t

Radio power mode.

#define
WEAK_TEST

Defines the maximum number of counters that are specified as reporting either on 2.4 GHz or Sub-GHz.

#define
EMBER_MAX_MAC_ONLY_COUNTERS 33

Defines the maximum number of counters that are specified as reporting either on 2.4 GHz or Sub-GHz.

#define
EMBER_MAX_NUM_PHYS 2

Defines the maximum number of PHYs supported.

#define
PHY_INDEX_NATIVE 0

PHY index for 2.4 GHz radio interface, valid for simultaneous multi radio network.

#define
PHY_INDEX_PRO2PLUS 1

PHY index for Sub-GHz radio interface, valid for simultaneous multi radio network.

Enumerations#

enum
EMBER_UNKNOWN_DEVICE = 0
EMBER_COORDINATOR = 1
EMBER_ROUTER = 2
EMBER_END_DEVICE = 3
EMBER_SLEEPY_END_DEVICE = 4
}

Defines the possible types of nodes and the roles that a node might play in a network.

enum
EMBER_END_DEVICE_CONFIG_NONE = 0x00
EMBER_END_DEVICE_CONFIG_PERSIST_DATA_ON_PARENT = 0x01
}

The configuration advertised by the end device to the parent when joining/rejoining.

enum
EMBER_NETWORK_INIT_NO_OPTIONS = 0x0000
EMBER_NETWORK_INIT_PARENT_INFO_IN_TOKEN = 0x0001
EMBER_NETWORK_INIT_END_DEVICE_REJOIN_ON_REBOOT = 0x0002
}

Defines the options that should be used when initializing the node's network configuration.

enum
NO_REJOIN
REJOIN_ANY_LINK_KEY
REJOIN_NON_DEFAULT_LINK_KEY
}

Options to allow/disallow rejoins using the default link key.

enum
EMBER_APS_OPTION_NONE = 0x0000
EMBER_APS_OPTION_DSA_SIGN = 0x0010
EMBER_APS_OPTION_ENCRYPTION = 0x0020
EMBER_APS_OPTION_RETRY = 0x0040
EMBER_APS_OPTION_ENABLE_ROUTE_DISCOVERY = 0x0100
EMBER_APS_OPTION_FORCE_ROUTE_DISCOVERY = 0x0200
EMBER_APS_OPTION_SOURCE_EUI64 = 0x0400
EMBER_APS_OPTION_DESTINATION_EUI64 = 0x0800
EMBER_APS_OPTION_ENABLE_ADDRESS_DISCOVERY = 0x1000
EMBER_APS_OPTION_POLL_RESPONSE = 0x2000
EMBER_APS_OPTION_ZDO_RESPONSE_REQUIRED = 0x4000
EMBER_APS_OPTION_FRAGMENT = SIGNED_ENUM 0x8000
}

Options to use when sending a message.

enum
EMBER_INCOMING_UNICAST
EMBER_INCOMING_UNICAST_REPLY
EMBER_INCOMING_MULTICAST
EMBER_INCOMING_MULTICAST_LOOPBACK
EMBER_INCOMING_BROADCAST
EMBER_INCOMING_BROADCAST_LOOPBACK
}

Defines the possible incoming message types.

enum
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
}

Defines the possible outgoing message types.

enum
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
}

A type of command received by the stack.

enum
EMBER_DROP_PACKET = 0
EMBER_ACCEPT_PACKET = 1
EMBER_MANGLE_PACKET
EMBER_ACCEPT_PACKET_OVERRIDE_SECURITY
EMBER_ACCEPT_PACKET_SKIP_NWK_CRYPTO
}

indication of the action taken on a packet

enum
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
}

A type of packet received by the stack.

enum
EMBER_NO_NETWORK
EMBER_JOINING_NETWORK
EMBER_JOINED_NETWORK
EMBER_JOINED_NETWORK_NO_PARENT
EMBER_LEAVING_NETWORK
}

Defines the possible join states for a node.

enum
EMBER_ENERGY_SCAN
EMBER_ACTIVE_SCAN
EMBER_START_RADIO_OFF_SCAN
EMBER_STACK_GP_CHANNEL_DELIVERY_SCAN
EMBER_LAST_SCAN_TYPE = EMBER_STACK_GP_CHANNEL_DELIVERY_SCAN
}

Type for a network scan.

enum
EMBER_UNUSED_BINDING = 0
EMBER_UNICAST_BINDING = 1
EMBER_MANY_TO_ONE_BINDING = 2
EMBER_MULTICAST_BINDING = 3
}

Defines binding types.

Variables#

const char *
uint16_t
uint8_t
uint8_t
uint8_t
uint8_t
uint16_t
uint8_t
uint16_t
int8_t
uint8_t
uint8_t
int8_t
uint8_t
int8_t
EmberPanId
EmberNodeId
uint8_t
uint16_t
EmberNodeId
uint32_t
uint8_t
uint16_t
uint16_t
uint16_t
uint8_t
uint8_t
EmberEUI64
EmberNodeId
uint8_t
uint8_t
uint8_t
uint8_t
uint16_t
uint8_t
EmberEUI64
uint16_t
uint8_t
uint8_t
uint8_t
uint8_t
EmberEUI64
uint16_t
uint16_t
uint8_t
uint8_t
uint8_t
uint8_t
uint8_t
uint8_t
uint8_t
void(*
bool
uint8_t
uint8_t
uint8_t
uint8_t
uint8_t
uint8_t
uint8_t
uint8_t
uint32_t
uint8_t
uint8_t
uint8_t
uint8_t
uint16_t
EmberEUI64
EmberEUI64
EmberNodeId
uint8_t
uint8_t
EmberNodeId
uint8_t
uint8_t

Macros#

#define
EMBER_MIN_BROADCAST_ADDRESS 0xFFF8
#define
emberIsZigbeeBroadcastAddress (address)

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

Definition at line 46 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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

Definition at line 440 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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

Definition at line 451 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

EmberLeaveRequestFlags#

EmberLeaveRequestFlags

EmberReleaseTypeStruct Data that relates release type to the correct string.

Enumerator
EMBER_ZIGBEE_LEAVE_AND_REJOIN

Leave and rejoin.

EMBER_ZIGBEE_LEAVE_WITHOUT_REJOIN

Leave.


Definition at line 462 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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

Definition at line 482 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

EmberMulticastId#

typedef uint16_t EmberMulticastId

16-bit ZigBee network address.

16-bit ZigBee multicast group identifier.


Definition at line 217 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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%).


Definition at line 230 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

emberVersion#

const EmberVersion emberVersion

A structure containing the version information.


Definition at line 108 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

ZigBee Broadcast Addresses Documentation#

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

To assume trust center is not a concentrator.

EMBER_ASSUME_TRUST_CENTER_IS_LOW_RAM_CONCENTRATOR

To assume trust center is a low RAM concentrator.

EMBER_ASSUME_TRUST_CENTER_IS_HIGH_RAM_CONCENTRATOR

To assume trust center is a high RAM concentrator.


Definition at line 996 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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

Allow the node to join. The node has the key.

EMBER_SEND_KEY_IN_THE_CLEAR

Allow the node to join. Send the key to the node.

EMBER_DENY_JOIN

Deny join.

EMBER_NO_ACTION

Take no action.


Definition at line 1014 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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

Definition at line 1047 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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

Definition at line 1072 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

EmberClusterListId#

EmberClusterListId

Defines the lists of clusters that must be provided for each endpoint.

Enumerator
EMBER_INPUT_CLUSTER_LIST

Input clusters the endpoint will accept.

EMBER_OUTPUT_CLUSTER_LIST

Output clusters the endpoint can send.


Definition at line 1103 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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

The event is not scheduled to run.

EMBER_EVENT_MS_TIME

The execution time is in approximate milliseconds.

EMBER_EVENT_QS_TIME

The execution time is in 'binary' quarter seconds (256 approximate milliseconds each).

EMBER_EVENT_MINUTE_TIME

The execution time is in 'binary' minutes (65536 approximate milliseconds each).

EMBER_EVENT_ZERO_DELAY

The event is scheduled to run at the earliest opportunity.


Definition at line 1120 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

EmberJoinMethod#

EmberJoinMethod

The type of method used for joining.

Enumerator
EMBER_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.

EMBER_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 EmberJoinDecision on the Trust Center returned by the emberTrustCenterJoinHandler().

EMBER_USE_NWK_REJOIN_HAVE_NWK_KEY
EMBER_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.


Definition at line 1144 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

EmberCounterType#

EmberCounterType

Defines the events reported to the application by the emberCounterHandler().

Enumerator
EMBER_COUNTER_MAC_RX_BROADCAST

The MAC received a broadcast.

EMBER_COUNTER_MAC_TX_BROADCAST

The MAC transmitted a broadcast.

EMBER_COUNTER_MAC_RX_UNICAST

The MAC received a unicast.

EMBER_COUNTER_MAC_TX_UNICAST_SUCCESS

The MAC successfully transmitted a unicast.

EMBER_COUNTER_MAC_TX_UNICAST_RETRY

The MAC retried a unicast. This is a placeholder and is not used by the emberCounterHandler() callback. Instead, the number of MAC retries are returned in the data parameter of the callback for the EMBER_COUNTER_MAC_TX_UNICAST_SUCCESS and EMBER_COUNTER_MAC_TX_UNICAST_FAILED types.

EMBER_COUNTER_MAC_TX_UNICAST_FAILED

The MAC unsuccessfully transmitted a unicast.

EMBER_COUNTER_APS_DATA_RX_BROADCAST

The APS layer received a data broadcast.

EMBER_COUNTER_APS_DATA_TX_BROADCAST

The APS layer transmitted a data broadcast.

EMBER_COUNTER_APS_DATA_RX_UNICAST

The APS layer received a data unicast.

EMBER_COUNTER_APS_DATA_TX_UNICAST_SUCCESS

The APS layer successfully transmitted a data unicast.

EMBER_COUNTER_APS_DATA_TX_UNICAST_RETRY

The APS layer retried a data unicast. This is a placeholder and is not used by the emberCounterHandler() callback. Instead, the number of APS retries are returned in the data parameter of the callback for the EMBER_COUNTER_APS_DATA_TX_UNICAST_SUCCESS and EMBER_COUNTER_APS_DATA_TX_UNICAST_FAILED types.

EMBER_COUNTER_APS_DATA_TX_UNICAST_FAILED

The APS layer unsuccessfully transmitted a data unicast.

EMBER_COUNTER_ROUTE_DISCOVERY_INITIATED

The network layer successfully submitted a new route discovery to the MAC.

EMBER_COUNTER_NEIGHBOR_ADDED

An entry was added to the neighbor table.

EMBER_COUNTER_NEIGHBOR_REMOVED

An entry was removed from the neighbor table.

EMBER_COUNTER_NEIGHBOR_STALE

A neighbor table entry became stale because it had not been heard from.

EMBER_COUNTER_JOIN_INDICATION

A node joined or rejoined to the network via this node.

EMBER_COUNTER_CHILD_REMOVED

An entry was removed from the child table.

EMBER_COUNTER_ASH_OVERFLOW_ERROR

EZSP-UART only. An overflow error occurred in the UART.

EMBER_COUNTER_ASH_FRAMING_ERROR

EZSP-UART only. A framing error occurred in the UART.

EMBER_COUNTER_ASH_OVERRUN_ERROR

EZSP-UART only. An overrun error occurred in the UART.

EMBER_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.

EMBER_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.

EMBER_COUNTER_ASH_XOFF

EZSP-UART only. An XOFF was transmitted by the UART.

EMBER_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.

EMBER_COUNTER_NWK_DECRYPTION_FAILURE

A NWK encrypted message was received but dropped because decryption failed.

EMBER_COUNTER_APS_DECRYPTION_FAILURE

An APS encrypted message was received but dropped because decryption failed.

EMBER_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.

EMBER_COUNTER_RELAYED_UNICAST

The number of relayed unicast packets.

EMBER_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 (emMaxPhyToMacQueueLength). The limit will determine how many messages are accepted by the PHY between calls to emberTick(). After that limit is reached, packets will be dropped. The number of dropped packets will be recorded in this counter.

NOTE: For each call to emberCounterHandler() 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.

EMBER_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.

EMBER_COUNTER_TYPE_NWK_RETRY_OVERFLOW

The number of times the NWK retry queue is full and a new message failed to be added.

EMBER_COUNTER_PHY_CCA_FAIL_COUNT

The number of times the PHY layer was unable to transmit due to a failed CCA.

EMBER_COUNTER_BROADCAST_TABLE_FULL

The number of times a NWK broadcast was dropped because the broadcast table was full.

EMBER_COUNTER_PTA_LO_PRI_REQUESTED

The number of times a low-priority packet traffic arbitration request has been made.

EMBER_COUNTER_PTA_HI_PRI_REQUESTED

The number of times a high-priority packet traffic arbitration request has been made.

EMBER_COUNTER_PTA_LO_PRI_DENIED

The number of times a low-priority packet traffic arbitration request has been denied.

EMBER_COUNTER_PTA_HI_PRI_DENIED

The number of times a high-priority packet traffic arbitration request has been denied.

EMBER_COUNTER_PTA_LO_PRI_TX_ABORTED

The number of times a low-priority packet traffic arbitration transmission has been aborted.

EMBER_COUNTER_PTA_HI_PRI_TX_ABORTED

The number of times a high-priority packet traffic arbitration transmission has been aborted.

EMBER_COUNTER_ADDRESS_CONFLICT_SENT

The number of times an address conflict has cuased node_id change, and an addresss conflict error is sent

EMBER_COUNTER_TYPE_COUNT

A placeholder giving the number of Ember counter types.


Definition at line 1383 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

EmberTaskId#

typedef uint8_t EmberTaskId

brief An identifier for a task.


Definition at line 1623 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

txPowerModes for emberSetTxPowerMode and mfglibSetPower Documentation#

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

Enables Distributed Trust Center Mode for the device forming the network. (Previously known as EMBER_NO_TRUST_CENTER_MODE)

EMBER_TRUST_CENTER_GLOBAL_LINK_KEY

Enables a Global Link Key for the Trust Center. All nodes will share the same Trust Center Link Key.

EMBER_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.

EMBER_HAVE_TRUST_CENTER_EUI64

This denotes that the EmberInitialSecurityState::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 EmberInitialSecurityState::preconfiguredTrustCenterEui64 must be populated with the appropriate EUI64.

EMBER_TRUST_CENTER_USES_HASHED_LINK_KEY

This denotes that the EmberInitialSecurityState::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.

EMBER_HAVE_PRECONFIGURED_KEY

This denotes that the EmberInitialSecurityState::preconfiguredKey element has valid data that should be used to configure the initial security state.

EMBER_HAVE_NETWORK_KEY

This denotes that the EmberInitialSecurityState::networkKey element has valid data that should be used to configure the initial security state.

EMBER_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).

EMBER_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.

EMBER_NO_FRAME_COUNTER_RESET

This denotes whether the device should NOT reset its outgoing frame counters (both NWK and APS) when emberSetInitialSecurityState() 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 EMBER_EXT_NO_FRAME_COUNTER_RESET field.

EMBER_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 emberSetInitialSecurityState() will fail.


Definition at line 1848 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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

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

EMBER_JOINER_GLOBAL_LINK_KEY

This denotes whether a joiner node (router or end-device) uses a Global Link Key or a Unique Link Key.

EMBER_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.

EMBER_NWK_LEAVE_WITHOUT_REJOIN_NOT_ALLOWED

This denotes whether a device should discard or accept network leave without rejoin commands.

EMBER_NWK_LEAVE_REQUEST_NOT_ALLOWED

This denotes whether a router node should discard or accept network Leave Commands.


Definition at line 1940 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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_

This denotes that the device is running in a network with ZigBee Standard Security.

EMBER_DISTRIBUTED_TRUST_CENTER_MODE_

This denotes that the device is running in a network without a centralized Trust Center.

EMBER_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.

EMBER_HAVE_TRUST_CENTER_LINK_KEY

This denotes that the node has a Trust Center Link Key.

EMBER_TRUST_CENTER_USES_HASHED_LINK_KEY_

This denotes that the Trust Center is using a Hashed Link Key.


Definition at line 2054 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

EmberKeyStructBitmask#

EmberKeyStructBitmask

This bitmask describes the presence of fields within the EmberKeyStruct.

Enumerator
EMBER_KEY_HAS_SEQUENCE_NUMBER

This indicates that the key has a sequence number associated with it. (i.e., a Network Key).

EMBER_KEY_HAS_OUTGOING_FRAME_COUNTER

This indicates that the key has an outgoing frame counter and the corresponding value within the EmberKeyStruct has been populated.

EMBER_KEY_HAS_INCOMING_FRAME_COUNTER

This indicates that the key has an incoming frame counter and the corresponding value within the EmberKeyStruct has been populated.

EMBER_KEY_HAS_PARTNER_EUI64

This indicates that the key has an associated Partner EUI64 address and the corresponding value within the EmberKeyStruct has been populated.

EMBER_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).

EMBER_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.

EMBER_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 EmberTcLinkKeyRequestPolicy is EMBER_ALLOW_TC_LINK_KEY_REQUEST_AND_GENERATE_NEW_KEY


Definition at line 2104 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

EmberKeyType#

EmberKeyType

This denotes the type of security key.

Enumerator
EMBER_TRUST_CENTER_LINK_KEY

This denotes that the key is a Trust Center Link Key.

EMBER_CURRENT_NETWORK_KEY

This denotes that the key is the Current Network Key.

EMBER_NEXT_NETWORK_KEY

This denotes that the key is the Next Network Key.

EMBER_APPLICATION_LINK_KEY

This denotes that the key is an Application Link Key.


Definition at line 2150 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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

Definition at line 2196 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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

Definition at line 2248 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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

Definition at line 2268 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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

Definition at line 2398 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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

No MAC passthrough messages.

EMBER_MAC_PASSTHROUGH_SE_INTERPAN

SE InterPAN messages.

EMBER_MAC_PASSTHROUGH_EMBERNET

EmberNet and first generation (v1) standalone bootloader messages.

EMBER_MAC_PASSTHROUGH_EMBERNET_SOURCE

EmberNet messages filtered by their source address.

EMBER_MAC_PASSTHROUGH_APPLICATION

Application-specific passthrough messages.

EMBER_MAC_PASSTHROUGH_CUSTOM

Custom inter-pan filter.


Definition at line 2497 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

EmberLibraryStatus#

typedef uint8_t EmberLibraryStatus

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


Definition at line 2535 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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.

Parameters
TypeDirectionArgument NameDescription
EmberKeyData *N/Akey

A pointer to an EmberKeyData structure.

Returns

  • uint8_t* Returns a pointer to the first byte of the Key data.


Definition at line 2286 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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.

Parameters
TypeDirectionArgument NameDescription
EmberCertificateData *N/Acert

A pointer to an EmberCertificateData structure.

Returns

  • uint8_t* Returns a pointer to the first byte of the certificate data.


Definition at line 2299 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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.

Parameters
TypeDirectionArgument NameDescription
EmberPublicKeyData *N/Akey

A pointer to an EmberPublicKeyData structure.

Returns

  • uint8_t* Returns a pointer to the first byte of the public key data.


Definition at line 2312 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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.

Parameters
TypeDirectionArgument NameDescription
EmberPrivateKeyData *N/Akey

A pointer to an EmberPrivateKeyData structure.

Returns

  • uint8_t* Returns a pointer to the first byte of the private key data.


Definition at line 2325 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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.

Parameters
TypeDirectionArgument NameDescription
EmberSmacData *N/Akey

Definition at line 2335 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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.

Parameters
TypeDirectionArgument NameDescription
EmberSignatureData *N/Asig

Definition at line 2344 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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.

Parameters
TypeDirectionArgument NameDescription
EmberCertificate283k1Data *N/Acert

A pointer to an ::Ember283k1CertificateData structure.

Returns

  • uint8_t* Returns a pointer to the first byte of the certificate data.


Definition at line 2357 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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.

Parameters
TypeDirectionArgument NameDescription
EmberPublicKey283k1Data *N/Akey

A pointer to an Ember283k1PublicKeyData structure.

Returns

  • uint8_t* Returns a pointer to the first byte of the public key data.


Definition at line 2370 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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.

Parameters
TypeDirectionArgument NameDescription
EmberPrivateKey283k1Data *N/Akey

A pointer to an Ember283k1PrivateKeyData structure.

Returns

  • uint8_t* Returns a pointer to the first byte of the private key data.


Definition at line 2383 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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.

Parameters
TypeDirectionArgument NameDescription
Ember283k1SignatureData *N/Asig

Definition at line 2392 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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

Definition at line 2548 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

Network and IEEE Address Request/Response Documentation#

Node Descriptor Request/Response Documentation#

Power Descriptor Request / Response Documentation#

Simple Descriptor Request / Response Documentation#

Active Endpoints Request / Response Documentation#

Match Descriptors Request / Response Documentation#

Discovery Cache Request / Response Documentation#

End Device Announce and End Device Announce Response Documentation#

System Server Discovery Request / Response Documentation#

Parent Announce and Parent Announce Response Documentation#

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

Definition at line 2760 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

Find Node Cache Request / Response Documentation#

End Device Bind Request / Response Documentation#

Binding types and Request / Response Documentation#

LQI Table Request / Response Documentation#

Routing Table Request / Response Documentation#

Binding Table Request / Response Documentation#

Leave Request / Response Documentation#

Permit Joining Request / Response Documentation#

Network Update Request / Response Documentation#

Unsupported Documentation#

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

Definition at line 3042 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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

Definition at line 3070 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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

There are messages waiting for transmission.

EMBER_INCOMING_MESSAGES

One or more incoming messages being processed.

EMBER_RADIO_IS_ON

The radio is currently powered on. On sleepy devices, the radio is turned off when not in use. On non-sleepy devices (EMBER_COORDINATOR, EMBER_ROUTER, or EMBER_END_DEVICE), the radio is always on.

EMBER_TRANSPORT_ACTIVE

The transport layer has messages awaiting an ACK.

EMBER_APS_LAYER_ACTIVE

The ZigBee APS layer has messages awaiting an ACK.

EMBER_ASSOCIATING

The node is currently trying to associate with a ZigBee PRO network.

EMBER_ZLL_TOUCH_LINKING

The node is currently touch linking.

EMBER_NETWORK_TIMEOUT_REQUEST

Network Timeout Request Event.

EMBER_SEND_ORPHAN_NOTIFICATION

Sending Orphan Notification Event.

EMBER_MAC_DATA_POLL_SUPER_RETRY

MAC Data Poll Super Retry Event .

INITIAL
SCAN_FOR_TOUCH_LINK
SCAN_FOR_DEVICE_INFORMATION
SCAN_FOR_IDENTIFY
SCAN_FOR_RESET
TARGET_NETWORK_FOUND
ABORTING_TOUCH_LINK
SCAN_COMPLETE
TOUCH_LINK_TARGET
FORMING_NETWORK
RESETTING_TO_FACTORY_NEW
ADC_REF_INT

Internal reference.

TOKEN_COUNT
COMM_SERIAL
COMM_RADIO

Definition at line 3113 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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

Definition at line 3130 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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
EMBER_RADIO_POWER_MODE_RX_ON
EMBER_RADIO_POWER_MODE_OFF
ADC_SAMPLE_CLOCKS_32

Rate 32 cycles, 5 effective bits in ADC_DATA[15:11]

ADC_SAMPLE_CLOCKS_64

Rate 64 cycles, 6 effective bits in ADC_DATA[15:10]

ADC_SAMPLE_CLOCKS_128

Rate 128 cycles, 7 effective bits in ADC_DATA[15:9]

ADC_SAMPLE_CLOCKS_256

Rate 256 cycles, 8 effective bits in ADC_DATA[15:8]

ADC_SAMPLE_CLOCKS_512

Rate 512 cycles, 9 effective bits in ADC_DATA[15:7]

ADC_SAMPLE_CLOCKS_1024

Rate 1024 cycles, 10 effective bits in ADC_DATA[15:6]

ADC_SAMPLE_CLOCKS_2048

Rate 2048 cycles, 11 effective bits in ADC_DATA[15:5]

ADC_SAMPLE_CLOCKS_4096

Rate 4096 cycles, 12 effective bits in ADC_DATA[15:4]


Definition at line 3142 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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 prent's keep alive mechanism is unknown to end-device.

EMBER_MAC_DATA_POLL_KEEP_ALIVE, means 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 parent needs explicit keep alive messages (net work timeoit requests) to keep the child in its child table.

EMBER_KEEP_ALIVE_SUPPORT_ALL bascially maps to EMBER_MAC_DATA_POLL_KEEP_ALIVE, as it is the prefered approach between the 2

Enumerator
EMBER_KEEP_ALIVE_SUPPORT_UNKNOWN
EMBER_MAC_DATA_POLL_KEEP_ALIVE
EMBER_END_DEVICE_TIMEOUT_KEEP_ALIVE
EMBER_KEEP_ALIVE_SUPPORT_ALL

Definition at line 3178 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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 immidiately and then trifggered periodically

Enumerator
EMBER_SOURCE_ROUTE_DISCOVERY_OFF

off

EMBER_SOURCE_ROUTE_DISCOVERY_ON

on

EMBER_SOURCE_ROUTE_DISCOVERY_RESCHEDULE

reschedule


Definition at line 3199 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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

Definition at line 3229 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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 preceeded 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)


Definition at line 3248 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

EmberRadioPowerMode#

typedef uint8_t EmberRadioPowerMode

Radio power mode.


Definition at line 3106 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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

The device is not joined.

EMBER_COORDINATOR

Will relay messages and can act as a parent to other nodes.

EMBER_ROUTER

Will relay messages and can act as a parent to other nodes.

EMBER_END_DEVICE

Communicates only with its parent and will not relay messages.

EMBER_SLEEPY_END_DEVICE

An end device whose radio can be turned off to save power. The application must call emberPollForData() to receive messages.


Definition at line 538 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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

Definition at line 562 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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

The Parent Node ID and EUI64 are stored in a token. This prevents the need to perform an Orphan scan on startup.

EMBER_NETWORK_INIT_END_DEVICE_REJOIN_ON_REBOOT

Z3 compliant end devices on a network must send a rejoin request on reboot.


Definition at line 589 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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

Definition at line 658 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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

No options.

EMBER_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 ::emberDsaSignHandler() 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 emberDsaSign() or the dsaSign EZSP command for more details about this requirement.

EMBER_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.

EMBER_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.

EMBER_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.

EMBER_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.

EMBER_APS_OPTION_SOURCE_EUI64

Include the source EUI64 in the network frame.

EMBER_APS_OPTION_DESTINATION_EUI64

Include the destination EUI64 in the network frame.

EMBER_APS_OPTION_ENABLE_ADDRESS_DISCOVERY

Send a ZDO request to discover the node ID of the destination if it is not already known.

EMBER_APS_OPTION_POLL_RESPONSE

This message is being sent in response to a call to emberPollHandler(). It causes the message to be sent immediately instead of being queued up until the next poll from the (end device) destination.

EMBER_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 emberIncomingMessageHandler() when EMBER_APPLICATION_RECEIVES_UNSUPPORTED_ZDO_REQUESTS is defined.

EMBER_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.


Definition at line 676 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

EmberIncomingMessageType#

EmberIncomingMessageType

Defines the possible incoming message types.

Enumerator
EMBER_INCOMING_UNICAST

Unicast.

EMBER_INCOMING_UNICAST_REPLY

Unicast reply.

EMBER_INCOMING_MULTICAST

Multicast.

EMBER_INCOMING_MULTICAST_LOOPBACK

Multicast sent by the local device.

EMBER_INCOMING_BROADCAST

Broadcast.

EMBER_INCOMING_BROADCAST_LOOPBACK

Broadcast sent by the local device.


Definition at line 747 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

EmberOutgoingMessageType#

EmberOutgoingMessageType

Defines the possible outgoing message types.

Enumerator
EMBER_OUTGOING_DIRECT

Unicast sent directly to an EmberNodeId.

EMBER_OUTGOING_VIA_ADDRESS_TABLE

Unicast sent using an entry in the address table.

EMBER_OUTGOING_VIA_BINDING

Unicast sent using an entry in the binding table.

EMBER_OUTGOING_MULTICAST

Multicast message. This value is passed to emberMessageSentHandler() only. It may not be passed to emberSendUnicast().

EMBER_OUTGOING_MULTICAST_WITH_ALIAS

An aliased multicast message. This value is passed to emberMessageSentHandler() only. It may not be passed to emberSendUnicast().

EMBER_OUTGOING_BROADCAST_WITH_ALIAS

An aliased Broadcast message. This value is passed to emberMessageSentHandler() only. It may not be passed to emberSendUnicast().

EMBER_OUTGOING_BROADCAST

A broadcast message. This value is passed to emberMessageSentHandler() only. It may not be passed to emberSendUnicast().


Definition at line 771 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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

Describes an 802.15.4 raw MAC message, unprocessed by the stack.

EMBER_ZIGBEE_COMMAND_TYPE_MAC_COMMAND

Describes an 802.15.4 MAC layer command.

EMBER_ZIGBEE_COMMAND_TYPE_NWK

Describes a ZigBee Network layer command.

EMBER_ZIGBEE_COMMAND_TYPE_APS

Describes a ZigBee Application Support layer command.

EMBER_ZIGBEE_COMMAND_TYPE_ZDO

Describes a ZigBee Device Object command.

EMBER_ZIGBEE_COMMAND_TYPE_ZCL

Describes a ZigBee Cluster Library command.

EMBER_ZIGBEE_COMMAND_TYPE_BEACON

Not a MAC command, but enumerated here for simplicity.


Definition at line 805 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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

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

EMBER_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.


Definition at line 829 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/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

Describes an 802.15.4 raw MAC message, unprocessed by the stack.

EMBER_ZIGBEE_PACKET_TYPE_MAC_COMMAND

Describes an 802.15.4 MAC layer command.

EMBER_ZIGBEE_PACKET_TYPE_NWK_DATA

Describes a ZigBee Network layer data message.

EMBER_ZIGBEE_PACKET_TYPE_NWK_COMMAND

Describes a ZigBee Network layer command.

EMBER_ZIGBEE_PACKET_TYPE_APS_DATA

Describes a ZigBee Application Support layer data message.

EMBER_ZIGBEE_PACKET_TYPE_APS_COMMAND

Describes a ZigBee Application Support layer command.

EMBER_ZIGBEE_PACKET_TYPE_ZDO

Describes a ZigBee Device Object command.

EMBER_ZIGBEE_PACKET_TYPE_ZCL

Describes a ZigBee Cluster Library command.

EMBER_ZIGBEE_PACKET_TYPE_BEACON

Distinguishing between raw MAC and beacons for simplicity

EMBER_ZIGBEE_PACKET_TYPE_INTERPAN

Describes a ZigBee Light Link message.

EMBER_ZIGBEE_PACKET_TYPE_NWK_DATA_PRE_DECRYPTION

Describes a ZigBee Network layer data message prior to (potential) decryption.

EMBER_ZIGBEE_PACKET_TYPE_NWK_COMMAND_PRE_DECRYPTION

Describes a ZigBee Network layer command prior to (potential) decryption.


Definition at line 858 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

EmberNetworkStatus#

EmberNetworkStatus

Defines the possible join states for a node.

Enumerator
EMBER_NO_NETWORK

The node is not associated with a network in any way.

EMBER_JOINING_NETWORK

The node is currently attempting to join a network.

EMBER_JOINED_NETWORK

The node is joined to a network.

EMBER_JOINED_NETWORK_NO_PARENT

The node is an end device joined to a network but its parent is not responding.

EMBER_LEAVING_NETWORK

The node is in the process of leaving its current network.


Definition at line 894 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

EmberNetworkScanType#

EmberNetworkScanType

Type for a network scan.

Enumerator
EMBER_ENERGY_SCAN

An energy scan scans each channel for its RSSI value.

EMBER_ACTIVE_SCAN

An active scan scans each channel for available networks.

EMBER_START_RADIO_OFF_SCAN

A fake scan that is used to turn off the radio.

EMBER_STACK_GP_CHANNEL_DELIVERY_SCAN

A green power channel delivery scan.

EMBER_LAST_SCAN_TYPE

Definition at line 927 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

EmberBindingType#

EmberBindingType

Defines binding types.

Enumerator
EMBER_UNUSED_BINDING

A binding that is currently not in use.

EMBER_UNICAST_BINDING

A unicast binding whose 64-bit identifier is the destination EUI64.

EMBER_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.

EMBER_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.


Definition at line 948 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

Variable Documentation#

typeNum#

EmberVersionType EmberReleaseTypeStruct::typeNum

Definition at line 75 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

typeString#

const char* EmberReleaseTypeStruct::typeString

Definition at line 76 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

build#

uint16_t EmberVersion::build

Definition at line 97 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

major#

uint8_t EmberVersion::major

Definition at line 98 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

minor#

uint8_t EmberVersion::minor

Definition at line 99 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

patch#

uint8_t EmberVersion::patch

Definition at line 100 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

special#

uint8_t EmberVersion::special

Definition at line 101 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

type#

EmberVersionType EmberVersion::type

Definition at line 102 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

panId#

uint16_t EmberZigbeeNetwork::panId

Definition at line 576 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

channel#

uint8_t EmberZigbeeNetwork::channel

Definition at line 577 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

allowingJoin#

bool EmberZigbeeNetwork::allowingJoin

Definition at line 578 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

extendedPanId#

uint8_t EmberZigbeeNetwork::extendedPanId[EXTENDED_PAN_ID_SIZE]

Definition at line 579 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

stackProfile#

uint8_t EmberZigbeeNetwork::stackProfile

Definition at line 580 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

nwkUpdateId#

uint8_t EmberZigbeeNetwork::nwkUpdateId

Definition at line 581 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

bitmask#

EmberNetworkInitBitmask EmberNetworkInitStruct::bitmask

Definition at line 609 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

nodeId#

uint16_t EmberBeaconSurvey::nodeId

Definition at line 617 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

rssi#

int8_t EmberBeaconSurvey::rssi

Definition at line 618 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

classificationMask#

uint8_t EmberBeaconSurvey::classificationMask

Definition at line 619 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

channel#

uint8_t EmberBeaconData::channel

Definition at line 627 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

lqi#

uint8_t EmberBeaconData::lqi

Definition at line 628 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

rssi#

int8_t EmberBeaconData::rssi

Definition at line 629 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

depth#

uint8_t EmberBeaconData::depth

Definition at line 630 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

nwkUpdateId#

uint8_t EmberBeaconData::nwkUpdateId

Definition at line 631 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

power#

int8_t EmberBeaconData::power

Definition at line 632 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

parentPriority#

int8_t EmberBeaconData::parentPriority

Definition at line 633 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

enhanced#

bool EmberBeaconData::enhanced

Definition at line 634 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

permitJoin#

bool EmberBeaconData::permitJoin

Definition at line 635 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

hasCapacity#

bool EmberBeaconData::hasCapacity

Definition at line 636 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

panId#

EmberPanId EmberBeaconData::panId

Definition at line 637 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

sender#

EmberNodeId EmberBeaconData::sender

Definition at line 638 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

extendedPanId#

uint8_t EmberBeaconData::extendedPanId[EXTENDED_PAN_ID_SIZE]

Definition at line 639 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

beacon#

EmberBeaconData EmberBeaconIterator::beacon

Definition at line 648 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

index#

uint8_t EmberBeaconIterator::index

Definition at line 651 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

extendedPanId#

uint8_t EmberNetworkParameters::extendedPanId[EXTENDED_PAN_ID_SIZE]

The network's extended PAN identifier.


Definition at line 1190 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

panId#

uint16_t EmberNetworkParameters::panId

The network's PAN identifier.


Definition at line 1192 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

radioTxPower#

int8_t EmberNetworkParameters::radioTxPower

A power setting, in dBm.


Definition at line 1194 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

radioChannel#

uint8_t EmberNetworkParameters::radioChannel

A radio channel. Be sure to specify a channel supported by the radio.


Definition at line 1196 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

joinMethod#

EmberJoinMethod EmberNetworkParameters::joinMethod

Join method: The protocol messages used to establish an initial parent. It is ignored when forming a ZigBee network, or when querying the stack for its network parameters.


Definition at line 1201 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

nwkManagerId#

EmberNodeId EmberNetworkParameters::nwkManagerId

NWK Manager ID. The ID of the network manager in the current network. This may only be set at joining when using EMBER_USE_CONFIGURED_NWK_STATE as the join method.


Definition at line 1207 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

nwkUpdateId#

uint8_t EmberNetworkParameters::nwkUpdateId

An NWK Update ID. The value of the ZigBee nwkUpdateId known by the stack. It is used to determine the newest instance of the network after a PAN ID or channel change. This may only be set at joining when using EMBER_USE_CONFIGURED_NWK_STATE as the join method.


Definition at line 1213 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

channels#

uint32_t EmberNetworkParameters::channels

The NWK channel mask. The list of preferred channels that the NWK manager has told this device to use when searching for the network. This may only be set at joining when using EMBER_USE_CONFIGURED_NWK_STATE as the join method.


Definition at line 1219 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

radioTxPower#

int8_t EmberMultiPhyRadioParameters::radioTxPower

Definition at line 1235 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

radioPage#

uint8_t EmberMultiPhyRadioParameters::radioPage

Definition at line 1236 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

radioChannel#

uint8_t EmberMultiPhyRadioParameters::radioChannel

Definition at line 1237 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

profileId#

uint16_t EmberApsFrame::profileId

The application profile ID that describes the format of the message.


Definition at line 1245 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

clusterId#

uint16_t EmberApsFrame::clusterId

The cluster ID for this message.


Definition at line 1247 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

sourceEndpoint#

uint8_t EmberApsFrame::sourceEndpoint

The source endpoint.


Definition at line 1249 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

destinationEndpoint#

uint8_t EmberApsFrame::destinationEndpoint

The destination endpoint.


Definition at line 1251 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

options#

EmberApsOption EmberApsFrame::options

A bitmask of options from the enumeration above.


Definition at line 1253 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

groupId#

uint16_t EmberApsFrame::groupId

The group ID for this message, if it is multicast mode.


Definition at line 1255 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

sequence#

uint8_t EmberApsFrame::sequence

The sequence number.


Definition at line 1257 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

radius#

uint8_t EmberApsFrame::radius

Definition at line 1258 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

eui64#

EmberEUI64 EmberChildData::eui64

Definition at line 1265 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

type#

EmberNodeType EmberChildData::type

Definition at line 1266 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

id#

EmberNodeId EmberChildData::id

Definition at line 1267 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

phy#

uint8_t EmberChildData::phy

Definition at line 1268 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

power#

uint8_t EmberChildData::power

Definition at line 1269 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

timeout#

uint8_t EmberChildData::timeout

Definition at line 1270 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

type#

EmberBindingType EmberBindingTableEntry::type

The type of binding.


Definition at line 1281 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

local#

uint8_t EmberBindingTableEntry::local

The endpoint on the local node.


Definition at line 1283 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

clusterId#

uint16_t EmberBindingTableEntry::clusterId

A cluster ID that matches one from the local endpoint's simple descriptor. This cluster ID is set by the provisioning application to indicate which part an endpoint's functionality is bound to this particular remote node and is used to distinguish between unicast and multicast bindings. Note that a binding can be used to to send messages with any cluster ID, not just that listed in the binding.


Definition at line 1291 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

remote#

uint8_t EmberBindingTableEntry::remote

The endpoint on the remote node (specified by identifier).


Definition at line 1293 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

identifier#

EmberEUI64 EmberBindingTableEntry::identifier

A 64-bit identifier. This is either:

  • The destination EUI64, for unicasts.

  • A 16-bit multicast group address, for multicasts.


Definition at line 1298 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

networkIndex#

uint8_t EmberBindingTableEntry::networkIndex

The index of the network the binding belongs to.


Definition at line 1300 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

shortId#

uint16_t EmberNeighborTableEntry::shortId

The neighbor's two-byte network ID.


Definition at line 1310 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

averageLqi#

uint8_t EmberNeighborTableEntry::averageLqi

An exponentially weighted moving average of the link quality values of incoming packets from this neighbor as reported by the PHY.


Definition at line 1313 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

inCost#

uint8_t EmberNeighborTableEntry::inCost

The incoming cost for this neighbor, computed from the average LQI. Values range from 1 for a good link to 7 for a bad link.


Definition at line 1316 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

outCost#

uint8_t EmberNeighborTableEntry::outCost

The outgoing cost for this neighbor, obtained from the most recently received neighbor exchange message from the neighbor. A value of zero means that a neighbor exchange message from the neighbor has not been received recently enough, or that our ID was not present in the most recently received one. EmberZNet Pro only.


Definition at line 1323 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

age#

uint8_t EmberNeighborTableEntry::age

In EmberZNet Pro, the number of aging periods elapsed since a neighbor exchange message was last received from this neighbor. In stack profile 1, the number of aging periods since any packet was received. An entry with an age greater than 3 is considered stale and may be reclaimed. The aging period is 16 seconds.


Definition at line 1329 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

longId#

EmberEUI64 EmberNeighborTableEntry::longId

The 8 byte EUI64 of the neighbor.


Definition at line 1331 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

destination#

uint16_t EmberRouteTableEntry::destination

The short ID of the destination.


Definition at line 1341 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

nextHop#

uint16_t EmberRouteTableEntry::nextHop

The short ID of the next hop to this destination.


Definition at line 1343 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

status#

uint8_t EmberRouteTableEntry::status

Indicates whether this entry is active (0), being discovered (1), or unused (3).


Definition at line 1346 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

age#

uint8_t EmberRouteTableEntry::age

The number of seconds since this route entry was last used to send a packet.


Definition at line 1349 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

concentratorType#

uint8_t EmberRouteTableEntry::concentratorType

Indicates whether this destination is a High-RAM Concentrator (2), a Low-RAM Concentrator (1), or not a concentrator (0).


Definition at line 1352 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

routeRecordState#

uint8_t EmberRouteTableEntry::routeRecordState

For a High-RAM Concentrator, indicates whether a route record is needed (2), has been sent (1), or is no long needed (0) because a source routed message from the concentrator has been received.


Definition at line 1357 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

multicastId#

EmberMulticastId EmberMulticastTableEntry::multicastId

The multicast group ID.


Definition at line 1369 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

endpoint#

uint8_t EmberMulticastTableEntry::endpoint

The endpoint that is a member, or 0 if this entry is not in use (the ZDO is not a member of any multicast groups).


Definition at line 1373 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

networkIndex#

uint8_t EmberMulticastTableEntry::networkIndex

The network index of the network the entry is related to.


Definition at line 1375 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

backgroundRx#

uint8_t EmberMultiprotocolPriorities::backgroundRx

The priority of a Zigbee RX operation while not receiving a packet.


Definition at line 1557 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

tx#

uint8_t EmberMultiprotocolPriorities::tx

The priority of a Zigbee TX operation.


Definition at line 1559 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

activeRx#

uint8_t EmberMultiprotocolPriorities::activeRx

The priority of a Zigbee RX operation while receiving a packet.


Definition at line 1561 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

data#

uint8_t EmberCounterInfo::data

Definition at line 1612 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

otherFields#

void* EmberCounterInfo::otherFields

Definition at line 1613 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

phy_index#

uint8_t EmberExtraCounterInfo::phy_index

Definition at line 1617 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

destinationNodeId#

EmberNodeId EmberExtraCounterInfo::destinationNodeId

Definition at line 1618 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

otherExtraFields#

void* EmberExtraCounterInfo::otherExtraFields

Definition at line 1619 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

status#

EmberEventUnits EmberEventControl::status

The event's status, either inactive or the units for timeToExecute.


Definition at line 1633 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

taskid#

EmberTaskId EmberEventControl::taskid

The ID of the task this event belongs to.


Definition at line 1635 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

timeToExecute#

uint32_t EmberEventControl::timeToExecute

Indicates how long before the event fires. Units are milliseconds.


Definition at line 1639 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

control#

EmberEventControl* EmberEventData::control

The control structure for the event.


Definition at line 1651 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

handler#

void(* EmberEventData::handler) (void)

The procedure to call when the event fires.


Definition at line 1653 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

nextEventTime#

uint32_t EmberTaskControl::nextEventTime

Definition at line 1662 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

events#

EmberEventData* EmberTaskControl::events

Definition at line 1664 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

busy#

bool EmberTaskControl::busy

Definition at line 1666 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

contents#

uint8_t EmberKeyData::contents[EMBER_ENCRYPTION_KEY_SIZE]

This is the key byte data.


Definition at line 1757 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

contents#

uint8_t EmberCertificateData::contents[EMBER_CERTIFICATE_SIZE]

Definition at line 1763 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

contents#

uint8_t EmberPublicKeyData::contents[EMBER_PUBLIC_KEY_SIZE]

Definition at line 1769 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

contents#

uint8_t EmberPrivateKeyData::contents[EMBER_PRIVATE_KEY_SIZE]

Definition at line 1775 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

contents#

uint8_t EmberSmacData::contents[EMBER_SMAC_SIZE]

Definition at line 1781 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

contents#

uint8_t EmberSignatureData::contents[EMBER_SIGNATURE_SIZE]

Definition at line 1788 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

contents#

uint8_t EmberMessageDigest::contents[EMBER_AES_HASH_BLOCK_SIZE]

Definition at line 1794 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

result#

uint8_t EmberAesMmoHashContext::result[EMBER_AES_HASH_BLOCK_SIZE]

Definition at line 1801 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

length#

uint32_t EmberAesMmoHashContext::length

Definition at line 1802 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

contents#

uint8_t EmberCertificate283k1Data::contents[EMBER_CERTIFICATE_283K1_SIZE]

Definition at line 1809 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

contents#

uint8_t EmberPublicKey283k1Data::contents[EMBER_PUBLIC_KEY_283K1_SIZE]

Definition at line 1815 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

contents#

uint8_t EmberPrivateKey283k1Data::contents[EMBER_PRIVATE_KEY_283K1_SIZE]

Definition at line 1821 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

contents#

uint8_t EmberSignature283k1Data::contents[EMBER_SIGNATURE_283K1_SIZE]

Definition at line 1829 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

bitmask#

uint16_t EmberInitialSecurityState::bitmask

This bitmask enumerates which security features should be used and the presence of valid data within other elements of the EmberInitialSecurityState data structure. For more details, see the EmberInitialSecurityBitmask.


Definition at line 2017 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

preconfiguredKey#

EmberKeyData EmberInitialSecurityState::preconfiguredKey

This is the pre-configured key that can be used by devices when joining the network if the Trust Center does not send the initial security data in-the-clear. For the Trust Center, it will be the global link key and must be set regardless of whether joining devices are expected to have a pre-configured Link Key. This parameter will only be used if the EmberInitialSecurityState::bitmask sets the bit indicating EMBER_HAVE_PRECONFIGURED_KEY.


Definition at line 2026 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

networkKey#

EmberKeyData EmberInitialSecurityState::networkKey

This is the Network Key used when initially forming the network. It must be set on the Trust Center and is not needed for devices joining the network. This parameter will only be used if the EmberInitialSecurityState::bitmask sets the bit indicating EMBER_HAVE_NETWORK_KEY.


Definition at line 2032 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

networkKeySequenceNumber#

uint8_t EmberInitialSecurityState::networkKeySequenceNumber

This is the sequence number associated with the network key. It must be set if the Network Key is set and is used to indicate a particular of the network key for updating and switching. This parameter will only be used if the EMBER_HAVE_NETWORK_KEY is set. Generally, it should be set to 0 when forming the network; joining devices can ignore this value.


Definition at line 2039 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

preconfiguredTrustCenterEui64#

EmberEUI64 EmberInitialSecurityState::preconfiguredTrustCenterEui64

This is the long address of the trust center on the network that will be joined. It is usually NOT set prior to joining the network and is learned during the joining message exchange. This field is only examined if EMBER_HAVE_TRUST_CENTER_EUI64 is set in the EmberInitialSecurityState::bitmask. Most devices should clear that bit and leave this field alone. This field must be set when using commissioning mode. It is required to be in little-endian format.


Definition at line 2047 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

bitmask#

EmberCurrentSecurityBitmask EmberCurrentSecurityState::bitmask

This bitmask indicates the security features currently in use on this node.


Definition at line 2093 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

trustCenterLongAddress#

EmberEUI64 EmberCurrentSecurityState::trustCenterLongAddress

This indicates the EUI64 of the Trust Center. It will be all zeroes if the Trust Center Address is not known (i.e., the device is in a Distributed Trust Center network).


Definition at line 2097 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

eui64#

EmberEUI64 EmberTransientKeyData::eui64

Definition at line 2140 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

keyData#

EmberKeyData EmberTransientKeyData::keyData

Definition at line 2141 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

incomingFrameCounter#

uint32_t EmberTransientKeyData::incomingFrameCounter

Definition at line 2142 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

bitmask#

EmberKeyStructBitmask EmberTransientKeyData::bitmask

Definition at line 2143 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

remainingTimeSeconds#

uint16_t EmberTransientKeyData::remainingTimeSeconds

Definition at line 2144 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

networkIndex#

uint8_t EmberTransientKeyData::networkIndex

Definition at line 2145 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

bitmask#

EmberKeyStructBitmask EmberKeyStruct::bitmask

This bitmask indicates whether various fields in the structure contain valid data. It also contains the index of the network the key belongs to.


Definition at line 2173 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

type#

EmberKeyType EmberKeyStruct::type

This indicates the type of the security key.


Definition at line 2175 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

key#

EmberKeyData EmberKeyStruct::key

This is the actual key data.


Definition at line 2177 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

outgoingFrameCounter#

uint32_t EmberKeyStruct::outgoingFrameCounter

This is the outgoing frame counter associated with the key. It will contain valid data based on the EmberKeyStructBitmask.


Definition at line 2180 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

incomingFrameCounter#

uint32_t EmberKeyStruct::incomingFrameCounter

This is the incoming frame counter associated with the key. It will contain valid data based on the EmberKeyStructBitmask.


Definition at line 2183 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

sequenceNumber#

uint8_t EmberKeyStruct::sequenceNumber

This is the sequence number associated with the key. It will contain valid data based on the EmberKeyStructBitmask.


Definition at line 2186 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

partnerEUI64#

EmberEUI64 EmberKeyStruct::partnerEUI64

This is the Partner EUI64 associated with the key. It will contain valid data based on the EmberKeyStructBitmask.


Definition at line 2189 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

keySettings#

EmberKeySettings EmberMfgSecurityStruct::keySettings

Definition at line 2413 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

limitThresh#

EmberDutyCycleHectoPct EmberDutyCycleLimits::limitThresh

The Limited Threshold in % * 100.


Definition at line 2430 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

critThresh#

EmberDutyCycleHectoPct EmberDutyCycleLimits::critThresh

The Critical Threshold in % * 100.


Definition at line 2432 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

suspLimit#

EmberDutyCycleHectoPct EmberDutyCycleLimits::suspLimit

The Suspended Limit (LBT) in % * 100.


Definition at line 2434 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

nodeId#

EmberNodeId EmberPerDeviceDutyCycle::nodeId

Node ID of the device whose duty cycle is reported.


Definition at line 2468 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

dutyCycleConsumed#

EmberDutyCycleHectoPct EmberPerDeviceDutyCycle::dutyCycleConsumed

The amount of overall duty cycle consumed (up to suspend limit).


Definition at line 2470 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

nwk_short_address#

EmberNodeId sl_nwk_packet_exchange_t::nwk_short_address

Node ID of the source or destination.


Definition at line 2479 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

bitmask#

uint8_t sl_nwk_packet_exchange_t::bitmask

A bitmask for configuration options.


Definition at line 2481 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

mac_interface_id#

uint8_t sl_nwk_packet_exchange_t::mac_interface_id

The MAC Interface ID.


Definition at line 2483 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

nwk_index#

uint8_t sl_nwk_packet_exchange_t::nwk_index

The Network Index.


Definition at line 2485 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

network_packet#

uint8_t* sl_nwk_packet_exchange_t::network_packet

A pointer to the actual packet.


Definition at line 2487 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

network_packet_length#

uint8_t sl_nwk_packet_exchange_t::network_packet_length

The length of the packet.


Definition at line 2489 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

filterIndexMatch#

uint8_t EmberMacFilterMatchStruct::filterIndexMatch

Definition at line 2527 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

legacyPassthroughType#

EmberMacPassthroughType EmberMacFilterMatchStruct::legacyPassthroughType

Definition at line 2528 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

message#

EmberMessageBuffer EmberMacFilterMatchStruct::message

Definition at line 2529 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

destination#

EmberNodeId SourceRouteTableEntry::destination

Definition at line 3058 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

closerIndex#

uint8_t SourceRouteTableEntry::closerIndex

Definition at line 3059 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

olderIndex#

uint8_t SourceRouteTableEntry::olderIndex

Definition at line 3060 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

minRssiForReceivingPkts#

int8_t EmberBeaconClassificationParams::minRssiForReceivingPkts

Definition at line 3109 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

beaconClassificationMask#

uint16_t EmberBeaconClassificationParams::beaconClassificationMask

Definition at line 3110 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

message#

Buffer EmberTagMapEntry::message

Definition at line 3214 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h

tag#

uint8_t EmberTagMapEntry::tag

Definition at line 3215 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/stack/include/ember-types.h