Vehicle Information

Table of Contents

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

buildDate(Object)
data.value

(Date) (timestamp) Build (construction) date of the vehicle.

timestamp

(Date)

colourName(Object)
data.value

(String) The colour name

timestamp

(Date)

countryCode(Object)
data.value

(String) The country code of the vehicle.

timestamp

(Date)

dataQuality(Object)
data.value

(String) (enum) Evaluation of the timeliness of the available vehicle data.

timestamp

(Date)

displayUnit(Object)
data.value

(String) (enum)

timestamp

(Date)

drive(Object)
data.value

(String) (enum) Wheels driven by the engine

timestamp

(Date)

driverSeatLocation(Object)
data.value

(String) (enum)

timestamp

(Date)

engineMaxTorque(Object)
data.value

(Number) (torque) The maximum engine torque

timestamp

(Date)

engineVolume(Object)
data.value

(Number) (volume) The engine volume displacement

timestamp

(Date)

equipments(Object)
data.value

(Array) (string) Names of equipment the vehicle is equipped with

timestamp

(Date)

extraEquipmentCodes(Object)
data.value

(Array) (string) Codes of the extra equipment the vehicle has

timestamp

(Date)

fuelTankCapacity(Object)
data.value

(Number) (volume) The fuel tank capacity measured in liters

timestamp

(Date)

gearbox(Object)
data.value

(String) (enum)

timestamp

(Date)

language(Object)
data.value

(String) The language on headunit

timestamp

(Date)

lastDataTransferDate(Object)
data.value

(Date) (timestamp) The last trip date

timestamp

(Date)

licensePlate(Object)
data.value

(String) The license plate number

timestamp

(Date)

modelKey(Object)
data.value

(String) The model key of the vehicle.

timestamp

(Date)

modelName(Object)
data.value

(String) The vehicle model name

timestamp

(Date)

modelYear(Object)
data.value

(Number) (uinteger) The vehicle model manufacturing year number

timestamp

(Date)

name(Object)
data.value

(String) The vehicle name (nickname)

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)

power(Object)
data.value

(Number) (power) The power of the vehicle

timestamp

(Date)

powertrain(Object)
data.value

(String) (enum) Type of the (primary) powertrain

timestamp

(Date)

powertrainSecondary(Object)
data.value

(String) (enum)

timestamp

(Date)

salesDesignation(Object)
data.value

(String) The sales designation of the model

timestamp

(Date)

series(Object)
data.value

(String) The vehicle model's series

timestamp

(Date)

timeformat(Object)
data.value

(String) (enum) The timeformat on headunit

timestamp

(Date)

timeZone(Object)
data.value

(String) (enum) Time zone setting in the vehicle.

timestamp

(Date)

vehicleMass(Object)
data.value

(Number) (mass) Vehicle mass.

timestamp

(Date)

Example

{
  "buildDate": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "2022-03-31T11:51:29.000Z"
    }
  },
  "colourName": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "Estoril Blau"
    }
  },
  "countryCode": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "DE"
    }
  },
  "dataQuality": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "up_to_date"
    }
  },
  "displayUnit": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "km"
    }
  },
  "drive": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "rwd"
    }
  },
  "driverSeatLocation": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "left"
    }
  },
  "engineMaxTorque": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 245,
      "unit": "newton_meters"
    }
  },
  "engineVolume": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 2.5,
      "unit": "liters"
    }
  },
  "equipments": [
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "value": "Parking sensors"
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "value": "Automatic wipers"
      }
    }
  ],
  "extraEquipmentCodes": [
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "value": "CODE123"
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "value": "EQP666"
      }
    }
  ],
  "fuelTankCapacity": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 80,
      "unit": "liters"
    }
  },
  "gearbox": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "automatic"
    }
  },
  "language": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "estonian"
    }
  },
  "lastDataTransferDate": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "2018-10-17T12:34:58.000Z"
    }
  },
  "licensePlate": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "ABC123"
    }
  },
  "modelKey": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "C32"
    }
  },
  "modelName": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "Type X"
    }
  },
  "modelYear": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 2019
    }
  },
  "name": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "Speedy"
    }
  },
  "numberOfDoors": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 5
    }
  },
  "numberOfSeats": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 5
    }
  },
  "power": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 220,
      "unit": "kilowatts"
    }
  },
  "powertrain": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "all_electric"
    }
  },
  "powertrainSecondary": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "petrol"
    }
  },
  "salesDesignation": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "Package+"
    }
  },
  "series": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "A4"
    }
  },
  "timeformat": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "twenty_four_h"
    }
  },
  "timeZone": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "summertime"
    }
  },
  "vehicleMass": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 1635,
      "unit": "kilograms"
    }
  }
}

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"
      }
    }
  }
}