Schema Documentation
Vehicle Telemetry Channel
Get Vehicle Telemetry messages
The unique identifier of the Company.
A Vehicle internal number
Accepts the following message:
{
"vehicle": {
"companyId": "1877c37hcebb4c4f808628d99d7bs0df",
"divisionId": "1877c37hcebb4c4f808628d99d7bs0df",
"internalNumber": "2255",
"vin": "2GBE4C3126H66WC5A",
"bmsIds": [
"FD43DE0DC4B6"
]
},
"gps": {
"lat": 0,
"lon": 0,
"alt": 0,
"satellites": 0,
"speed": 0,
"angle": 0,
"timestamp": "2023-06-30T00:00:00.000Z"
},
"ignition": {
"value": true,
"timestamp": "2023-06-30T00:00:00.000Z"
},
"totalFuelConsumed": {
"value": 0,
"timestamp": "2023-06-30T00:00:00.000Z"
},
"odometer": {
"value": 0,
"timestamp": "2023-06-30T00:00:00.000Z"
},
"soc": {
"value": 0,
"timestamp": "2023-06-30T00:00:00.000Z"
}
}
Vehicle Telemetry Channel
Publish Vehicle Telemetry messages
The unique identifier of the Company.
A Vehicle internal number
Accepts the following message:
{
"vehicle": {
"companyId": "1877c37hcebb4c4f808628d99d7bs0df",
"divisionId": "1877c37hcebb4c4f808628d99d7bs0df",
"internalNumber": "2255",
"vin": "2GBE4C3126H66WC5A",
"bmsIds": [
"FD43DE0DC4B6"
]
},
"gps": {
"lat": 0,
"lon": 0,
"alt": 0,
"satellites": 0,
"speed": 0,
"angle": 0,
"timestamp": "2023-06-30T00:00:00.000Z"
},
"ignition": {
"value": true,
"timestamp": "2023-06-30T00:00:00.000Z"
},
"totalFuelConsumed": {
"value": 0,
"timestamp": "2023-06-30T00:00:00.000Z"
},
"odometer": {
"value": 0,
"timestamp": "2023-06-30T00:00:00.000Z"
},
"soc": {
"value": 0,
"timestamp": "2023-06-30T00:00:00.000Z"
}
}
Charger State Topic
Receive Charger State messages
The unique identifier of the Company.
The unique identifier of the Depot.
The unique identifier of the charger.
The unique identifier of the connector.
Accepts the following message:
A message providing the complete state of a charging session.
{
"timestamp": "2023-06-30T00:00:00.000Z",
"idTag": "string",
"vehicle": {
"companyId": "1877c37hcebb4c4f808628d99d7bs0df",
"divisionId": "1877c37hcebb4c4f808628d99d7bs0df",
"internalNumber": "2255",
"vin": "2GBE4C3126H66WC5A",
"bmsIds": [
"FD43DE0DC4B6"
]
},
"chargePoint": {
"chargerId": "string",
"connectorId": 0
},
"sessionStart": "2023-06-30T00:00:00.000Z",
"sessionEnd": "2023-06-30T00:00:00.000Z",
"socStart": 0,
"consumedEnergy": 0,
"chargingCost": {
"amount": 0,
"currency": "string"
},
"lastPower": 0,
"lastSoc": 0,
"lastVoltage": 0,
"estimatedCompletionTime": "2023-06-30T00:00:00.000Z",
"status": "PENDING",
"errorCode": "E1234"
}
A Vehicle Telemetry message
A message providing the complete state of a charging session.