nRF5 SDK for Thread and Zigbee v3.2.0
Data Structures
ZCL Diagnostics cluster

Data Structures

struct  zb_zcl_diagnostics_data_s
 Structure saved all diagnostic attribute. More...
 

Diagnostics cluster attributes

enum  zb_zcl_diagnostics_attr_e {
  ZB_ZCL_ATTR_DIAGNOSTICS_NUMBER_OF_RESETS_ID = 0x0000, ZB_ZCL_ATTR_DIAGNOSTICS_PERSISTENT_MEMORY_WRITES_ID = 0x0001, ZB_ZCL_ATTR_DIAGNOSTICS_MAC_RX_BCAST_ID = 0x0100, ZB_ZCL_ATTR_DIAGNOSTICS_MAC_TX_BCAST_ID = 0x0101,
  ZB_ZCL_ATTR_DIAGNOSTICS_MAC_RX_UCAST_ID = 0x0102, ZB_ZCL_ATTR_DIAGNOSTICS_MAC_TX_UCAST_ID = 0x0103, ZB_ZCL_ATTR_DIAGNOSTICS_MAC_TX_UCAST_RETRY_ID = 0x0104, ZB_ZCL_ATTR_DIAGNOSTICS_MAC_TX_UCAST_FAIL_ID = 0x0105,
  ZB_ZCL_ATTR_DIAGNOSTICS_APS_RX_BCAST_ID = 0x0106, ZB_ZCL_ATTR_DIAGNOSTICS_APS_TX_BCAST_ID = 0x0107, ZB_ZCL_ATTR_DIAGNOSTICS_APS_RX_UCAST_ID = 0x0108, ZB_ZCL_ATTR_DIAGNOSTICS_APS_TX_UCAST_SUCCESS_ID = 0x0109,
  ZB_ZCL_ATTR_DIAGNOSTICS_APS_TX_UCAST_RETRY_ID = 0x010A, ZB_ZCL_ATTR_DIAGNOSTICS_APS_TX_UCAST_FAIL_ID = 0x010b, ZB_ZCL_ATTR_DIAGNOSTICS_ROUTE_DISC_INITIATED_ID = 0x010C, ZB_ZCL_ATTR_DIAGNOSTICS_NEIGHBOR_ADDED_ID = 0x010D,
  ZB_ZCL_ATTR_DIAGNOSTICS_NEIGHBOR_REMOVED_ID = 0x010E, ZB_ZCL_ATTR_DIAGNOSTICS_NEIGHBOR_STALE_ID = 0x010F, ZB_ZCL_ATTR_DIAGNOSTICS_JOIN_INDICATION_ID = 0x0110, ZB_ZCL_ATTR_DIAGNOSTICS_CHILD_MOVED_ID = 0x0111,
  ZB_ZCL_ATTR_DIAGNOSTICS_NWKFC_FAILURE_ID = 0x0112, ZB_ZCL_ATTR_DIAGNOSTICS_APSFC_FAILURE_ID = 0x0113, ZB_ZCL_ATTR_DIAGNOSTICS_APS_UNAUTHORIZED_KEY_ID = 0x0114, ZB_ZCL_ATTR_DIAGNOSTICS_NWK_DECRYPT_FAILURES_ID = 0x0115,
  ZB_ZCL_ATTR_DIAGNOSTICS_APS_DECRYPT_FAILURES_ID = 0x0116, ZB_ZCL_ATTR_DIAGNOSTICS_PACKET_BUFFER_ALLOCATE_FAILURES_ID = 0x0117, ZB_ZCL_ATTR_DIAGNOSTICS_RELAYED_UCAST_ID = 0x0118, ZB_ZCL_ATTR_DIAGNOSTICS_PHYTOMACQUEUELIMITREACHED_ID = 0x0119,
  ZB_ZCL_ATTR_DIAGNOSTICS_PACKET_VALIDATEDROPCOUNT_ID = 0x011A, ZB_ZCL_ATTR_DIAGNOSTICS_AVERAGE_MAC_RETRY_PER_APS_ID = 0x011b, ZB_ZCL_ATTR_DIAGNOSTICS_LAST_LQI_ID = 0x011c, ZB_ZCL_ATTR_DIAGNOSTICS_LAST_RSSI_ID = 0x011d
}
 Diagnostics cluster attribute identifiers. More...
 
