The Reading object - re.alto Docs

API Reference

Core Resources

Entities
Collectives
Tenants

Onboarding API

Entity Onboarding
Collective Onboarding
Guided Onboarding

Readings API

Readings
Aggregations

Commands API

Charge Sessions API

GET
List all Charge Sessions

Entity Settings

Features
Locations
Battery Capacity
Heated Area
Disaggregators
Custom Properties

Offboarding API

Offboard Entities

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.

data.instantaneousCurrent

object

A phased measurement.

data.instantaneousVoltage

object

A phased measurement.

data.isCharging

boolean | null

A value indicating whether or not the entity is charging.

data.isPluggedIn

boolean | null

A value indicating whether or not the entity is plugged in.

data.location

object

A location measurement.

data.locationMatches

object[] | null

The location of the reading matched to the entity locations.

data.negativeActiveEnergy

object

A tiered measurement.

data.negativeActiveEnergyPhases

object

A phased measurement.

data.negativeActiveInstantaneousPower

object

A phased measurement.

data.negativeGasVolume

object

A measurement.

data.odometer

object

A measurement.

data.positiveActiveEnergy

object

A tiered measurement.

data.positiveActiveEnergyPhases

object

A phased measurement.

data.positiveActiveInstantaneousPower

object

A phased measurement.

data.positiveGasVolume

object

A measurement.

data.positiveReactiveEnergy

object

A tiered measurement.

data.range

object

A measurement.

data.stateOfCharge

object

A measurement.

entityId

string

The id of the Entity

string

The id of the reading.

measured

string

The timestamp of the reading.

processed

string | null

The timestamp the reading was processed.

received

string | null

The timestamp the reading was received.

Was this page helpful?

Create a Guided Onboarding Session List all Readings

{
  "data": {
    "instantaneousCurrent": {
      "l1": 123,
      "l2": 123,
      "l3": 123,
      "total": 123,
      "unit": "<string>"
    },
    "instantaneousVoltage": {
      "l1": 123,
      "l2": 123,
      "l3": 123,
      "total": 123,
      "unit": "<string>"
    },
    "isCharging": true,
    "isPluggedIn": true,
    "location": {
      "address": "<string>",
      "latitude": 123,
      "longitude": 123
    },
    "locationMatches": [
      {
        "accuracy": 123,
        "location": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "label": "<string>"
        }
      }
    ],
    "negativeActiveEnergy": {
      "t1": 123,
      "t2": 123,
      "t3": 123,
      "t4": 123,
      "total": 123,
      "unit": "<string>"
    },
    "negativeActiveEnergyPhases": {
      "l1": 123,
      "l2": 123,
      "l3": 123,
      "total": 123,
      "unit": "<string>"
    },
    "negativeActiveInstantaneousPower": {
      "l1": 123,
      "l2": 123,
      "l3": 123,
      "total": 123,
      "unit": "<string>"
    },
    "negativeGasVolume": {
      "unit": "<string>",
      "value": 123
    },
    "odometer": {
      "unit": "<string>",
      "value": 123
    },
    "positiveActiveEnergy": {
      "t1": 123,
      "t2": 123,
      "t3": 123,
      "t4": 123,
      "total": 123,
      "unit": "<string>"
    },
    "positiveActiveEnergyPhases": {
      "l1": 123,
      "l2": 123,
      "l3": 123,
      "total": 123,
      "unit": "<string>"
    },
    "positiveActiveInstantaneousPower": {
      "l1": 123,
      "l2": 123,
      "l3": 123,
      "total": 123,
      "unit": "<string>"
    },
    "positiveGasVolume": {
      "unit": "<string>",
      "value": 123
    },
    "positiveReactiveEnergy": {
      "t1": 123,
      "t2": 123,
      "t3": 123,
      "t4": 123,
      "total": 123,
      "unit": "<string>"
    },
    "range": {
      "unit": "<string>",
      "value": 123
    },
    "stateOfCharge": {
      "unit": "<string>",
      "value": 123
    }
  },
  "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "measured": "2023-11-07T05:31:56Z",
  "processed": "2023-11-07T05:31:56Z",
  "received": "2023-11-07T05:31:56Z"
}

API Reference

Core Resources

Onboarding API

Readings API

Commands API

Charge Sessions API

Entity Settings

Offboarding API

​Metrics

​ Related to electricity use & production

​ Related to gas use & offset

​ Related to EVs

​The full object

Metrics

Related to electricity use & production

Related to gas use & offset

Related to EVs

The full object