ZCL Meter Identification cluster

nRF5 SDK for Thread and Zigbee v4.2.0

Meter Identification cluster attributes

enum  zb_zcl_meter_identification_attr_e {
  ZB_ZCl_ATTR_METER_IDENTIFICATION_COMPANY_NAME = 0x0000, ZB_ZCl_ATTR_METER_IDENTIFICATION_METER_TYPE_ID = 0x0001, ZB_ZCl_ATTR_METER_IDENTIFICATION_DATA_QUALITY_ID = 0x0004, ZB_ZCl_ATTR_METER_IDENTIFICATION_CUSTOMER_NAME = 0x0005,
  ZB_ZCl_ATTR_METER_IDENTIFICATION_MODEL = 0x0006, ZB_ZCl_ATTR_METER_IDENTIFICATION_PART_NUMBER = 0x0007, ZB_ZCl_ATTR_METER_IDENTIFICATION_PRODUCT_REVISION = 0x0008, ZB_ZCl_ATTR_METER_IDENTIFICATION_SOFTWARE_REVISION = 0x000A,
  ZB_ZCl_ATTR_METER_IDENTIFICATION_UTILITY_NAME = 0x000B, ZB_ZCl_ATTR_METER_IDENTIFICATION_POD = 0x000C, ZB_ZCl_ATTR_METER_IDENTIFICATION_AVAILABLE_POWER = 0x000D, ZB_ZCl_ATTR_METER_IDENTIFICATION_POWER_THRESHOLD = 0x000E
}
 Meter Identification server attributes identifiers. More...
 
enum  zb_zcl_meter_identification_meter_type_e {
  ZB_ZCL_METER_TYPE_UTILITY_PRIMARY = 0x0000, ZB_ZCL_METER_TYPE_UTILITY_PRODUCTION = 0x0001, ZB_ZCL_METER_TYPE_UTILITY_SECONDARY = 0x0002, ZB_ZCL_METER_TYPE_PRIVATE_PRIMARY = 0x0100,
  ZB_ZCL_METER_TYPE_PRIVATE_PRODUCTION = 0x0101, ZB_ZCL_METER_TYPE_PRIVATE_SECONDARY = 0x0102, ZB_ZCL_METER_TYPE_GENERIC = 0x0110
}
 
enum  zb_zcl_meter_identification_data_quality_e { ZB_ZCL_DATA_QUALITY_ALL_DATA_CERTIFIED = 0x0000, ZB_ZCL_DATA_QUALITY_ONLY_INSTANTANEOUS_POWER_NOT_CERTIFIED = 0x0001, ZB_ZCL_DATA_QUALITY_ONLY_CUMULATED_CONSUMPTION_NOT_CERTIFIED = 0x0002, ZB_ZCL_DATA_QUALITY_NOT_CERTIFIED_DATA = 0x0003 }
 
typedef enum zb_zcl_meter_identification_meter_type_e zb_zcl_meter_identification_meter_type_t
 
typedef enum zb_zcl_meter_identification_data_quality_e zb_zcl_meter_identification_data_quality_t
 
#define ZB_ZCL_METER_IDENTIFICATION_CLUSTER_REVISION_DEFAULT   ((zb_uint16_t)0x0002u)
 Default value for Meter Identification cluster revision global attribute.
 
#define ZB_ZCl_ATTR_METER_IDENTIFICATION_COMPANY_NAME_DEFAULT_VALUE   { 0 }
 Default value for Company Name attribute.
 
#define ZB_ZCl_ATTR_METER_IDENTIFICATION_METER_TYPE_ID_DEFAULT_VALUE   0
 Default value for Meter Type ID attribute.
 
#define ZB_ZCl_ATTR_METER_IDENTIFICATION_DATA_QUALITY_ID_DEFAULT_VALUE   0
 Default value for Data Quality ID attribute.
 
#define ZB_ZCl_ATTR_METER_IDENTIFICATION_POD_DEFAULT_VALUE   { 0 }
 Default value for POD (Point of Delivery) attribute.
 