typedef struct
zb_zcl_diagnostics_data_s 
zb_zcl_diagnostics_data_t
 Structure saved all diagnostic attribute.
 
zb_zcl_diagnostics_data_t diagnostics_data
 
#define ZB_ZCL_DIAGNOSTICS_NUMBER_OF_RESETS_DEFAULT_VALUE   ((zb_uint16_t)0x00000000)
 Default value for NumberOfResets attribute.
 
#define ZB_ZCL_DIAGNOSTICS_PERSISTENT_MEMORY_WRITES_DEFAULT_VALUE   ((zb_uint16_t)0x00000000)
 Default value for PersistentMemoryWrites attribute.
 
#define ZB_ZCL_DIAGNOSTICS_MAC_RX_BCAST_DEFAULT_VALUE   ((zb_uint32_t)0)
 Default value for MacRxBcast attribute.
 
#define ZB_ZCL_DIAGNOSTICS_MAC_TX_BCAST_DEFAULT_VALUE   ((zb_uint32_t)0)
 Default value for MacTxBcast attribute.
 
#define ZB_ZCL_DIAGNOSTICS_MAC_RX_UCAST_DEFAULT_VALUE   ((zb_uint32_t)0)
 Default value for MacRxUcast attribute.
 
#define ZB_ZCL_DIAGNOSTICS_MAC_TX_UCAST_DEFAULT_VALUE   ((zb_uint32_t)0)
 Default value for MacTxUcast attribute.
 
#define ZB_ZCL_DIAGNOSTICS_MAC_TX_UCAST_RETRY_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for MacTxUcastRetry attribute.
 
#define ZB_ZCL_DIAGNOSTICS_MAC_TX_UCAST_FAIL_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for MacTxUcastFail attribute.
 
#define ZB_ZCL_DIAGNOSTICS_APS_RX_BCAST_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for APSRxBcast attribute.
 
#define ZB_ZCL_DIAGNOSTICS_APS_TX_BCAST_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for APSTxBcast attribute.
 
#define ZB_ZCL_DIAGNOSTICS_APS_RX_UCAST_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for APSRxUcast attribute.
 
#define ZB_ZCL_DIAGNOSTICS_APS_TX_UCAST_SUCCESS_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for APSTxUcastSuccess attribute.
 
#define ZB_ZCL_DIAGNOSTICS_APS_TX_UCAST_RETRY_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for APSTxUcastRetry attribute.
 
#define ZB_ZCL_DIAGNOSTICS_APS_TX_UCAST_FAIL_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for APSTxUcastFail attribute.
 
#define ZB_ZCL_DIAGNOSTICS_ROUTE_DISC_INITIATED_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for RouteDiscInitiated attribute.
 
#define ZB_ZCL_DIAGNOSTICS_NEIGHBOR_ADDED_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for NeighborAdded attribute.
 
#define ZB_ZCL_DIAGNOSTICS_NEIGHBOR_REMOVED_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for NeighborRemoved attribute.
 
#define ZB_ZCL_DIAGNOSTICS_NEIGHBOR_STALE_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for NeighborStale attribute.
 
#define ZB_ZCL_DIAGNOSTICS_JOIN_INDICATION_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for JoinIndication attribute.
 
#define ZB_ZCL_DIAGNOSTICS_CHILD_MOVED_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for ChildMoved attribute.
 
#define ZB_ZCL_DIAGNOSTICS_NWKFC_FAILURE_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for NWKFCFailure attribute.
 
#define ZB_ZCL_DIAGNOSTICS_APSFC_FAILURE_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for APSFCFailure attribute.
 
#define ZB_ZCL_DIAGNOSTICS_APS_UNAUTHORIZED_KEY_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for APSUnauthorizedKey attribute.
 
#define ZB_ZCL_DIAGNOSTICS_NWK_DECRYPT_FAILURES_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for NWKDecryptFailures attribute.
 
