diff options
Diffstat (limited to 'Middlewares/ST/STM32_WPAN/zigbee/stack/include/zcl/zcl.diagnostics.h')
| -rw-r--r-- | Middlewares/ST/STM32_WPAN/zigbee/stack/include/zcl/zcl.diagnostics.h | 97 |
1 files changed, 58 insertions, 39 deletions
diff --git a/Middlewares/ST/STM32_WPAN/zigbee/stack/include/zcl/zcl.diagnostics.h b/Middlewares/ST/STM32_WPAN/zigbee/stack/include/zcl/zcl.diagnostics.h index 2816d37a9..5e85e4f71 100644 --- a/Middlewares/ST/STM32_WPAN/zigbee/stack/include/zcl/zcl.diagnostics.h +++ b/Middlewares/ST/STM32_WPAN/zigbee/stack/include/zcl/zcl.diagnostics.h @@ -1,4 +1,10 @@ -/* Copyright [2019 - 2020] Exegin Technologies Limited. All rights reserved. */ +/** + * @file zcl.diagnostics.h + * @brief ZCL Diagnostics cluster header + * ZCL 7 section 3.15 + * ZCL 8 section 3.15 + * @copyright Copyright [2019 - 2020] Exegin Technologies Limited. All rights reserved. + */ #ifndef ZCL_DIAGNOSTICS_H #define ZCL_DIAGNOSTICS_H @@ -52,60 +58,73 @@ * DIAG.S.Afffe | False * * Client Attributes - * DIAG.C.Afffd | True - * DIAG.C.Afffe | False + * ILLVL.C.Afffd | True + * ILLVL.C.Afffe | False */ /** Diagnostics Server Attribute IDs */ enum ZbZclDiagSvrAttrT { - ZCL_DIAG_SVR_ATTR_RESETS = 0x0000, - ZCL_DIAG_SVR_ATTR_PERSIST_WRITES = 0x0001, - ZCL_DIAG_SVR_ATTR_MAC_RX_BCAST = 0x0100, - ZCL_DIAG_SVR_ATTR_MAC_TX_BCAST = 0x0101, - ZCL_DIAG_SVR_ATTR_MAC_RX_UCAST = 0x0102, - ZCL_DIAG_SVR_ATTR_MAC_TX_UCAST = 0x0103, - ZCL_DIAG_SVR_ATTR_MAC_TX_UCAST_RETRY = 0x0104, - ZCL_DIAG_SVR_ATTR_MAC_TX_UCAST_FAIL = 0x0105, - ZCL_DIAG_SVR_ATTR_APS_RX_BCAST = 0x0106, - ZCL_DIAG_SVR_ATTR_APS_TX_BCAST = 0x0107, - ZCL_DIAG_SVR_ATTR_APS_RX_UCAST = 0x0108, - ZCL_DIAG_SVR_ATTR_APS_TX_UCAST_SUCCESS = 0x0109, - ZCL_DIAG_SVR_ATTR_APS_TX_UCAST_RETRY = 0x010a, - ZCL_DIAG_SVR_ATTR_APS_TX_UCAST_FAIL = 0x010b, - ZCL_DIAG_SVR_ATTR_ROUTE_DISC_INIT = 0x010c, - ZCL_DIAG_SVR_ATTR_NEIGHBOR_ADDED = 0x010d, - ZCL_DIAG_SVR_ATTR_NEIGHBOUR_REMOVED = 0x010e, - ZCL_DIAG_SVR_ATTR_NEIGHBOUR_STALE = 0x010f, - ZCL_DIAG_SVR_ATTR_JOIN_IND = 0x0110, - ZCL_DIAG_SVR_ATTR_CHILD_MOVED = 0x0111, - ZCL_DIAG_SVR_ATTR_NWK_FC_FAILURE = 0x0112, - ZCL_DIAG_SVR_ATTR_APS_FC_FAILURE = 0x0113, - ZCL_DIAG_SVR_ATTR_APS_UNAUTH_KEY = 0x0114, - ZCL_DIAG_SVR_ATTR_NWK_DECRYPT_FAILS = 0x0115, - ZCL_DIAG_SVR_ATTR_APS_DECRYPT_FAILS = 0x0116, - ZCL_DIAG_SVR_ATTR_PACKET_BUF_ALLOC_FAILS = 0x0117, - ZCL_DIAG_SVR_ATTR_RELAYED_UCAST = 0x0118, - ZCL_DIAG_SVR_ATTR_PHY_MAC_QUEUE_LIM = 0x0119, - ZCL_DIAG_SVR_ATTR_PACKET_VAL_DROP_COUNT = 0x011a, - ZCL_DIAG_SVR_ATTR_AVG_MAC_RETRY_PER_APS_MSG = 0x011b, - ZCL_DIAG_SVR_ATTR_LAST_MSG_LQI = 0x011c, - ZCL_DIAG_SVR_ATTR_LAST_MSG_RSSI = 0x011d, + ZCL_DIAG_SVR_ATTR_RESETS = 0x0000, /**< NumberOfResets (Optional) */ + ZCL_DIAG_SVR_ATTR_PERSIST_WRITES = 0x0001, /**< PersistentMemoryWrites (Optional) */ + ZCL_DIAG_SVR_ATTR_MAC_RX_BCAST = 0x0100, /**< MacRxBcast (Optional) */ + ZCL_DIAG_SVR_ATTR_MAC_TX_BCAST = 0x0101, /**< MacTxBcast (Optional) */ + ZCL_DIAG_SVR_ATTR_MAC_RX_UCAST = 0x0102, /**< MacRxUcast (Optional) */ + ZCL_DIAG_SVR_ATTR_MAC_TX_UCAST = 0x0103, /**< MacTxUcast (Optional) */ + ZCL_DIAG_SVR_ATTR_MAC_TX_UCAST_RETRY = 0x0104, /**< MacTxUcastRetry (Optional) */ + ZCL_DIAG_SVR_ATTR_MAC_TX_UCAST_FAIL = 0x0105, /**< MacTxUcastFail (Optional) */ + ZCL_DIAG_SVR_ATTR_APS_RX_BCAST = 0x0106, /**< APSRxBcast (Optional) */ + ZCL_DIAG_SVR_ATTR_APS_TX_BCAST = 0x0107, /**< APSTxBcast (Optional) */ + ZCL_DIAG_SVR_ATTR_APS_RX_UCAST = 0x0108, /**< APSRxUcast (Optional) */ + ZCL_DIAG_SVR_ATTR_APS_TX_UCAST_SUCCESS = 0x0109, /**< APSTxUcastSuccess (Optional) */ + ZCL_DIAG_SVR_ATTR_APS_TX_UCAST_RETRY = 0x010a, /**< APSTxUcastRetry (Optional) */ + ZCL_DIAG_SVR_ATTR_APS_TX_UCAST_FAIL = 0x010b, /**< APSTxUcastFail (Optional) */ + ZCL_DIAG_SVR_ATTR_ROUTE_DISC_INIT = 0x010c, /**< RouteDiscInitiated (Optional) */ + ZCL_DIAG_SVR_ATTR_NEIGHBOR_ADDED = 0x010d, /**< NeighborAdded (Optional) */ + ZCL_DIAG_SVR_ATTR_NEIGHBOUR_REMOVED = 0x010e, /**< NeighborRemoved (Optional) */ + ZCL_DIAG_SVR_ATTR_NEIGHBOUR_STALE = 0x010f, /**< NeighborStale (Optional) */ + ZCL_DIAG_SVR_ATTR_JOIN_IND = 0x0110, /**< JoinIndication (Optional) */ + ZCL_DIAG_SVR_ATTR_CHILD_MOVED = 0x0111, /**< ChildMoved (Optional) */ + ZCL_DIAG_SVR_ATTR_NWK_FC_FAILURE = 0x0112, /**< NWKFCFailure (Optional) */ + ZCL_DIAG_SVR_ATTR_APS_FC_FAILURE = 0x0113, /**< APSFCFailure (Optional) */ + ZCL_DIAG_SVR_ATTR_APS_UNAUTH_KEY = 0x0114, /**< APSUnauthorizedKey (Optional) */ + ZCL_DIAG_SVR_ATTR_NWK_DECRYPT_FAILS = 0x0115, /**< NWKDecryptFailures (Optional) */ + ZCL_DIAG_SVR_ATTR_APS_DECRYPT_FAILS = 0x0116, /**< APSDecryptFailures (Optional) */ + ZCL_DIAG_SVR_ATTR_PACKET_BUF_ALLOC_FAILS = 0x0117, /**< PacketBufferAllocateFailures (Optional) */ + ZCL_DIAG_SVR_ATTR_RELAYED_UCAST = 0x0118, /**< RelayedUcast (Optional) */ + ZCL_DIAG_SVR_ATTR_PHY_MAC_QUEUE_LIM = 0x0119, /**< PhytoMACqueuelimitreached (Optional) */ + ZCL_DIAG_SVR_ATTR_PACKET_VAL_DROP_COUNT = 0x011a, /**< PacketValidatedropcount (Optional) */ + ZCL_DIAG_SVR_ATTR_AVG_MAC_RETRY_PER_APS_MSG = 0x011b, /**< AverageMACRetryPerAPSMessageSent (Optional) */ + ZCL_DIAG_SVR_ATTR_LAST_MSG_LQI = 0x011c, /**< LastMessageLQI (Optional) */ + ZCL_DIAG_SVR_ATTR_LAST_MSG_RSSI = 0x011d, /**< LastMessageRSSI (Optional) */ }; /*--------------------------------------------------------------- * Diagnostics Client *--------------------------------------------------------------- */ + +/** + * Create a new instance of the Diagnostics Client cluster + * @param zb Zigbee stack instance + * @param endpoint Endpoint on which to create cluster + * @return Cluster pointer, or NULL if there is an error + */ struct ZbZclClusterT * ZbZclDiagClientAlloc(struct ZigBeeT *zb, uint8_t endpoint); /*--------------------------------------------------------------- * Diagnostics Server *--------------------------------------------------------------- */ -/* endpoint - set the Endpoint for this cluster */ -/* profileId - set the Profile ID, unless set to ZCL_PROFILE_WILDCARD. */ -/* minSecurity - can be either: ZB_APS_STATUS_UNSECURED, ZB_APS_STATUS_SECURED_NWK_KEY, or ZB_APS_STATUS_SECURED_LINK_KEY */ -/* Note, only one diagnostics server can be allocated on the device. */ + +/** + * Create a new instance of the Diagnostics Server cluster. Only one Diagnostics Server can be allocated on the device + * @param zb Zigbee stack instance + * @param endpoint Endpoint on which to create cluster + * @param profileId Profile ID setting, unless set to ZCL_PROFILE_WILDCARD + * @param minSecurity Minimum security level can be either: ZB_APS_STATUS_UNSECURED, ZB_APS_STATUS_SECURED_NWK_KEY, or + * ZB_APS_STATUS_SECURED_LINK_KEY + * @return True on success, false otherwise + */ bool ZbZclDiagServerAlloc(struct ZigBeeT *zb, uint8_t endpoint, uint16_t profileId, enum ZbStatusCodeT minSecurity); #endif /* __ZCL_DIAGNOSTICS_H */ |