> ## Documentation Index
> Fetch the complete documentation index at: https://docs.der-connect.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# The Reading object

> A Reading represents a single snapshot of the state of an Entity.

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

### <Icon icon="bolt" size={18} iconType="solid" /> Related to electricity use & production

<ParamField body="instantaneousCurrent" type="amperage">
  The current flowing through the device at a specific moment, measured in amperes (A).
</ParamField>

<ParamField body="instantaneousVoltage" type="voltage">
  The voltage level of the device at a specific moment, measured in volts (V).
</ParamField>

<ParamField body="negativeActiveEnergy" type="observed injection">
  The total amount of energy sent back to the grid, measured in kilowatt-hours (kWh).
</ParamField>

<ParamField body="negativeActiveEnergyPhases" type="observed injection">
  Breakdown of returned energy by phase, for multi-phase systems.
</ParamField>

<ParamField body="negativeActiveInstantaneousPower" type="real-time injection">
  The real-time power being sent back to the grid, measured in watts (W).
</ParamField>

<ParamField body="positiveActiveEnergy" type="observed consumption">
  The total amount of energy consumed by the device, measured in kilowatt-hours (kWh).
</ParamField>

<ParamField body="positiveActiveEnergyPhases" type="observed consumption">
  Breakdown of consumed energy by phase, for multi-phase systems.
</ParamField>

<ParamField body="positiveActiveInstantaneousPower" type="real-time consumption">
  The real-time power being consumed by the device, measured in watts (W).
</ParamField>

<ParamField body="positiveReactiveEnergy" type="reactive consumption">
  The reactive energy consumed by the device, typically measured in kilovolt-amperes reactive hours (kVA).
</ParamField>

### <Icon icon="fire-flame-simple" size={18} iconType="solid" /> Related to gas use & offset

<ParamField body="positiveGasVolume" type="volume">
  The total volume of gas consumed, measured in cubic meters (m³).
</ParamField>

<ParamField body="negativeGasVolume" type="volume">
  The volume of gas returned or offset, measured in cubic meters (m³).
</ParamField>

### <Icon icon="car-bolt" size={18} iconType="solid" /> Related to EVs

<ParamField body="isCharging" type="boolean">
  Indicates whether the device is currently charging (true/false).
</ParamField>

<ParamField body="isPluggedIn" type="boolean">
  Shows whether the device is physically connected to a power source (true/false).
</ParamField>

<ParamField body="location" type="coordinates">
  The current geographic location of the device in latitude and longitude coordinates.
  <Warning>Only available upon request.</Warning>
</ParamField>

<ParamField body="locationMatches" type="locations">
  An array of Entity-Locations that we've matched to this Reading.
</ParamField>

<ParamField body="odometer" type="distance">
  The total distance the device has traveled, typically measured in kilometers (km) or miles.
</ParamField>

<ParamField body="range" type="distance">
  The estimated distance the device can travel or operate before recharging (or refuelling, in case of PHEV).
</ParamField>

<ParamField body="stateOfCharge" type="charge">
  The current charge level of the device's battery, expressed relative to the maximum charge level.
</ParamField>

## The full object