Dashboard Lights
getDashboardLights([, propertyNames])
Declaration
hmkit.commands.DashboardLights.getDashboardLights()
Parameters
| propertyNames | (optional) Array of names of the properties you want returned. |
Returns
DashboardLightsResponse
Example
hmkit.telematics.sendCommand(
hmkit.commands.DashboardLights.getDashboardLights(),
accessCertificate
);
DashboardLightsResponse
Parameters
| dashboardLights | (Object) |
| data.value | (Array |
| timestamp | (Date) |
Example
{
"dashboardLights": [
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "high_beam"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "low_beam"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "hazard_warning"
},
"state": {
"value": "on"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "brake_failure"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "hatch_open"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "fuel_level"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "engine_coolant_temperature"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "battery_charging_condition"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "engine_oil"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "position_lights"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "front_fog_light"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "rear_fog_light"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "park_heating"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "engine_indicator"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "service_call"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "transmission_fluid_temperature"
},
"state": {
"value": "on"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "transmission_failure"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "anti_lock_brake_failure"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "worn_brake_linings"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "windscreen_washer_fluid"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "tire_failure"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "engine_oil_level"
},
"state": {
"value": "on"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "engine_coolant_level"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "steering_failure"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "esc_indication"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "brake_lights"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "adblue_level"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "fuel_filter_diff_pressure"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "seat_belt"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "advanced_braking"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "acc"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "trailer_connected"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "airbag"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "esc_switched_off"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "lane_departure_warning_off"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "air_filter_minder"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "air_suspension_ride_control_fault"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "all_wheel_drive_disabled"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "anti_theft"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "blind_spot_detection"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "charge_system_fault"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "check_fuel_cap"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "check_fuel_fill_inlet"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "check_fuel_filter"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "dc_temp_warning"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "dc_warning_status"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "diesel_engine_idle_shutdown"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "diesel_engine_warning"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "diesel_exhaust_fluid_system_fault"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "diesel_exhaust_over_temp"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "diesel_exhaust_fluid_quality"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "diesel_filter_regeneration"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "diesel_particulate_filter"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "diesel_pre_heat"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "electric_trailer_brake_connection"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "ev_battery_cell_max_volt_warning"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "ev_battery_cell_min_volt_warning"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "ev_battery_charge_energy_storage_warning"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "ev_battery_high_level_warning"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "ev_battery_high_temperature_warning"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "ev_battery_insulation_resist_warning"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "ev_battery_jump_level_warning"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "ev_battery_low_level_warning"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "ev_battery_max_volt_veh_energy_warning"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "ev_battery_min_volt_veh_energy_warning"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "ev_battery_over_charge_warning"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "ev_battery_poor_cell_warning"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "ev_battery_temp_diff_warning"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "forward_collision_warning"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "fuel_door_open"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "hill_descent_control_fault"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "hill_start_assist_warning"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "hv_interlocking_status_warning"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "lighting_system_failure"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "malfunction_indicator"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "motor_controller_temp_warning"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "park_aid_malfunction"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "passive_entry_passive_start"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "powertrain_malfunction"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "restraints_indicator_warning"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "start_stop_engine_warning"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "traction_control_disabled"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "traction_control_active"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "traction_motor_temp_warning"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "tire_pressure_monitor_system_warning"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "water_in_fuel"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "tire_warning_front_right"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "tire_warning_front_left"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "tire_warning_rear_right"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "tire_warning_rear_left"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "tire_warning_system_error"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "battery_low_warning"
},
"state": {
"value": "off"
}
}
}
},
{
"timestamp": "2020-12-21T15:48:04.887Z",
"data": {
"value": {
"name": {
"value": "brake_fluid_warning"
},
"state": {
"value": "off"
}
}
}
}
]
}
getAvailability([, propertyNames])
Declaration
hmkit.commands.DashboardLights.getAvailability()
Parameters
| propertyNames | (optional) Array of names of the properties you want returned. |
Example
// Get availability for all properties
hmkit.telematics.sendCommand(
hmkit.commands.DashboardLights.getAvailability(),
accessCertificate
);
// Get availability for specific properties
hmkit.telematics.sendCommand(
hmkit.commands.DashboardLights.getAvailability(['dashboard_lights']),
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
{
"dashboard_lights": {
"availability": {
"updateRate": {
"value": "trip_high"
},
"rateLimit": {
"value": 64,
"unit": "hertz"
},
"appliesPer": {
"value": "vehicle"
}
}
}
}