Defines the events reported to the application by the ::emberCounterHandler(). Usage of the destinationNodeId or data fields found in the EmberCounterInfo or EmberExtraCounterInfo structs is denoted for counter types that use them. (See comments accompanying enum definitions in this source file for details.)

Enumeration Members

ADDRESS_CONFLICT_SENT

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

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.

APS_DATA_RX_BROADCAST

The APS layer received a data broadcast.

  • destinationNodeId: sender's node ID
  • data: not used
APS_DATA_RX_UNICAST

The APS layer received a data unicast.

  • destinationNodeId: sender's node ID
  • data: not used
APS_DATA_TX_BROADCAST

The APS layer transmitted a data broadcast.

APS_DATA_TX_UNICAST_FAILED

The APS layer unsuccessfully transmitted a data unicast.

  • destinationNodeId: NWK destination address
  • data: number of APS retries (>=0) consumed for this unicast.
APS_DATA_TX_UNICAST_RETRY

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

::APS_DATA_TX_UNICAST_SUCCESS and

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

::MAC_TX_UNICAST_RETRY .

APS_DATA_TX_UNICAST_SUCCESS

The APS layer successfully transmitted a data unicast.

  • destinationNodeId: NWK destination address
  • data: number of APS retries (>=0) consumed for this unicast.
APS_DECRYPTION_FAILURE

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

  • destinationNodeId: sender of the dropped packet
  • data: not used
APS_FRAME_COUNTER_FAILURE

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

  • destinationNodeId: node ID of MAC source that relayed the message
  • data: not used
APS_LINK_KEY_NOT_AUTHORIZED

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

  • destinationNodeId: EMBER_NULL_NODE_ID
  • data: APS key table index related to the sender
ASH_FRAMING_ERROR

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

ASH_OVERFLOW_ERROR

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

ASH_OVERRUN_ERROR

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

ASH_XOFF

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

BROADCAST_TABLE_FULL

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

CHILD_REMOVED

An entry was removed from the child table.

  • destinationNodeId: node ID of child
  • data: not used
COUNT

A placeholder giving the number of Ember counter types.

JOIN_INDICATION

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

  • destinationNodeId: node ID of child
  • data: not used
MAC_RX_BROADCAST

The MAC received a broadcast Data frame, Command frame, or Beacon.

  • destinationNodeId: BROADCAST_ADDRESS or Data frames or sender node ID for Beacon frames
  • data: not used
MAC_RX_UNICAST

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
MAC_TX_BROADCAST

The MAC transmitted a broadcast Data frame, Command frame or Beacon.

  • destinationNodeId: BROADCAST_ADDRESS
  • data: not used
MAC_TX_UNICAST_FAILED

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

  • destinationNodeId: MAC layer destination address
  • data: not used
MAC_TX_UNICAST_RETRY

The MAC retried a unicast Data or Command frame after initial Tx attempt. Note: CSMA-related failures are tracked separately via 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.)
MAC_TX_UNICAST_SUCCESS

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

  • destinationNodeId: MAC layer destination address
  • data: not used
NEIGHBOR_ADDED

An entry was added to the neighbor table.

NEIGHBOR_REMOVED

An entry was removed from the neighbor table.

NEIGHBOR_STALE

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

NWK_DECRYPTION_FAILURE

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

  • destinationNodeId: sender of the dropped packet
  • data: not used
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.

PACKET_VALIDATE_LIBRARY_DROPPED_COUNT

The number of times a packet was dropped due to the packet-validate library checking a packet and rejecting it due to length or other formatting problems.

  • destinationNodeId: not used
  • data: type of validation condition that failed
PHY_CCA_FAIL_COUNT

The number of times the PHY layer was unable to transmit due to a failed CCA (Clear Channel Assessment) attempt. See also: 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
PHY_TO_MAC_QUEUE_LIMIT_REACHED

The number of times a packet was dropped due to reaching the preset PHY-to-MAC queue limit (sli_mac_phy_to_mac_queue_length). The limit will determine how many messages are accepted by the PHY between calls to 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
PTA_HI_PRI_DENIED

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

PTA_HI_PRI_REQUESTED

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

PTA_HI_PRI_TX_ABORTED

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

PTA_LO_PRI_DENIED

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

PTA_LO_PRI_REQUESTED

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

PTA_LO_PRI_TX_ABORTED

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

RELAYED_UNICAST

The number of relayed unicast packets.

  • destinationId: NWK layer destination address of relayed packet
  • data: not used
ROUTE_DISCOVERY_INITIATED

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

TYPE_NWK_RETRY_OVERFLOW

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

  • destinationNodeId; not used
  • data: NWK retry queue size that has been exceeded