Developing with ZBOSS for Zigbee
ZCL Metering Cluster

Modules

 Metering cluster client attributes and enumerations
 
 Metering cluster server attributes and enumerations
 
 Metering cluster commands
 

Data Structures

struct  zb_zcl_metering_attrs_s
 
struct  zb_zcl_metering_attrs_t
 Metering cluster attributes. More...
 

Macros

#define ZB_ZCL_DECLARE_METERING_ATTRIB_LIST(attr_list, curr_summ_delivered, status, unit_of_measure, summation_formatting, metering_device_type)
 Declare attribute list for Electrical Measurement cluster. More...
 
#define ZB_ZCL_DECLARE_METERING_ATTRIB_LIST_EXT(attr_list, curr_summ_delivered, status, unit_of_measure, summation_formatting, metering_device_type, instantaneous_demand, demand_formatting, historical_consumption_formatting, multiplier, divisor)
 Declare attribute list for Electrical Measurement cluster (extended attribute set) More...
 
#define ZB_ZCL_DECLARE_METERING_ATTR_LIST(attr_list, attrs)
 Declare attribute list for Metering cluster cluster. More...
 

Typedefs

typedef struct zb_zcl_metering_attrs_s zb_zcl_metering_attrs_t
 

Detailed Description

The Metering Cluster provides a mechanism to retrieve usage information from Electric, Gas, Water, and potentially Thermal metering devices.

Macro Definition Documentation

◆ ZB_ZCL_DECLARE_METERING_ATTR_LIST

#define ZB_ZCL_DECLARE_METERING_ATTR_LIST (   attr_list,
  attrs 
)
Value:
ZB_ZCL_DECLARE_METERING_ATTRIB_LIST(attr_list, &attrs.curr_summ_delivered, \
&attrs.status, &attrs.unit_of_measure, &attrs.summation_formatting, \
&attrs.device_type)

Declare attribute list for Metering cluster cluster.

Parameters
[in]attr_list- attribute list variable name
[in]attrs- variable of zb_zcl_metering_attrs_t type (containing Metering cluster attributes)

◆ ZB_ZCL_DECLARE_METERING_ATTRIB_LIST

#define ZB_ZCL_DECLARE_METERING_ATTRIB_LIST (   attr_list,
  curr_summ_delivered,
  status,
  unit_of_measure,
  summation_formatting,
  metering_device_type 
)
Value:
ZB_ZCL_START_DECLARE_ATTRIB_LIST(attr_list) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_METERING_CURRENT_SUMMATION_DELIVERED_ID, (curr_summ_delivered)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_METERING_STATUS_ID, (status)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_METERING_UNIT_OF_MEASURE_ID, (unit_of_measure)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_METERING_SUMMATION_FORMATTING_ID, (summation_formatting)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_METERING_METERING_DEVICE_TYPE_ID, (metering_device_type)) \
ZB_ZCL_FINISH_DECLARE_ATTRIB_LIST

Declare attribute list for Electrical Measurement cluster.

Parameters
attr_list- attribute list name
curr_summ_delivered- pointer to variable to store Current Summation Delivered attribute value
status- pointer to variable to store Status attribute value
unit_of_measure- pointer to variable to store Unit Of Measure attribute value
summation_formatting- pointer to variable to store Summation Formatting attribute value
metering_device_type- pointer to variable to store Device Type attribute value

◆ ZB_ZCL_DECLARE_METERING_ATTRIB_LIST_EXT