#define ZB_ZCL_DIAGNOSTICS_APS_DECRYPT_FAILURES_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for APSDecryptFailures attribute.
 
#define ZB_ZCL_DIAGNOSTICS_PACKET_BUFFER_ALLOCATE_FAILURES_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for PacketBufferAllocateFailures attribute.
 
#define ZB_ZCL_DIAGNOSTICS_RELAYED_UCAST_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for RelayedUcast attribute.
 
#define ZB_ZCL_DIAGNOSTICS_PHYTO_MA_CQUEUELIMITREACHED_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for PhytoMACqueuelimitreached attribute.
 
#define ZB_ZCL_DIAGNOSTICS_PACKET_VALIDATEDROPCOUNT_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for PacketValidatedropcount attribute.
 
#define ZB_ZCL_DIAGNOSTICS_AVERAGE_MAC_RETRY_PER_APS_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for AverageMACRetryPerAPS attribute.
 
#define ZB_ZCL_DIAGNOSTICS_LAST_LQI_DEFAULT_VALUE   ((zb_uint8_t)0)
 Default value for LastLQI attribute.
 
#define ZB_ZCL_DIAGNOSTICS_LAST_RSSI_DEFAULT_VALUE   ((zb_int8_t)0)
 Default value for LastRSSI attribute.
 
#define ZB_ZCL_DECLARE_DIAGNOSTICS_ATTRIB_LIST(attr_list)
 Declare attribute list for Diagnostics cluster - server side. More...
 

Detailed Description

ZCL Diagnostics cluster definitions

Macro Definition Documentation

#define ZB_ZCL_DECLARE_DIAGNOSTICS_ATTRIB_LIST (   attr_list)
Value:
ZB_ZCL_START_DECLARE_ATTRIB_LIST(attr_list) \
&(diagnostics_data.numberOfResets)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_DIAGNOSTICS_MAC_RX_BCAST_ID, &(diagnostics_data.macRxBcast)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_DIAGNOSTICS_MAC_TX_BCAST_ID, &(diagnostics_data.macTxBcast)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_DIAGNOSTICS_MAC_TX_UCAST_ID, &(diagnostics_data.macTxUcast)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_DIAGNOSTICS_APS_TX_BCAST_ID, &(diagnostics_data.apsTxBcast)) \
&(diagnostics_data.apsTxUcastSuccess)) \
&(diagnostics_data.apsTxUcastFail)) \
&(diagnostics_data.packetBufferAllocateFeatures)) \
&(diagnostics_data.joinIndication)) \
&(diagnostics_data.packetBufferAllocateFeatures)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_DIAGNOSTICS_LAST_LQI_ID, &(diagnostics_data.lastMessageLQI)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_DIAGNOSTICS_LAST_RSSI_ID, &(diagnostics_data.lastMessageRSSI)) \
ZB_ZCL_FINISH_DECLARE_ATTRIB_LIST
zb_uint16_t joinIndication
JoinIndication, Zigbee Diagnostic Cluster spec 1.2.2.2.17.
Definition: zb_zcl_diagnostics.h:81
LastMessageLQI, HA spec 9.3.2.2.2.
Definition: zb_zcl_diagnostics.h:184
zb_uint16_t apsTxUcastFail
APSTxUcastzb_zcl_diagnostics_data_t diagnostics_data;Fail, HA spec 9.3.2.2.2.
Definition: zb_zcl_diagnostics.h:79
zb_uint16_t macTxUcast
MacTxUcast, HA spec 9.3.2.2.2.
Definition: zb_zcl_diagnostics.h:73
AverageMACRetryPerAPSMessageSent, HA spec 9.3.2.2.2.27.
Definition: zb_zcl_diagnostics.h:173
PacketBufferAllocateFeatures, Zigbee Diagnostic Cluster spec 1.2.2.2.24.
Definition: zb_zcl_diagnostics.h:182
zb_uint16_t apsTxBcast
APSTxBcast, HA spec 9.3.2.2.2.
Definition: zb_zcl_diagnostics.h:75
APSTxUcastSuccess, HA spec 9.3.2.2.2.
Definition: zb_zcl_diagnostics.h:131
zb_uint16_t packetBufferAllocateFeatures
JoinIndication, Zigbee Diagnostic Cluster spec 1.2.2.2.24.
Definition: zb_zcl_diagnostics.h:85
MacTxBcast, HA spec 9.3.2.2.2.
Definition: zb_zcl_diagnostics.h:110
zb_uint16_t apsTxUcastSuccess
APSTxUcastSuccess, HA spec 9.3.2.2.2.
Definition: zb_zcl_diagnostics.h:77
APSTxBcast, HA spec 9.3.2.2.2.
Definition: zb_zcl_diagnostics.h:126
zb_uint16_t macTxBcast
MacTxBcast, HA spec 9.3.2.2.2.
Definition: zb_zcl_diagnostics.h:71
LastMessageRSSI, HA spec 9.3.2.2.2.
Definition: zb_zcl_diagnostics.h:186
zb_uint8_t lastMessageLQI
LastMessageLQI, HA spec 9.3.2.2.2.
Definition: zb_zcl_diagnostics.h:87
APSTxUcastFail, HA spec 9.3.2.2.2.
Definition: zb_zcl_diagnostics.h:136
zb_int8_t lastMessageRSSI
LastMessageRSSI, HA spec 9.3.2.2.2.
Definition: zb_zcl_diagnostics.h:89
MacTxUcast, HA spec 9.3.2.2.2.
Definition: zb_zcl_diagnostics.h:115
MacRxBcast, HA spec 9.3.2.2.2.
Definition: zb_zcl_diagnostics.h:108
JoinIndication, HA spec 1.2.2.2.17.
Definition: zb_zcl_diagnostics.h:150
NumberOfResets, Zigbee Diagnostic Cluster spec 1.2.2.1.1.
Definition: zb_zcl_diagnostics.h:104
zb_uint16_t numberOfResets
numberOfResets, Zigbee Diagnostic Cluster spec 1.2.2.1.1
Definition: zb_zcl_diagnostics.h:67
zb_uint16_t macRxBcast
MacRxBcast, HA spec 9.3.2.2.2.
Definition: zb_zcl_diagnostics.h:69

