STANDARD: Metrics data collection

Last modified by Wim Verheirstraeten on 2024/01/31 11:39

Contents

Introduction
Understanding InfluxDB: retention policies, tags, measurements
- More on retention policies
- More info about InfluxDB
Standard usage of measurements, tags and fields
Example

Introduction

This standard explains how Eniris stores data and how data must be delivered. You will see that fields and metrics are always listed in camelCase https://en.wikipedia.org/wiki/Camel_case.

We also include the unit of the field in the fieldname. This unit is not written in camelcase.

Understanding InfluxDB: retention policies, tags, measurements

Behind the scenes an Influx database is used. The advantage of this system is that it is optimized for efficient storage and querying of time series. Database is organized as follows:

Top level: retention policies. See the following paragraphs.
Within each retention policy there are a series of measurements (Influx terminology, not to be confused with physical measurements). You can imagine such a measurement as a table in Excel (one with not too many columns, but possibly a lot of rows), or as an SQL table.
Within a measurement there are three types of columns: a timestamp, a set of tags and a set of fields.
1. The timestamp shows a time point per row (we call a row a measurement point in this context). This time point does not have to be unique: there can be several measurement points that share the same timestamp.
2. The second column is called the tags set. This is a group of columns that uniquely describes properties of the measurement point. For example, the id of the installation and device that the measurement point was taken on, the used reference system, the type of fuel or gas the measurement is about, etc.
3. The fields contain the values of the actual physical measurements. Depending on the context they can be a float, an int, a boolean, or a string.

Example of how an influx measurement looks like
This could be e.g. a part from the measurement "gridMetrics"

Measurement Example.png

More on retention policies

One particular aspect that plays an important role in the database and that has to be explained within the context of the API, is the idea of so-called 'retention policies'. Data within a certain retention policy is stored for a certain period of time. Once it is over, it will be automatically aggregated to a lower frequency retention policy and rotated out of the database. The Eniris retention policies have names that indicate the maximum update frequency of a particular metric stored within that policy. For example, we have the following retention policies:

'rp_one_s' (één seconde)
'rp_one_m' (één minuut)
'rp_ten_m' (tien minuten)
'rp_one_h' (één uur)
'rp_six_h' (zes uren)

Data stored in a the highest frequency retention policy (rp_one_s) is deleted within 10 days, while data stored in the lowest-rate retention policy (rp_six_h) is retained for decades. The motivation is simple:

The more time has passed since a measurement point, the less of interest the low time scale of the data tends to be.
The amount of data that is stored in the database per series is the product of the frequency of the measurement point and the duration that data is stored. So, by limiting the duration, we limit the amount of data per measuring point.

Before frequent data is circulated, it is automatically aggregated within a retention policy with a lower frequency (to avoid that a user with frequent measurements who clicks back a few days in his history suddenly no longer finds values). This whole story explains why, if you're passing data through the standards, you must indicate the frequency of updates per series by explicitly specifying the retention policy.

Generally speaking, use the retention policy that is closest to the frequency you're pushing data with.

Example: How measurements are contained inside retention policies
The measurements "installationMetrics", "consumptionMetrics" & "gridMetrics" are shown here within the retention policies "rp_one_s", "rp_one_m", "rp_six_h".

Retention policy diagram.png

More info about InfluxDB

https://docs.influxdata.com/influxdb/v1.8/concepts/glossary/

Standard usage of measurements, tags and fields

Measurements

Measurements are organized per typical usage / positioning of a device in real life.

The database has the following measurements:

Electrical energy measurements

Name	Meaning
loadMetrics	Metrics of loads, energy consumers
batteryMetrics	Metrics of batteries (home storage batteries)
submeteringMetrics	Metrics for submetering of different parts of an electrical installation, e.g. of tenants in a building
gridMetrics	Metrics of the main energy exchange with the public distribution grid
solarInverterMetrics	Metrics of solar inverters
solarOptimizerMetrics	Metrics of solar optimizers / MPPT modules
hybridInverterMetrics	Metrics of hybrid inverters (note: only the grid input. For other inputs, use child metadata devices)
windMetrics	Metrics of wind turbines
hydroMetrics	Metrics of hydro turbines
cogenMetrics	Metrics of cogeneration (wkk, warmtekrachtkoppeling)
evChargerMetrics	Metrics of EV charging stations (laadpalen)
meterMetrics	Metrics of all types of meters ( anti injection meter, ...)

Other utility measurements

Name	Meaning
gasMetrics	For natural gas metrics
waterMetrics	For water consumption

Building HVAC measurements

