Skip to main content
Entities of the same type, produce similarly structured Readings. This allows you to process them uniformly, regardless of type of device or vehicle your working with. Each Reading may contain several independent metrics. Depending on the type of Entity or it’s manufacturer, some metrics may be omitted because they are irrelevant, temporarly not available, or due to manufacturer limitations.

​
Metrics

​
instantaneousCurrent
amperage
The current flowing through the device at a specific moment, measured in amperes (A).
​
instantaneousVoltage
voltage
The voltage level of the device at a specific moment, measured in volts (V).
​
negativeActiveEnergy
observed injection
The total amount of energy sent back to the grid, measured in kilowatt-hours (kWh).
​
negativeActiveEnergyPhases
observed injection
Breakdown of returned energy by phase, for multi-phase systems.
​
negativeActiveInstantaneousPower
real-time injection
The real-time power being sent back to the grid, measured in watts (W).
​
positiveActiveEnergy
observed consumption
The total amount of energy consumed by the device, measured in kilowatt-hours (kWh).
​
positiveActiveEnergyPhases
observed consumption
Breakdown of consumed energy by phase, for multi-phase systems.
​
positiveActiveInstantaneousPower
real-time consumption
The real-time power being consumed by the device, measured in watts (W).
​
positiveReactiveEnergy
reactive consumption
The reactive energy consumed by the device, typically measured in kilovolt-amperes reactive hours (kVA).
​
positiveGasVolume
volume
The total volume of gas consumed, measured in cubic meters (m³).
​
negativeGasVolume
volume
The volume of gas returned or offset, measured in cubic meters (m³).
​
isCharging
boolean
Indicates whether the device is currently charging (true/false).
​
isPluggedIn
boolean
Shows whether the device is physically connected to a power source (true/false).
​
location
coordinates
The current geographic location of the device in latitude and longitude coordinates.
Only available upon request.
​
locationMatches
locations
An array of Entity-Locations that we’ve matched to this Reading.
​
odometer
distance
The total distance the device has traveled, typically measured in kilometers (km) or miles.
​
range
distance
The estimated distance the device can travel or operate before recharging (or refuelling, in case of PHEV).
​
stateOfCharge
charge
The current charge level of the device’s battery, expressed relative to the maximum charge level.

​
The full object

A reading.

​
data
object

The data of a reading.

​
entityId
string<uuid>

The id of the Entity

​
id
string<uuid>

The id of the reading.

​
measured
string<date-time>

The timestamp of the reading.

​
processed
string<date-time> | null

The timestamp the reading was processed.

​
received
string<date-time> | null

The timestamp the reading was received.