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
GetVehicleData

Class GetVehicleData

Hierarchy

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

Package
com.smartdevicelink.proxy.rpc

Overview

Non periodic vehicle data read request.

Parameter List

Name Type Description Reg. Notes Version
gps Boolean GPS data. See {@linkplain com.smartdevicelink.proxy.rpc.GPSData }for details N Subscribable SmartDeviceLink 2.0
speed Boolean The vehicle speed in kilometers per hour N Subscribable SmartDeviceLink 2.0
rpm Boolean 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 Subscribable SmartDeviceLink 5.0.0
instantFuelConsumption Boolean The instantaneous fuel consumption in micro litres N Subscribable SmartDeviceLink 2.0
externalTemperature Boolean The external temperature in degrees celsius N Subscribable SmartDeviceLink 2.0
vin Boolean Vehicle identification number N Subscribable SmartDeviceLink 2.0
gearStatus Boolean See GearStatus N SmartDeviceLink 7.0.0
prndl Boolean See PRNDL. This parameter is deprecated and it is now covered in `gearStatus` N SmartDeviceLink 7.0.0
tirePressure Boolean Tire pressure status N Subscribable SmartDeviceLink 2.0
odometer Boolean Odometer in km N Max Length: 500 SmartDeviceLink 2.0
beltStatus Boolean The status of the seat belts N Subscribable SmartDeviceLink 2.0
bodyInformation Boolean The body information including ignition status and internal temp N Subscribable SmartDeviceLink 2.0
deviceStatus Boolean The device status including signal and battery strength N Subscribable SmartDeviceLink 2.0
driverBraking Boolean The status of the brake pedal N Subscribable SmartDeviceLink 2.0
wiperStatus Boolean The status of the wipers N Subscribable SmartDeviceLink 2.0
headLampStatus Boolean Status of the head lamps N Subscribable SmartDeviceLink 2.0
engineTorque Boolean Torque value for engine (in Nm) on non-diesel variants N Subscribable SmartDeviceLink 2.0
engineOilLife Boolean The estimated percentage of remaining oil life of the engine N Subscribable SmartDeviceLink 5.0
accPedalPosition Boolean Accelerator pedal position (percentage depressed) N Subscribable SmartDeviceLink 2.0
steeringWheelAngle Boolean Current angle of the steering wheel (in deg) N Subscribable SmartDeviceLink 2.0
turnSignal Boolean @see TurnSignal N Subscribable SmartDeviceLink 5.0
cloudAppVehicleID Boolean ID for the vehicle when connecting to cloud applications N Subscribable SmartDeviceLink 5.1
stabilityControlsStatus Boolean See StabilityControlsStatus N SmartDeviceLink 7.0.0
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

Response

Non-default Result Codes:

SUCCESS

INVALID_DATA

OUT_OF_MEMORY

TOO_MANY_PENDING_REQUESTS

APPLICATION_NOT_REGISTERED

GENERIC_ERROR

REJECTED

VEHICLE_DATA_NOT_ALLOWED

VEHICLE_DATA_NOT_AVAILABLE

USER_DISALLOWED

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_WINDOW_STATUS

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

KEY_HANDS_OFF_STEERING

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

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.RPCRequest onResponseListener
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

GetVehicleData()

Constructs a new GetVehicleData object

public GetVehicleData()

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

Constructs a new GetVehicleDta object indicated by the Hashtable parameter

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

Parameters

hash
The Hashtable to use

Methods

setGps( Boolean gps )

public com.smartdevicelink.proxy.rpc.GetVehicleData setGps(Boolean gps)

Parameters

gps

getGps()

public java.lang.Boolean getGps()

setSpeed( Boolean speed )

public com.smartdevicelink.proxy.rpc.GetVehicleData setSpeed(Boolean speed)

Parameters

speed

getSpeed()

public java.lang.Boolean getSpeed()

setRpm( Boolean rpm )

public com.smartdevicelink.proxy.rpc.GetVehicleData setRpm(Boolean rpm)

Parameters

rpm

getRpm()

public java.lang.Boolean getRpm()

setFuelLevel( Boolean fuelLevel )

Deprecated
Sets the fuelLevel.