#define ZB_ZCl_ATTR_METER_IDENTIFICATION_AVAILABLE_POWER_DEFAULT_VALUE   ZB_INIT_UINT24(0,0)
 Default value for Available Power attribute.
 
#define ZB_ZCl_ATTR_METER_IDENTIFICATION_POWER_THRESHOLD_DEFAULT_VALUE   ZB_INIT_UINT24(0, 0)
 Default value for Power Threshold attribute.
 
#define ZB_ZCl_ATTR_METER_IDENTIFICATION_COMPANY_NAME_MAX_LENGTH   16
 Max length of Company Name attribute.
 
#define ZB_ZCl_ATTR_METER_IDENTIFICATION_POD_MAX_LENGTH   16
 Max length of POD (Point of Delivery) attribute.
 
#define ZB_ZCL_DECLARE_METER_IDENTIFICATION_ATTRIB_LIST(attr_list, company_name, meter_type_id, data_quality_id, pod, available_power, power_threshold)
 Declare attribute list for Thermostat cluster. More...
 

Detailed Description

Macro Definition Documentation

◆ ZB_ZCL_DECLARE_METER_IDENTIFICATION_ATTRIB_LIST

#define ZB_ZCL_DECLARE_METER_IDENTIFICATION_ATTRIB_LIST (   attr_list,
  company_name,
  meter_type_id,
  data_quality_id,
  pod,
  available_power,
  power_threshold 
)
Value:
ZB_ZCL_START_DECLARE_ATTRIB_LIST_CLUSTER_REVISION(attr_list, ZB_ZCL_METER_IDENTIFICATION)  \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_METER_IDENTIFICATION_COMPANY_NAME, (company_name))        \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_METER_IDENTIFICATION_METER_TYPE_ID, (meter_type_id))      \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_METER_IDENTIFICATION_DATA_QUALITY_ID, (data_quality_id))  \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_METER_IDENTIFICATION_POD, (pod))                          \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_METER_IDENTIFICATION_AVAILABLE_POWER, (available_power))  \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_METER_IDENTIFICATION_POWER_THRESHOLD, (power_threshold))  \
  ZB_ZCL_FINISH_DECLARE_ATTRIB_LIST

Declare attribute list for Thermostat cluster.

Parameters
attr_list- attribute list name
company_name- pointer to variable to store Company Name attribute value
meter_type_id- pointer to variable to store Meter Type ID attribute value
data_quality_id- pointer to variable to store Data Quality ID attribute value
pod- pointer to variable to store POD (Point of Delivery) attribute value
available_power- pointer to variable to store Availabe Power attribute value
power_threshold- pointer to variable to store Power Threshold attribute value

Typedef Documentation

◆ zb_zcl_meter_identification_data_quality_t

typedef enum zb_zcl_meter_identification_data_quality_e zb_zcl_meter_identification_data_quality_t

DataQualityID attribute values

See also
ZCL spec, subclause 3.18.2.1.3

◆ zb_zcl_meter_identification_meter_type_t

typedef enum zb_zcl_meter_identification_meter_type_e zb_zcl_meter_identification_meter_type_t

MeterTypeID attribute values

See also
ZCL spec, subclause 3.18.2.1.2

Enumeration Type Documentation

◆ zb_zcl_meter_identification_attr_e

enum zb_zcl_meter_identification_attr_e

Meter Identification server attributes identifiers.

See also
ZCL spec, subclause 3.18.2.1
Enumerator
ZB_ZCl_ATTR_METER_IDENTIFICATION_COMPANY_NAME 

CompanyName is a ZCL Octet String field capable of storing up to 16 character string (the first Octet indicates length) encoded in the UTF-8 format. Company Name defines the meter manufacturer name, decided by manufacturer

ZB_ZCl_ATTR_METER_IDENTIFICATION_METER_TYPE_ID 

MeterTypeID defines the Meter installation features, decided by manufacturer.

ZB_ZCl_ATTR_METER_IDENTIFICATION_DATA_QUALITY_ID 

DataQualityID defines the Meter Simple Metering information certification type, decided by manufacturer.

ZB_ZCl_ATTR_METER_IDENTIFICATION_CUSTOMER_NAME 

