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
US
JP
US
JP
JavaEE Documentation
SubscribeVehicleData

Class SubscribeVehicleData

Hierarchy

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

Package
com.smartdevicelink.proxy.rpc

Overview

Subscribes for specific published vehicle data items. The data will be only sent, if it has changed. The application will be notified by the onVehicleData notification whenever new data is available. The update rate is very much dependent on sensors, vehicle architecture and vehicle type. Be also prepared for the situation that a signal is not available on a vehicle

Function Group: Location, VehicleInfo and DrivingChara

HMILevel needs to be FULL, LIMITED or BACKGROUND

Parameter List

Name Type Description Reg. Notes SmartDeviceLink Version
gps Boolean GPS data. See GPSDatafor 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. This parameter is deprecated starting RPCSpec 7.1.0, please see climateData. N Subscribable

Quick Jump

Fields
Constructors
Methods

Fields

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_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_SPEED

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

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"

KEY_CLIMATE_DATA

public static final java.lang.String KEY_CLIMATE_DATA
Constant Value
"climateData"

KEY_SEAT_OCCUPANCY

public static final java.lang.String KEY_SEAT_OCCUPANCY
Constant Value
"seatOccupancy"

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

SubscribeVehicleData()

Constructs a new SubscribeVehicleData object 

public SubscribeVehicleData()

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

Constructs a new SubscribeVehicleData object indicated by the Hashtable parameter

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

Parameters

hash
The Hashtable to use

Methods

setGps( Boolean gps )

Sets a boolean value. If true, subscribes Gps data 

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

Parameters

gps
a boolean value

getGps()

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

public java.lang.Boolean getGps()

setSpeed( Boolean speed )

Sets a boolean value. If true, subscribes speed data 

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

Parameters

speed
a boolean value

getSpeed()

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

public java.lang.Boolean getSpeed()

setRpm( Boolean rpm )

Sets a boolean value. If true, subscribes rpm data 

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

Parameters

rpm
a boolean value

getRpm()

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

public java.lang.Boolean getRpm()

setFuelLevel( Boolean fuelLevel )

Deprecated
Sets the fuelLevel. 

public com.smartdevicelink.proxy.rpc.SubscribeVehicleData 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
Sets a boolean value. If true, subscribes fuelLevelState data 

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

Parameters

fuelLevelState
a boolean value

getFuelLevelState()

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

public java.lang.Boolean getFuelLevelState()

setInstantFuelConsumption( Boolean instantFuelConsumption )

Sets a boolean value. If true, subscribes instantFuelConsumption data 

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

Parameters

instantFuelConsumption
a boolean value

getInstantFuelConsumption()

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

public java.lang.Boolean getInstantFuelConsumption()

setExternalTemperature( Boolean externalTemperature )

Deprecated
Sets the externalTemperature. 

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

Parameters

externalTemperature
The external temperature in degrees celsius. This parameter is deprecated starting RPC Spec 7.1.0, please see climateData.

getExternalTemperature()

Deprecated
Gets the externalTemperature. 

public java.lang.Boolean getExternalTemperature()

setGearStatus( Boolean gearStatus )

Sets the gearStatus. 

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

Parameters

gearStatus
See GearStatus

getGearStatus()

Gets the gearStatus. 

public java.lang.Boolean getGearStatus()

setPrndl( Boolean prndl )

Deprecated
Sets the prndl. 