public com.smartdevicelink.proxy.rpc.GetVehicleData setFuelLevel(Boolean 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.Boolean getFuelLevel()

setFuelLevelState( Boolean fuelLevelState )

Deprecated

public com.smartdevicelink.proxy.rpc.GetVehicleData setFuelLevelState(Boolean fuelLevelState)

Parameters

fuelLevelState

getFuelLevelState()

Deprecated

public java.lang.Boolean getFuelLevelState()

setInstantFuelConsumption( Boolean instantFuelConsumption )

public com.smartdevicelink.proxy.rpc.GetVehicleData setInstantFuelConsumption(Boolean instantFuelConsumption)

Parameters

instantFuelConsumption

getInstantFuelConsumption()

public java.lang.Boolean getInstantFuelConsumption()

setFuelRange( Boolean fuelRange )

public com.smartdevicelink.proxy.rpc.GetVehicleData setFuelRange(Boolean fuelRange)

Parameters

fuelRange

getFuelRange()

public java.lang.Boolean getFuelRange()

setExternalTemperature( Boolean externalTemperature )

public com.smartdevicelink.proxy.rpc.GetVehicleData setExternalTemperature(Boolean externalTemperature)

Parameters

externalTemperature

getExternalTemperature()

public java.lang.Boolean getExternalTemperature()

setVin( Boolean vin )

public com.smartdevicelink.proxy.rpc.GetVehicleData setVin(Boolean vin)

Parameters

vin

getVin()

public java.lang.Boolean getVin()

setPrndl( Boolean prndl )

Deprecated
Sets the prndl.

public com.smartdevicelink.proxy.rpc.GetVehicleData setPrndl(Boolean prndl)

Parameters

prndl
See PRNDL.

getPrndl()

Deprecated
Gets the prndl.

public java.lang.Boolean getPrndl()

setTirePressure( Boolean tirePressure )

public com.smartdevicelink.proxy.rpc.GetVehicleData setTirePressure(Boolean tirePressure)

Parameters

tirePressure

getTirePressure()

public java.lang.Boolean getTirePressure()

setOdometer( Boolean odometer )

public com.smartdevicelink.proxy.rpc.GetVehicleData setOdometer(Boolean odometer)

Parameters

odometer

getOdometer()

public java.lang.Boolean getOdometer()

setBeltStatus( Boolean beltStatus )

public com.smartdevicelink.proxy.rpc.GetVehicleData setBeltStatus(Boolean beltStatus)

Parameters

beltStatus

getBeltStatus()

public java.lang.Boolean getBeltStatus()

setBodyInformation( Boolean bodyInformation )

public com.smartdevicelink.proxy.rpc.GetVehicleData setBodyInformation(Boolean bodyInformation)

Parameters

bodyInformation

getBodyInformation()

public java.lang.Boolean getBodyInformation()

setDeviceStatus( Boolean deviceStatus )

public com.smartdevicelink.proxy.rpc.GetVehicleData setDeviceStatus(Boolean deviceStatus)

Parameters

deviceStatus

getDeviceStatus()

public java.lang.Boolean getDeviceStatus()

setDriverBraking( Boolean driverBraking )

public com.smartdevicelink.proxy.rpc.GetVehicleData setDriverBraking(Boolean driverBraking)

Parameters

driverBraking

getDriverBraking()

public java.lang.Boolean getDriverBraking()

setWiperStatus( Boolean wiperStatus )

public com.smartdevicelink.proxy.rpc.GetVehicleData setWiperStatus(Boolean wiperStatus)

Parameters

wiperStatus

getWiperStatus()

public java.lang.Boolean getWiperStatus()

setHeadLampStatus( Boolean headLampStatus )

public com.smartdevicelink.proxy.rpc.GetVehicleData setHeadLampStatus(Boolean headLampStatus)

Parameters

headLampStatus

getHeadLampStatus()

public java.lang.Boolean getHeadLampStatus()

setEngineTorque( Boolean engineTorque )

public com.smartdevicelink.proxy.rpc.GetVehicleData setEngineTorque(Boolean engineTorque)

Parameters

engineTorque

getEngineTorque()

public java.lang.Boolean getEngineTorque()

setEngineOilLife( Boolean engineOilLife )

public com.smartdevicelink.proxy.rpc.GetVehicleData setEngineOilLife(Boolean engineOilLife)

Parameters

engineOilLife

getEngineOilLife()

public java.lang.Boolean getEngineOilLife()

setAccPedalPosition( Boolean accPedalPosition )

public com.smartdevicelink.proxy.rpc.GetVehicleData setAccPedalPosition(Boolean accPedalPosition)

Parameters

accPedalPosition

getAccPedalPosition()

public java.lang.Boolean getAccPedalPosition()

setSteeringWheelAngle( Boolean steeringWheelAngle )

public com.smartdevicelink.proxy.rpc.GetVehicleData setSteeringWheelAngle(Boolean steeringWheelAngle)

Parameters

steeringWheelAngle

getSteeringWheelAngle()

public java.lang.Boolean getSteeringWheelAngle()

setECallInfo( Boolean eCallInfo )

public com.smartdevicelink.proxy.rpc.GetVehicleData setECallInfo(Boolean eCallInfo)

Parameters

eCallInfo

getECallInfo()

public java.lang.Boolean getECallInfo()

setAirbagStatus( Boolean airbagStatus )

public com.smartdevicelink.proxy.rpc.GetVehicleData setAirbagStatus(Boolean airbagStatus)

Parameters

airbagStatus

getAirbagStatus()

public java.lang.Boolean getAirbagStatus()

setEmergencyEvent( Boolean emergencyEvent )

public com.smartdevicelink.proxy.rpc.GetVehicleData setEmergencyEvent(Boolean emergencyEvent)

Parameters

emergencyEvent

getEmergencyEvent()

public java.lang.Boolean getEmergencyEvent()

setClusterModeStatus( Boolean clusterModeStatus )

public com.smartdevicelink.proxy.rpc.GetVehicleData setClusterModeStatus(Boolean clusterModeStatus)

Parameters

clusterModeStatus

getClusterModeStatus()

public java.lang.Boolean getClusterModeStatus()

setMyKey( Boolean myKey )

public com.smartdevicelink.proxy.rpc.GetVehicleData setMyKey(Boolean myKey)

Parameters

myKey

getMyKey()

public java.lang.Boolean getMyKey()

setTurnSignal( Boolean turnSignal )

Sets a boolean value. If true, subscribes turnSignal data

public com.smartdevicelink.proxy.rpc.GetVehicleData setTurnSignal(Boolean turnSignal)

Parameters

turnSignal
a boolean value

getTurnSignal()

Gets a boolean value. If true, means the turnSignal data has been subscribed.

public java.lang.Boolean getTurnSignal()

setElectronicParkBrakeStatus( Boolean electronicParkBrakeStatus )

Sets a boolean value. If true, subscribes electronicParkBrakeStatus data

public com.smartdevicelink.proxy.rpc.GetVehicleData setElectronicParkBrakeStatus(Boolean electronicParkBrakeStatus)

Parameters

electronicParkBrakeStatus
a boolean value

getElectronicParkBrakeStatus()

Gets a boolean value. If true, means the electronicParkBrakeStatus data has been subscribed.

public java.lang.Boolean getElectronicParkBrakeStatus()

setCloudAppVehicleID( boolean cloudAppVehicleID )

Sets a boolean value. If true, gets the cloudAppVehicleID data

public com.smartdevicelink.proxy.rpc.GetVehicleData setCloudAppVehicleID(boolean cloudAppVehicleID)

Parameters

cloudAppVehicleID
a boolean value

getCloudAppVehicleID()

Gets a boolean value. If true, means the cloudAppVehicleDataID data has been set to retrieve.

public java.lang.Boolean getCloudAppVehicleID()

setOEMCustomVehicleData( String vehicleDataName, Boolean vehicleDataState )

Sets a boolean value for OEM Custom VehicleData.

public com.smartdevicelink.proxy.rpc.GetVehicleData setOEMCustomVehicleData(String vehicleDataName,Boolean vehicleDataState)

Parameters

vehicleDataName
a String value
vehicleDataState
a boolean value

getOEMCustomVehicleData( String vehicleDataName )

Gets a boolean value for OEM Custom VehicleData.

public java.lang.Boolean getOEMCustomVehicleData(String vehicleDataName)

Parameters

vehicleDataName

setWindowStatus( Boolean windowStatus )

Sets the windowStatus.

public com.smartdevicelink.proxy.rpc.GetVehicleData setWindowStatus(Boolean windowStatus)

Parameters

windowStatus
See WindowStatus

getWindowStatus()

Gets the windowStatus.

public java.lang.Boolean getWindowStatus()

setHandsOffSteering( Boolean handsOffSteering )

Sets the handsOffSteering.

public com.smartdevicelink.proxy.rpc.GetVehicleData 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( Boolean gearStatus )

Sets the gearStatus.

public com.smartdevicelink.proxy.rpc.GetVehicleData setGearStatus(Boolean gearStatus)

Parameters

gearStatus
See GearStatus

getGearStatus()

Gets the gearStatus.

public java.lang.Boolean getGearStatus()

setStabilityControlsStatus( Boolean stabilityControlsStatus )

Sets the stabilityControlsStatus.

public com.smartdevicelink.proxy.rpc.GetVehicleData setStabilityControlsStatus(Boolean stabilityControlsStatus)

Parameters

stabilityControlsStatus
See StabilityControlsStatus

getStabilityControlsStatus()

Gets the stabilityControlsStatus.

public java.lang.Boolean getStabilityControlsStatus()

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCRequest getCorrelationID, setCorrelationID, setOnRPCResponseListener, getOnRPCResponseListener
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