nRF5 SDK for Thread and Zigbee v1.0.0
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
ZCL Electrical Measurement cluster

Electrical Measurement cluster attributes

enum  zb_zcl_electrical_measurement_attr_e {
  ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_MEASUREMENT_TYPE_ID = 0x0000, ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_DCPOWER_ID = 0x0106, ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_TOTAL_ACTIVE_POWER_ID = 0x0304, ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_TOTAL_APPARENT_POWER_ID = 0x0306,
  ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_POWER_MULTIPLIER_ID = 0x0402, ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_POWER_DEVISOR_ID = 0x0403, ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_LINE_CURRENT_ID = 0x0501, ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_RMSVOLTAGE_ID = 0x0505,
  ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_RMSCURRENT_ID = 0x0508, ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_ACTIVE_POWER_ID = 0x050B, ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_APPARENT_POWER_ID = 0x050F, ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_POWER_FACTOR_ID = 0x0510,
  ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_AVERAGE_RMSVOLTAGE_MEASUREMENT_PERIOD_ID = 0x0511, ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_ACVOLTAGE_MULTIPLIER_ID = 0x0600, ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_ACVOLTAGE_DIVISOR_ID = 0x0601, ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_ACCURRENT_MULTIPLIER_ID = 0x0602,
  ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_ACCURRENT_DIVISOR_ID = 0x0603, ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_ACPOWER_MULTIPLIER_ID = 0x0604, ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_ACPOWER_DIVISOR_ID = 0x0605, ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_RMSVOLTAGE_PHB_ID = 0x0905,
  ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_RMSCURRENT_PHB_ID = 0x0908, ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_ACTIVE_POWER_PHB_ID = 0x090B, ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_APPARENT_POWER_PHB_ID = 0x090F, ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_AVERAGE_RMSVOLTAGE_MEASUREMENT_PERIOD_PHB_ID = 0x0911,
  ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_RMSVOLTAGE_PHC_ID = 0x0A05, ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_RMSCURRENT_PHC_ID = 0x0A08, ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_ACTIVE_POWER_PHC_ID = 0x0A0B, ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_APPARENT_POWER_PHC_ID = 0x0A0F,
  ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_AVERAGE_RMSVOLTAGE_MEASUREMENT_PERIOD_PHC_ID = 0x0A11
}
 Electrical Measurement cluster attribute identifiers. More...
 
enum  zb_zcl_electrical_measurement_measurement_type_e {
  ZB_ZCL_ELECTRICAL_MEASUREMENT_ACTIVE_MEASUREMENT = 0x00000001, ZB_ZCL_ELECTRICAL_MEASUREMENT_REACTIVE_MEASUREMENT = 0x00000002, ZB_ZCL_ELECTRICAL_MEASUREMENT_APPARENT_MEASUREMENT = 0x00000004, ZB_ZCL_ELECTRICAL_MEASUREMENT_PHASE_A_MEASUREMENT = 0x00000008,
  ZB_ZCL_ELECTRICAL_MEASUREMENT_PHASE_B_MEASUREMENT = 0x00000010, ZB_ZCL_ELECTRICAL_MEASUREMENT_PHASE_C_MEASUREMENT = 0x00000020, ZB_ZCL_ELECTRICAL_MEASUREMENT_DC_MEASUREMENT = 0x00000040, ZB_ZCL_ELECTRICAL_MEASUREMENT_HARMONIC_MEASUREMENT = 0x00000080,
  ZB_ZCL_ELECTRICAL_MEASUREMENT_POWER_QUALITY_MEASUREMENT = 0x00000100, ZB_ZCL_ELECTRICAL_MEASUREMENT_RESERVED = 0x00000200
}
 Bit mapping for Measurement Type attribute,. More...
 
#define ZB_ZCL_ELECTRICAL_MEASUREMENT_MEASUREMENT_TYPE_DEFAULT_VALUE   0x00000000
 Default value for Measurement Type attribute.
 
#define ZB_ZCL_ELECTRICAL_MEASUREMENT_DCPOWER_DEFAULT_VALUE   0x8000
 Default value for DCPower attribute.
 
#define ZB_ZCL_ELECTRICAL_MEASUREMENT_RMSVOLTAGE_DEFAULT_VALUE   0xffff
 Default value for RMSVoltage attribute.
 
#define ZB_ZCL_ELECTRICAL_MEASUREMENT_RMSCURRENT_DEFAULT_VALUE   0xffff
 Default value for RMSCurrent attribute.
 
#define ZB_ZCL_ELECTRICAL_MEASUREMENT_ACTIVE_POWER_DEFAULT_VALUE   0xffff
 Default value for ActivePower attribute.
 
#define ZB_ZCL_ELECTRICAL_MEASUREMENT_POWER_FACTOR_DEFAULT_VALUE   0x0
 Default value for RMSCurrent attribute.
 
#define ZB_ZCL_ELECTRICAL_MEASUREMENT_ACPOWER_MULTIPLIER_DEFAULT_VALUE   0x0001
 Default value for PowerMultiplier attribute.
 
#define ZB_ZCL_ELECTRICAL_MEASUREMENT_ACPOWER_DIVISOR_DEFAULT_VALUE   0x0001
 Default value for PowerDivisor attribute.
 
#define ZB_ZCL_ELECTRICAL_MEASUREMENT_ACCURRENT_MULTIPLIER_DEFAULT_VALUE   0x0001
 Default value for ACCurrentMultiplier attribute.
 
#define ZB_ZCL_ELECTRICAL_MEASUREMENT_ACCURRENT_DIVISOR_DEFAULT_VALUE   0x0001
 Default value for ACCurrentDivisor attribute.
 

