diff options
Diffstat (limited to 'Middlewares/ST/STM32_WPAN/zigbee/stack/include/zcl/zcl.illum.meas.h')
-rw-r--r-- | Middlewares/ST/STM32_WPAN/zigbee/stack/include/zcl/zcl.illum.meas.h | 44 |
1 files changed, 27 insertions, 17 deletions
diff --git a/Middlewares/ST/STM32_WPAN/zigbee/stack/include/zcl/zcl.illum.meas.h b/Middlewares/ST/STM32_WPAN/zigbee/stack/include/zcl/zcl.illum.meas.h index d5fd3f613..74cf9af41 100644 --- a/Middlewares/ST/STM32_WPAN/zigbee/stack/include/zcl/zcl.illum.meas.h +++ b/Middlewares/ST/STM32_WPAN/zigbee/stack/include/zcl/zcl.illum.meas.h @@ -1,14 +1,14 @@ -/* Copyright [2009 - 2020] Exegin Technologies Limited. All rights reserved. */ +/** + * @file zcl.illum.meas.h + * @brief ZCL Illuminance Measurement cluster header + * ZCL 7 section 4.2 + * ZCL 8 section 4.2 + * @copyright Copyright [2009 - 2020] Exegin Technologies Limited. All rights reserved. + */ #ifndef ZCL_ILLUM_MEAS_H # define ZCL_ILLUM_MEAS_H -/*-------------------------------------------------------------------------- - * DESCRIPTION - * Interface definition for the ZCL Illuminance Measurement cluster. - *-------------------------------------------------------------------------- - */ - /* PICS.ZCL.Illuminance_Measurement * IM.S | True * IM.C | True @@ -32,17 +32,13 @@ #include "zcl/zcl.h" -/*--------------------------------------------------------------- - * Illuminance Measurement Cluster Definitions - *--------------------------------------------------------------- - */ -/* Illuminance Measurement Server Attribute IDs */ +/** Illuminance Measurement Server Attribute IDs */ enum ZbZclIllumMeasSvrAttrT { - ZCL_ILLUM_MEAS_ATTR_MEAS_VAL = 0x0000, - ZCL_ILLUM_MEAS_ATTR_MIN_MEAS_VAL = 0x0001, - ZCL_ILLUM_MEAS_ATTR_MAX_MEAS_VAL = 0x0002, - ZCL_ILLUM_MEAS_ATTR_TOLERANCE = 0x0003, - ZCL_ILLUM_MEAS_ATTR_LIGHT_SENSOR_TYPE = 0x0004, + ZCL_ILLUM_MEAS_ATTR_MEAS_VAL = 0x0000, /**< MeasuredValue */ + ZCL_ILLUM_MEAS_ATTR_MIN_MEAS_VAL = 0x0001, /**< MinMeasuredValue */ + ZCL_ILLUM_MEAS_ATTR_MAX_MEAS_VAL = 0x0002, /**< MaxMeasuredValue */ + ZCL_ILLUM_MEAS_ATTR_TOLERANCE = 0x0003, /**< Tolerance (Optional) */ + ZCL_ILLUM_MEAS_ATTR_LIGHT_SENSOR_TYPE = 0x0004, /**< LightSensorType (Optional) */ }; /* Illuminance Measurement Defines */ @@ -61,9 +57,23 @@ enum ZbZclIllumMeasSvrAttrT { #define ZCL_ILLUM_MEAS_LIGHT_SENS_TYPE_UNKNOWN 0x00ff /* Illuminance Measurement Client */ +/** + * Create a new instance of the Illuminance 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 * ZbZclIllumMeasClientAlloc(struct ZigBeeT *zb, uint8_t endpoint); /* Illuminance Measurement Server */ +/** + * Create a new instance of the Illuminance 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) + * @return Cluster pointer, or NULL if there is an error + */ struct ZbZclClusterT * ZbZclIllumMeasServerAlloc(struct ZigBeeT *zb, uint8_t endpoint, uint16_t min, uint16_t max); #endif |