Vehicle Information
getVehicleInformation([, propertyNames])
Declaration
hmkit.commands.VehicleInformation.getVehicleInformation()
Parameters
propertyNames | (optional) Array of names of the properties you want returned. |
Returns
VehicleInformationResponse
Example
hmkit.telematics.sendCommand(
hmkit.commands.VehicleInformation.getVehicleInformation(),
accessCertificate
);
VehicleInformationResponse
Parameters
powertrain | (Object) |
data.value | (String) (enum) |
timestamp | (Date) |
modelName | (Object) |
data.value | (String) The vehicle model name |
timestamp | (Date) |
name | (Object) |
data.value | (String) The vehicle name (nickname) |
timestamp | (Date) |
licensePlate | (Object) |
data.value | (String) The license plate number |
timestamp | (Date) |
salesDesignation | (Object) |
data.value | (String) The sales designation of the model |
timestamp | (Date) |
modelYear | (Object) |
data.value | (Number) (uinteger) The vehicle model manufacturing year number |
timestamp | (Date) |
colourName | (Object) |
data.value | (String) The colour name |
timestamp | (Date) |
powerInKW | (Object) |
data.value | (Number) (power) The power of the vehicle |
timestamp | (Date) |
numberOfDoors | (Object) |
data.value | (Number) (uinteger) The number of doors |
timestamp | (Date) |
numberOfSeats | (Object) |
data.value | (Number) (uinteger) The number of seats |
timestamp | (Date) |
engineVolume | (Object) |
data.value | (Number) (volume) The engine volume displacement |
timestamp | (Date) |
engineMaxTorque | (Object) |
data.value | (Number) (torque) The maximum engine torque |
timestamp | (Date) |
gearbox | (Object) |
data.value | (String) (enum) |
timestamp | (Date) |
displayUnit | (Object) |
data.value | (String) (enum) |
timestamp | (Date) |
driverSeatLocation | (Object) |
data.value | (String) (enum) |
timestamp | (Date) |
equipments | (Object) |
data.value | (Array |
timestamp | (Date) |
power | (Object) |
data.value | (Number) (power) The power of the vehicle |
timestamp | (Date) |
language | (Object) |
data.value | (String) The language on headunit |
timestamp | (Date) |
timeformat | (Object) |
data.value | (String) (enum) The timeformat on headunit |
timestamp | (Date) |
drive | (Object) |
data.value | (String) (enum) Wheels driven by the engine |
timestamp | (Date) |
Example
{
"powertrain": {
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"value": "all_electric"
}
}
},
"modelName": {
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"value": "Type X"
}
}
},
"name": {
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"value": "Speedy"
}
}
},
"licensePlate": {
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"value": "ABC123"
}
}
},
"salesDesignation": {
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"value": "Package+"
}
}
},
"modelYear": {
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"value": 2019
}
}
},
"colourName": {
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"value": "Estoril Blau"
}
}
},
"powerInKW": {
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"value": 220,
"unit": "kilowatts"
}
}
},
"numberOfDoors": {
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"value": 5
}
}
},
"numberOfSeats": {
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"value": 5
}
}
},
"engineVolume": {
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"value": 2.5,
"unit": "liters"
}
}
},
"engineMaxTorque": {
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"value": 245,
"unit": "newton_meters"
}
}
},
"gearbox": {
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"value": "automatic"
}
}
},
"displayUnit": {
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"value": "km"
}
}
},
"driverSeatLocation": {
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"value": "left"
}
}
},
"equipments": [
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"value": "Parking sensors"
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"value": "Automatic wipers"
}
}
}
],
"power": {
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"value": 220,
"unit": "kilowatts"
}
}
},
"language": {
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"value": "estonian"
}
}
},
"timeformat": {
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"value": "twenty_four_h"
}
}
},
"drive": {
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"value": "rwd"
}
}
}
}
getAvailability([, propertyNames])
Declaration
hmkit.commands.VehicleInformation.getAvailability()
Parameters
propertyNames | (optional) Array of names of the properties you want returned. |
Example
// Get availability for all properties
hmkit.telematics.sendCommand(
hmkit.commands.VehicleInformation.getAvailability(),
accessCertificate
);
// Get availability for specific properties
hmkit.telematics.sendCommand(
hmkit.commands.VehicleInformation.getAvailability(['powertrain']),
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
{
"powertrain": {
"availability": {
"updateRate": {
"value": "trip_high"
},
"rateLimit": {
"value": 64,
"unit": "hertz"
},
"appliesPer": {
"value": "vehicle"
}
}
}
}