diff options
Diffstat (limited to 'Middlewares/ST/STM32_WPAN/zigbee/stack/include/zcl/zcl.temp.meas.h')
| -rw-r--r-- | Middlewares/ST/STM32_WPAN/zigbee/stack/include/zcl/zcl.temp.meas.h | 31 |
1 files changed, 26 insertions, 5 deletions
diff --git a/Middlewares/ST/STM32_WPAN/zigbee/stack/include/zcl/zcl.temp.meas.h b/Middlewares/ST/STM32_WPAN/zigbee/stack/include/zcl/zcl.temp.meas.h index 320ecee86..7f2ac577f 100644 --- a/Middlewares/ST/STM32_WPAN/zigbee/stack/include/zcl/zcl.temp.meas.h +++ b/Middlewares/ST/STM32_WPAN/zigbee/stack/include/zcl/zcl.temp.meas.h @@ -1,4 +1,10 @@ -/* Copyright [2009 - 2020] Exegin Technologies Limited. All rights reserved. */ +/** + * @file zcl.temp.meas.h + * @brief ZCL Temperature Measurement cluster header + * ZCL 7 section 4.4 + * ZCL 8 section 4.4 + * @copyright Copyright [2009 - 2020] Exegin Technologies Limited. All rights reserved. + */ #ifndef ZCL_MEASURE_H # define ZCL_MEASURE_H @@ -26,10 +32,10 @@ /** Temperature Measurement Server Attribute IDs */ enum ZbZclTempMeasSvrAttrT { - ZCL_TEMP_MEAS_ATTR_MEAS_VAL = 0x0000, - ZCL_TEMP_MEAS_ATTR_MIN_MEAS_VAL = 0x0001, - ZCL_TEMP_MEAS_ATTR_MAX_MEAS_VAL = 0x0002, - ZCL_TEMP_MEAS_ATTR_TOLERANCE = 0x0003 + ZCL_TEMP_MEAS_ATTR_MEAS_VAL = 0x0000, /**< MeasuredValue */ + ZCL_TEMP_MEAS_ATTR_MIN_MEAS_VAL = 0x0001, /**< MinMeasuredValue */ + ZCL_TEMP_MEAS_ATTR_MAX_MEAS_VAL = 0x0002, /**< MaxMeasuredValue */ + ZCL_TEMP_MEAS_ATTR_TOLERANCE = 0x0003 /**< Tolerance (Optional) */ }; /* Temperature Measurement Defines */ @@ -43,9 +49,24 @@ enum ZbZclTempMeasSvrAttrT { #define ZCL_TEMP_MEAS_TOLERANCE_MAX 0x0800 /* Temperature Measurement Client */ +/** + * Create a new instance of the Temperature Measurement 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 * ZbZclTempMeasClientAlloc(struct ZigBeeT *zb, uint8_t endpoint); /* Temperature Measurement Server */ +/** + * Create a new instance of the Temperature Measurement Server cluster + * @param zb Zigbee stack instance + * @param endpoint Endpoint on which to create cluster + * @param min Minimum value capable of being measured (MinMeasuredValue) + * @param max Maximum value capable of being measured (MaxMeasuredValue) + * @param tolerance Tolerance + * @return Cluster pointer, or NULL if there is an error + */ struct ZbZclClusterT * ZbZclTempMeasServerAlloc(struct ZigBeeT *zb, uint8_t endpoint, int16_t min, int16_t max, uint16_t tolerance); #endif |