Name	Meaning
ventilationMetrics	For anything related to ventilation and inside air quality. Things like CO2 concentration, individual temperature sensors etc. should also report to this metric.
heatPumpMetrics	For heat pumps
airconditionerMetrics	For air conditioners
heaterMetrics	For fuel based heaters (gas stove, petroleum stove)

Weather related measurements

Name	Meaning
pyranometerMetrics	Metrics of pyranometers

Messages

Messages for alarms, warnings, info, errors, etc. should be sent to the "messages" measurement. It should be used together with the autogen retention policy when the frequency is not regular.

Mandatory extraTags

Tags must always be strings (see also our MQTT documentation).

All measurements must have at least the following tags:

Tag	Possible values	Meaning
id	Any string	Use id that corresponds to the id of the metadata. The user management works on the id level (a user can see measurements per id). If you work with our mqtt standard, the id is already known and should not be specified. The id corresponds to the mqtt username.

Optional extraTags

Tag	Possible values	Meaning
subId	Any string	Optional Use subId for a device that is part of this installation (e.g. a charging station has a string as subId “chargingStation”)
cableType	Any string	Optional (machine data) to specify the cable type.

Fields

Standardized fields shall be used for the measurements as much as possible. Fields is a dictionary with key & value pairs.

Common fields for all metrics

Key	Unit	Type	Value range	Meaning
alive		Integer	0, 1	Indicator that the device is alive. Useful if there is no other data to be reported, but it is desirable to keep track of the connection still existing.

Common electrical fields for loadMetrics, batteryMetrics, gridMetrics, submeteringMetrics, solarInverterMetrics, windMetrics, hydroMetrics, cogenMetrics, evChargerMetrics

Key	Unit	Type	Value range	Meaning
actualPowerL1_W actualPowerL2_W actualPowerL3_W	W	Float		Actual active power of phase L1, L2, L3. For loadMetrics, batteryMetrics, gridMetrics, submeteringMetrics, evChargerMetrics: Positive power = consumed, charging or imported power Negative power = produced, discharging or exported power For solarInverterMetrics, windMetrics, hydroMetrics, cogenMetrics: Positive power = produced power Negative power = consumed power (e.g. autoconsumption of the plant)
actualPowerTot_W	W	Float		Actual total active power; equal to the sum of the active powers of the three phases. For loadMetrics, batteryMetrics, gridMetrics, submeteringMetrics, evChargerMetrics: Positive power = consumed, charging or imported power Negative power = produced, discharging or exported power For solarInverterMetrics, windMetrics, hydroMetrics, cogenMetrics: Positive power = produced power Negative power = consumed power (e.g. autoconsumption of the plant)
reacPowerL1_VAr reacPowerL2_VAr reacPowerL3_VAr	VAr	Float		Reactive power of phase L1, L2, L3 For loadMetrics, batteryMetrics, gridMetrics, submeteringMetrics, evChargerMetrics: Positive reactive power = consumed or imported reactive power Negative reactive power = produced or exported power For solarInverterMetrics, windMetrics, hydroMetrics, cogenMetrics: Positive reactive power = produced reactive power Negative reactive power = consumed reactive power (e.g. autoconsumption of the plant)
reacPowerTot_VAr	VAr	Float		Total reactive power; equal to the sum of the reactive powers of the three phases. For loadMetrics, batteryMetrics, gridMetrics, submeteringMetrics, evChargerMetrics: Positive reactive power = consumed or imported reactive power Negative reactive power = produced or exported power For solarInvertedMetrics, windMetrics, hydroMetrics, cogenMetrics: Positive reactive power = produced reactive power Negative reactive power = consumed reactive power (e.g. autoconsumption of the plant)
frequency_Hz	Hz	Float	≥ 0.0	Actual AC frequency.
currentL1_A currentL2_A currentL3_A currentN_A currentTot_A	A	Float	≥ 0.0	Actual line current of phase L1, L2, L3, or neutral wire
voltageL1N_V voltageL2N_V voltageL3N_V	V	Float	≥ 0.0	Actual voltage between phase L1 and N, L2 and N, L3 and N
voltageL1L2_V voltageL2L3_V voltageL3L1_V	V	Float	≥ 0.0	Actual line-line voltage between phases L1 and L2, L2 and L3, L3 and L1
PF_L1 PF_L2 PF_L3	-	Float	0 - 1	Power factor of phase L1, L2, L3
PF_Tot	-	Float	0 - 1	Overall power factor
currentTHD_L1 currentTHD_L2 currentTHD_L3	-	Float	≥ 0.0	THD of line current in phase L1, L2, L3
voltageTHD_L1N voltageTHD_L2N voltageTHD_L3N	-	Float	≥ 0.0	THD of line-neutral voltage between phase L1 and N, L2 and N, L3 and N
voltageTHD_L1L2 voltageTHD_L2L3 voltageTHD_L3L1	-	Float	≥ 0.0	THD of line-line voltage between phases L1 and L2, L2 and L3, L3 and L1

