Api Measurements
The following table lists the available fields for which data can be retrieved via the Eniris Metadata & Telemetry Query API.
Data for a specific field is only available for the specified measurements and retention policies.
Power related fields
| Field name | Description | Unit Of Measurement | Measurement | Retention Policy |
|---|---|---|---|---|
| actualPowerTot_W | Total active power at the current time. | Watt (W) |
⚠️ For the previous measurements: Positive values indicate charging, consumption or import. Negative values indicate discharging or export.
⚠️ For these measurements the values indicate production.
⚠️ For these measurements values indicate consumption. |
|
| childrenStoragePower_W | Total real-time charging or discharging power of all connected batteries at a particular site. | Watt (W) | submeteringMetrics |
|
| childrenProducedPower_W | Total real-time power production of all connected power producing devices at a particular site. | Watt (W) | submeteringMetrics |
|
| childrenEVPower_W | Total real-time power consumption of all connected EV chargers at a particular site. | Watt (W) | submeteringMetrics |
|
| childrenConsumedPower_W | Total real-time power demand of all connected energy consuming devices at a particular site. | Watt (W) | submeteringMetrics | rp_one_m |
| childrenOtherPower_W | Total real-time power consumption of devices that aren't EV chargers or heatpumps at a particular site. | Watt (W) | submeteringMetrics |
|
Energy related fields
| Field name | Description | Unit Of Measurement | Measurement | Retention Policy |
|---|---|---|---|---|
| importedAbsEnergyTot_Wh | Total imported energy | Watt-hour (Wh) |
|
|
| exportedAbsEnergyTot_Wh | Total exported energy | Watt-hour (Wh) |
|
|
| producedAbsEnergyTot_Wh | Total produced energy | Watt-hour (Wh) |
|
|
| consumedAbsEnergyTot_Wh | Total consumed energy | Watt-hour (Wh) |
|
|
| chargedAbsEnergyTot_Wh | Total charged energy | Watt-hour (Wh) |
|
|
| dischargedAbsEnergyTot_Wh | Total discharged energy | Watt-hour (Wh) |
|
|
| importedEnergyDeltaTot_Wh | Imported energy delta between two points in time | Watt-hour (Wh) |
|
|
| exportedEnergyDeltaTot_Wh | Exported energy delta between two points in time | Watt-hour (Wh) |
|
|
| childrenStorageChargedEnergyDeltaTot_Wh | Total charged energy delta between two points in time of all connected batteries at a particular site. | Watt-hour (Wh) | submeteringMetrics |
|
| childrenStorageDischargedEnergyDeltaTot_Wh | Total discharged energy delta between two points in time of all connected batteries at a particular site. | Watt-hour (Wh) | submeteringMetrics |
|
| producedEnergyDeltaTot_Wh | Total produced energy delta between two points in time | Watt-hour (Wh) |
|
|
| chargedEnergyDeltaTot_Wh | Charged energy delta between two points in time | Watt-hour (Wh) |
|
|
| dischargedEnergyDeltaTot_Wh | Discharged energy delta between two points in time | Watt-hour (Wh) |
|
|
Planning related fields
| Field name | Description | Unit Of Measurement | Measurement | Retention Policy |
|---|---|---|---|---|
| powerSetpoint_W | Command power setpoint | Watt (W) | planning |
|
| policy | Command Policy | - | planning |
|
| constraint_ph0_label | Constraint Label | - | planning |
|
| reactivePowerSetpoint_VAr | Reactive Power Setpoint | Volt-Ampere reactive (VAr) | planning |
|
Other fields
| Field name | Description | Unit Of Measurement | Measurement | Retention Policy |
|---|---|---|---|---|
| currentL1_A | Phase 1 (Line 1) current | Ampere (A) |
|
|
| currentL2_A | Phase 2 (Line 2) current | Ampere (A) |
|
|
| currentL3_A | Phase 3 (Line 3) current | Ampere (A) |
|
|
| currentN_A | Neutral current | Ampere (A) |
| rp_one_m |
| voltageL1N_V | Phase 1 to Neutral voltage (Phase Voltage) | Volt (V) |
|
|
| voltageL2N_V | Phase 2 to Neutral voltage (Phase Voltage) | Volt (V) |
|
|
| voltageL3N_V | Phase 3 to Neutral voltage (Phase Voltage) | Volt (V) |
|
|
| voltageL1L2_V | Line-to-Line voltage between Phase 1 and Phase 2 | Volt (V) |
|
|
| voltageL2L3_V | Line-to-Line voltage between Phase 2 and Phase 3 | Volt (V) |
|
|
| voltageL3L1_V | Line-to-Line voltage between Phase 3 and Phase 1 | Volt (V) |
|
|
| frequency_Hz | System frequency | Hertz (Hz) |
|
|
| powerFactorTot | Total power factor | - |
|
|
| powerFactorL1 | Phase 1 power factor | - |
| rp_one_m |
| powerFactorL2 | Phase 2 power factor | - |
| rp_one_m |
| powerFactorL3 | Phase 3 power factor | - |
| rp_one_m |
| voltageDC_V | DC voltage | Volt (V) |
|
|
| currentDC_A | DC current | Ampere (A) |
|
|
| status | Device status (e.g. On, Off, Error) | - |
|
|
| operationMode | Device operation mode | - |
|
|
| stateOfCharge_frac | State of Charge (SoC) | fraction (number between 0 and 1) |
|
|
| stateOfHealth_frac | State of Health (SoH) | fraction (number between 0 and 1) | batteryMetrics | rp_one_m |
| childrenStorageStateOfCharge_frac | Average State of Charge (SoC) of all connected batteries at a particular site. | fraction (number between 0 and 1) | submeteringMetrics |
|
| batteryCurrent_A | Real-time current to/from the battery | Ampere (A) | batteryMetrics |
|
| batteryVoltage_V | Real-time voltage of the battery | Volt (V) | batteryMetrics |
|
| evRequiringCharge | Indicates whether an EV is connected and requires a charge | True or False | evChargerMetrics |
|
| setpoint_W | External signal power setpoint | Watt (W) | externalSignalMetrics |
|
| strategy | External signal strategy | - | externalSignalMetrics |
|
| signalActive | Is an external signal active or not | 0 or 1 | externalSignalMetrics |
|
| reacPowerSetpoint_VAr | Reactive power setpoint | Volt-Ampere reactive (VAr) | externalSignalMetrics |
|
| importLimit_W | Import power limit command for a particular site. | Watt (W) | externalSignalMetrics |
|
| exportLimit_W | Export power limit command for a particular site. | Watt (W) | externalSignalMetrics |
|