Parameters
Vehicle Labels¶
The following parameters are available for all Vehicle request (historical and real-time):
| Label | Unit | Time interval [ms] | Format | Note |
|---|---|---|---|---|
| odo | km | vehicle dependent | float | |
| soc | % | vehicle dependent | float | State of Charge |
| speed | km/h | vehicle dependent | float | |
| current | A | vehicle dependent | float | |
| voltage | V | vehicle dependent | float | |
| power | kW | based on current | float | |
| odo_reference_per_day | km | based on odo | float | |
| energy_used_per_day | kWh | based on power | float | EV only |
| fuel_used_per_day | l | vehicle dependent | float | Diesel and Hybrids only |
| fuel | l | vehicle dependent | float | Current fuel level, Diesel and Hybrids only |
| analyses.estimated_range | km | vehicle dependent | float | Calculated based off historical data, if enough |
| gps | degrees | 1000 - 2000 | string "lat|lon" |
The parameters that mention vehicle dependent as time interval are available in the interval set by the vehicle or battery management system.
Any parameters that ends with per_day will be resetted to 0 according to the vehicle's timezone
The gps location data originates from ViriCiti's datahub. See the datasheet of SIMCOM's GNSS module SIM68V for detailed information on the accuracy of the location data.
Charging Station Parameters¶
The following parameters are available real-time for Charging Stations:
| Parameter | Updates when | Note |
|---|---|---|
| alive | Upon change | Read OCPP1.6 for more info |
| status | Upon change | |
| power | 30s interval (while charging) | |
| soc | 30s interval (while charging) | |
| transactions | Upon start / stop charging | |
| current | 30s interval (while charging) | |
| voltage | 30s interval (while charging) |
Charging Station measurements and units¶
The following parameters are available for historical requests related to measurements from a charging station:
| Label | Unit | Time interval [s] | Format | Note |
|---|---|---|---|---|
| energy | Wh | 30 | integer | |
| power | W | 30 | integer | |
| soc | % | 30 | integer | |
| voltage | V | 30 | integer | |
| current | A | 30 | integer |
Charging Station Connector Statuses¶
The following connector statuses are not exhaustive. We listed the most common ones. Read OCPP1.6 for more detailed information: https://www.openchargealliance.org/downloads/
| Status | Meaning |
|---|---|
| Available | Connector is ready to be used |
| Preparing | Connector is going to charge |
| Charging | Connector is charging |
| Finishing | Connector is stopping the charge transaction |
| Faulted | Connector is in a faulted state |
| UnAvailable | Connector is NOT ready to be used |