Electrical energy fields

If the electrical energy is to be calculated from the electrical power over an interval, then e.g. for gridMetrics the energy deltas must be calculated as:
Unknown macro: formula. Click on this message for details.
The [formula] macro is not in the list of registered macros. Verify the spelling or contact your administrator.
This macro is provided by the following compatible extensions: Formula Macro 14.8

Unknown macro: formula. Click on this message for details.

Unknown macro: formula. Click on this message for details.
The [formula] macro is not in the list of registered macros. Verify the spelling or contact your administrator.
This macro is provided by the following compatible extensions: Formula Macro 14.8

Unknown macro: formula. Click on this message for details.

For other measurements this is similar, so that the right energy fields are used! If not, data analysis may fail later to produce correct results.

Energy fields for loadMetrics, solarInverterMetrics, windMetrics, hydroMetrics, cogenMetrics

Key	Unit	Type	Value range	Meaning
consumedEnergyDeltaL1_Wh consumedEnergyDeltaL2_Wh consumedEnergyDeltaL3_Wh	Wh	Float	≥ 0.0	Delta of energy consumed in phase L1, L2, L3 since the previous measurement
consumedEnergyDeltaTot_Wh	Wh	Float	≥ 0.0	Delta of energy consumed in total (sum of the three phases) since the previous measurement
producedEnergyDeltaL1_Wh producedEnergyDeltaL2_Wh producedEnergyDeltaL3_Wh	Wh	Float	≥ 0.0	Delta of energy produced in phase L1, L2, L3 since the previous measurement
producedEnergyDeltaTot_Wh	Wh	Float	≥ 0.0	Delta of energy produced in total (sum of the three phases) since the previous measurement
consumedAbsEnergyL1_Wh consumedAbsEnergyL2_Wh consumedAbsEnergyL3_Wh	Wh	Float	≥ 0.0	Consumed energy absolute counter value for phase L1, L2, L3
consumedAbsEnergyTot_Wh	Wh	Float	≥ 0.0	Consumed energy absolute counter value for the total (sum of the three phases)
producedAbsEnergyL1_Wh producedAbsEnergyL2_Wh producedAbsEnergyL3_Wh	Wh	Float	≥ 0.0	Produced energy absolute counter value for phase L1, L2, L3
producedAbsEnergyTot_Wh	Wh	Float	≥ 0.0	Produced energy absolute counter value for the total (sum of the three phases)
producedEnergyTodayTot_Wh	Wh	Float	≥ 0.0	Produced energy on the given day for the sum of the three phases. The value of the metric at each timestamp reflects how much energy has been produced that day up to the moment of the timestamp.
consumedReacEnergyDeltaL1_VArh consumedReacEnergyDeltaL2_VArh consumedReacEnergyDeltaL3_VArh	VArh	Float	≥ 0.0	Delta of reactive energy consumed in phase L1, L2, L3 since the previous measurement
consumedReacEnergyDeltaTot_VArh	VArh	Float	≥ 0.0	Delta of reactive energy consumed in total (sum of the three phases) since the previous measurement
producedReacEnergyDeltaL1_VArh producedReacEnergyDeltaL2_VArh producedReacEnergyDeltaL3_VArh	VArh	Float	≥ 0.0	Delta of reactive energy produced in phase L1, L2, L3 since the previous measurement
producedReacEnergyDeltaTot_VArh	VArh	Float	≥ 0.0	Delta of reactive energy produced in total (sum of the three phases) since the previous measurement
consumedAbsReacEnergyL1_VArh consumedAbsReacEnergyL2_VArh consumedAbsReacEnergyL3_VArh	VArh	Float	≥ 0.0	Consumed reactive energy absolute counter value for phase L1, L2, L3
consumedAbsReacEnergyTot_VArh	VArh	Float	≥ 0.0	Consumed reactive energy absolute counter value for the total (sum of the three phases)
producedAbsReacEnergyL1_VArh producedAbsReacEnergyL2_VArh producedAbsReacEnergyL3_VArh	VArh	Float	≥ 0.0	Produced reactive energy absolute counter value for phase L1, L2, L3
producedAbsReacEnergyTot_VArh	VArh	Float	≥ 0.0	Produced reactive energy absolute counter value for the total (sum of the three phases)
duration_m	m	Float	≥ 0.0	Operating time of a machine in minutes
duration_h	h	Float	≥ 0.0	Operating time of a machine in hours

Fields for solarInverterMetrics

