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.
JavaSE 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 | Version |
|---|---|---|---|---|---|
| gps | Boolean | GPS data. See 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 |
| 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 |
| 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 |
| 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 | Boolean | See StabilityControlsStatus | N | SmartDeviceLink 7.0.0 |
Response
Non-default Result Codes:
SUCCESS
WARNINGS
INVALID_DATA
OUT_OF_MEMORY
TOO_MANY_PENDING_REQUESTS
APPLICATION_NOT_REGISTERED
GENERIC_ERROR
IGNORED
DISALLOWED
public static final java.lang.String KEY_SPEED
public static final java.lang.String KEY_RPM
public static final java.lang.String KEY_EXTERNAL_TEMPERATURE
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_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_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
public static final java.lang.String KEY_HANDS_OFF_STEERING
public static final java.lang.String KEY_GEAR_STATUS
public static final java.lang.String KEY_WINDOW_STATUS
public static final java.lang.String KEY_FUEL_LEVEL
public static final java.lang.String KEY_FUEL_LEVEL_STATE
public static final java.lang.String KEY_STABILITY_CONTROLS_STATUS
Constructs a new UnsubscribeVehicleData object
public UnsubscribeVehicleData()
Constructs a new UnsubscribeVehicleData object indicated by the Hashtable parameter
public UnsubscribeVehicleData(java.util.Hashtable<java.lang.String, java.lang.Object> hash)
Sets a boolean value. If true, unsubscribes from Gps data
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setGps(Boolean gps)
Gets a boolean value. If true, means the Gps data has been unsubscribed.
public java.lang.Boolean getGps()
Sets a boolean value. If true, unsubscribes from speed data
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setSpeed(Boolean speed)
Gets a boolean value. If true, means the Speed data has been unsubscribed.
public java.lang.Boolean getSpeed()
Sets a boolean value. If true, unsubscribe data
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setRpm(Boolean rpm)
Gets a boolean value. If true, means the rpm data has been unsubscribed.
public java.lang.Boolean getRpm()
Deprecated
Sets the fuelLevel.
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setFuelLevel(Boolean fuelLevel)
Deprecated
Gets the fuelLevel.
public java.lang.Boolean getFuelLevel()
Deprecated
Sets the fuelRange.
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setFuelLevelState(Boolean fuelLevelState)
Deprecated
Gets the fuelRange.
public java.lang.Boolean getFuelLevelState()
Sets a boolean value. If true, unsubscribes from instantFuelConsumption data
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setInstantFuelConsumption(Boolean instantFuelConsumption)
Gets a boolean value. If true, means the getInstantFuelConsumption data has been unsubscribed.
public java.lang.Boolean getInstantFuelConsumption()
Sets a boolean value. If true, unsubscribes from externalTemperature data
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setExternalTemperature(Boolean externalTemperature)
Gets a boolean value. If true, means the externalTemperature data has been unsubscribed.
public java.lang.Boolean getExternalTemperature()
Deprecated
Sets the prndl.
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setPrndl(Boolean prndl)
Deprecated
Gets the prndl.
public java.lang.Boolean getPrndl()
Sets a boolean value. If true, unsubscribes from tire pressure status data
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setTirePressure(Boolean tirePressure)
Gets a boolean value. If true, means the tire pressure status data has been unsubscribed.
public java.lang.Boolean getTirePressure()
Sets a boolean value. If true, unsubscribes from odometer data
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setOdometer(Boolean odometer)
Gets a boolean value. If true, means the odometer data has been unsubscribed.
public java.lang.Boolean getOdometer()
Sets a boolean value. If true, unsubscribes from belt Status data
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setBeltStatus(Boolean beltStatus)
Gets a boolean value. If true, means the belt Status data has been unsubscribed.
public java.lang.Boolean getBeltStatus()
Sets a boolean value. If true, unsubscribes from body Information data
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setBodyInformation(Boolean bodyInformation)
Gets a boolean value. If true, means the body Information data has been unsubscribed.
public java.lang.Boolean getBodyInformation()
Sets a boolean value. If true, unsubscribes from device Status data
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setDeviceStatus(Boolean deviceStatus)
Gets a boolean value. If true, means the device Status data has been unsubscribed.
public java.lang.Boolean getDeviceStatus()
Sets a boolean value. If true, unsubscribes from driver Braking data
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setDriverBraking(Boolean driverBraking)
Gets a boolean value. If true, means the driver Braking data has been unsubscribed.
public java.lang.Boolean getDriverBraking()
Sets a boolean value. If true, unsubscribes from wiper Status data
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setWiperStatus(Boolean wiperStatus)
Gets a boolean value. If true, means the wiper Status data has been unsubscribed.
public java.lang.Boolean getWiperStatus()
Sets a boolean value. If true, unsubscribes from Head Lamp Status data
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setHeadLampStatus(Boolean headLampStatus)
Gets a boolean value. If true, means the Head Lamp Status data has been unsubscribed.
public java.lang.Boolean getHeadLampStatus()
Sets a boolean value. If true, unsubscribes from Engine Torque data
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setEngineTorque(Boolean engineTorque)
Gets a boolean value. If true, means the Engine Torque data has been unsubscribed.
public java.lang.Boolean getEngineTorque()
Sets a boolean value. If true, unsubscribes from Engine Oil Life data
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setEngineOilLife(Boolean engineOilLife)
Gets a boolean value. If true, means the Engine Oil Life data has been unsubscribed.
public java.lang.Boolean getEngineOilLife()
Sets a boolean value. If true, unsubscribes from accPedalPosition data
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setAccPedalPosition(Boolean accPedalPosition)
Gets a boolean value. If true, means the accPedalPosition data has been unsubscribed.
public java.lang.Boolean getAccPedalPosition()
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setSteeringWheelAngle(Boolean steeringWheelAngle)
public java.lang.Boolean getSteeringWheelAngle()
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setECallInfo(Boolean eCallInfo)
public java.lang.Boolean getECallInfo()
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setAirbagStatus(Boolean airbagStatus)
public java.lang.Boolean getAirbagStatus()
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setEmergencyEvent(Boolean emergencyEvent)
public java.lang.Boolean getEmergencyEvent()
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setClusterModeStatus(Boolean clusterModeStatus)
public java.lang.Boolean getClusterModeStatus()
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setMyKey(Boolean myKey)
public java.lang.Boolean getMyKey()
Sets a boolean value. If true, unsubscribes from fuelRange data
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setFuelRange(Boolean fuelRange)
Gets a boolean value. If true, means the fuelRange data has been unsubscribed.
public java.lang.Boolean getFuelRange()
Sets a boolean value. If true, unsubscribes from turnSignal data
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setTurnSignal(Boolean turnSignal)
Gets a boolean value. If true, means the turnSignal data has been unsubscribed.
public java.lang.Boolean getTurnSignal()
Sets a boolean value. If true, unsubscribes from electronicParkBrakeStatus data
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData 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, unsubscribes from cloudAppVehicleID data
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setCloudAppVehicleID(boolean cloudAppVehicleID)
Gets a boolean value. If true, means the cloudAppVehicleID data has been unsubscribed.
public java.lang.Boolean getCloudAppVehicleID()
Sets a boolean value for OEM Custom VehicleData.
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setOEMCustomVehicleData(String vehicleDataName,Boolean vehicleDataState)
Gets a boolean value for OEM Custom VehicleData.
public java.lang.Boolean getOEMCustomVehicleData(String vehicleDataName)
Sets the gearStatus.
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setGearStatus(Boolean gearStatus)
Gets the gearStatus.
public java.lang.Boolean getGearStatus()
Sets the handsOffSteering.
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setHandsOffSteering(Boolean handsOffSteering)
Gets the handsOffSteering.
public java.lang.Boolean getHandsOffSteering()
Sets the windowStatus.
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setWindowStatus(Boolean windowStatus)
Gets the windowStatus.
public java.lang.Boolean getWindowStatus()
Sets the stabilityControlsStatus.
public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setStabilityControlsStatus(Boolean stabilityControlsStatus)
Gets the stabilityControlsStatus.
public java.lang.Boolean getStabilityControlsStatus()
| 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 |