Declare attribute list for Diagnostics cluster - server side.

Parameters
attr_list- attribute list name

Enumeration Type Documentation

Diagnostics cluster attribute identifiers.

See also
HA spec, Diagnostics Cluster 9.3.2.2.2
Enumerator
ZB_ZCL_ATTR_DIAGNOSTICS_NUMBER_OF_RESETS_ID 

NumberOfResets, Zigbee Diagnostic Cluster spec 1.2.2.1.1.

ZB_ZCL_ATTR_DIAGNOSTICS_PERSISTENT_MEMORY_WRITES_ID 

This attribute keeps track of the number of writes to persistent memory.

ZB_ZCL_ATTR_DIAGNOSTICS_MAC_RX_BCAST_ID 

MacRxBcast, HA spec 9.3.2.2.2.

ZB_ZCL_ATTR_DIAGNOSTICS_MAC_TX_BCAST_ID 

MacTxBcast, HA spec 9.3.2.2.2.

ZB_ZCL_ATTR_DIAGNOSTICS_MAC_RX_UCAST_ID 

MacRxUcast Attribute A counter that is incremented each time the MAC layer receives a unicast.

ZB_ZCL_ATTR_DIAGNOSTICS_MAC_TX_UCAST_ID 

MacTxUcast, HA spec 9.3.2.2.2.

ZB_ZCL_ATTR_DIAGNOSTICS_MAC_TX_UCAST_RETRY_ID 

MacTxUcastRetry Attribute A counter that is incremented each time the MAC layer retries a unicast.

ZB_ZCL_ATTR_DIAGNOSTICS_MAC_TX_UCAST_FAIL_ID 

MacTxUcastFail Attribute A counter that is incremented each time the MAC layer fails to send a unicast.

ZB_ZCL_ATTR_DIAGNOSTICS_APS_RX_BCAST_ID 

APSRxBcast Attribute A counter that is incremented each time the APS layer receives a broadcast.

ZB_ZCL_ATTR_DIAGNOSTICS_APS_TX_BCAST_ID 

APSTxBcast, HA spec 9.3.2.2.2.