Key	Unit	Type	Value range	Meaning
insulationLeakResistance_Ohm	Ohm	Float	≥ 0.0	isolation leak resistance

Energy fields for gridMetrics, submeteringMetrics

Key	Unit	Type	Value range	Meaning
importedEnergyDeltaL1_Wh importedEnergyDeltaL2_Wh importedEnergyDeltaL3_Wh	Wh	Float	≥ 0.0	Delta of energy imported in phase L1, L2, L3 since the previous measurement
importedEnergyDeltaTot_Wh	Wh	Float	≥ 0.0	Delta of energy imported in total (sum of the three phases) since the previous measurement
importedPeakEnergyDeltaTot_Wh	Wh	Float	≥ 0.0	Delta of energy imported on peak times in total (sum of the three phases) since the previous measurement
importedOffPeakEnergyDeltaTot_Wh	Wh	Float	≥ 0.0	Delta of energy imported not on peak times in total (sum of the three phases) since the previous measurement
exportedEnergyDeltaL1_Wh exportedEnergyDeltaL2_Wh exportedEnergyDeltaL3_Wh	Wh	Float	≥ 0.0	Delta of energy exported in phase L1, L2, L3 since the previous measurement
exportedEnergyDeltaTot_Wh	Wh	Float	≥ 0.0	Delta of energy exported in total (sum of the three phases) since the previous measurement
autoconsumedEnergyDeltaTot_Wh	Wh	Float	≥ 0.0	Delta of energy produced by the children of the energy meter that is NOT exported. This can be used for calculating autoconsumption fractions etc
childrenProducedEnergyDeltaTot_Wh	Wh	Float	≥ 0.0	Delta of the energy that is produced (or discharged if a battery) by the children of the energy meter.
exportedPeakEnergyDeltaTot_Wh	Wh	Float	≥ 0.0	Delta of energy exported on peak times in total (sum of the three phases) since the previous measurement
exportedOffPeakEnergyDeltaTot_Wh	Wh	Float	≥ 0.0	Delta of energy exported not on peak times in total (sum of the three phases) since the previous measurement
importedAbsEnergyL1_Wh importedAbsEnergyL2_Wh importedAbsEnergyL3_Wh	Wh	Float	≥ 0.0	Imported energy absolute counter value for phase L1, L2, L3
importedAbsEnergyTot_Wh	Wh	Float	≥ 0.0	Imported energy absolute counter value for the total (sum of the three phases)
exportedAbsEnergyL1_Wh exportedAbsEnergyL2_Wh exportedAbsEnergyL3_Wh	Wh	Float	≥ 0.0	Exported energy absolute counter value for phase L1, L2, L3
exportedAbsEnergyTot_Wh	Wh	Float	≥ 0.0	Exported energy absolute counter value for the total (sum of the three phases)
importedReacEnergyDeltaL1_VArh importedReacEnergyDeltaL2_VArh importedReacEnergyDeltaL3_VArh	VArh	Float	≥ 0.0	Delta of reactive energy imported in phase L1, L2, L3 since the previous measurement
importedReacEnergyDeltaTot_VArh	VArh	Float	≥ 0.0	Delta of reactive energy imported in total (sum of the three phases) since the previous measurement
exportedReacEnergyDeltaL1_VArh exportedReacEnergyDeltaL2_VArh exportedReacEnergyDeltaL3_VArh	VArh	Float	≥ 0.0	Delta of reactive energy exported in phase L1, L2, L3 since the previous measurement
exportedReacEnergyDeltaTot_VArh	VArh	Float	≥ 0.0	Delta of reactive energy exported in total (sum of the three phases) since the previous measurement
importedAbsReacEnergyL1_VArh importedAbsReacEnergyL2_VArh importedAbsReacEnergyL3_VArh	VArh	Float	≥ 0.0	Imported reactive energy absolute counter value for phase L1, L2, L3
importedAbsReacEnergyTot_VArh	VArh	Float	≥ 0.0	Imported reactive energy absolute counter value for the total (sum of the three phases)
exportedAbsReacEnergyL1_VArh exportedAbsReacEnergyL2_VArh exportedAbsReacEnergyL3_VArh	VArh	Float	≥ 0.0	Exported reactive energy absolute counter value for phase L1, L2, L3
exportedAbsReacEnergyTot_VArh	VArh	Float	≥ 0.0	Exported reactive energy absolute counter value for the total (sum of the three phases)

Energy fields for batteryMetrics, evChargerMetrics

