Skip to content

Vehicle Events

Info

This document is a work in progress.

Currently, Vehicle events contain below events, still working in progress:

  • Vehicle Events
    • Start Engine Event - When ignition is turned on, HMI application should send "START_ENGINE" event.
    • Stop Engine Event - When ignition is turned off, HMI application should send "STOP_ENGINE" event.
    • Charge State Event - Should be sent when updates on current charge state of the vehicle.
    • Climate State Event - Should be sent when updates on current climate state of the vehicle.

Vehicle Events

Start Engine Event

When ignition is turned on, HMI application should send a "START_ENGINE" event.

Key methods: No need, no mandatory data field need to be filled in.

Sample code

1
2
3
4
SendEventRequest.Builder builder = dataCollectorClient.sendEventRequest();
SendEventResponse response = builder
  .setEvent(StartEngineEvent.builder().
  .build()).build().execute();

1
2
3
4
var builder = dataCollectorClient.sendEventRequest()
var response = builder
  .setEvent(StartEngineEvent.builder().
  .build()).build().execute()

Response example

1
2
3
4
5
{
  "code": "SUCCESS",
  "message": "SendEventResponse Success",
  "response_time": 1
}

Stop Engine Event

When ignition is turned off, HMI application should send a "STOP_ENGINE" event.

Key methods: No need, no mandatory data field need to be filled in.

Sample code

1
2
3
4
SendEventRequest.Builder builder = dataCollectorClient.sendEventRequest();
SendEventResponse response = builder
  .setEvent(StopEngineEvent.builder().
  .build()).build().execute();

1
2
3
4
var builder = dataCollectorClient.sendEventRequest()
var response = builder
  .setEvent(StopEngineEvent.builder().
  .build()).build().execute()

Response example

1
2
3
4
5
{
  "code": "SUCCESS",
  "message": "SendEventResponse Success",
  "response_time": 1
}

Charge State Event

Should be sent when updates on current charge state of the vehicle.

Key methods:

Method Details
setBatteryLevel(Double battery_level) Set battery level in percentage, mandatory data field.
setBatteryRange(Double battery_range) Set battery range in km, mandatory data field.
setTimestamp(Long timestamp) The time at which location was determined in milliseconds, mandatory data field.

Sample code

1
2
3
SendEventRequest.Builder builder = dataCollectorClient.sendEventRequest();
SendEventResponse response = builder.setEvent(ChargeStateEvent.builder().setBatteryLevel(77.7).setBatteryRange(100.0).setTimestamp(1597029160173L)
  .build()).build().execute();

1
2
3
var builder = dataCollectorClient.sendEventRequest()
var response = builder.setEvent(ChargeStateEvent.builder().setBatteryLevel(77.7).setBatteryRange(100.0).setTimestamp(1597029160173L)
  .build()).build().execute()

Response example

1
2
3
4
5
{
  "code": "SUCCESS",
  "message": "SendEventResponse Success",
  "response_time": 1
}

Climate State Event

Should be sent when updates on current climate state of the vehicle.

Key methods:

Method Details
setInsideTemp(Double inside_temp) Set vehicle inside temperature in celsius, optional data field.
setOutsideTemp(Double outside_temp) Set vehicle outside temperature in celsius, mandatory data field.
setDriverTempSetting(Double driver_temp_setting) Set vehicle temperature set by driver in celsius, optional data field.
setTimestamp(Long timestamp) The time at which location was determined in milliseconds, mandatory data field.

Sample code

1
2
3
SendEventRequest.Builder builder = dataCollectorClient.sendEventRequest();
SendEventResponse response = builder.setEvent(ClimateStateEvent.builder().setDriverTempSetting(7.7).setInsideTemp(7.7).setOutsideTemp(7.7).setTimestamp(1597029160173L)
  .build()).build().execute();

1
2
3
var builder = dataCollectorClient.sendEventRequest()
var response = builder.setEvent(CClimateStateEvent.builder().setDriverTempSetting(7.7).setInsideTemp(7.7).setOutsideTemp(7.7).setTimestamp(1597029160173L)
  .build()).build().execute()

Response example

1
2
3
4
5
{
  "code": "SUCCESS",
  "message": "SendEventResponse Success",
  "response_time": 1
}