Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

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 {@linkplain 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 Float The fuel level in the tank (percentage) N Subscribable SmartDeviceLink 2.0
fuelLevel_State ComponentVolumeStatus The fuel level state (Ok/Low) N Subscribable SmartDeviceLink 2.0
instantFuelConsumption Float The instantaneous fuel consumption in microlitres 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
prndl PRNDL Currently selected gear. N Subscribable SmartDeviceLink 2.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 EmergencyEvernt 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

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_FUEL_LEVEL

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

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_FUEL_LEVEL_STATE

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

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"

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 void setGps(GPSData gps)

Parameters

gps

getGps()

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

setSpeed( Double speed )

public void setSpeed(Double speed)

Parameters

speed

getSpeed()

public java.lang.Double getSpeed()

setRpm( Integer rpm )

public void setRpm(Integer rpm)

Parameters

rpm

getRpm()

public java.lang.Integer getRpm()

setFuelLevel( Double fuelLevel )

public void setFuelLevel(Double fuelLevel)

Parameters

fuelLevel

getFuelLevel()

public java.lang.Double getFuelLevel()

setFuelLevel_State( ComponentVolumeStatus fuelLevel_State )

Deprecated

public void setFuelLevel_State(ComponentVolumeStatus fuelLevel_State)

Parameters

fuelLevel_State

getFuelLevel_State()

Deprecated

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

setFuelLevelState( ComponentVolumeStatus fuelLevelState )

public void setFuelLevelState(ComponentVolumeStatus fuelLevelState)

Parameters

fuelLevelState

getFuelLevelState()

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

setInstantFuelConsumption( Double instantFuelConsumption )

public void setInstantFuelConsumption(Double instantFuelConsumption)

Parameters

instantFuelConsumption

getInstantFuelConsumption()

public java.lang.Double getInstantFuelConsumption()

setExternalTemperature( Double externalTemperature )

public void setExternalTemperature(Double externalTemperature)

Parameters

externalTemperature

getExternalTemperature()

public java.lang.Double getExternalTemperature()

setVin( String vin )

public void setVin(String vin)

Parameters

vin

getVin()

public java.lang.String getVin()

setPrndl( PRNDL prndl )

public void setPrndl(PRNDL prndl)

Parameters

prndl

getPrndl()

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

setTirePressure( TireStatus tirePressure )

public void setTirePressure(TireStatus tirePressure)

Parameters

tirePressure

getTirePressure()

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

setOdometer( Integer odometer )

public void setOdometer(Integer odometer)

Parameters

odometer

getOdometer()

public java.lang.Integer getOdometer()

setBeltStatus( BeltStatus beltStatus )

public void setBeltStatus(BeltStatus beltStatus)

Parameters

beltStatus

getBeltStatus()

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

setBodyInformation( BodyInformation bodyInformation )

public void setBodyInformation(BodyInformation bodyInformation)

Parameters

bodyInformation

getBodyInformation()

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

setDeviceStatus( DeviceStatus deviceStatus )

public void setDeviceStatus(DeviceStatus deviceStatus)

Parameters

deviceStatus

getDeviceStatus()

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

setDriverBraking( VehicleDataEventStatus driverBraking )

public void setDriverBraking(VehicleDataEventStatus driverBraking)

Parameters

driverBraking

getDriverBraking()

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

setWiperStatus( WiperStatus wiperStatus )

public void setWiperStatus(WiperStatus wiperStatus)

Parameters

wiperStatus

getWiperStatus()

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

setHeadLampStatus( HeadLampStatus headLampStatus )

public void setHeadLampStatus(HeadLampStatus headLampStatus)

Parameters

headLampStatus

getHeadLampStatus()

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

setEngineTorque( Double engineTorque )

public void setEngineTorque(Double engineTorque)

Parameters

engineTorque

getEngineTorque()

public java.lang.Double getEngineTorque()

setEngineOilLife( Float engineOilLife )

public void setEngineOilLife(Float engineOilLife)

Parameters

engineOilLife

getEngineOilLife()

public java.lang.Float getEngineOilLife()

setAccPedalPosition( Double accPedalPosition )

public void setAccPedalPosition(Double accPedalPosition)

Parameters

accPedalPosition

getAccPedalPosition()

public java.lang.Double getAccPedalPosition()

setSteeringWheelAngle( Double steeringWheelAngle )

public void setSteeringWheelAngle(Double steeringWheelAngle)

Parameters

steeringWheelAngle

getSteeringWheelAngle()

public java.lang.Double getSteeringWheelAngle()

setECallInfo( ECallInfo eCallInfo )

public void setECallInfo(ECallInfo eCallInfo)

Parameters

eCallInfo

getECallInfo()

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

setAirbagStatus( AirbagStatus airbagStatus )

public void setAirbagStatus(AirbagStatus airbagStatus)

Parameters

airbagStatus

getAirbagStatus()

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

setEmergencyEvent( EmergencyEvent emergencyEvent )

public void setEmergencyEvent(EmergencyEvent emergencyEvent)

Parameters

emergencyEvent

getEmergencyEvent()

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

setClusterModeStatus( ClusterModeStatus clusterModeStatus )

public void setClusterModeStatus(ClusterModeStatus clusterModeStatus)

Parameters

clusterModeStatus

getClusterModeStatus()

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

setMyKey( MyKey myKey )

public void setMyKey(MyKey myKey)

Parameters

myKey

getMyKey()

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

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

Sets Fuel Range List. Fuel Range - The estimate range in KM the vehicle can travel based on fuel level and consumption.

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

Parameters

fuelRange

getFuelRange()

Gets Fuel Range List.

public java.util.List getFuelRange()

setTurnSignal( TurnSignal turnSignal )

Sets turnSignal

public void setTurnSignal(TurnSignal turnSignal)

Parameters

turnSignal

getTurnSignal()

Gets turnSignal

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

setElectronicParkBrakeStatus( ElectronicParkBrakeStatus electronicParkBrakeStatus )

Sets electronicParkBrakeStatus

public void setElectronicParkBrakeStatus(ElectronicParkBrakeStatus electronicParkBrakeStatus)

Parameters

electronicParkBrakeStatus

getElectronicParkBrakeStatus()

Gets electronicParkBrakeStatus

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

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCMessage getFunctionName, setFunctionName, getMessageType, setParameters, getParameters, getObject, getString, getInteger, getFloat, getDouble, getBoolean, getLong
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, deserializeJSONObject, 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