Key	Unit	Type	Value range	Meaning
stateOfCharge_frac	% as a float between 0 & 1	Float	0.0 - 1.0	State of charge of the battery
stateOfHealth_frac	% as a float between 0 & 1	Float	0.0 - 1.0	State of health of the battery
chargedEnergyDeltaL1_Wh chargedEnergyDeltaL2_Wh chargedEnergyDeltaL3_Wh	Wh	Float	≥ 0.0	Delta of energy charged in phase L1, L2, L3 since the previous measurement
chargedEnergyDeltaTot_Wh	Wh	Float	≥ 0.0	Delta of energy charged in total (sum of the three phases) since the previous measurement
dischargedEnergyDeltaL1_Wh dischargedEnergyDeltaL2_Wh dischargedEnergyDeltaL3_Wh	Wh	Float	≥ 0.0	Delta of energy discharged in phase L1, L2, L3 since the previous measurement
dischargedEnergyDeltaTot_Wh	Wh	Float	≥ 0.0	Delta of energy discharged in total (sum of the three phases) since the previous measurement
chargedAbsEnergyL1_Wh chargedAbsEnergyL2_Wh chargedAbsEnergyL3_Wh	Wh	Float	≥ 0.0	Charged energy absolute counter value for phase L1, L2, L3
chargedAbsEnergyTot_Wh	Wh	Float	≥ 0.0	Charged energy absolute counter value for the total (sum of the three phases)
chargedAbsSessionEnergyTot_Wh	Wh	Float	≥ 0.0	Charged energy in the current charging session absolute counter value for the total (sum of the three phases)
dischargedAbsEnergyL1_Wh dischargedAbsEnergyL2_Wh dischargedAbsEnergyL3_Wh	Wh	Float	≥ 0.0	Discharged energy absolute counter value for phase L1, L2, L3
dischargedAbsEnergyTot_Wh	Wh	Float	≥ 0.0	Discharged energy absolute counter value for the total (sum of the three phases)
consumedReacEnergyDeltaL1_VArh consumedReacEnergyDeltaL2_VArh consumedReacEnergyDeltaL3_VArh	VArh	Float	≥ 0.0	Delta of reactive energy consumed in phase L1, L2, L3 since the previous measurement
consumedReacEnergyDeltaTot_VArh	VArh	Float	≥ 0.0	Delta of reactive energy consumed in total (sum of the three phases) since the previous measurement
producedReacEnergyDeltaL1_VArh producedReacEnergyDeltaL2_VArh producedReacEnergyDeltaL3_VArh	VArh	Float	≥ 0.0	Delta of reactive energy produced in phase L1, L2, L3 since the previous measurement
producedReacEnergyDeltaTot_VArh	VArh	Float	≥ 0.0	Delta of reactive energy produced in total (sum of the three phases) since the previous measurement
consumedAbsReacEnergyL1_VArh consumedAbsReacEnergyL2_VArh consumedAbsReacEnergyL3_VArh	VArh	Float	≥ 0.0	Consumed reactive energy absolute counter value for phase L1, L2, L3
consumedAbsReacEnergyTot_VArh	VArh	Float	≥ 0.0	Consumed reactive energy absolute counter value for the total (sum of the three phases)
producedAbsReacEnergyL1_VArh producedAbsReacEnergyL2_VArh producedAbsReacEnergyL3_VArh	VArh	Float	≥ 0.0	Produced reactive energy absolute counter value for phase L1, L2, L3
producedAbsReacEnergyTot_VArh	VArh	Float	≥ 0.0	Produced reactive energy absolute counter value for the total (sum of the three phases)
mode	-	Integer	0 / 1 / 2	Modes in which the battery or electric vehicle can operate 0: standaard 1: eco 2: solar

Other evChargerMetrics

For electric vehicle chargers.

Key	Unit	Type	Value range	Meaning
maxPower_W	W	Float	≥ 0.0	Maximum power the charger can deliver. This can be different from individual charger connectors.
maxCurrent_A	A	Float	≥ 0.0	Maximum current the charger can deliver. This can be different from individual charger connectors.
safeCurrent_A	A	Float	≥ 0.0	Minimum current the charger will deliver when the charger has no setpoint or reference.
status	-	String		Charger status. The message depends on the charger brand, model and/or driver implementation.
sessionDuration_s	s	Float	≥ 0.0	Duration of a charging session.
chargingSessionId	-	String		Current charging session Id - can be used for detecting charge passes etc.
evNumOfPhases	-	Int	≥ 1	Number of phases that the electric vehicle uses for charging.
evUsedPhases	-	Enum of strings	"L1" "L2" "L3" "L1+L2+L3" "L1+L2" "L2+L3" "L1+L3" "Unknown" "Split phase"	Which phases are used by the electric vehicle for charing
evTargetACChargeCurrent_A	A	Float	≥ 0.0	Target AC phase current for charging.
smartgridMode	-	Bool	True / False	If True, smart grid mode is enabled.
powerSetpoint_W	W	Float		Smart grid mode power setpoint.
currentSetpoint_A	A	Float		Smart grid mode current setpoint.
evRequiringCharge	-	Boolean	True / False	Indicate if there is an electric vehicle connected that wants to be charged / has capacity left to be charged. This should be False if there is no ev on the charger (connector) or when the ev is fully charged. It should also be True when the EV on the charger is actually charging!

