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.
JavaEE Documentation
java.lang.Object
com.smartdevicelink.proxy.RPCStruct
com.smartdevicelink.proxy.RPCMessage
com.smartdevicelink.proxy.RPCRequest
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) | N | Subscribable | SmartDeviceLink 2.0 |
| fuelLevel_State | Boolean | The fuel level state | N | Subscribable | SmartDeviceLink 2.0 |
| instantFuelConsumption | Boolean | The instantaneous fuel consumption in microlitres | N | Subscribable | SmartDeviceLink 2.0 |
| externalTemperature | Boolean | The external temperature in degrees celsius | N | Subscribable | SmartDeviceLink 2.0 |
| prndl | Boolean | Currently selected gear. | N | Subscribable | SmartDeviceLink 2.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 |
| eCallInfo | Boolean | Emergency Call notification and confirmation data. | N | Subscribable | SmartDeviceLink 2.0 |
| airbagStatus | Boolean | The status of the air bags. | N | Subscribable | SmartDeviceLink 2.0 |
| emergencyEvent | Boolean | Information related to an emergency event (and if it occurred). | N | Subscribable | SmartDeviceLink 2.0 |
| clusterModeStatus | Boolean | The status modes of the instrument panel cluster. | N | Subscribable | SmartDeviceLink 2.0 |
| myKey | Boolean | Information related to the MyKey feature. | 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 |
Response
Non-default Result Codes:
SUCCESS
WARNINGS
INVALID_DATA
OUT_OF_MEMORY
TOO_MANY_PENDING_REQUESTS
APPLICATION_NOT_REGISTERED
GENERIC_ERROR
IGNORED
DISALLOWED
USER_DISALLOWED
public static final java.lang.String KEY_RPM
public static final java.lang.String KEY_EXTERNAL_TEMPERATURE
public static final java.lang.String KEY_FUEL_LEVEL
public static final java.lang.String KEY_PRNDL
public static final java.lang.String KEY_TIRE_PRESSURE
public static final java.lang.String KEY_ENGINE_TORQUE
public static final java.lang.String KEY_ENGINE_OIL_LIFE
public static final java.lang.String KEY_ODOMETER
public static final java.lang.String KEY_GPS
public static final java.lang.String KEY_FUEL_LEVEL_STATE
public static final java.lang.String KEY_INSTANT_FUEL_CONSUMPTION
public static final java.lang.String KEY_BELT_STATUS
public static final java.lang.String KEY_BODY_INFORMATION
public static final java.lang.String KEY_DEVICE_STATUS
public static final java.lang.String KEY_DRIVER_BRAKING
public static final java.lang.String KEY_WIPER_STATUS
public static final java.lang.String KEY_HEAD_LAMP_STATUS
public static final java.lang.String KEY_ACC_PEDAL_POSITION
public static final java.lang.String KEY_STEERING_WHEEL_ANGLE
public static final java.lang.String KEY_E_CALL_INFO
public static final java.lang.String KEY_AIRBAG_STATUS
public static final java.lang.String KEY_EMERGENCY_EVENT
public static final java.lang.String KEY_CLUSTER_MODE_STATUS
public static final java.lang.String KEY_MY_KEY
public static final java.lang.String KEY_SPEED
public static final java.lang.String KEY_FUEL_RANGE
public static final java.lang.String KEY_TURN_SIGNAL
public static final java.lang.String KEY_ELECTRONIC_PARK_BRAKE_STATUS
public static final java.lang.String KEY_CLOUD_APP_VEHICLE_ID
Constructs a new SubscribeVehicleData object
public SubscribeVehicleData()
Constructs a new SubscribeVehicleData object indicated by the Hashtable parameter
public SubscribeVehicleData(java.util.Hashtable<java.lang.String, java.lang.Object> hash)
Sets a boolean value. If true, subscribes Gps data
public void setGps(Boolean gps)
Gets a boolean value. If true, means the Gps data has been subscribed.
public java.lang.Boolean getGps()
Sets a boolean value. If true, subscribes speed data
public void setSpeed(Boolean speed)
Gets a boolean value. If true, means the Speed data has been subscribed.
public java.lang.Boolean getSpeed()
Sets a boolean value. If true, subscribes rpm data
public void setRpm(Boolean rpm)
Gets a boolean value. If true, means the rpm data has been subscribed.
public java.lang.Boolean getRpm()
Sets a boolean value. If true, subscribes FuelLevel data
public void setFuelLevel(Boolean fuelLevel)
Gets a boolean value. If true, means the FuelLevel data has been subscribed.
public java.lang.Boolean getFuelLevel()
Deprecated
Sets a boolean value. If true, subscribes fuelLevel_State data
public void setFuelLevel_State(Boolean fuelLevel_State)
Deprecated
Gets a boolean value. If true, means the fuelLevel_State data has been
subscribed.
public java.lang.Boolean getFuelLevel_State()
Sets a boolean value. If true, subscribes fuelLevelState data
public void setFuelLevelState(Boolean fuelLevelState)
Gets a boolean value. If true, means the fuelLevelState data has been subscribed.
public java.lang.Boolean getFuelLevelState()
Sets a boolean value. If true, subscribes instantFuelConsumption data
public void setInstantFuelConsumption(Boolean instantFuelConsumption)
Gets a boolean value. If true, means the getInstantFuelConsumption data has been subscribed.
public java.lang.Boolean getInstantFuelConsumption()
Sets a boolean value. If true, subscribes externalTemperature data
public void setExternalTemperature(Boolean externalTemperature)
Gets a boolean value. If true, means the externalTemperature data has been subscribed.
public java.lang.Boolean getExternalTemperature()
Sets a boolean value. If true, subscribes Currently selected gear data
public void setPrndl(Boolean prndl)
Gets a boolean value. If true, means the Currently selected gear data has been subscribed.
public java.lang.Boolean getPrndl()
Sets a boolean value. If true, subscribes tire pressure status data
public void setTirePressure(Boolean tirePressure)
Gets a boolean value. If true, means the tire pressure status data has been subscribed.
public java.lang.Boolean getTirePressure()
Sets a boolean value. If true, subscribes odometer data
public void setOdometer(Boolean odometer)
Gets a boolean value. If true, means the odometer data has been subscribed.
public java.lang.Boolean getOdometer()
Sets a boolean value. If true, subscribes belt Status data
public void setBeltStatus(Boolean beltStatus)
Gets a boolean value. If true, means the belt Status data has been subscribed.
public java.lang.Boolean getBeltStatus()
Sets a boolean value. If true, subscribes body Information data
public void setBodyInformation(Boolean bodyInformation)
Gets a boolean value. If true, means the body Information data has been subscribed.
public java.lang.Boolean getBodyInformation()
Sets a boolean value. If true, subscribes device Status data
public void setDeviceStatus(Boolean deviceStatus)
Gets a boolean value. If true, means the device Status data has been subscribed.
public java.lang.Boolean getDeviceStatus()
Sets a boolean value. If true, subscribes driver Braking data
public void setDriverBraking(Boolean driverBraking)
Gets a boolean value. If true, means the driver Braking data has been subscribed.
public java.lang.Boolean getDriverBraking()
Sets a boolean value. If true, subscribes wiper Status data
public void setWiperStatus(Boolean wiperStatus)
Gets a boolean value. If true, means the wiper Status data has been subscribed.
public java.lang.Boolean getWiperStatus()
Sets a boolean value. If true, subscribes Head Lamp Status data
public void setHeadLampStatus(Boolean headLampStatus)
Gets a boolean value. If true, means the Head Lamp Status data has been subscribed.
public java.lang.Boolean getHeadLampStatus()
Sets a boolean value. If true, subscribes Engine Torque data
public void setEngineTorque(Boolean engineTorque)
Gets a boolean value. If true, means the Engine Oil Life data has been subscribed.
public java.lang.Boolean getEngineOilLife()
Sets a boolean value. If true, subscribes Engine Oil Life data
public void setEngineOilLife(Boolean engineOilLife)
Gets a boolean value. If true, means the Engine Torque data has been subscribed.
public java.lang.Boolean getEngineTorque()
Sets a boolean value. If true, subscribes accPedalPosition data
public void setAccPedalPosition(Boolean accPedalPosition)
Gets a boolean value. If true, means the accPedalPosition data has been subscribed.
public java.lang.Boolean getAccPedalPosition()
public void setSteeringWheelAngle(Boolean steeringWheelAngle)
public java.lang.Boolean getSteeringWheelAngle()
public void setECallInfo(Boolean eCallInfo)
public java.lang.Boolean getECallInfo()
public void setAirbagStatus(Boolean airbagStatus)
public java.lang.Boolean getAirbagStatus()
public void setEmergencyEvent(Boolean emergencyEvent)
public java.lang.Boolean getEmergencyEvent()
public void setClusterModeStatus(Boolean clusterModeStatus)
public java.lang.Boolean getClusterModeStatus()
public void setMyKey(Boolean myKey)
public java.lang.Boolean getMyKey()
Sets a boolean value. If true, subscribes fuelRange data
public void setFuelRange(Boolean fuelRange)
Gets a boolean value. If true, means the Fuel Range data has been subscribed.
public java.lang.Boolean getFuelRange()
Sets a boolean value. If true, subscribes turnSignal data
public void setTurnSignal(Boolean turnSignal)
Gets a boolean value. If true, means the turnSignal data has been subscribed.
public java.lang.Boolean getTurnSignal()
Sets a boolean value. If true, subscribes electronicParkBrakeStatus data
public void setElectronicParkBrakeStatus(boolean electronicParkBrakeStatus)
Gets a boolean value. If true, means the electronicParkBrakeStatus data has been subscribed.
public java.lang.Boolean getElectronicParkBrakeStatus()
Sets a boolean value. If true, subscribes cloudAppVehicleID data
public void setCloudAppVehicleID(boolean cloudAppVehicleID)
Gets a boolean value. If true, means the cloudAppVehicleDataID data has been subscribed.
public java.lang.Boolean getCloudAppVehicleID()
Sets a boolean value for OEM Custom VehicleData.
public void setOEMCustomVehicleData(String vehicleDataName,Boolean vehicleDataState)
Gets a boolean value for OEM Custom VehicleData.
public java.lang.Boolean getOEMCustomVehicleData(String vehicleDataName)
| 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, 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 |