Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
Documentation
OnVehicleData

Class OnVehicleData

Hierarchy

java.lang.Object
     com.smartdevicelink.proxy.RPCStruct
         com.smartdevicelink.proxy.RPCMessage
             com.smartdevicelink.proxy.RPCNotification

Package
com.smartdevicelink.proxy.rpc

Overview

Individual requested DID result and data.

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 com.smartdevicelink.proxy.rpc.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
stabilityControlsStatus StabilityControlsStatus See StabilityControlsStatus N SmartDeviceLink 7.0.0

Quick Jump

Fields
Constructors
Methods

Fields

KEY_SPEED

public static final java.lang.String KEY_SPEED
Constant Value
"speed"

KEY_RPM

public static final java.lang.String KEY_RPM
Constant Value
"rpm"

KEY_EXTERNAL_TEMPERATURE

public static final java.lang.String KEY_EXTERNAL_TEMPERATURE
Constant Value
"externalTemperature"

KEY_VIN

public static final java.lang.String KEY_VIN
Constant Value
"vin"

KEY_PRNDL

public static final java.lang.String KEY_PRNDL
Constant Value
"prndl"

KEY_TIRE_PRESSURE

public static final java.lang.String KEY_TIRE_PRESSURE
Constant Value
"tirePressure"

KEY_ENGINE_TORQUE

public static final java.lang.String KEY_ENGINE_TORQUE
Constant Value
"engineTorque"

KEY_ENGINE_OIL_LIFE

public static final java.lang.String KEY_ENGINE_OIL_LIFE
Constant Value
"engineOilLife"

KEY_ODOMETER

public static final java.lang.String KEY_ODOMETER
Constant Value
"odometer"

KEY_GPS

public static final java.lang.String KEY_GPS
Constant Value
"gps"

KEY_INSTANT_FUEL_CONSUMPTION

public static final java.lang.String KEY_INSTANT_FUEL_CONSUMPTION
Constant Value
"instantFuelConsumption"

KEY_BELT_STATUS

public static final java.lang.String KEY_BELT_STATUS
Constant Value
"beltStatus"

KEY_BODY_INFORMATION

public static final java.lang.String KEY_BODY_INFORMATION
Constant Value
"bodyInformation"

KEY_DEVICE_STATUS

public static final java.lang.String KEY_DEVICE_STATUS
Constant Value
"deviceStatus"

KEY_DRIVER_BRAKING

public static final java.lang.String KEY_DRIVER_BRAKING
Constant Value
"driverBraking"

KEY_WIPER_STATUS

public static final java.lang.String KEY_WIPER_STATUS
Constant Value
"wiperStatus"

KEY_HEAD_LAMP_STATUS

public static final java.lang.String KEY_HEAD_LAMP_STATUS
Constant Value
"headLampStatus"

KEY_ACC_PEDAL_POSITION

public static final java.lang.String KEY_ACC_PEDAL_POSITION
Constant Value
"accPedalPosition"

KEY_STEERING_WHEEL_ANGLE

public static final java.lang.String KEY_STEERING_WHEEL_ANGLE
Constant Value
"steeringWheelAngle"

KEY_E_CALL_INFO

public static final java.lang.String KEY_E_CALL_INFO
Constant Value
"eCallInfo"

KEY_AIRBAG_STATUS

public static final java.lang.String KEY_AIRBAG_STATUS
Constant Value
"airbagStatus"

KEY_EMERGENCY_EVENT

public static final java.lang.String KEY_EMERGENCY_EVENT
Constant Value
"emergencyEvent"

KEY_CLUSTER_MODE_STATUS

public static final java.lang.String KEY_CLUSTER_MODE_STATUS
Constant Value
"clusterModeStatus"

KEY_MY_KEY

public static final java.lang.String KEY_MY_KEY
Constant Value
"myKey"

KEY_FUEL_RANGE

public static final java.lang.String KEY_FUEL_RANGE
Constant Value
"fuelRange"

KEY_TURN_SIGNAL

public static final java.lang.String KEY_TURN_SIGNAL
Constant Value
"turnSignal"

KEY_ELECTRONIC_PARK_BRAKE_STATUS

public static final java.lang.String KEY_ELECTRONIC_PARK_BRAKE_STATUS
Constant Value
"electronicParkBrakeStatus"

KEY_CLOUD_APP_VEHICLE_ID

public static final java.lang.String KEY_CLOUD_APP_VEHICLE_ID
Constant Value
"cloudAppVehicleID"