caloriMeterMetrics

Key	Unit	Type	Value range	Meaning
heatingEnergyDelta_Wh	Wh	Float	≥ 0.0	Delta of heating thermal energy since the previous measurement
heatingAbsEnergy_Wh	Wh	Float	≥ 0.0	Heating thermal energy absolute counter value
coolingEnergyDelta_Wh	Wh	Float	≥ 0.0	Delta of cooling thermal energy since the previous measurement
coolingAbsEnergy_Wh	Wh	Float	≥ 0.0	Cooling thermal energy absolute counter value
thermalPower_W	W	Float		Thermal power measured by the calorimeter. Positive power = heating, heat delivered to the measured heating/cooling circuit. Negative power = cooling, heat taken away from the measured heating/cooling circuit.

heatingAbsVolume_m3	m³	Float	≥ 0.0	Total volume of heat transfer fluid that has passed through the calorimeter
coolingAbsVolume_m3	m³	Float	≥ 0.0	Total volume of coolant fluid that has passed through the calorimeter
totalAbsVolume_m3	m³	Float	≥ 0.0	Combined total volume of heat transfer / coolant fluid that has passed through the calorimeter. No distinction is made between the fluid being used for heating or cooling.
flowRate_m3ph	m³/h	Float		Flow rate of heat transfer / coolant fluid. Positive = flow towards the heating/cooling circuit in the departure line. Negative = flow coming from the heating/cooling circuit in the departure line.
departureLineTemp_degC	°C	Float		Heat transfer / coolant fluid temperature in the line towards the heating/cooling circuit
returnLineTemp_degC	°C	Float		Heat transfer / coolant fluid temperature in the line returning from the heating/cooling circuit

gasMetrics

Key	Unit	Type	Value range	Meaning
absEnergy_Wh	Wh	Float	≥ 0.0	Caloric energy counter value.
energyDelta_Wh	Wh	Float	≥ 0.0	Caloric energy since the previous measurement was sent to the database.
absVolume_Nm3	Nm³	Float	≥ 0.0	Gas volume counter value.
volumeDelta_Nm3	Nm³	Float	≥ 0.0	Gas volume since the previous measurement was sent to the database.
LHV_WhpNm3	Wh/Nm³	Float	≥ 0.0	Lower heating value caloric content of the gas
HHV_WhpNm3	Wh/Nm³	Float	≥ 0.0	Higher heating value caloric content of the gas
pressure_bar	bar	Float	≥ 0.0	Pressure of the gas
flow_Nm3ps	Nm³/s	Float		Flow rate
density_kgpm3	kg/m³	Float	≥ 0.0	Density
temperature_degC	°C	Float		Temperature
gasConversionFactor		Float	>0.0	conversion factor related to richness of gas used

waterMetrics

Key	Unit	Type	Min. value	Max. value	Meaning
absVolume_m3	m³	Float	0.0	-	Absolute water volume counter value.
volumeDelta_m3	m³	Float	0.0	-	Water volume since the previous measurement was sent to the database.
flow_m3ps	m³/s	Float	-	-	Flow rate
temperature_degC	°C	Float	-	-	Temperature
absPulseCount	-	Integer	-	-	For pulse counters: for an absolute totale amount of pulses
pulseCountDelta	-	Integer	-	-	For pulse counters: for counting individual pulses. E.g., if one pulse is sent every time a liter of water is consumed
pulseRate_ph	1/h	Float	-	-	For pulse counters: for counting a pulse rates per hour, e.g. can represent a flow rate

ventilationMetrics

Key	Unit	Type	Meaning
airFlow_m3ps	m³/s	Float	Flow rate of air in a ventilation system
insideAirTemp_degC	°C	Float	Air temperature inside a room
outsideAirTemp_degC	°C	Float	Air temperature outside
insideAirPressure_mbar	mbar	Float	Air pressure inside a room
outsideAirPressure_mbar	mbar	Float	Air pressure outside
CO2conc_ppm	ppm	Float	CO2 concentration inside a room

heatPumpMetrics

For the electrical side of the heat pump, use loadMetrics.