ZB_ZCL_ATTR_DIAGNOSTICS_APS_RX_UCAST_ID 

APSRxUcast Attribute A counter that is incremented each time the APS layer receives a unicast.

ZB_ZCL_ATTR_DIAGNOSTICS_APS_TX_UCAST_SUCCESS_ID 

APSTxUcastSuccess, HA spec 9.3.2.2.2.

ZB_ZCL_ATTR_DIAGNOSTICS_APS_TX_UCAST_RETRY_ID 

APSTxUcastRetry Attribute A counter that is incremented each time the APS layer retries the sending of a unicast.

ZB_ZCL_ATTR_DIAGNOSTICS_APS_TX_UCAST_FAIL_ID 

APSTxUcastFail, HA spec 9.3.2.2.2.

ZB_ZCL_ATTR_DIAGNOSTICS_ROUTE_DISC_INITIATED_ID 

RouteDiscInitiated Attribute A counter that is incremented each time a route request is initiated .

ZB_ZCL_ATTR_DIAGNOSTICS_NEIGHBOR_ADDED_ID 

NeighborAdded Attribute A counter that is incremented each time an entry is added to the neighbor table.

ZB_ZCL_ATTR_DIAGNOSTICS_NEIGHBOR_REMOVED_ID 

NeighborRemoved Attribute A counter that is incremented each time an entry is removed from the neighbor table.

ZB_ZCL_ATTR_DIAGNOSTICS_NEIGHBOR_STALE_ID 

A counter that is incremented each time a neighbor table entry becomes stale because the neighbor has not been heard from.

ZB_ZCL_ATTR_DIAGNOSTICS_JOIN_INDICATION_ID 

JoinIndication, HA spec 1.2.2.2.17.

ZB_ZCL_ATTR_DIAGNOSTICS_CHILD_MOVED_ID 

A counter that is incremented each time an entry is removed from the child table.

ZB_ZCL_ATTR_DIAGNOSTICS_NWKFC_FAILURE_ID 

A counter that is incremented each time a message is dropped at the network layer because the APS frame counter was not higher than the last message seen from that source.

ZB_ZCL_ATTR_DIAGNOSTICS_APSFC_FAILURE_ID 

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

ZB_ZCL_ATTR_DIAGNOSTICS_APS_UNAUTHORIZED_KEY_ID 

A counter that is incremented each time a message is dropped at the APS layer because it had APS encryption but the key associated with the sender has not been authenticated, and thus the key is not authorized for use in APS data messages.

ZB_ZCL_ATTR_DIAGNOSTICS_NWK_DECRYPT_FAILURES_ID 

A counter that is incremented each time a NWK encrypted message was received but dropped because decryption failed.

ZB_ZCL_ATTR_DIAGNOSTICS_APS_DECRYPT_FAILURES_ID 

A counter that is incremented each time an APS encrypted message was received but dropped because decryption failed.

ZB_ZCL_ATTR_DIAGNOSTICS_PACKET_BUFFER_ALLOCATE_FAILURES_ID 

AverageMACRetryPerAPSMessageSent, HA spec 9.3.2.2.2.27.

ZB_ZCL_ATTR_DIAGNOSTICS_RELAYED_UCAST_ID 

A counter that is incremented each time a unicast packet is relayed.

ZB_ZCL_ATTR_DIAGNOSTICS_PACKET_VALIDATEDROPCOUNT_ID 

A counter that is incremented each time a packet was dropped due to a packet validation error. This could be due to length or other formatting problems in the packet.

ZB_ZCL_ATTR_DIAGNOSTICS_AVERAGE_MAC_RETRY_PER_APS_ID 

PacketBufferAllocateFeatures, Zigbee Diagnostic Cluster spec 1.2.2.2.24.

ZB_ZCL_ATTR_DIAGNOSTICS_LAST_LQI_ID 

LastMessageLQI, HA spec 9.3.2.2.2.

ZB_ZCL_ATTR_DIAGNOSTICS_LAST_RSSI_ID 

LastMessageRSSI, HA spec 9.3.2.2.2.


Documentation feedback | Developer Zone | Subscribe | Updated