CustomerName is a ZCL Character String field capable of storing up to 16 character string (the first Octet indicates length) encoded in the ASCII format.

ZB_ZCl_ATTR_METER_IDENTIFICATION_MODEL 

Model is a ZCL Octet String field capable of storing up to 16 character string (the first Octet indicates length) encoded in the UTF-8 format. Model defines the meter model name, decided by manufacturer.

ZB_ZCl_ATTR_METER_IDENTIFICATION_PART_NUMBER 

PartNumber is a ZCL Octet String field capable of storing up to 16 character string (the first Octet indicates length) encoded in the UTF-8 format. PartNumber defines the meter part number, decided by manufacturer.

ZB_ZCl_ATTR_METER_IDENTIFICATION_PRODUCT_REVISION 

ProductRevision is a ZCL Octet String field capable of storing up to 6 character string (the first Octet indicates length) encoded in the UTF-8 format. ProductRevision defines the meter revision code, decided by manufacturer.

ZB_ZCl_ATTR_METER_IDENTIFICATION_SOFTWARE_REVISION 

SoftwareRevision is a ZCL Octet String field capable of storing up to 6 character string (the first Octet indicates length) encoded in the UTF-8 format. SoftwareRevision defines the meter software revision code, decided by manufacturer.

ZB_ZCl_ATTR_METER_IDENTIFICATION_UTILITY_NAME 

UtilityName is a ZCL Character String field capable of storing up to 16 character string (the first Octet indicates length) encoded in the ASCII format.

ZB_ZCl_ATTR_METER_IDENTIFICATION_POD 

POD (Point of Delivery) is a ZCL Character String field capable of storing up to 16 character string (the first Octet indicates length) encoded in the ASCII format. POD is the unique identification ID of the premise connection point. It is also a contractual information known by the clients and indicated in the bill.

ZB_ZCl_ATTR_METER_IDENTIFICATION_AVAILABLE_POWER 

AvailablePower represents the InstantaneousDemand that can be distributed to the customer (e.g., 3.3KW power) without any risk of overload. The Available Power SHALL use the same formatting conventions as the one used in the simple metering cluster formatting attribute set for the InstantaneousDemand attribute, i.e., the UnitOfMeasure and DemandFormatting.

ZB_ZCl_ATTR_METER_IDENTIFICATION_POWER_THRESHOLD 

PowerThreshold represents a threshold of InstantaneousDemand distributed to the customer (e.g., 4.191KW) that will lead to an imminent risk of overload.

◆ zb_zcl_meter_identification_data_quality_e

enum zb_zcl_meter_identification_data_quality_e

DataQualityID attribute values

See also
ZCL spec, subclause 3.18.2.1.3
Enumerator
ZB_ZCL_DATA_QUALITY_ALL_DATA_CERTIFIED 

All Data Certified

ZB_ZCL_DATA_QUALITY_ONLY_INSTANTANEOUS_POWER_NOT_CERTIFIED 

Only Instantaneous Power not Certified

ZB_ZCL_DATA_QUALITY_ONLY_CUMULATED_CONSUMPTION_NOT_CERTIFIED 

Only Cumulated Consumption not Certified

ZB_ZCL_DATA_QUALITY_NOT_CERTIFIED_DATA 

Not Certified data

◆ zb_zcl_meter_identification_meter_type_e

enum zb_zcl_meter_identification_meter_type_e

MeterTypeID attribute values

See also
ZCL spec, subclause 3.18.2.1.2
Enumerator
ZB_ZCL_METER_TYPE_UTILITY_PRIMARY 

Utility Primary Meter

ZB_ZCL_METER_TYPE_UTILITY_PRODUCTION 

Utility Production Meter

ZB_ZCL_METER_TYPE_UTILITY_SECONDARY 

Utility Secondary Meter

ZB_ZCL_METER_TYPE_PRIVATE_PRIMARY 

Private Primary Meter

ZB_ZCL_METER_TYPE_PRIVATE_PRODUCTION 

Private Production Meter

ZB_ZCL_METER_TYPE_PRIVATE_SECONDARY 

Private Secondary Meters

ZB_ZCL_METER_TYPE_GENERIC 

Generic Meter