Ember Common Data Types#

Leave and rejoin.

Leave.

To assume trust center is not a concentrator.

To assume trust center is a low RAM concentrator.

To assume trust center is a high RAM concentrator.

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

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

Deny join.

Take no action.

Allow rejoins only.

Input clusters the endpoint will accept.

Output clusters the endpoint can send.

The event is not scheduled to run.

The execution time is in approximate milliseconds.

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

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

The event is scheduled to run at the earliest opportunity.

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.

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

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.

This enumeration causes an unencrypted Network Commissioning Request to be sent out with joinType set to initial join. The trust center may respond by establishing a new dynamic link key and then sending the network key. Network Commissioning Requests should only be sent to parents that support processing of the command.

This enumeration causes an unencrypted Network Commissioning Request to be sent out with joinType set to rejoin. The trust center may respond by establishing a new dynamic link key and then sending the network key. Network Commissioning Requests should only be sent to parents that support processing of the command.

This enumeration causes an encrypted Network Commissioning Request to be sent out with joinType set to rejoin. This enumeration is used by devices that already have the network key and wish to recover connection to a parent or the network in general. Network Commissioning Requests should only be sent to parents that support processing of the command.

The MAC received a broadcast Data frame, Command frame, or Beacon destinationNodeId: BROADCAST_ADDRESS or Data frames or sender node ID for Beacon frames data: not used

The MAC transmitted a broadcast Data frame, Command frame or Beacon. destinationNodeId: BROADCAST_ADDRESS data: not used

The MAC received a unicast Data or Command frame destinationNodeId: MAC layer source or EMBER_UNKNOWN_NODE_ID if no 16-bit source node ID is present in the frame data: not used

The MAC successfully transmitted a unicast Data or Command frame Note: Only frames with a 16-bit destination node ID are counted. destinationNodeId: MAC layer destination address data: not used

The MAC retried a unicast Data or Command frame after initial Tx attempt. Note: CSMA-related failures are tracked separately via EMBER_COUNTER_PHY_CCA_FAIL_COUNT. destinationNodeId: MAC layer destination or EMBER_UNKNOWN_NODE_ID if no 16-bit destination node ID is present in the frame data: number of retries (after initial Tx attempt) accumulated so far for this packet. (Should always be >0.)

The MAC unsuccessfully transmitted a unicast Data or Command frame. Note: Only frames with a 16-bit destination node ID are counted. destinationNodeId: MAC layer destination address data: not used

The APS layer received a data broadcast. destinationNodeId: sender's node ID data: not used

The APS layer transmitted a data broadcast.

The APS layer received a data unicast. destinationNodeId: sender's node ID data: not used

The APS layer successfully transmitted a data unicast. destinationNodeId: NWK destination address data: number of APS retries (>=0) consumed for this unicast.

The APS layer retried a unicast Data frame. 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. However, our supplied Counters component code will attempt to collect this information from the aforementioned counters and populate this counter. Note that this counter's behavior differs from that of EMBER_COUNTER_MAC_TX_UNICAST_RETRY .

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

An entry was added to the neighbor table.

An entry was removed from the neighbor table.

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

A node joined or rejoined to the network via this node. destinationNodeId: node ID of child data: not used

An entry was removed from the child table. destinationNodeId: node ID of child data: not used

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

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

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

A message was dropped at the Network layer because the NWK frame counter was not higher than the last message seen from that source.

A message was dropped at the APS layer because the APS frame counter was not higher than the last message seen from that source. destinationNodeId: node ID of MAC source that relayed the message data: not used

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

An encrypted message was dropped by the APS layer because the sender's key has not been authenticated. As a result, the key is not authorized for use in APS data messages. destinationNodeId: EMBER_NULL_NODE_ID data: APS key table index related to the sender

A NWK encrypted message was received but dropped because decryption failed. destinationNodeId: sender of the dropped packet data: not used

An APS encrypted message was received but dropped because decryption failed. destinationNodeId: sender of the dropped packet data: not used

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.

The number of relayed unicast packets. destinationId: NWK layer destination address of relayed packet data: not used

The number of times a packet was dropped due to reaching the preset PHY-to-MAC queue limit (sli_mac_phy_to_mac_queue_length). The limit will determine how many messages are accepted by the PHY between calls to emberTick(). After that limit is reached, packets will be dropped. The counter records the number of dropped packets.

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.

destinationNodeId: not used data: number of dropped packets represented by this counter event phyIndex: present

The number of times a packet was dropped due to the packet-validate library checking a packet and rejecting it due to length or other formatting problems. destinationNodeId: not used data: type of validation condition that failed

The number of times the NWK retry queue is full and a new message failed to be added. destinationNodeId; not used data: NWK retry queue size that has been exceeded