Key	Unit	Type	Value range	Meaning
heatFlowIn_W	W	Float		Heat flow from ambient to outside unit (is negative when the heat pump is used for cooling!)
heatFlowOut_W	W	Float		Heat flow from inside unit to heating water circuit or inside air (is negative when the heat pump is used for cooling!)
evaporatorInTemp_degC	°C	Float		Temperature of the coolant (heat transfer fluid) when entering the evaporator of the heat pump
evaporatorOutTemp_degC	°C	Float		Temperature of the coolant (heat transfer fluid) when leaving the evaporator of the heat pump
compressorInTemp_degC	°C	Float		Temperature of the coolant (heat transfer fluid) when entering the compressor of the heat pump
compressorOutTemp_degC	°C	Float		Temperature of the coolant (heat transfer fluid) when leaving the compressor of the heat pump
condenserInTemp_degC	°C	Float		Temperature of the coolant (heat transfer fluid) when entering the condenser of the heat pump
condenserOutTemp_degC	°C	Float		Temperature of the coolant (heat transfer fluid) when leaving the condenser of the heat pump
expValveInTemp_degC	°C	Float		Temperature of the coolant (heat transfer fluid) when entering the expansion valve of the heat pump
expValveOutTemp_degC	°C	Float		Temperature of the coolant (heat transfer fluid) when leaving the expansion valve of the heat pump
evaporatorInPressure_bar	bar	Float		Pressure of the coolant (heat transfer fluid) when entering the evaporator of the heat pump
evaporatorOutPressure_bar	bar	Float		Pressure of the coolant (heat transfer fluid) when leaving the evaporator of the heat pump
compressorInPressure_bar	bar	Float		Pressure of the coolant (heat transfer fluid) when entering the compressor of the heat pump
compressorOutPressure_bar	bar	Float		Pressure of the coolant (heat transfer fluid) when leaving the compressor of the heat pump
condenserInPressure_bar	bar	Float		Pressure of the coolant (heat transfer fluid) when entering the condenser of the heat pump
condenserOutPressure_bar	bar	Float		Pressure of the coolant (heat transfer fluid) when leaving the condenser of the heat pump
expValveInPressure_bar	bar	Float		Pressure of the coolant (heat transfer fluid) when entering the expansion valve of the heat pump
expValveOutPressure_bar	bar	Float		Pressure of the coolant (heat transfer fluid) when leaving the expansion valve of the heat pump
coolantFlow_m³/s	m³/s	Float		Flow rate of the coolant (heat transfer fluid) inside the heat pump
heatingWaterInTemp_degC	°C	Float		Temperature of the water of the central heating system entering the heat pump
heatingWaterOutTemp_degC	°C	Float		Temperature of the water of the central heating system leaving the heat pump
heatingWaterFlow_m3ps	m³/s	Float		Flow rate of heating water of the central heating system
insideAirTemp_degC	°C	Float		Temperature inside building
outsideAirTemp_degC	°C	Float		Temperature outside building
mode	-	Integer	0 / 1 / 2	Modes in which the heatpump can operate 0: standaard 1: eco 2: solar
sourceThermalEnergyInputDelta_Wh	Wh	Float		Thermal energy that is taken from the source, expressed as an energy delta

airconditionerMetrics

For the electrical side of the airconditioner, use loadMetrics.

