Logo
Developing with ZBOSS for Zigbee
Data Structures | Macros | Functions
zb_zcl_diagnostics.h File Reference
#include "zcl/zb_zcl_common.h"
#include "zcl/zb_zcl_commands.h"

Data Structures

struct  zb_zcl_diagnostics_ctx_s
 

Macros

#define ZB_ZCL_CLUSTER_ID_DIAGNOSTICS_SERVER_ROLE_INIT   zb_zcl_diagnostics_init_server
 
#define ZB_ZCL_CLUSTER_ID_DIAGNOSTICS_CLIENT_ROLE_INIT   zb_zcl_diagnostics_init_client
 

Functions

void zb_zcl_diagnostics_init_server (void)
 
void zb_zcl_diagnostics_init_client (void)
 
zb_ret_t zb_zcl_diagnostics_sync_counters (zb_uint8_t cb_param, zb_callback_t cb)
 Synchronize MAC and ZDO counters with ZCL attributes. More...
 

Diagnostics cluster attributes

#define ZB_ZCL_DIAGNOSTICS_CLUSTER_REVISION_DEFAULT   ((zb_uint16_t)0x0003u)
 Default value for Diagnostics cluster revision global attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_NUMBER_OF_RESETS_DEFAULT_VALUE   ((zb_uint16_t)0x00000000)
 Default value for number_of_resets attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_PERSISTENT_MEMORY_WRITES_DEFAULT_VALUE   ((zb_uint16_t)0x00000000)
 Default value for PersistentMemoryWrites attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_MAC_RX_BCAST_DEFAULT_VALUE   ((zb_uint32_t)0)
 Default value for MacRxBcast attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_MAC_TX_BCAST_DEFAULT_VALUE   ((zb_uint32_t)0)
 Default value for MacTxBcast attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_MAC_RX_UCAST_DEFAULT_VALUE   ((zb_uint32_t)0)
 Default value for MacRxUcast attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_MAC_TX_UCAST_DEFAULT_VALUE   ((zb_uint32_t)0)
 Default value for MacTxUcast attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_MAC_TX_UCAST_RETRY_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for MacTxUcastRetry attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_MAC_TX_UCAST_FAIL_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for MacTxUcastFail attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_APS_RX_BCAST_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for APSRxBcast attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_APS_TX_BCAST_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for aps_tx_bcast attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_APS_RX_UCAST_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for APSRxUcast attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_APS_TX_UCAST_SUCCESS_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for aps_tx_ucast_success attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_APS_TX_UCAST_RETRY_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for APSTxUcastRetry attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_APS_TX_UCAST_FAIL_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for aps_tx_ucast_fail attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_ROUTE_DISC_INITIATED_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for RouteDiscInitiated attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_NEIGHBOR_ADDED_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for NeighborAdded attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_NEIGHBOR_REMOVED_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for NeighborRemoved attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_NEIGHBOR_STALE_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for NeighborStale attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_JOIN_INDICATION_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for join_indication attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_CHILD_MOVED_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for ChildMoved attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_NWKFC_FAILURE_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for nwk_fc_failure attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_APSFC_FAILURE_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for aps_fc_failure attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_APS_UNAUTHORIZED_KEY_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for APSUnauthorizedKey attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_NWK_DECRYPT_FAILURES_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for NWKDecryptFailures attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_APS_DECRYPT_FAILURES_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for APSDecryptFailures attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_PACKET_BUFFER_ALLOCATE_FAILURES_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for packet_buffer_allocate_failures attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_RELAYED_UCAST_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for RelayedUcast attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_PHYTO_MA_CQUEUELIMITREACHED_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for PhytoMACqueuelimitreached attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_PACKET_VALIDATEDROPCOUNT_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for PacketValidatedropcount attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_AVERAGE_MAC_RETRY_PER_APS_DEFAULT_VALUE   ((zb_uint16_t)0)
 Default value for AverageMACRetryPerAPS attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_LAST_LQI_DEFAULT_VALUE   ((zb_uint8_t)0)
 Default value for LastLQI attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_LAST_RSSI_DEFAULT_VALUE   ((zb_int8_t)0)
 Default value for LastRSSI attribute. More...
 
#define ZB_ZCL_DIAGNOSTICS_CUSTOM_ATTR_NWK_RETRY_OVERFLOW_DEFAULT_VALUE   ((zb_uint16_t)0)
 
#define ZB_ZCL_DIAGNOSTICS_CUSTOM_ATTR_PHY_CCA_FAILURES_DEFAULT_VALUE   ((zb_uint16_t)0)
 
#define ZB_ZCL_DIAGNOSTICS_CUSTOM_ATTR_BCAST_TABLE_FULL_DEFAULT_VALUE   ((zb_uint16_t)0)
 
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,
  ZB_ZCL_ATTR_DIAGNOSTICS_CUSTOM_ATTR_NWK_RETRY_OVERFLOW_ID = 0xff00, ZB_ZCL_ATTR_DIAGNOSTICS_CUSTOM_ATTR_PHY_CCA_FAILURES_ID = 0xff01, ZB_ZCL_ATTR_DIAGNOSTICS_CUSTOM_ATTR_BCAST_TABLE_FULL_ID = 0xff02
}
 Diagnostics cluster attribute identifiers. More...
 
typedef struct zb_zcl_diagnostics_ctx_s zb_zcl_diagnostics_ctx_t
 
zb_zcl_diagnostics_ctx_t diagnostics_ctx_zcl
 

Macro Definition Documentation

§ ZB_ZCL_CLUSTER_ID_DIAGNOSTICS_CLIENT_ROLE_INIT

#define ZB_ZCL_CLUSTER_ID_DIAGNOSTICS_CLIENT_ROLE_INIT   zb_zcl_diagnostics_init_client

§ ZB_ZCL_CLUSTER_ID_DIAGNOSTICS_SERVER_ROLE_INIT

#define ZB_ZCL_CLUSTER_ID_DIAGNOSTICS_SERVER_ROLE_INIT   zb_zcl_diagnostics_init_server

Function Documentation

§ zb_zcl_diagnostics_init_client()

void zb_zcl_diagnostics_init_client ( void  )

§ zb_zcl_diagnostics_init_server()

void zb_zcl_diagnostics_init_server ( void  )

§ zb_zcl_diagnostics_sync_counters()

zb_ret_t zb_zcl_diagnostics_sync_counters ( zb_uint8_t  cb_param,
zb_callback_t  cb 
)

Synchronize MAC and ZDO counters with ZCL attributes.

Call this function each time when you want to get an attribute value and process statistic using

When synchronization will be finished, users callback with a specified parameter will be called.

Parameters
cb_param- a parameter of users callback
cb- users callback
Copyright (c) 2012-2022 DSR Corporation, Golden CO, USA. http://www.dsr-zboss.com http://www.dsr-corporation.com
ZBOSS documentation. Wed Oct 29 2025.