public class OnVehicleData extends RPCNotification
Callback for the periodic and non periodic vehicle data read function.
Note:
Initially SDL sends SubscribeVehicleData for getting the periodic updates from HMI whenever each of subscribed data types changes. OnVehicleData is expected to bring such updated values to SDL
Parameter List
| Param Name | Type | Description | Req. | Notes | Version Available |
|---|---|---|---|---|---|
| Gps | Boolean | GPS data. See GPSData for details | N | Subscribable | SmartDeviceLink 2.0 |
| Speed | Float | The vehicle speed in kilometers per hour | N | Subscribable | SmartDeviceLink 2.0 |
| rpm | Integer | The number of revolutions per minute of the engine | N | Subscribable | SmartDeviceLink 2.0 |
| fuelLevel | Boolean | The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec7.0, please see fuelRange. | N | Subscribable | SmartDeviceLink 7.0.0 |
| fuelLevel_State | Boolean | The fuel level state. This parameter is deprecated starting RPC Spec 7.0, please see fuelRange. | N | Subscribable | SmartDeviceLink 7.0.0 |
| fuelRange | Boolean | The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details. | N | {"array_min_size": 0, "array_max_size": 100} | SmartDeviceLink 5.0.0 |
| instantFuelConsumption | Float | The instantaneous fuel consumption in micro litres | N | Subscribable | SmartDeviceLink 2.0 |
| externalTemperature | Float | The external temperature in degrees celsius. | N | Subscribable | SmartDeviceLink 2.0 |
| vin | String | Vehicle identification number. | N | Subscribable | SmartDeviceLink 2.0 |
| gearStatus | GearStatus | See GearStatus | N | SmartDeviceLink 7.0.0 | |
| gearStatus | GearStatus | See GearStatus | N | SmartDeviceLink 7.0.0 | |
| prndl | PRNDL | See PRNDL. This parameter is deprecated and it is now covered in `gearStatus` | N | SmartDeviceLink 7.0.0 | |
| tirePressure | TireStatus | Tire pressure status | N | Subscribable | SmartDeviceLink 2.0 |
| odometer | Integer | Odometer in km | N | Subscribable | SmartDeviceLink 2.0 |
| beltStatus | BeltStatus | The status of the seat belts. | N | Subscribable | SmartDeviceLink 2.0 |
| bodyInformation | BodyInformation | The body information including power modes. | N | Subscribable | SmartDeviceLink 2.0 |
| deviceStatus | DeviceStatus | The connected mobile device status including signal and battery strength. | N | Subscribable | SmartDeviceLink 2.0 |
| eCallInfo | ECallInfo | Emergency Call notification and confirmation data. | N | Subscribable | SmartDeviceLink 2.0 |
| airbagStatus | AirBagStatus | The status of the air bags. | N | Subscribable | SmartDeviceLink 2.0 |
| emergencyEvent | EmergencyEvent | Information related to an emergency event (and if it occurred). | N | Subscribable | SmartDeviceLink 2.0 |
| clusterModeStatus | ClusterModeStatus | The status modes of the instrument panel cluster. | N | Subscribable | SmartDeviceLink 2.0 |
| myKey | MyKey | Information related to the MyKey feature. | N | Subscribable | SmartDeviceLink 2.0 |
| driverBraking | vehicleDataEventStatus | The status of the brake pedal. | N | Subscribable | SmartDeviceLink 2.0 |
| wiperStatus | WiperStatus | The status of the wipers | N | SmartDeviceLink 2.0 | |
| headLampStatus | headLampStatus | Status of the head lamps | N | SmartDeviceLink 2.0 | |
| engineTorque | Float | Torque value for engine (in Nm) on non-diesel variants | N | minvalue:-1000; maxvalue:2000 | SmartDeviceLink 2.0 |
| engineOilLife | Float | The estimated percentage of remaining oil life of the engine | N | minvalue:0; maxvalue:100 | SmartDeviceLink 5.0 |
| accPedalPosition | Float | Accelerator pedal position (percentage depressed) | N | minvalue: 0; maxvalue:100 | SmartDeviceLink 2.0 |
| steeringWheelAngle | Float | Current angle of the steering wheel (in deg) | N | minvalue: -2000; maxvalue:2000 | SmartDeviceLink 2.0 |
| cloudAppVehicleID | String | ID for the vehicle when connecting to cloud applications | N | SmartDeviceLink 5.1 | |
| handsOffSteering | Boolean | To indicate whether driver hands are off the steering wheel | N | SmartDeviceLink 7.0.0 | |
| windowStatus | Boolean | See WindowStatus | N | SmartDeviceLink 7.0.0 | |
| climateData | ClimateData | See ClimateData | N |
|
|
| stabilityControlsStatus | StabilityControlsStatus | See StabilityControlsStatus | N | SmartDeviceLink 7.0.0 | |
| seatOccupancy | SeatOccupancy | See SeatOccupancy | N | , SmartDeviceLink 7.1.0 |
SubscribeVehicleData,
UnsubscribeVehicleDatafunction, KEY_CORRELATION_ID, KEY_FUNCTION_NAME, KEY_NOTIFICATION, KEY_PARAMETERS, KEY_REQUEST, KEY_RESPONSE, messageType, parametersKEY_BULK_DATA, KEY_PROTECTED, store| Constructor and Description |
|---|
OnVehicleData() |
OnVehicleData(Hashtable<String,Object> hash) |
getBoolean, getDouble, getFloat, getFunctionID, getFunctionName, getInteger, getLong, getMessageType, getObject, getParameters, getString, setFunctionName, setParametersclone, deserializeJSON, equals, format, formatObject, getBulkData, getMessageTypeName, getStore, getStoreValue, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValuepublic static final String KEY_SPEED
public static final String KEY_RPM
@Deprecated public static final String KEY_EXTERNAL_TEMPERATURE
public static final String KEY_VIN
public static final String KEY_PRNDL
public static final String KEY_TIRE_PRESSURE
public static final String KEY_ENGINE_TORQUE
public static final String KEY_ENGINE_OIL_LIFE
public static final String KEY_ODOMETER
public static final String KEY_GPS
public static final String KEY_INSTANT_FUEL_CONSUMPTION
public static final String KEY_BELT_STATUS
public static final String KEY_BODY_INFORMATION
public static final String KEY_DEVICE_STATUS
public static final String KEY_DRIVER_BRAKING
public static final String KEY_WIPER_STATUS
public static final String KEY_HEAD_LAMP_STATUS
public static final String KEY_ACC_PEDAL_POSITION
public static final String KEY_STEERING_WHEEL_ANGLE
public static final String KEY_E_CALL_INFO
public static final String KEY_AIRBAG_STATUS
public static final String KEY_EMERGENCY_EVENT
public static final String KEY_CLUSTER_MODE_STATUS
public static final String KEY_MY_KEY
public static final String KEY_FUEL_RANGE
public static final String KEY_TURN_SIGNAL
public static final String KEY_ELECTRONIC_PARK_BRAKE_STATUS
public static final String KEY_CLOUD_APP_VEHICLE_ID
public static final String KEY_HANDS_OFF_STEERING
public static final String KEY_WINDOW_STATUS
public static final String KEY_GEAR_STATUS
public static final String KEY_CLIMATE_DATA
@Deprecated public static final String KEY_FUEL_LEVEL
@Deprecated public static final String KEY_FUEL_LEVEL_STATE
public static final String KEY_STABILITY_CONTROLS_STATUS
public static final String KEY_SEAT_OCCUPANCY
public OnVehicleData setGps(GPSData gps)
public GPSData getGps()
public OnVehicleData setSpeed(Double speed)
public Double getSpeed()
public OnVehicleData setRpm(Integer rpm)
public Integer getRpm()
@Deprecated public OnVehicleData setFuelLevel(Double fuelLevel)
fuelLevel - The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec
7.0, please see fuelRange.@Deprecated public Double getFuelLevel()
@Deprecated public OnVehicleData setFuelLevelState(ComponentVolumeStatus fuelLevelState)
@Deprecated public ComponentVolumeStatus getFuelLevelState()
public OnVehicleData setInstantFuelConsumption(Double instantFuelConsumption)
public Double getInstantFuelConsumption()
@Deprecated public OnVehicleData setExternalTemperature(Double externalTemperature)
externalTemperature - The external temperature in degrees celsius. This parameter is deprecated starting RPC
Spec 7.1.0, please see climateData.
{"num_min_value": -40.0, "num_max_value": 100.0}@Deprecated public Double getExternalTemperature()
public OnVehicleData setVin(String vin)
public String getVin()
@Deprecated public OnVehicleData setPrndl(PRNDL prndl)
prndl - See PRNDL. This parameter is deprecated since 7.0.0 and it is now covered in `gearStatus`@Deprecated public PRNDL getPrndl()
public OnVehicleData setTirePressure(TireStatus tirePressure)
tirePressure - See TireStatuspublic TireStatus getTirePressure()
public OnVehicleData setOdometer(Integer odometer)
public Integer getOdometer()
public OnVehicleData setBeltStatus(BeltStatus beltStatus)
public BeltStatus getBeltStatus()
public OnVehicleData setBodyInformation(BodyInformation bodyInformation)
public BodyInformation getBodyInformation()
public OnVehicleData setDeviceStatus(DeviceStatus deviceStatus)
public DeviceStatus getDeviceStatus()
public OnVehicleData setDriverBraking(VehicleDataEventStatus driverBraking)
public VehicleDataEventStatus getDriverBraking()
public OnVehicleData setWiperStatus(WiperStatus wiperStatus)
public WiperStatus getWiperStatus()
public OnVehicleData setHeadLampStatus(HeadLampStatus headLampStatus)
public HeadLampStatus getHeadLampStatus()
public OnVehicleData setEngineTorque(Double engineTorque)
public Double getEngineTorque()
public OnVehicleData setEngineOilLife(Float engineOilLife)
public Float getEngineOilLife()
public OnVehicleData setAccPedalPosition(Double accPedalPosition)
public Double getAccPedalPosition()
public OnVehicleData setSteeringWheelAngle(Double steeringWheelAngle)
public Double getSteeringWheelAngle()
public OnVehicleData setECallInfo(ECallInfo eCallInfo)
public ECallInfo getECallInfo()
public OnVehicleData setAirbagStatus(AirbagStatus airbagStatus)
public AirbagStatus getAirbagStatus()
public OnVehicleData setEmergencyEvent(EmergencyEvent emergencyEvent)
public EmergencyEvent getEmergencyEvent()
public OnVehicleData setClusterModeStatus(ClusterModeStatus clusterModeStatus)
public ClusterModeStatus getClusterModeStatus()
public OnVehicleData setMyKey(MyKey myKey)
public MyKey getMyKey()
public OnVehicleData setFuelRange(List<FuelRange> fuelRange)
fuelRange - The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the
vehicle. See struct FuelRange for details.
{"array_min_size": 0, "array_max_size": 100}public List<FuelRange> getFuelRange()
public OnVehicleData setTurnSignal(TurnSignal turnSignal)
turnSignal - public TurnSignal getTurnSignal()
public OnVehicleData setElectronicParkBrakeStatus(ElectronicParkBrakeStatus electronicParkBrakeStatus)
electronicParkBrakeStatus - public ElectronicParkBrakeStatus getElectronicParkBrakeStatus()
public OnVehicleData setCloudAppVehicleID(String cloudAppVehicleID)
cloudAppVehicleID - a string valuepublic String getCloudAppVehicleID()
public OnVehicleData setOEMCustomVehicleData(String vehicleDataName, Object vehicleDataState)
vehicleDataName - a String valuevehicleDataState - a VehicleDataResult valuepublic Object getOEMCustomVehicleData(String vehicleDataName)
public OnVehicleData setWindowStatus(List<WindowStatus> windowStatus)
windowStatus - See WindowStatuspublic List<WindowStatus> getWindowStatus()
public StabilityControlsStatus getStabilityControlsStatus()
public OnVehicleData setStabilityControlsStatus(StabilityControlsStatus stabilityControlsStatus)
stabilityControlsStatus - See StabilityControlsStatuspublic OnVehicleData setHandsOffSteering(Boolean handsOffSteering)
handsOffSteering - To indicate whether driver hands are off the steering wheelpublic Boolean getHandsOffSteering()
public OnVehicleData setGearStatus(GearStatus gearStatus)
gearStatus - See GearStatuspublic GearStatus getGearStatus()
public OnVehicleData setClimateData(ClimateData climateData)
climateData - See ClimateDatapublic ClimateData getClimateData()
public OnVehicleData setSeatOccupancy(SeatOccupancy seatOccupancy)
seatOccupancy - See SeatOccupancypublic SeatOccupancy getSeatOccupancy()