#define ZB_ZCL_DECLARE_METERING_ATTRIB_LIST_EXT (   attr_list,
  curr_summ_delivered,
  status,
  unit_of_measure,
  summation_formatting,
  metering_device_type,
  instantaneous_demand,
  demand_formatting,
  historical_consumption_formatting,
  multiplier,
  divisor 
)
Value:
ZB_ZCL_START_DECLARE_ATTRIB_LIST(attr_list) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_METERING_CURRENT_SUMMATION_DELIVERED_ID, (curr_summ_delivered)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_METERING_STATUS_ID, (status)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_METERING_UNIT_OF_MEASURE_ID, (unit_of_measure)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_METERING_SUMMATION_FORMATTING_ID, (summation_formatting)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_METERING_METERING_DEVICE_TYPE_ID, (metering_device_type)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_METERING_INSTANTANEOUS_DEMAND_ID, (instantaneous_demand)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_METERING_DEMAND_FORMATTING_ID, (demand_formatting)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_METERING_HISTORICAL_CONSUMPTION_FORMATTING_ID, (historical_consumption_formatting)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_METERING_MULTIPLIER_ID, (multiplier)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_METERING_DIVISOR_ID, (divisor)) \
ZB_ZCL_FINISH_DECLARE_ATTRIB_LIST

Declare attribute list for Electrical Measurement cluster (extended attribute set)

Parameters
attr_list- attribute list name
curr_summ_delivered- pointer to variable to store Current Summ Delivered attribute value
status- pointer to variable to store Status attribute value
unit_of_measure- pointer to variable to store Unit Of Measure attribute value
summation_formatting- pointer to variable to store Summation Formatting attribute value
metering_device_type- pointer to variable to store Device Type attribute value
instantaneous_demand- pointer to variable to store Instantaneous Demand attribute value
demand_formatting- pointer to variable to store Demand Formatting attribute value
historical_consumption_formatting- pointer to variable to store Historical Consumption Formatting attribute value
multiplier- pointer to variable to store Multiplier attribute value
divisor- pointer to variable to store Divisor attribute value
ZB_ZCL_ATTR_METERING_INSTANTANEOUS_DEMAND_ID
@ ZB_ZCL_ATTR_METERING_INSTANTANEOUS_DEMAND_ID
Definition: zb_zcl_metering.h:391
ZB_ZCL_ATTR_METERING_METERING_DEVICE_TYPE_ID
@ ZB_ZCL_ATTR_METERING_METERING_DEVICE_TYPE_ID
Definition: zb_zcl_metering.h:354
ZB_ZCL_ATTR_METERING_CURRENT_SUMMATION_DELIVERED_ID
@ ZB_ZCL_ATTR_METERING_CURRENT_SUMMATION_DELIVERED_ID
Definition: zb_zcl_metering.h:105
ZB_ZCL_ATTR_METERING_HISTORICAL_CONSUMPTION_FORMATTING_ID
@ ZB_ZCL_ATTR_METERING_HISTORICAL_CONSUMPTION_FORMATTING_ID
Definition: zb_zcl_metering.h:351
ZB_ZCL_ATTR_METERING_DEMAND_FORMATTING_ID
@ ZB_ZCL_ATTR_METERING_DEMAND_FORMATTING_ID
Definition: zb_zcl_metering.h:349
ZB_ZCL_ATTR_METERING_SUMMATION_FORMATTING_ID
@ ZB_ZCL_ATTR_METERING_SUMMATION_FORMATTING_ID
Definition: zb_zcl_metering.h:347
ZB_ZCL_ATTR_METERING_DIVISOR_ID
@ ZB_ZCL_ATTR_METERING_DIVISOR_ID
Definition: zb_zcl_metering.h:344
ZB_ZCL_DECLARE_METERING_ATTRIB_LIST
#define ZB_ZCL_DECLARE_METERING_ATTRIB_LIST(attr_list, curr_summ_delivered, status, unit_of_measure, summation_formatting, metering_device_type)
Declare attribute list for Electrical Measurement cluster.
Definition: zb_zcl_metering.h:2434
ZB_ZCL_ATTR_METERING_MULTIPLIER_ID
@ ZB_ZCL_ATTR_METERING_MULTIPLIER_ID
Definition: zb_zcl_metering.h:342
ZB_ZCL_ATTR_METERING_STATUS_ID
@ ZB_ZCL_ATTR_METERING_STATUS_ID
Definition: zb_zcl_metering.h:306
ZB_ZCL_ATTR_METERING_UNIT_OF_MEASURE_ID
@ ZB_ZCL_ATTR_METERING_UNIT_OF_MEASURE_ID
Definition: zb_zcl_metering.h:339