Key	Unit	Type	Meaning
heatFlowIn_W	W	Float	Heat flow from inside air to coolant (is negative when the air conditioner is used for heating!)
heatFlowOut_W	W	Float	Heat flow from coolant to outside air (is negative when the air conditioner is used for cooling!)
evaporatorInTemp_degC	°C	Float	Temperature of the coolant (heat transfer fluid) when entering the evaporator of the air conditioner
evaporatorOutTemp_degC	°C	Float	Temperature of the coolant (heat transfer fluid) when leaving the evaporator of the air conditioner
compressorInTemp_degC	°C	Float	Temperature of the coolant (heat transfer fluid) when entering the compressor of the air conditioner
compressorOutTemp_degC	°C	Float	Temperature of the coolant (heat transfer fluid) when leaving the compressor of the air conditioner
condenserInTemp_degC	°C	Float	Temperature of the coolant (heat transfer fluid) when entering the condenser of the air conditioner
condenserOutTemp_degC	°C	Float	Temperature of the coolant (heat transfer fluid) when leaving the condenser of the air conditioner
expValveInTemp_degC	°C	Float	Temperature of the coolant (heat transfer fluid) when entering the expansion valve of the air conditioner
expValveOutTemp_degC	°C	Float	Temperature of the coolant (heat transfer fluid) when leaving the expansion valve of the air conditioner
evaporatorInPressure_bar	bar	Float	Pressure of the coolant (heat transfer fluid) when entering the evaporator of the air conditioner
evaporatorOutPressure_bar	bar	Float	Pressure of the coolant (heat transfer fluid) when leaving the evaporator of the air conditioner
compressorInPressure_bar	bar	Float	Pressure of the coolant (heat transfer fluid) when entering the compressor of the air conditioner
compressorOutPressure_bar	bar	Float	Pressure of the coolant (heat transfer fluid) when leaving the compressor of the air conditioner
condenserInPressure_bar	bar	Float	Pressure of the coolant (heat transfer fluid) when entering the condenser of the air conditioner
condenserOutPressure_bar	bar	Float	Pressure of the coolant (heat transfer fluid) when leaving the condenser of the air conditioner
expValveInPressure_bar	bar	Float	Pressure of the coolant (heat transfer fluid) when entering the expansion valve of the air conditioner
expValveOutPressure_bar	bar	Float	Pressure of the coolant (heat transfer fluid) when leaving the expansion valve of the air conditioner
coolantFlow_m³/s	m³/s	Float	Flow rate of the coolant (heat transfer fluid) inside the air conditioner
insideAirInTemp_degC	°C	Float	Temperature of the air entering the inside unit
insideAirOutTemp_degC	°C	Float	Temperature of the air leaving the inside unit
insideAirFlow_m3ps	m³/s	Float	Flow rate of air through the air conditioner inside unit
outsideAirInTemp_degC	°C	Float	Temperature of the air entering the outside unit
outsideAirOutTemp_degC	°C	Float	Temperature of the air leaving the outside unit
outsideAirFlow_m3ps	m³/s	Float	Flow rate of air through the outside unit
insideAirTemp_degC	°C	Float	Temperature inside building
outsideAirTemp_degC	°C	Float	Temperature outside building

heaterMetrics

For heating units.

Key	Unit	Type	Value range	Meaning
heatingPower_W	W	Float		Current heating power, energy per second added to the heating water
fuelConsumption_Nm3ps	Nm³/s	Float		Fuel consumption
LHV_WhpNm3	Wh/Nm³	Float	≥ 0.0	Lower heating value caloric content of the fuel
HHV_WhpNm3	Wh/Nm³	Float	≥ 0.0	Higher heating value caloric content of the fuel
fuelDensity_kgpm3	kg/m³	Float	≥ 0.0	Density of the fuel
fuelPressure_bar	bar	Float	≥ 0.0	Pressure of the fuel (if a gas)
tankLevel_frac	% as a fraction between 0 and 1	Float	0 - 1	Fraction of fuel left in fuel tank
heatingWaterInTemp_degC	°C	Float		Temperature of the water of the central heating system entering the heat pump
heatingWaterOutTemp_degC	°C	Float		Temperature of the water of the central heating system leaving the heat pump
heatingWaterFlow_m3ps	m³/s	Float		Flow rate of heating water of the central heating system
pumpInPressure_bar	bar	Float		Pressure of the heating circuit water before entering the pump
pumpOutPressure_bar	bar	Float		Pressure of the heating circuit water when leaving the pump
insideAirTemp_degC	°C	Float		Temperature inside building
outsideAirTemp_degC	°C	Float		Temperature outside building

pyranometerMetrics

For pyranometers.

Key	Unit	Type	Value range	Meaning
irradiance_Wpm2	W/m²	Float	≥ 0.0	Solar irradiance
radiantExposureDelta_Whpm2	Wh/m²	Float	≥ 0.0	Radiant energy received by a surface per unit area since the previous measurement, or equivalently irradiance of a surface integrated over the time of irradiation between the current and the previous measurement.

meterMetrics

For all types of meters like anti injection meters

Key	Unit	Type	Value range	Meaning
ActualPowerA_W ActualPowerB_W ActualPowerC_W	W	Float		Actual active power of phase A, B, C. Positive power = produced power Negative power = consumed power (e.g. autoconsumption of the plant)
antiInjection_Frac	% as a float between 0 & 1	Float	0-1	Percentage that inverts are working at 1 = no anti injection 0 = inverters are shutdown

Example

As an example of an MQTT message for the measurement "gridMetrics":

The id corresponds to the mqtt username.

{
   "time": 1629896519,
   "extraTags": {
       "id": "012345",
       "subId": "mainMeter1234567890"
    },
   "fields": {
       "voltageL1N_V": 230.0,
       "voltageL2N_V": 229.7,
       "voltageL3N_V": 231.2,
       "actualPowerL1_W": 1123.1,
       "actualPowerL2_W": -172.8,
       "actualPowerL3_W": 874.1,
       "exportedAbsEnergyL1_Wh": 2340129,
       "importedAbsEnergyL1_Wh": 93482,
       "exportedAbsReacEnergyL1_VArh": 23013129,
       "importedAbsReacEnergyL1_VArh": 7523
    }
}