improved
Updates to MeterValue API
8 months ago by Thomas Haelsig
Adding additional fields and query parameters to the MeterValues object as well as improving consistency.
Benefits
added additional fields and query parameters
- the phase is now added, making it easier to focus on the whole output of a Charge Station and not per phase, which made it not usable for some Charge Stations with phases
- link metervalues to a session_id
- filter on Unit, e.g. kWh. This allows you to ignore MeterValues in Amps or Volts that might not be useful for your purposes
Breaking changes
- Adding required query parameters
- Removing endpoints for single charge station and EVSE as they were not used
Mandatory query parameters
date_from, date_to and limit have been made mandatory query parameters.
This has to do with stability of retrieving metervalues.Dates can be max. 72h apart and the Limit is at least 10000
Endpoints to be deprecated
We have opted to remove the option to query Meter Values for a single ChargeStation or EVSE, as this has seen little use.
These endpoints will no longer be accessible.
New Fields
Below is an overview of new fields
| Value | Description |
|---|---|
| Location_id | to replace 'charge_location_id' as just 'location_id' is more consistent with other API responses |
| message_id | identifier of related values for the same MeterValue |
| session_id | the session ID related to this meter_value. |
| connector_ID | the relevant connector |
| context | the MeterValue contact |
| measurand | The relevant measurand |
| phase | The phase of the meter value |
| format | The format (raw or signed) |
| location | Location of measurement within the CS |
For more information on the fields, see https://developer.greenflux.com/docs/metervalue-data-type
Below is a comparison of fields added or to be removed.
Additional query parameters
New Query parameters have been added:
- measurand
- phase
- context
- unit
This should help API Customers to narrow down their search to only the relevant MeterValues, e.g.
- only interested in kwh and not in V or Amp
- only see metervalues for all phases combined, instead of all three phases separately
required query parameters
The 'limit' query parameter MUST be present and have at least 10000 as minimum value.
date_from and date_to are now also required. Minimum 72h bust be between the two dates.
Example new JSON
{
"data": [
{
"meter_value_uid": "50eb22e3-429c-4f3a-b178-53276748a461",
"value": 0.0,
"unit": "A",
"evse_id": "NL-GFX-ENL-GFX-RDABC-1",
"charge_station_id": "NL-GFX-RDABC",
"location_id": "e649f5c0-a177-4ff1-a0c8-c4285ffc8aad",
"meter_type": "EVSE",
"created": "2022-09-19T07:18:33Z",
"timestamp": "2022-09-19T07:18:30Z",
"message_id": "5e90284ccc990L",
"session_id": "NLGFX637985930900393478-bac93",
"connector_id": 2,
"context": "SamplePeriodic",
"measurand": "CurrentImport",
"phase": "None",
"format": "Raw",
"location": "Outlet",
},
{
"meter_value_uid": "0704c4d8-791c-4a12-8de5-591746f17d20",
"value": 16.0,
"unit": "A",
"evse_id": "NL-GFX-ENL-GFX-RDABC-1",
"charge_station_id": "NL-GFX-RDABC",
"location_id": "e649f5c0-a177-4ff1-a0c8-c4285ffc8aad",
"meter_type": "EVSE",
"created": "2022-09-19T07:18:33Z",
"timestamp": "2022-09-19T07:18:30Z",
"message_id": "5e90284ccc990L",
"session_id": "NLGFX637985930900393478-bac93",
"connector_id": 2,
"context": "SamplePeriodic",
"measurand": "CurrentOffered",
"phase": "None",
"format": "Raw",
"location": "Outlet",
},
{
"meter_value_uid": "d0672042-b73f-42cc-a38f-1a0a3be2fd45",
"value": 55390.0,
"unit": "Wh",
"evse_id": "NL-GFX-ENL-GFX-RDABC-1",
"charge_station_id": "NL-GFX-RDABC",
"location_id": "e649f5c0-a177-4ff1-a0c8-c4285ffc8aad",
"meter_type": "EVSE",
"created": "2022-09-19T07:18:33Z",
"timestamp": "2022-09-19T07:18:30Z",
"message_id": "5e90284ccc990L",
"session_id": "NLGFX637985930900393478-bac93",
"connector_id": 2,
"context": "SamplePeriodic",
"measurand": "EnergyActiveImportRegister",
"phase": "None",
"format": "Raw",
"location": "Outlet",
},
{
"meter_value_uid": "17e5d7fe-b37e-4b1a-9c73-4d606de97164",
"value": 0.0,
"unit": "W",
"evse_id": "NL-GFX-ENL-GFX-RDABC-1",
"charge_station_id": "NL-GFX-RDABC",
"location_id": "e649f5c0-a177-4ff1-a0c8-c4285ffc8aad",
"meter_type": "EVSE",
"created": "2022-09-19T07:18:33Z",
"timestamp": "2022-09-19T07:18:30Z",
"message_id": "5e90284ccc990L",
"session_id": "NLGFX637985930900393478-bac93",
"connector_id": 2,
"context": "SamplePeriodic",
"measurand": "PowerActiveImport",
"phase": "None",
"format": "Raw",
"location": "Outlet",
},
{
"meter_value_uid": "17e5d7fe-b37e-4b1a-9c73-4d606de97164",
"value": 0.0,
"unit": "W",
"evse_id": "NL-GFX-ENL-GFX-RDABC-1",
"charge_station_id": "NL-GFX-RDABC",
"location_id": "e649f5c0-a177-4ff1-a0c8-c4285ffc8aad",
"meter_type": "EVSE",
"created": "2022-09-19T07:18:33Z",
"timestamp": "2022-09-19T07:18:30Z",
"message_id": "5e90284ccc990L",
"session_id": "NLGFX637985930900393478-bac93",
"connector_id": 2,
"context": "SamplePeriodic",
"measurand": "PowerActiveImport",
"phase": "None",
"format": "Raw",
"location": "Outlet",
},
{
"meter_value_uid": "d0672042-b73f-42cc-a38f-1a0a3be2fd45",
"value": 55390.0,
"unit": "Wh",
"evse_id": "NL-GFX-ENL-GFX-RDABC-1",
"charge_station_id": "NL-GFX-RDABC",
"location_id": "e649f5c0-a177-4ff1-a0c8-c4285ffc8aad",
"meter_type": "EVSE",
"created": "2022-09-19T07:18:33Z",
"timestamp": "2022-09-19T07:18:30Z",
"message_id": "5e90284ccc990L",
"session_id": "NLGFX637985930900393478-bac93",
"connector_id": 2,
"context": "SamplePeriodic",
"measurand": "EnergyActiveImportRegister",
"phase": "None",
"format": "Raw",
"location": "Outlet",
},
{
"meter_value_uid": "0704c4d8-791c-4a12-8de5-591746f17d20",
"value": 16.0,
"unit": "A",
"evse_id": "NL-GFX-ENL-GFX-RDABC-1",
"charge_station_id": "NL-GFX-RDABC",
"location_id": "e649f5c0-a177-4ff1-a0c8-c4285ffc8aad",
"meter_type": "EVSE",
"created": "2022-09-19T07:18:33Z",
"timestamp": "2022-09-19T07:18:30Z",
"message_id": "5e90284ccc990L",
"session_id": "NLGFX637985930900393478-bac93",
"connector_id": 2,
"context": "SamplePeriodic",
"measurand": "CurrentOffered",
"phase": "None",
"format": "Raw",
"location": "Outlet",
},
{
"meter_value_uid": "50eb22e3-429c-4f3a-b178-53276748a461",
"value": 0.0,
"unit": "A",
"evse_id": "NL-GFX-ENL-GFX-RDABC-1",
"charge_station_id": "NL-GFX-RDABC",
"location_id": "e649f5c0-a177-4ff1-a0c8-c4285ffc8aad",
"meter_type": "EVSE",
"created": "2022-09-19T07:18:33Z",
"timestamp": "2022-09-19T07:18:30Z",
"message_id": "5e90284ccc990L",
"session_id": "NLGFX637985930900393478-bac93",
"connector_id": 2,
"context": "SamplePeriodic",
"measurand": "CurrentImport",
"phase": "None",
"format": "Raw",
"location": "Outlet",
}
"count": 1668,
"total_count": 0,
"limit": 10000,
"status_code": 1000,
"status_message": "Success",
"timestamp": "2022-09-20T13:15:44.4947334Z"
}