Skip to content

Telemetry ​

Each registered device reports the following keys on every poll.

KeyUnitMeaning
powerWInstantaneous active power
voltageVRMS voltage
currentARMS current
powerFactor-1..1Power factor. Always 0 on the combined total, which has no single meaningful value
totalForwardEnergykWhCumulative energy consumed since the meter was last reset
totalReturnedEnergykWhCumulative energy exported to the grid
validbooleanfalse when the meter could not read the channel

Relay channels ​

A switch:N channel reports the same fields as a meter, plus its relay state:

FieldUnitNotes
activeboolRelay state. This is what the OpenBridge toggle controls.
powerWZero on non-metering relays.
voltageVZero on non-metering relays.
currentAZero on non-metering relays.
totalForwardEnergykWhCumulative, counted by the device itself.

Non-metering relays report zeros rather than omitting the fields, so a channel's telemetry keys stay stable and history charts do not develop gaps if you swap hardware.

Gates ​

A device configured as a gate reports where the gate is instead of electrical readings:

FieldTypeNotes
statestringopen, closed, opening, closing or stopped
targetstringopen or closed: where it was last asked to go
openLimitboolThe fully-open limit switch, as read
closedLimitboolThe fully-closed limit switch, as read
wiringFaultbooltrue when both limits read high, which cannot happen on a working gate

stopped means the gate is between its limits and not believed to be moving, either because a pulse halted it or because it did not reach a limit within travelTime.

Units ​

Gen1 devices report cumulative energy in watt-hours. OpenBridge energy history is kept in kilowatt-hours, so the plugin divides by 1000 before reporting. A raw device value of 224585.1 becomes 224.5851 kWh.

Getting this wrong is silent and expensive: the history chart would read 1000x high and the error would only be obvious months later.

How the total is computed ​

The combined device is not simply a fourth channel:

  • Power uses the device's own total_power when present, falling back to summing channels.
  • Current and energy are summed across channels.
  • Voltage is the mean of the valid channels. Summing three 240 V phases into 720 V would be meaningless.
  • Power factor is reported as 0, since a single figure across phases with different loads would be misleading.

Energy history ​

OpenBridge samples totalForwardEnergy periodically into ~/.openbridge/energy-history/<deviceId>.json and serves day, month and year buckets from it. Because each phase is its own device, each gets its own history file and its own chart.