public com.smartdevicelink.proxy.rpc.SubscribeVehicleData setPrndl(Boolean 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 java.lang.Boolean getPrndl()

setTirePressure( Boolean tirePressure )

Sets a boolean value. If true, subscribes tire pressure status data 

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

Parameters

tirePressure
a boolean value

getTirePressure()

Gets a boolean value. If true, means the tire pressure status data has been subscribed. 

public java.lang.Boolean getTirePressure()

setOdometer( Boolean odometer )

Sets a boolean value. If true, subscribes odometer data 

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

Parameters

odometer
a boolean value

getOdometer()

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

public java.lang.Boolean getOdometer()

setBeltStatus( Boolean beltStatus )

Sets a boolean value. If true, subscribes belt Status data 

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

Parameters

beltStatus
a boolean value

getBeltStatus()

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

public java.lang.Boolean getBeltStatus()

setBodyInformation( Boolean bodyInformation )

Sets a boolean value. If true, subscribes body Information data 

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

Parameters

bodyInformation
a boolean value

getBodyInformation()

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

public java.lang.Boolean getBodyInformation()

setDeviceStatus( Boolean deviceStatus )

Sets a boolean value. If true, subscribes device Status data 

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

Parameters

deviceStatus
a boolean value

getDeviceStatus()

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

public java.lang.Boolean getDeviceStatus()

setDriverBraking( Boolean driverBraking )

Sets a boolean value. If true, subscribes driver Braking data 

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

Parameters

driverBraking
a boolean value

getDriverBraking()

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

public java.lang.Boolean getDriverBraking()

setWiperStatus( Boolean wiperStatus )

Sets a boolean value. If true, subscribes wiper Status data 

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

Parameters

wiperStatus
a boolean value

getWiperStatus()

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

public java.lang.Boolean getWiperStatus()

setHeadLampStatus( Boolean headLampStatus )

Sets a boolean value. If true, subscribes Head Lamp Status data 

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

Parameters

headLampStatus
a boolean value

getHeadLampStatus()

Gets a boolean value. If true, means the Head Lamp Status data has been subscribed. 

public java.lang.Boolean getHeadLampStatus()

setEngineTorque( Boolean engineTorque )

Sets a boolean value. If true, subscribes Engine Torque data 

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

Parameters

engineTorque
a boolean value

getEngineOilLife()

Gets a boolean value. If true, means the Engine Oil Life data has been subscribed. 

public java.lang.Boolean getEngineOilLife()

setEngineOilLife( Boolean engineOilLife )

Sets a boolean value. If true, subscribes Engine Oil Life data 

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

Parameters

engineOilLife
a boolean value

getEngineTorque()

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

public java.lang.Boolean getEngineTorque()

setAccPedalPosition( Boolean accPedalPosition )

Sets a boolean value. If true, subscribes accPedalPosition data 

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

Parameters

accPedalPosition
a boolean value

getAccPedalPosition()

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

public java.lang.Boolean getAccPedalPosition()

setSteeringWheelAngle( Boolean steeringWheelAngle )

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

Parameters

steeringWheelAngle

getSteeringWheelAngle()

public java.lang.Boolean getSteeringWheelAngle()

setECallInfo( Boolean eCallInfo )

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

Parameters

eCallInfo

getECallInfo()

public java.lang.Boolean getECallInfo()

setAirbagStatus( Boolean airbagStatus )

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

Parameters

airbagStatus

getAirbagStatus()

public java.lang.Boolean getAirbagStatus()

setEmergencyEvent( Boolean emergencyEvent )

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

Parameters

emergencyEvent

getEmergencyEvent()

public java.lang.Boolean getEmergencyEvent()

setClusterModeStatus( Boolean clusterModeStatus )

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

Parameters

clusterModeStatus

getClusterModeStatus()

public java.lang.Boolean getClusterModeStatus()

setMyKey( Boolean myKey )

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

Parameters

myKey

getMyKey()

public java.lang.Boolean getMyKey()

setFuelRange( Boolean fuelRange )

Sets the fuelRange. 

public com.smartdevicelink.proxy.rpc.SubscribeVehicleData setFuelRange(Boolean 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.

getFuelRange()

Gets the fuelRange. 

public java.lang.Boolean getFuelRange()

setTurnSignal( Boolean turnSignal )

Sets a boolean value. If true, subscribes turnSignal data 

public com.smartdevicelink.proxy.rpc.SubscribeVehicleData 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.SubscribeVehicleData 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, subscribes cloudAppVehicleID data 

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

Parameters

cloudAppVehicleID
a boolean value

getCloudAppVehicleID()

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

public java.lang.Boolean getCloudAppVehicleID()

setOEMCustomVehicleData( String vehicleDataName, Boolean vehicleDataState )

Sets a boolean value for OEM Custom VehicleData. 

public com.smartdevicelink.proxy.rpc.SubscribeVehicleData 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.SubscribeVehicleData 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.SubscribeVehicleData setHandsOffSteering(Boolean handsOffSteering)

Parameters

handsOffSteering
To indicate whether driver hands are off the steering wheel

getHandsOffSteering()

Gets the handsOffSteering. 

public java.lang.Boolean getHandsOffSteering()

getStabilityControlsStatus()

Gets the stabilityControlsStatus. 

public java.lang.Boolean getStabilityControlsStatus()

setStabilityControlsStatus( Boolean stabilityControlsStatus )

Sets the stabilityControlsStatus. 

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

Parameters

stabilityControlsStatus
See StabilityControlsStatus

setClimateData( Boolean climateData )

Sets the climateData. 

public com.smartdevicelink.proxy.rpc.SubscribeVehicleData setClimateData(Boolean climateData)

Parameters

climateData
See ClimateData

getClimateData()

Gets the climateData. 

public java.lang.Boolean getClimateData()

setSeatOccupancy( Boolean seatOccupancy )

Sets the seatOccupancy. 

public com.smartdevicelink.proxy.rpc.SubscribeVehicleData setSeatOccupancy(Boolean seatOccupancy)

Parameters

seatOccupancy
See SeatOccupancy

getSeatOccupancy()

Gets the seatOccupancy. 

public java.lang.Boolean getSeatOccupancy()

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, clone, equals, hashCode
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section