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

GetVehicleData

Type
Function
Sender
SDL
Purpose
Get current values of specified vehicle data types.

Request

Parameters

Name Type Mandatory Additional
gps Boolean false
speed Boolean false
rpm Boolean false
fuelLevel Boolean false
fuelLevel_State Boolean false
instantFuelConsumption Boolean false
externalTemperature Boolean false
vin Boolean false
prndl Boolean false
tirePressure Boolean false
odometer Boolean false
beltStatus Boolean false
bodyInformation Boolean false
deviceStatus Boolean false
driverBraking Boolean false
wiperStatus Boolean false
headLampStatus Boolean false
engineTorque Boolean false
accPedalPosition Boolean false
steeringWheelAngle Boolean false
eCallInfo Boolean false
airbagStatus Boolean false
emergencyEvent Boolean false
clusterModeStatus Boolean false
myKey Boolean false
turnSignal Boolean false
fuelRange Boolean false
engineOilLife Boolean false
electronicParkBrakeStatus Boolean false

Response

Parameters

Name Type Mandatory Additional
gps Common.GPSData false
speed Float false minvalue: 0
maxvalue: 700
rpm Integer false minvalue: 0
maxvalue: 20000
fuelLevel Float false minvalue: -6
maxvalue: 106
fuelLevel_State Common.ComponentVolumeStatus false
instantFuelConsumption Float false minvalue: 0
maxvalue: 25575
externalTemperature Float false minvalue: -40
maxvalue: 100
vin String false maxlength: 17
prndl Common.PRNDL false
tirePressure Common.TireStatus false
odometer Integer false minvalue: 0
maxvalue: 17000000
beltStatus Common.BeltStatus false
bodyInformation Common.BodyInformation false
deviceStatus Common.DeviceStatus false
driverBraking Common.VehicleDataEventStatus false
wiperStatus Common.WiperStatus false
headLampStatus Common.HeadLampStatus false
engineTorque Float false minvalue: -1000
maxvalue: 2000
accPedalPosition Float false minvalue: 0
maxvalue: 100
steeringWheelAngle Float false minvalue: -2000
maxvalue: 2000
eCallInfo Common.ECallInfo false
airbagStatus Common.AirbagStatus false
emergencyEvent Common.EmergencyEvent false
clusterModeStatus Common.ClusterModeStatus false
myKey Common.MyKey false
turnSignal Common.TurnSignal false
fuelRange Common.FuelRange false minsize=0
maxsize=100
array=true
engineOilLife Float false minvalue=0
maxvalue=100
electronicParkBrakeStatus Common.ElectronicParkBrakeStatus false

Sequence Diagrams

Example Request

{
  "id" : 139,
  "jsonrpc" : "2.0",
  "method" : "VehicleInfo.GetVehicleData",
  "params" :
  {
    "gps" : true,
    "speed" : true,
    "fuelLevel_State" : true,
    "externalTemperature" : true,
    "prndl" : true,
    "tirePressure" : true,
    "odometer" : true,
    "beltStatus" : true,
    "bodyInformation" : true,
    "deviceStatus" : true,
    "wiperStatus" : true,
    "headLampStatus" : true,
    "accPedalPosition" : true
  }
}

Example Response

{
  "id" : 139,
  "jsonrpc" : "2.0",
  "result" :
  {
    "gps" :
    {
      "longitudeDegrees" : 46.4774700,
      "latitudeDegrees" : 30.7326200,
      "utcYear" : 2013,
      "utcMonth" : 12,
      "utcDay" : 31,
      "utcHours" : 23,
      "utcMinutes" : 50,
      "utcSeconds" : 5,
      "compassDirection" : "NORTH",
      "pdop" : 0.15,
      "hdop" : 1.01,
      "vdop" : 1.56,
      "actual" : true,
      "satellites" : 8,
      "dimension" : "3D",
      "altitude" : 47,
      "heading" : 0,
      "speed" : 90
    },
    "speed" : 90,
    "fuelLevel_State" : "LOW",
    "externalTemperature" : -5,
    "prndl" : "FOURTH",
    "tirePressure" :
    {
        "pressureTelltale" : "ON",
        "leftFront" : {
          "status" : "NORMAL"
        },
        "rightFront" : {
          "status" : "NORMAL"
        },
        "leftRear" : {
          "status" : "LOW"
        },
        "rightRear" : {
          "status" : "UNKNOWN"
        }
    },
    "odometer" : 1065,
    "beltStatus" :
    {
        "driverBeltDeployed" : "YES",
        "passengerBeltDeployed" : "YES",
    },
    "bodyInformation" :
    {
        "parkBrakeActive" : false,
        "ignitionStableStatus" : "IGNITION_SWITCH_STABLE",
        "ignitionStatus" : "RUN"
    },
    "deviceStatus" :
    {
        "voiceRecOn" : false,
        "btIconOn" : false,
        "callActive" : false,
        "phoneRoaming" : false,
        "textMsgAvailable" : true,
        "battLevelStatus" : "THREE_LEVEL_BARS",
        "stereoAudioOutputMuted" : true,
        "monoAudioOutputMuted" : false,
        "signalLevelStatus" : "NOT_PROVIDED",
        "primaryAudioSource" : "MOBILE_APP",
        "eCallEventActive" : false
    },
    "wiperStatus" : "OFF",
    "headLampStatus" :
    {
        "lowBeamsOn" : true,
        "highBeamsOn" : false
    },
    "accPedalPosition" : 80,
    "code" : 0,
    "method" : "VehicleInfo.GetVehicleData"
  }
}

Example Error

{
  "id" : 139,
  "jsonrpc" : "2.0",
  "error" :
  {
    "code" : 9,
    "message" : "The requested data is not available",
    "data" :
    {
      "method" : "VehicleInfo.GetVehicleData"
    }
  }
}
View on GitHub.com
Previous Section Next Section