Maintenance
getState([, propertyNames])
Declaration
hmkit.commands.Maintenance.getState()
Parameters
| propertyNames | (optional) Array of names of the properties you want returned. |
Returns
MaintenanceResponse
Example
hmkit.telematics.sendCommand(
hmkit.commands.Maintenance.getState(),
accessCertificate
);
MaintenanceResponse
Parameters
| automaticTeleserviceCallDate | (Object) |
| data.value | (Date) (timestamp) Automatic teleservice call date |
| timestamp | (Date) |
| brakeFluidChangeDate | (Object) |
| data.value | (Date) (timestamp) Brake fluid change date |
| timestamp | (Date) |
| brakeFluidRemainingDistance | (Object) |
| data.value | (Number) (length) Indicates the remaining distance for brake fluid. |
| timestamp | (Date) |
| brakeFluidStatus | (Object) |
| data.value | (String) (enum) Brake fluid's service status. |
| timestamp | (Date) |
| brakesServiceDueDates | (Object) |
| data.value | (Array |
| timestamp | (Date) |
| brakesServiceRemainingDistances | (Object) |
| data.value | (Array |
| timestamp | (Date) |
| brakesServiceStatuses | (Object) |
| data.value | (Array |
| timestamp | (Date) |
| cbsReportsCount | (Object) |
| data.value | (Number) (uinteger) The number of CBS reports |
| timestamp | (Date) |
| conditionBasedServices | (Object) |
| data.value | (Array |
| timestamp | (Date) |
| distanceToNextOilService | (Object) |
| data.value | (Number) (length) Indicates the remaining distance until the next oil service; if this limit was exceeded, this value indicates the distance that has been driven since then. |
| timestamp | (Date) |
| distanceToNextService | (Object) |
| data.value | (Number) (length) The distance until next servicing of the vehicle |
| timestamp | (Date) |
| driveInInspectionDate | (Object) |
| data.value | (Date) (timestamp) Next drive-in inspection date. |
| timestamp | (Date) |
| driveInInspectionDistanceTo | (Object) |
| data.value | (Number) (length) The distance until next drive-in inspection of the vehicle |
| timestamp | (Date) |
| driveInInspectionStatus | (Object) |
| data.value | (String) (enum) Drive-in inspection service status. |
| timestamp | (Date) |
| inspectionStatus | (Object) |
| data.value | (String) (enum) Vehicle inspection service status. |
| timestamp | (Date) |
| lastECall | (Object) |
| data.value | (Date) (timestamp) Date-time of the last eCall |
| timestamp | (Date) |
| legalInspectionDate | (Object) |
| data.value | (Date) (timestamp) Next legally required inspection date |
| timestamp | (Date) |
| nextInspectionDate | (Object) |
| data.value | (Date) (timestamp) Next inspection date |
| timestamp | (Date) |
| nextInspectionDistanceTo | (Object) |
| data.value | (Number) (length) Distance until the next inspection. |
| timestamp | (Date) |
| nextOilServiceDate | (Object) |
| data.value | (Date) (timestamp) Next oil service date. |
| timestamp | (Date) |
| serviceDate | (Object) |
| data.value | (Date) (timestamp) Date of the earliest service. If this service is overdue, the date is in the past. |
| timestamp | (Date) |
| serviceDistanceThreshold | (Object) |
| data.value | (Number) (length) Distance threshold for service |
| timestamp | (Date) |
| serviceStatus | (Object) |
| data.value | (String) (enum) Consolidated status regarding service requirements. OK: no current service requirement, WARNING: at least one service has reported requirement, CRITICAL: at least one service is overdue. |
| timestamp | (Date) |
| serviceTimeThreshold | (Object) |
| data.value | (Number) (duration) Time threshold for service |
| timestamp | (Date) |
| teleserviceAvailability | (Object) |
| data.value | (String) (enum) |
| timestamp | (Date) |
| teleserviceBatteryCallDate | (Object) |
| data.value | (Date) (timestamp) Teleservice batter call date |
| timestamp | (Date) |
| timeToExhaustInspection | (Object) |
| data.value | (Number) (duration) Time until exhaust inspection |
| timestamp | (Date) |
| timeToNextOilService | (Object) |
| data.value | (Number) (duration) Indicates the time remaining until the next oil service; if this limit was exceeded, this value indicates the time that has passed since then. |
| timestamp | (Date) |
| timeToNextService | (Object) |
| data.value | (Number) (duration) Time until next servicing of the vehicle |
| timestamp | (Date) |
| vehicleCheckDate | (Object) |
| data.value | (Date) (timestamp) Vehicle check date (usually after a predetermined distance). |
| timestamp | (Date) |
| vehicleCheckDistanceTo | (Object) |
| data.value | (Number) (length) The distance until next vehicle check. |
| timestamp | (Date) |
| vehicleCheckStatus | (Object) |
| data.value | (String) (enum) Vehicle check service status. |
| timestamp | (Date) |
Example
{
"automaticTeleserviceCallDate": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": "2018-11-23T11:33:50.000Z"
}
},
"brakeFluidChangeDate": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": "2018-12-05T03:22:56.000Z"
}
},
"brakeFluidRemainingDistance": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": 1500.25,
"unit": "kilometers"
}
},
"brakeFluidStatus": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": "ok"
}
},
"brakesServiceDueDates": [
{
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"axle": {
"value": "front"
},
"dueDate": {
"value": "2022-03-30T09:58:48.000Z"
}
}
},
{
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"axle": {
"value": "rear"
},
"dueDate": {
"value": "2022-03-30T09:58:48.000Z"
}
}
}
],
"brakesServiceRemainingDistances": [
{
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"axle": {
"value": "front"
},
"distance": {
"value": 1500.25,
"unit": "kilometers"
}
}
},
{
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"axle": {
"value": "rear"
},
"distance": {
"value": 1500.25,
"unit": "kilometers"
}
}
}
],
"brakesServiceStatuses": [
{
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"axle": {
"value": "front"
},
"status": {
"value": "ok"
}
}
},
{
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"axle": {
"value": "rear"
},
"status": {
"value": "ok"
}
}
}
],
"cbsReportsCount": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": 3
}
},
"conditionBasedServices": [
{
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"year": {
"value": 2019
},
"month": {
"value": 5
},
"id": {
"value": 3
},
"dueStatus": {
"value": "ok"
},
"text": {
"value": "Brake fluid"
},
"description": {
"value": "Next change at specified date at the latest."
}
}
}
],
"distanceToNextOilService": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": 525.6,
"unit": "kilometers"
}
},
"distanceToNextService": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": 3681,
"unit": "kilometers"
}
},
"driveInInspectionDate": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": "2022-04-05T11:00:00.000Z"
}
},
"driveInInspectionDistanceTo": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": 3681,
"unit": "kilometers"
}
},
"driveInInspectionStatus": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": "ok"
}
},
"inspectionStatus": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": "ok"
}
},
"lastECall": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": "2018-12-05T03:22:56.000Z"
}
},
"legalInspectionDate": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": "2022-03-30T12:11:44.000Z"
}
},
"nextInspectionDate": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": "2018-10-23T14:38:47.000Z"
}
},
"nextInspectionDistanceTo": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": 1500.25,
"unit": "kilometers"
}
},
"nextOilServiceDate": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": "2022-03-30T12:11:44.000Z"
}
},
"serviceDate": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": "2022-03-30T12:11:44.000Z"
}
},
"serviceDistanceThreshold": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": 5000,
"unit": "kilometers"
}
},
"serviceStatus": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": "ok"
}
},
"serviceTimeThreshold": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": 4,
"unit": "weeks"
}
},
"teleserviceAvailability": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": "successful"
}
},
"teleserviceBatteryCallDate": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": "2018-11-23T10:36:50.000Z"
}
},
"timeToExhaustInspection": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": 5,
"unit": "months"
}
},
"timeToNextOilService": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": 66.8,
"unit": "days"
}
},
"timeToNextService": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": 501,
"unit": "days"
}
},
"vehicleCheckDate": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": "2022-04-01T08:51:28.093Z"
}
},
"vehicleCheckDistanceTo": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": 1350.4,
"unit": "kilometers"
}
},
"vehicleCheckStatus": {
"timestamp": "2021-06-01T15:48:04.887Z",
"data": {
"value": "ok"
}
}
}
getAvailability([, propertyNames])
Declaration
hmkit.commands.Maintenance.getAvailability()
Parameters
| propertyNames | (optional) Array of names of the properties you want returned. |
Example
// Get availability for all properties
hmkit.telematics.sendCommand(
hmkit.commands.Maintenance.getAvailability(),
accessCertificate
);
// Get availability for specific properties
hmkit.telematics.sendCommand(
hmkit.commands.Maintenance.getAvailability(['cbsReportsCount']),
accessCertificate
);
Response
Parameters
| availability | (Object) |
| updateRate.value | (String) enum |
| rateLimit.value | (Number) |
| rateLimit.unit | (String) |
| appliesPer.value | (String) |
Discussion
The response contains an availability object for each property, as shown in the example
Example
{
"cbsReportsCount": {
"availability": {
"updateRate": {
"value": "trip_high"
},
"rateLimit": {
"value": 64,
"unit": "hertz"
},
"appliesPer": {
"value": "vehicle"
}
}
}
}