Detailed Description

Enumeration Type Documentation

Electrical Measurement cluster attribute identifiers.

See also
HA spec, subclause 9.2.2.2
Enumerator
ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_MEASUREMENT_TYPE_ID 

This attribute indicates a device’s measurement capabilities.

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_DCPOWER_ID 

The DCPower attribute represents the most recent DC power reading in Watts (W)

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_TOTAL_ACTIVE_POWER_ID 

Active power represents the current demand of active power delivered or received at the premises, in kW

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_TOTAL_APPARENT_POWER_ID 

Represents the current demand of apparent power, in kVA

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_POWER_MULTIPLIER_ID 

Provides a value to be multiplied against a raw or uncompensated sensor count of power being measured by the metering device.

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_POWER_DEVISOR_ID 

Provides a value to divide against the results of applying the Multiplier attribute against a raw or uncompensated sensor count of power being measured by the metering device.

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_LINE_CURRENT_ID 

Represents the single phase or Phase A, AC line current (Square root of active and reactive current) value at the moment in time the attribute is read, in Amps (A).

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_RMSVOLTAGE_ID 

Represents the most recent RMS voltage reading in Volts (V).

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_RMSCURRENT_ID 

Represents the most recent RMS current reading in Amps (A).

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_ACTIVE_POWER_ID 

Represents the single phase or Phase A, current demand of active power delivered or received at the premises, in Watts (W).

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_APPARENT_POWER_ID 

Represents the single phase or Phase A, current demand of apparent (Square root of active and reactive power) power, in VA.

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_POWER_FACTOR_ID 

Contains the single phase or PhaseA, Power Factor ratio in 1/100ths.

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_AVERAGE_RMSVOLTAGE_MEASUREMENT_PERIOD_ID 

The Period in seconds that the RMS voltage is averaged over.

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_ACVOLTAGE_MULTIPLIER_ID 

Provides a value to be multiplied against the InstantaneousVoltage and RMSVoltage attributes.

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_ACVOLTAGE_DIVISOR_ID 

Provides a value to be divided against the InstantaneousVoltage and RMSVoltage attributes. This attribute must be used in conjunction with the ACVoltageMultiplier attribute. 0x0000 is an invalid value for this attribute.

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_ACCURRENT_MULTIPLIER_ID 

Provides a value to be multiplied against the InstantaneousCurrent and RMSCurrent attributes

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_ACCURRENT_DIVISOR_ID 

Provides a value to be divided against the ACCurrent, InstantaneousCurrent and RMSCurrent attributes.

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_ACPOWER_MULTIPLIER_ID 

Provides a value to be multiplied against the InstantaneousPower and ActivePower attributes

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_ACPOWER_DIVISOR_ID 

Provides a value to be divided against the InstantaneousPower and ActivePower attributes.

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_RMSVOLTAGE_PHB_ID 

Represents the most recent RMS voltage reading in Volts (V).

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_RMSCURRENT_PHB_ID 

Represents the most recent RMS current reading in Amps (A).

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_ACTIVE_POWER_PHB_ID 

Represents the Phase B, current demand of active power delivered or received at the premises, in Watts (W).

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_APPARENT_POWER_PHB_ID 

Represents the Phase B, current demand of apparent (Square root of active and reactive power) power, in VA.

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_AVERAGE_RMSVOLTAGE_MEASUREMENT_PERIOD_PHB_ID 

The number of times the average RMS voltage, has been above the AverageRMS OverVoltage threshold since last reset.

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_RMSVOLTAGE_PHC_ID 

Represents the most recent RMS voltage reading in Volts (V).

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_RMSCURRENT_PHC_ID 

Represents the most recent RMS current reading in Amps (A).

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_ACTIVE_POWER_PHC_ID 

Represents the Phase C, current demand of active power delivered or received at the premises, in Watts (W).

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_APPARENT_POWER_PHC_ID 

Represents the Phase C, current demand of apparent (Square root of active and reactive power) power, in VA.

ZB_ZCL_ATTR_ELECTRICAL_MEASUREMENT_AVERAGE_RMSVOLTAGE_MEASUREMENT_PERIOD_PHC_ID 

The Period in seconds that the RMS voltage is averaged over

Bit mapping for Measurement Type attribute,.

See also
HA spec, subclause 9.2.2.2.1.1
Enumerator
ZB_ZCL_ELECTRICAL_MEASUREMENT_ACTIVE_MEASUREMENT 

Active Measurement bit

ZB_ZCL_ELECTRICAL_MEASUREMENT_REACTIVE_MEASUREMENT 

Reactive Measurement bit

ZB_ZCL_ELECTRICAL_MEASUREMENT_APPARENT_MEASUREMENT 

Apparent Measurement bit

ZB_ZCL_ELECTRICAL_MEASUREMENT_PHASE_A_MEASUREMENT 

Phase A Measurement bit

ZB_ZCL_ELECTRICAL_MEASUREMENT_PHASE_B_MEASUREMENT 

Phase B Measurement bit

ZB_ZCL_ELECTRICAL_MEASUREMENT_PHASE_C_MEASUREMENT 

Phase C Measurement bit

ZB_ZCL_ELECTRICAL_MEASUREMENT_DC_MEASUREMENT 

DC Measurement bit

ZB_ZCL_ELECTRICAL_MEASUREMENT_HARMONIC_MEASUREMENT 

Harmonic Measurement bit

ZB_ZCL_ELECTRICAL_MEASUREMENT_POWER_QUALITY_MEASUREMENT 

Power Quality Measurement bit