ProvideChargingInformation messages (Provide Live Charging Data via DepotInfoList) MUST
What is a ProvideChargingInformation message?
Via ProvideChargingInformation.req messages ChargePilot® can send a DepotInfoList to an Upstream system.
The DepotInfoList mainly contains live charging data including the depot setup, the charging infrastructure as well as the corresponding charging station/point statuses, ongoing charging processes and potential error information.
Optionally this message also contains charging processes scheduled in the future, if sent via ChargingRequests before.
Based on all these information, ProvideChargingRequests.req messages can be sent to ChargePilot®.
Default Charging Station and Charging Point
Default Charging Station and Charging Point will be always provided in ProvideChargingInformation messages with their corresponding ScheduledChargingProcessList if any exists. Their statuses will be always reported as Unavailable without any additional information about its state.
ProvideChargingInformation - Example Payload
ProvideChargingInformation.req message sent by ChargePilot®
[
1, //Request
"CMS",
"Presystem1",
"2023-09-13T10:15:40.064Z",
"afe00401-da68-4fc8-bd6b-22f21de9f81f",
"ProvideChargingInformation",
{
"depotInfoList": [
{
"depotId": "29e7d1c4-89b7-40a0-8025-2cd2c92664de",
"name": "Client site",
"chargingStationInfoList": [
{
"chargingStationId": "29e7d1c4-89b7-40a0-8025-2cd2c92664de/0", // Default Charging Station
"chargingStationStatus": "Unavailable",
"chargingPointInfoList": [
{
"chargingPointId": "29e7d1c4-89b7-40a0-8025-2cd2c92664de/0/0", // Default Charging Point
"chargingPointStatus": "Unavailable",
"scheduledChargingProcessList": [
{
"presystemId": "Presystem1",
"chargingRequestId": "0",
"chargingProcessId": "9feb400e-f018-4455-9c6f-48849e00206b",
"vehicleId": "4T3ZF19C52LL20766",
"startTime": "2023-09-16T08:57:08Z",
"chargingPredictionData": {
"chargingPredictionDataMinSoc": {
"requestedMinSoc": 50
}
}
}
],
}
]
},
{
"chargingStationId": "0024830c-68d4-4206-9c5e-51752d26685b",
"chargingStationStatus": "Available",
"chargingPointInfoList": [
{
"chargingPointFaultInfo": {
"chargingPointFaultCode": "UsageFailure",
"faultText": "Something bad happened",
"faultTimeStamp": "2023-09-16T05:35:49Z"
},
"chargingPointId": "08c44fb2-c570-4009-ac52-f6b1f97cfb60",
"chargingPointStatus": "Occupied",
"presentPower": 6.91,
"energyMeterReading": 6543.53,
"vehicleInfo": {
"vehicleId": "12345644430000000",
"vehicleChargingStatus": "Charging", // Mock data
"preconditioningInfo": {}, // Mock data
"vehicleStatusInfo": {}, // Mock data
"tractionBatteryInfo": {
"stateOfCharge": 4.5
}
},
"scheduledChargingProcessList": [
{
"presystemId": "Presystem1",
"chargingRequestId": "1",
"chargingProcessId": "0a8f2d98-f702-44fc-880e-b43b6d0c5e1e",
"vehicleId": "12345644430000000",
"startTime": "2023-09-30T09:30:00Z",
"chargingPredictionData": {
"chargingPredictionDataMinSoc": {
"requestedMinSoc": 50
}
}
}
],
"chargingProcessInfo": {
"chargingProcessId": "0a8f2d98-f702-44fc-880e-b43b6d0c5e1e",
"startTime": "2023-09-30T09:30:00Z",
"processStatus": "Charging",
"chargingPredictionData": { // Mock data
"chargingPredictionDataMinSoc": { // Mock data
"requestedMinSoc": 50, // Mock data
"predictedTime": "2023-10-23T07:57:21Z" // Mock data
}
},
"electricData": { // Mock data
"chargingPower": 5 // Mock data
}
}
},
{
"chargingPointId": "08c44fb2-c570-4009-ac52-f6b1f97cfb60",
"chargingPointStatus": "Unavailable",
"energyMeterReading": 6543.5324,
"scheduledChargingProcessList": [
{
"presystemId": "Presystem1",
"chargingRequestId": "2",
"chargingProcessId": "d09dcf94-4276-4d74-a224-3f1a4cb174f5",
"vehicleId": "12345644430000000",
"startTime": "2023-09-16T09:30:00Z",
"chargingPredictionData": {
"chargingPredictionDataMinSoc": {
"requestedMinSoc": 20
}
}
}
]
},
{
"chargingPointId": "81512e28-a64a-463f-84b1-c4362d190b8d",
"chargingPointStatus": "Available",
"energyMeterReading": 1234.43
}
]
},
]
}
]
}
]| Substructure description | Substructure | Field in substructure | Description | Type | Unit of measurement | Value range | Format |
|---|---|---|---|---|---|---|---|
| List containing information about the depot. For now, this list can only contain a single depot. | depotInfoList | depotId | Unique identifier of the depot. | string, uuid | - | - | XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX |
| name | Name of the depot. | string | - | Minimum: 1 character Maximum: 255 characters |
- | ||
| Information about charging stations. | chargingStationInfoList | chargingStationId | Unique identifier of a charging station. | string, uuid or default charging station id | - | - | XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX or XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/0 |
| chargingStationStatus | Status of a charging station. | string, enum of charging station statuses | - | Explained in charging statuses section | - | ||
| Information about charging station fault | chargingStationFaultInfo | chargingStationFaultCode | Error code of a charging station if an error occurred | string, enum of charging station error codes | - | Explained in charging statuses section | - |
| faultText | Additional information about the error | string | - | - | - | ||
| faultTimeStamp | Time when the error occurred | UTC timestamp | - | - | YYYY-MM-DDThh:mm:ss.sZ | ||
| Information about charging points. | chargingPointInfoList | chargingPointId | Unique identifier of a charging point. | string, uuid or default charging point id | - | - | XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX or XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/0/0 |
| chargingPointStatus | Status of a charging point. | string, enum of charging point statuses | - | Explained in charging statuses section | - | ||
| energyMeterReading (optional) | Total energy consumption during all the transactions. | float | Watt-hour | Minimum: 0 | - | ||
| presentPower (optional) | The power that is used to charge the plugged EV. | float | Kilowatt-hour | Minimum: 0 | - | ||
| Information about a vehicle that is charging at a charging point (optional). | vehicleInfo | vehicleId | Unique identifier of a vehicle that is charging at a charging point. | string, vin | - | XXXXXXXXXXXXXXXX | |
| preconditioningInfo (mock data) | Information about current status of preconditioning. For now we provide only dummy data for this structure and this value is always an empty object. | empty object | - | - | - | ||
| vehicleStatusInfo (mock data) | Status information about the vehicle. For now we provide only dummy data for this structure and this value is always an empty object. | empty object | - | - | - | ||
| vehicleChargingStatus (mock data) | Status information on the charging process of the vehicle. For now we provide only dummy data for this property and it is constant value of Charging. | string | - | 'Charging' | - | ||
| tractionBatteryInfo (optional) | stateOfCharge | State of charge of an EV that is charging at a charging point. | float | percentage | Minimum: 0 Maximum: 100 |
- | |
| Information about charging point fault | chargingPointFaultInfo | chargingPointFaultCode | Error code of a charging point if an error occurred | string, enum of charging point error codes | - | Explained in charging statuses section | - |
| faultText | Additional information about the error | string | - | - | - | ||
| faultTimeStamp | Time when the error occurred | UTC timestamp | - | - | YYYY-MM-DDThh:mm:ss.sZ | ||
| Details about currently ongoing charging process at a given charging point. | chargingProcessInfo | chargingProcessId | Identifier of the charging process that takes place. | string | - | - | - |
| processStatus | Status of the charging process. | string enum | - | Enum according to section 2.1.7 in VDV 463 documentation. | - | ||
| startTime | Start time of charging process. | UTC timestamp | - | - | YYYY-MM-DDThh:mm:ss.sZ | ||
| electricData | chargingPower (mock data) | Current charging power. For now we provide only dummy data for this property and it is the same value as presentPower property. | number | Kilowatts | - | - | |
| chargingPredictionData (mock data) | - | - | - | - | - | - | |
| chargingPredictionDataMinSoc | requestedMinSoc (mock data) | Predefined SoC in % that will be reached by the time target. For now we provide only dummy data for this property and it is constant value of 50. | number | percentage | - | - | |
| - | predictedTime (mock data) | Prediction of when the SoC target (minimum value) will be met. | timestamp UTC | - | - | YYYY-MM-DDThh:mm:ss.sZ | |
| Information about scheduled charging processes for a charging point (optional). | scheduledChargingProcessList | preSystemId | Unique identifier of the presystem that is connected to ChargePilot®. | string | - | - | - |
| chargingRequestId | Unique identifier of a given charging request given by BMS. | string | - | Minimum: 1 character | - | ||
| chargingProcessId | Unique identifier of a given charging request given by CMS. | string, uuid | - | - | XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX | ||
| vehicleId | Unique identifier of a vehicle that will be charged during this charging process. | string, vin | - | - | XXXXXXXXXXXXXXXX | ||
| startTime | Charging start time. | UTC timestamp | - | - | YYYY-MM-DDThh:mm:ss.sZ | ||
| Information about charging prediction | chargingPredictionData → chargingPredictionDataMinSoc | requestedMinSoc | Requested minimum SOC, a vehicle will be charged to within this charging process. | float | percentage | Minimum: 0 Maximum: 100 |
- |
ProvideChargingInformation.conf message sent by the Upstream System
[
2, //Confirmation
"BMS",
"Presystem1",
"2023-06-19T13:51:14.081Z",
"afe00401-da68-4fc8-bd6b-22f21de9f81f",
"ProvideChargingInformation",
{},
]- Every ProvideChargingInformation.req message must be confirmed by a ProvideChargingInformation.conf message.
- If the request message is not confirmed within 10 seconds, the connection with the upstream system will be closed.
The Upstream System is responsible to reconnect to ChargePilot® again.
(For more informations, see stepwise guidance in section 2)
Time Interval of ProvideChargingInformation messages
ProvideChargingInformation.req messages are sent cyclic every 15 seconds.