Skip to Content
🚀 We just launched! Please star us on Github!

Electrical Energy Channel

Channel Category: electrical_energy

Measures cumulative energy consumption over time in kilowatt-hours (kWh). The consumption property is a running total; use measurement_kind and reset_behavior metadata to determine how to compute deltas for billing or aggregation.


Required Properties

PropertyData TypeRange/ValuesUnitPermissions
consumptionFloat0–∞kWhRO (Read-Only)

Property Details

consumption

Cumulative total energy consumed since last counter reset, in kWh. Monotonically increasing under normal operation. Use reset_behavior to handle counter resets or rollovers.

Optional Properties

PropertyData TypeRange/ValuesUnitPermissions
average_powerFloat0–100000WRO (Read-Only)
grid_importFloat0–∞kWhRO (Read-Only)
grid_exportFloat0–∞kWhRO (Read-Only)
activeBool--RO (Read-Only)
faultUchar0–255-RO (Read-Only)

Property Details

average_power

Average power draw over the last reporting interval, in watts. Computed by the device as energy delta divided by interval duration. Not an instantaneous reading.

grid_import

Cumulative total energy imported from the public grid into the home since last counter reset, in kWh. Monotonically increasing under normal operation. Only present on devices with a main grid meter. Use reset_behavior to handle counter resets or rollovers.

grid_export

Cumulative total energy exported from the home into the public grid since last counter reset, in kWh. Monotonically increasing under normal operation. Represents excess generation (e.g. PV) fed back to the grid. Use reset_behavior to handle counter resets or rollovers.

active

Indicates if the channel/sensor is currently active and functioning

fault

Fault code or diagnostic indicator (0 = no fault)

Last updated on