Energy Meter

class st.zigbee.defaults.energyMeter
zigbee_handlers: table
attribute_configurations: table
capability_handlers: table
default_current_summation_delivered_configuration: st.zigbee.defaults.energyMeter.CurrentSummationDelivered
static energy_meter_handler(driver, device, value, zb_rx)

Default handler for CurrentSummationDelivered attribute on SimpleMetering cluster

This converts the Uint48 CurrentSummationDelivered into the energyMeter.energy capability event. This will check the device for values set in the constants.SIMPLE_METERING_MULTIPLIER_KEY and constants.SIMPLE_METERING_DIVISOR_KEY to convert the raw value to the correctly scaled values. These fields should be set by reading the values from the same cluster

Parameters
static simple_metering_divisor_handler(driver, device, divisor, zb_rx)

Default handler for Divisor attribute on SimpleMetering cluster

This will take the Int24 value of the Divisor on the SimpleMetering cluster and set the devices field constants.SIMPLE_METERING_DIVISOR_KEY to the value. This will then be used in the default handling of the InstantaneousDemand attribute

Parameters
static simple_metering_multiplier_handler(driver, device, multiplier, zb_rx)

Default handler for Multiplier attribute on SimpleMetering cluster

This will take the Int24 value of the Multiplier on the SimpleMetering cluster and set the devices field constants.SIMPLE_METERING_MULTIPLIER_KEY to the value. This will then be used in the default handling of the InstantaneousDemand attribute

Parameters
static reset(driver, device, command)

Default handler for resetting the energy meter reading to zero

This will store the most recent energy meter reading, and all subsequent reports will have this value subtracted from the value reported. Zigbee (unlike Z-Wave) does not provide a way to reset the value to zero, so this is an attempt at a workaround.

Parameters

  • driver (ZigbeeDriver) – The current driver running containing necessary context for execution

  • device (st.zigbee.Device) – The device this message was received from containing identifying information

  • command (CapabilityCommand) – the capability command table