The number of times the PHY layer was unable to transmit due to a failed CCA (Clear Channel Assessment) attempt. See also: EMBER_COUNTER_MAC_TX_UNICAST_RETRY. destinationNodeId: MAC layer destination or EMBER_UNKNOWN_NODE_ID if no 16-bit destination node ID is present in the frame data: not used

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

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

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

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

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

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

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

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

A placeholder giving the number of Ember counter types.

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

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

Enables devices that perform MAC Association with a pre-configured Network Key to join the network. It is only set on the Trust Center.

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.

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.

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

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

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

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.

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.

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.

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

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

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.

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

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

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

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

This denotes that the device has a Global Link Key. The Trust Center Link Key is the same across multiple nodes.

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

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

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

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

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

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

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

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.

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

This indicates that the actual key data is stored in PSA, and the respective PSA ID is recorded in the psa_id field.

This indicates that the keyData field has valid data. On certain parts and depending on the security configuration, keys may live in secure storage and are not exportable. In such cases, keyData will not house the actual key contents.

This indicates that the key represents a Device Authentication Token and is not an encryption key. The Authentication token is persisted for the lifetime of the device on the network and used to validate and update the device connection. It is only removed when the device leaves or is decommissioned from the network

This indicates that the key has been derived by the Dynamic Link Key feature.

This indicates that the device this key is being used to communicate with supports the APS frame counter synchronization procedure.

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

This denotes that the key is the Current Network Key.

This denotes that the key is the Next Network Key.

This denotes that the key is an Application Link Key.

No duty cycle tracking or metrics are taking place.

Duty Cycle is tracked and has not exceeded any thresholds.

The limited threshold of the total duty cycle allotment was exceeded.

The critical threshold of the total duty cycle allotment was exceeded.

The suspend limit was reached and all outbound transmissions are blocked.

No MAC passthrough messages.

SE InterPAN messages.

EmberNet and first generation (v1) standalone bootloader messages.

EmberNet messages filtered by their source address.

Application-specific passthrough messages.

Custom inter-pan filter.

DEPRECATED

DEPRECATED

Default: don't encrypt broadcasts, encrypt unicasts

Encrypt both broadcasts and unicasts

Do not encrypt broadcasts and unicasts

The device is not joined.

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

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

Communicates only with its parent and will not relay messages.

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

Sleepy end device which transmits with wake up frames (CSL).

Sleepy end device which duty cycles the radio Rx (CSL).

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

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

No options.

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.

Send the message using APS Encryption using the Link Key shared with the destination node to encrypt the data at the APS Level.

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.

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.

Send the message with the NWK 'force route discovery' flag, which causes a route discovery to be initiated even if one is known.

Include the source EUI64 in the network frame.

Include the destination EUI64 in the network frame.

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

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.

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.

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.

Unicast.

Unicast reply.

Multicast.

Multicast sent by the local device.

Broadcast.

Broadcast sent by the local device.

Unicast sent directly to an EmberNodeId.

Unicast sent using an entry in the address table.

Unicast sent using an entry in the binding table.

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

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

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

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

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

Describes an 802.15.4 MAC layer command.

Describes a ZigBee Network layer command.

Describes a ZigBee Application Support layer command.

Describes a ZigBee Device Object command.

Describes a ZigBee Cluster Library command.

Not a MAC command, but enumerated here for simplicity.

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

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.

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

Describes an 802.15.4 MAC layer command.

Describes a ZigBee Network layer data message.

Describes a ZigBee Network layer command.

Describes a ZigBee Application Support layer data message.

Describes a ZigBee Application Support layer command.

Describes a ZigBee Device Object command.

Describes a ZigBee Cluster Library command.

Distinguishing between raw MAC and beacons for simplicity

Describes a ZigBee Light Link message.

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

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

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

The node is currently attempting to join a network.

The node is joined to a network.

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

The node is a Sleepy-to-Sleepy initiator

The node is a Sleepy-to-Sleepy target

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

An energy scan scans each channel for its RSSI value.

An active scan scans each channel for available networks. Use this scan type during network-steering to filter for beacons with available child capacity. The network found callback emberAfNetworkFoundCallback fires for all received beacons, while only beacons matching the capacity criteria and therefore viable for joining are cached

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

A green power channel delivery scan.

An active scan scans each channel for available networks. Use this scan type during network-steering to filter for and cache beacons with available router capacity - Note that this scan type temporarily sets nodeType to EMBER_ROUTER for the duration of the scan process. The network found callback emberAfNetworkFoundCallback fires for all received beacons, while only beacons matching the capacity criteria and therefore viable for joining are cached

A binding that is currently not in use.

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

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.

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.

off

on

reschedule

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 policy means that the local node never sends a route record message (Note: Non-compliant)

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)