KEY_HANDS_OFF_STEERING

public static final java.lang.String KEY_HANDS_OFF_STEERING
Constant Value
"handsOffSteering"

KEY_WINDOW_STATUS

public static final java.lang.String KEY_WINDOW_STATUS
Constant Value
"windowStatus"

KEY_GEAR_STATUS

public static final java.lang.String KEY_GEAR_STATUS
Constant Value
"gearStatus"

KEY_FUEL_LEVEL

public static final java.lang.String KEY_FUEL_LEVEL
Constant Value
"fuelLevel"

KEY_FUEL_LEVEL_STATE

public static final java.lang.String KEY_FUEL_LEVEL_STATE
Constant Value
"fuelLevel_State"

KEY_STABILITY_CONTROLS_STATUS

public static final java.lang.String KEY_STABILITY_CONTROLS_STATUS
Constant Value
"stabilityControlsStatus"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCMessage KEY_REQUEST, KEY_RESPONSE, KEY_NOTIFICATION, KEY_FUNCTION_NAME, KEY_PARAMETERS, KEY_CORRELATION_ID, messageType, parameters, function
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

OnVehicleData()

public OnVehicleData()

OnVehicleData( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

public OnVehicleData(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Parameters

hash

Methods

setGps( GPSData gps )

public com.smartdevicelink.proxy.rpc.OnVehicleData setGps(GPSData gps)

Parameters

gps

getGps()

public com.smartdevicelink.proxy.rpc.GPSData getGps()

setSpeed( Double speed )

public com.smartdevicelink.proxy.rpc.OnVehicleData setSpeed(Double speed)

Parameters

speed

getSpeed()

public java.lang.Double getSpeed()

setRpm( Integer rpm )

public com.smartdevicelink.proxy.rpc.OnVehicleData setRpm(Integer rpm)

Parameters

rpm

getRpm()

public java.lang.Integer getRpm()

setFuelLevel( Double fuelLevel )

Deprecated
Sets the fuelLevel.

public com.smartdevicelink.proxy.rpc.OnVehicleData setFuelLevel(Double fuelLevel)

Parameters

fuelLevel
The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec 7.0, please see fuelRange.

getFuelLevel()

Deprecated
Gets the fuelLevel.

public java.lang.Double getFuelLevel()

setFuelLevelState( ComponentVolumeStatus fuelLevelState )

Deprecated

public com.smartdevicelink.proxy.rpc.OnVehicleData setFuelLevelState(ComponentVolumeStatus fuelLevelState)

Parameters

fuelLevelState

getFuelLevelState()

Deprecated

public com.smartdevicelink.proxy.rpc.enums.ComponentVolumeStatus getFuelLevelState()

setInstantFuelConsumption( Double instantFuelConsumption )

public com.smartdevicelink.proxy.rpc.OnVehicleData setInstantFuelConsumption(Double instantFuelConsumption)

Parameters

instantFuelConsumption

getInstantFuelConsumption()

public java.lang.Double getInstantFuelConsumption()

setExternalTemperature( Double externalTemperature )

public com.smartdevicelink.proxy.rpc.OnVehicleData setExternalTemperature(Double externalTemperature)

Parameters

externalTemperature

getExternalTemperature()

public java.lang.Double getExternalTemperature()

setVin( String vin )

public com.smartdevicelink.proxy.rpc.OnVehicleData setVin(String vin)

Parameters

vin

getVin()

public java.lang.String getVin()

setPrndl( PRNDL prndl )

Deprecated
Sets the prndl.

public com.smartdevicelink.proxy.rpc.OnVehicleData setPrndl(PRNDL prndl)

Parameters

prndl
See PRNDL. This parameter is deprecated since 7.0.0 and it is now covered in `gearStatus`

getPrndl()

Deprecated
Gets the prndl.

public com.smartdevicelink.proxy.rpc.enums.PRNDL getPrndl()

setTirePressure( TireStatus tirePressure )

Sets the tirePressure.

public com.smartdevicelink.proxy.rpc.OnVehicleData setTirePressure(TireStatus tirePressure)

Parameters

tirePressure
See TireStatus

getTirePressure()

public com.smartdevicelink.proxy.rpc.TireStatus getTirePressure()

setOdometer( Integer odometer )

public com.smartdevicelink.proxy.rpc.OnVehicleData setOdometer(Integer odometer)

Parameters

odometer

getOdometer()

public java.lang.Integer getOdometer()

setBeltStatus( BeltStatus beltStatus )

public com.smartdevicelink.proxy.rpc.OnVehicleData setBeltStatus(BeltStatus beltStatus)

Parameters

beltStatus

getBeltStatus()

public com.smartdevicelink.proxy.rpc.BeltStatus getBeltStatus()

setBodyInformation( BodyInformation bodyInformation )

public com.smartdevicelink.proxy.rpc.OnVehicleData setBodyInformation(BodyInformation bodyInformation)

Parameters

bodyInformation

getBodyInformation()

public com.smartdevicelink.proxy.rpc.BodyInformation getBodyInformation()

setDeviceStatus( DeviceStatus deviceStatus )

public com.smartdevicelink.proxy.rpc.OnVehicleData setDeviceStatus(DeviceStatus deviceStatus)

Parameters

deviceStatus

getDeviceStatus()

public com.smartdevicelink.proxy.rpc.DeviceStatus getDeviceStatus()

setDriverBraking( VehicleDataEventStatus driverBraking )

public com.smartdevicelink.proxy.rpc.OnVehicleData setDriverBraking(VehicleDataEventStatus driverBraking)

Parameters

driverBraking

getDriverBraking()

public com.smartdevicelink.proxy.rpc.enums.VehicleDataEventStatus getDriverBraking()

setWiperStatus( WiperStatus wiperStatus )

public com.smartdevicelink.proxy.rpc.OnVehicleData setWiperStatus(WiperStatus wiperStatus)

Parameters

wiperStatus

getWiperStatus()

public com.smartdevicelink.proxy.rpc.enums.WiperStatus getWiperStatus()

setHeadLampStatus( HeadLampStatus headLampStatus )

public com.smartdevicelink.proxy.rpc.OnVehicleData setHeadLampStatus(HeadLampStatus headLampStatus)

Parameters

headLampStatus

getHeadLampStatus()

public com.smartdevicelink.proxy.rpc.HeadLampStatus getHeadLampStatus()

setEngineTorque( Double engineTorque )

public com.smartdevicelink.proxy.rpc.OnVehicleData setEngineTorque(Double engineTorque)

Parameters

engineTorque

getEngineTorque()

public java.lang.Double getEngineTorque()

setEngineOilLife( Float engineOilLife )

public com.smartdevicelink.proxy.rpc.OnVehicleData setEngineOilLife(Float engineOilLife)

Parameters

engineOilLife

getEngineOilLife()

public java.lang.Float getEngineOilLife()

setAccPedalPosition( Double accPedalPosition )

public com.smartdevicelink.proxy.rpc.OnVehicleData setAccPedalPosition(Double accPedalPosition)

Parameters

accPedalPosition

getAccPedalPosition()

public java.lang.Double getAccPedalPosition()

setSteeringWheelAngle( Double steeringWheelAngle )

public com.smartdevicelink.proxy.rpc.OnVehicleData setSteeringWheelAngle(Double steeringWheelAngle)

Parameters

steeringWheelAngle

getSteeringWheelAngle()

public java.lang.Double getSteeringWheelAngle()

setECallInfo( ECallInfo eCallInfo )

public com.smartdevicelink.proxy.rpc.OnVehicleData setECallInfo(ECallInfo eCallInfo)

Parameters

eCallInfo

getECallInfo()

public com.smartdevicelink.proxy.rpc.ECallInfo getECallInfo()

setAirbagStatus( AirbagStatus airbagStatus )

public com.smartdevicelink.proxy.rpc.OnVehicleData setAirbagStatus(AirbagStatus airbagStatus)

Parameters

airbagStatus

getAirbagStatus()

public com.smartdevicelink.proxy.rpc.AirbagStatus getAirbagStatus()

setEmergencyEvent( EmergencyEvent emergencyEvent )

public com.smartdevicelink.proxy.rpc.OnVehicleData setEmergencyEvent(EmergencyEvent emergencyEvent)

Parameters

emergencyEvent

getEmergencyEvent()

public com.smartdevicelink.proxy.rpc.EmergencyEvent getEmergencyEvent()

setClusterModeStatus( ClusterModeStatus clusterModeStatus )

public com.smartdevicelink.proxy.rpc.OnVehicleData setClusterModeStatus(ClusterModeStatus clusterModeStatus)

Parameters

clusterModeStatus

getClusterModeStatus()

public com.smartdevicelink.proxy.rpc.ClusterModeStatus getClusterModeStatus()

setMyKey( MyKey myKey )

public com.smartdevicelink.proxy.rpc.OnVehicleData setMyKey(MyKey myKey)

Parameters

myKey

getMyKey()

public com.smartdevicelink.proxy.rpc.MyKey getMyKey()

setFuelRange( java.util.List<com.smartdevicelink.proxy.rpc.FuelRange> fuelRange )

Sets the fuelRange.

public com.smartdevicelink.proxy.rpc.OnVehicleData setFuelRange(java.util.List<com.smartdevicelink.proxy.rpc.FuelRange> fuelRange)

Parameters

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}

getFuelRange()

Gets the fuelRange.

public java.util.List getFuelRange()

setTurnSignal( TurnSignal turnSignal )

Sets turnSignal

public com.smartdevicelink.proxy.rpc.OnVehicleData setTurnSignal(TurnSignal turnSignal)

Parameters

turnSignal

getTurnSignal()

Gets turnSignal

public com.smartdevicelink.proxy.rpc.enums.TurnSignal getTurnSignal()

setElectronicParkBrakeStatus( ElectronicParkBrakeStatus electronicParkBrakeStatus )

Sets electronicParkBrakeStatus

public com.smartdevicelink.proxy.rpc.OnVehicleData setElectronicParkBrakeStatus(ElectronicParkBrakeStatus electronicParkBrakeStatus)

Parameters

electronicParkBrakeStatus

getElectronicParkBrakeStatus()

Gets electronicParkBrakeStatus

public com.smartdevicelink.proxy.rpc.enums.ElectronicParkBrakeStatus getElectronicParkBrakeStatus()

setCloudAppVehicleID( String cloudAppVehicleID )

Sets a string value for the cloud app vehicle ID

public com.smartdevicelink.proxy.rpc.OnVehicleData setCloudAppVehicleID(String cloudAppVehicleID)

Parameters

cloudAppVehicleID
a string value

getCloudAppVehicleID()

Gets a String value of the returned cloud app vehicle ID

public java.lang.String getCloudAppVehicleID()

setOEMCustomVehicleData( String vehicleDataName, Object vehicleDataState )

Sets a value for OEM Custom VehicleData.

public com.smartdevicelink.proxy.rpc.OnVehicleData setOEMCustomVehicleData(String vehicleDataName,Object vehicleDataState)

Parameters

vehicleDataName
a String value
vehicleDataState
a VehicleDataResult value

getOEMCustomVehicleData( String vehicleDataName )

Gets a VehicleData value for the vehicle data item.

public java.lang.Object getOEMCustomVehicleData(String vehicleDataName)

Parameters

vehicleDataName

setWindowStatus( java.util.List<com.smartdevicelink.proxy.rpc.WindowStatus> windowStatus )

Sets the windowStatus.

public com.smartdevicelink.proxy.rpc.OnVehicleData setWindowStatus(java.util.List<com.smartdevicelink.proxy.rpc.WindowStatus> windowStatus)

Parameters

windowStatus
See WindowStatus

getWindowStatus()

Gets the windowStatus.

public java.util.List getWindowStatus()

getStabilityControlsStatus()

Gets the stabilityControlsStatus.

public com.smartdevicelink.proxy.rpc.StabilityControlsStatus getStabilityControlsStatus()

setStabilityControlsStatus( StabilityControlsStatus stabilityControlsStatus )

Sets the stabilityControlsStatus.

public com.smartdevicelink.proxy.rpc.OnVehicleData setStabilityControlsStatus(StabilityControlsStatus stabilityControlsStatus)

Parameters

stabilityControlsStatus
See StabilityControlsStatus

setHandsOffSteering( Boolean handsOffSteering )

Sets the handsOffSteering.

public com.smartdevicelink.proxy.rpc.OnVehicleData setHandsOffSteering(Boolean handsOffSteering)

Parameters

handsOffSteering
To indicate whether driver hands are off the steering wheel

getHandsOffSteering()

Gets the handsOffSteering.

public java.lang.Boolean getHandsOffSteering()

setGearStatus( GearStatus gearStatus )

Sets the gearStatus.

public com.smartdevicelink.proxy.rpc.OnVehicleData setGearStatus(GearStatus gearStatus)

Parameters

gearStatus
See GearStatus

getGearStatus()

Gets the gearStatus.

public com.smartdevicelink.proxy.rpc.GearStatus getGearStatus()

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCMessage getFunctionID, getFunctionName, setFunctionName, getMessageType, setParameters, getParameters, getObject, getString, getInteger, getFloat, getDouble, getBoolean, getLong
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section