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
SDLGetVehicleData

SDLGetVehicleData Class Reference

Section Contents

Overview

Requests current values of specific published vehicle data items.

Function Group: Location, VehicleInfo and DrivingChara HMILevel needs to be FULL, LIMITED or BACKGROUND Since SmartDeviceLink 2.0 See SDLSubscribeVehicleData, SDLUnsubscribeVehicleData

-initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:cloudAppVehicleID:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:electronicParkBrakeStatus:emergencyEvent:engineOilLife:engineTorque:externalTemperature:fuelLevel:fuelLevelState:fuelRange:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:turnSignal:vin:wiperStatus:

Convenience init for getting data for all possible vehicle data items.

Objective-C

- (nonnull instancetype)
    initWithAccelerationPedalPosition:(BOOL)accelerationPedalPosition
                         airbagStatus:(BOOL)airbagStatus
                           beltStatus:(BOOL)beltStatus
                      bodyInformation:(BOOL)bodyInformation
                    cloudAppVehicleID:(BOOL)cloudAppVehicleID
                    clusterModeStatus:(BOOL)clusterModeStatus
                         deviceStatus:(BOOL)deviceStatus
                        driverBraking:(BOOL)driverBraking
                            eCallInfo:(BOOL)eCallInfo
            electronicParkBrakeStatus:(BOOL)electronicParkBrakeStatus
                       emergencyEvent:(BOOL)emergencyEvent
                        engineOilLife:(BOOL)engineOilLife
                         engineTorque:(BOOL)engineTorque
                  externalTemperature:(BOOL)externalTemperature
                            fuelLevel:(BOOL)fuelLevel
                       fuelLevelState:(BOOL)fuelLevelState
                            fuelRange:(BOOL)fuelRange
                                  gps:(BOOL)gps
                       headLampStatus:(BOOL)headLampStatus
               instantFuelConsumption:(BOOL)instantFuelConsumption
                                myKey:(BOOL)myKey
                             odometer:(BOOL)odometer
                                prndl:(BOOL)prndl
                                  rpm:(BOOL)rpm
                                speed:(BOOL)speed
                   steeringWheelAngle:(BOOL)steeringWheelAngle
                         tirePressure:(BOOL)tirePressure
                           turnSignal:(BOOL)turnSignal
                                  vin:(BOOL)vin
                          wiperStatus:(BOOL)wiperStatus;

Swift

init(accelerationPedalPosition: Bool, airbagStatus: Bool, beltStatus: Bool, bodyInformation: Bool, cloudAppVehicleID: Bool, clusterModeStatus: Bool, deviceStatus: Bool, driverBraking: Bool, eCallInfo: Bool, electronicParkBrakeStatus: Bool, emergencyEvent: Bool, engineOilLife: Bool, engineTorque: Bool, externalTemperature: Bool, fuelLevel: Bool, fuelLevelState: Bool, fuelRange: Bool, gps: Bool, headLampStatus: Bool, instantFuelConsumption: Bool, myKey: Bool, odometer: Bool, prndl: Bool, rpm: Bool, speed: Bool, steeringWheelAngle: Bool, tirePressure: Bool, turnSignal: Bool, vin: Bool, wiperStatus: Bool)

Parameters

accelerationPedalPosition

Get accelerationPedalPosition data

airbagStatus

Get airbagStatus data

beltStatus

Get beltStatus data

bodyInformation

Get bodyInformation data

cloudAppVehicleID

Get cloudAppVehicleID data

clusterModeStatus

Get clusterModeStatus data

deviceStatus

Get deviceStatus data

driverBraking

Get driverBraking data

eCallInfo

Get eCallInfo data

electronicParkBrakeStatus

Get electronicParkBrakeStatus data

emergencyEvent

Get emergencyEvent data

engineOilLife

Get engineOilLife data

engineTorque

Get engineTorque data

externalTemperature

Get externalTemperature data

fuelLevel

Get fuelLevel data

fuelLevelState

Get fuelLevelState data

fuelRange

Get fuelRange data

gps

Get gps data

headLampStatus

Get headLampStatus data

instantFuelConsumption

Get instantFuelConsumption data

myKey

Get myKey data

odometer

Get odometer data

prndl

Get prndl data

rpm

Get rpm data

speed

Get speed data

steeringWheelAngle

Get steeringWheelAngle data

tirePressure

Get tirePressure data

turnSignal

Get turnSignal data

vin

Get vin data

wiperStatus

Get wiperStatus data

Return Value

A SDLGetVehicleData object

-initWithGps:speed:rpm:instantFuelConsumption:fuelRange:externalTemperature:turnSignal:vin:gearStatus:tirePressure:odometer:beltStatus:bodyInformation:deviceStatus:driverBraking:wiperStatus:headLampStatus:engineTorque:accPedalPosition:steeringWheelAngle:engineOilLife:electronicParkBrakeStatus:cloudAppVehicleID:stabilityControlsStatus:eCallInfo:airbagStatus:emergencyEvent:clusterModeStatus:myKey:handsOffSteering:windowStatus:

Convenience init for getting data for all possible vehicle data items.

Objective-C

- (nonnull instancetype)
                  initWithGps:(nullable NSNumber<SDLBool> *)gps
                        speed:(nullable NSNumber<SDLBool> *)speed
                          rpm:(nullable NSNumber<SDLBool> *)rpm
       instantFuelConsumption:
           (nullable NSNumber<SDLBool> *)instantFuelConsumption
                    fuelRange:(nullable NSNumber<SDLBool> *)fuelRange
          externalTemperature:(nullable NSNumber<SDLBool> *)externalTemperature
                   turnSignal:(nullable NSNumber<SDLBool> *)turnSignal
                          vin:(nullable NSNumber<SDLBool> *)vin
                   gearStatus:(nullable NSNumber<SDLBool> *)gearStatus
                 tirePressure:(nullable NSNumber<SDLBool> *)tirePressure
                     odometer:(nullable NSNumber<SDLBool> *)odometer
                   beltStatus:(nullable NSNumber<SDLBool> *)beltStatus
              bodyInformation:(nullable NSNumber<SDLBool> *)bodyInformation
                 deviceStatus:(nullable NSNumber<SDLBool> *)deviceStatus
                driverBraking:(nullable NSNumber<SDLBool> *)driverBraking
                  wiperStatus:(nullable NSNumber<SDLBool> *)wiperStatus
               headLampStatus:(nullable NSNumber<SDLBool> *)headLampStatus
                 engineTorque:(nullable NSNumber<SDLBool> *)engineTorque
             accPedalPosition:(nullable NSNumber<SDLBool> *)accPedalPosition
           steeringWheelAngle:(nullable NSNumber<SDLBool> *)steeringWheelAngle
                engineOilLife:(nullable NSNumber<SDLBool> *)engineOilLife
    electronicParkBrakeStatus:
        (nullable NSNumber<SDLBool> *)electronicParkBrakeStatus
            cloudAppVehicleID:(nullable NSNumber<SDLBool> *)cloudAppVehicleID
      stabilityControlsStatus:
          (nullable NSNumber<SDLBool> *)stabilityControlsStatus
                    eCallInfo:(nullable NSNumber<SDLBool> *)eCallInfo
                 airbagStatus:(nullable NSNumber<SDLBool> *)airbagStatus
               emergencyEvent:(nullable NSNumber<SDLBool> *)emergencyEvent
            clusterModeStatus:(nullable NSNumber<SDLBool> *)clusterModeStatus
                        myKey:(nullable NSNumber<SDLBool> *)myKey
             handsOffSteering:(nullable NSNumber<SDLBool> *)handsOffSteering
                 windowStatus:(nullable NSNumber<SDLBool> *)windowStatus;

Swift

init(gps: (NSNumber & SDLBool)?, speed: (NSNumber & SDLBool)?, rpm: (NSNumber & SDLBool)?, instantFuelConsumption: (NSNumber & SDLBool)?, fuelRange: (NSNumber & SDLBool)?, externalTemperature: (NSNumber & SDLBool)?, turnSignal: (NSNumber & SDLBool)?, vin: (NSNumber & SDLBool)?, gearStatus: (NSNumber & SDLBool)?, tirePressure: (NSNumber & SDLBool)?, odometer: (NSNumber & SDLBool)?, beltStatus: (NSNumber & SDLBool)?, bodyInformation: (NSNumber & SDLBool)?, deviceStatus: (NSNumber & SDLBool)?, driverBraking: (NSNumber & SDLBool)?, wiperStatus: (NSNumber & SDLBool)?, headLampStatus: (NSNumber & SDLBool)?, engineTorque: (NSNumber & SDLBool)?, accPedalPosition: (NSNumber & SDLBool)?, steeringWheelAngle: (NSNumber & SDLBool)?, engineOilLife: (NSNumber & SDLBool)?, electronicParkBrakeStatus: (NSNumber & SDLBool)?, cloudAppVehicleID: (NSNumber & SDLBool)?, stabilityControlsStatus: (NSNumber & SDLBool)?, eCallInfo: (NSNumber & SDLBool)?, airbagStatus: (NSNumber & SDLBool)?, emergencyEvent: (NSNumber & SDLBool)?, clusterModeStatus: (NSNumber & SDLBool)?, myKey: (NSNumber & SDLBool)?, handsOffSteering: (NSNumber & SDLBool)?, windowStatus: (NSNumber & SDLBool)?)

Parameters

gps

- gps

speed

- speed

rpm

- rpm

instantFuelConsumption

- instantFuelConsumption

fuelRange

- fuelRange

externalTemperature

- externalTemperature

turnSignal

- turnSignal

vin

- vin

gearStatus

- gearStatus

tirePressure

- tirePressure

odometer

- odometer

beltStatus

- beltStatus

bodyInformation

- bodyInformation

deviceStatus

- deviceStatus

driverBraking

- driverBraking

wiperStatus

- wiperStatus

headLampStatus

- headLampStatus

engineTorque

- engineTorque

accPedalPosition

- accPedalPosition

steeringWheelAngle

- steeringWheelAngle

engineOilLife

- engineOilLife

electronicParkBrakeStatus

- electronicParkBrakeStatus

cloudAppVehicleID

- cloudAppVehicleID

stabilityControlsStatus

- stabilityControlsStatus

eCallInfo

- eCallInfo

airbagStatus

- airbagStatus

emergencyEvent

- emergencyEvent

clusterModeStatus

- clusterModeStatus

myKey

- myKey

handsOffSteering

- handsOffSteering

windowStatus

- windowStatus

Return Value

A SDLGetVehicleData object

gearStatus

See GearStatus

@since SDL 7.0

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *gearStatus;

Swift

var gearStatus: (NSNumber & SDLBool)? { get set }

gps

A boolean value. If true, requests GPS data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *gps;

Swift

var gps: (NSNumber & SDLBool)? { get set }

speed

A boolean value. If true, requests Speed data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *speed;

Swift

var speed: (NSNumber & SDLBool)? { get set }

rpm

A boolean value. If true, requests RPM data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *rpm;

Swift

var rpm: (NSNumber & SDLBool)? { get set }

fuelLevel

A boolean value. If true, requests Fuel Level data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *fuelLevel;

Swift

var fuelLevel: (NSNumber & SDLBool)? { get set }

fuelLevel_State

A boolean value. If true, requests Fuel Level State data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *fuelLevel_State;

Swift

var fuelLevel_State: (NSNumber & SDLBool)? { get set }

fuelRange

A boolean value. If true, requests Fuel Range data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *fuelRange;

Swift

var fuelRange: (NSNumber & SDLBool)? { get set }

instantFuelConsumption

A boolean value. If true, requests Instant Fuel Consumption data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *instantFuelConsumption;

Swift

var instantFuelConsumption: (NSNumber & SDLBool)? { get set }

externalTemperature

A boolean value. If true, requests External Temperature data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *externalTemperature;

Swift

var externalTemperature: (NSNumber & SDLBool)? { get set }

vin

A boolean value. If true, requests the Vehicle Identification Number.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *vin;

Swift

var vin: (NSNumber & SDLBool)? { get set }

prndl

See PRNDL. This parameter is deprecated and it is now covered in gearStatus

@deprecated @since SDL 7.0

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *prndl;

Swift

var prndl: (NSNumber & SDLBool)? { get set }

tirePressure

A boolean value. If true, requests Tire Pressure data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *tirePressure;

Swift

var tirePressure: (NSNumber & SDLBool)? { get set }

odometer

A boolean value. If true, requests Odometer data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *odometer;

Swift

var odometer: (NSNumber & SDLBool)? { get set }

beltStatus

A boolean value. If true, requests Belt Status data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *beltStatus;

Swift

var beltStatus: (NSNumber & SDLBool)? { get set }

bodyInformation

A boolean value. If true, requests Body Information data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *bodyInformation;

Swift

var bodyInformation: (NSNumber & SDLBool)? { get set }

deviceStatus

A boolean value. If true, requests Device Status data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *deviceStatus;

Swift

var deviceStatus: (NSNumber & SDLBool)? { get set }

driverBraking

A boolean value. If true, requests Driver Braking data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *driverBraking;

Swift

var driverBraking: (NSNumber & SDLBool)? { get set }

windowStatus

See WindowStatus

@since SDL 7.0

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *windowStatus;

Swift

var windowStatus: (NSNumber & SDLBool)? { get set }

wiperStatus

A boolean value. If true, requests Wiper Status data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *wiperStatus;

Swift

var wiperStatus: (NSNumber & SDLBool)? { get set }

handsOffSteering

To indicate whether driver hands are off the steering wheel

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *handsOffSteering;

Swift

var handsOffSteering: (NSNumber & SDLBool)? { get set }

headLampStatus

A boolean value. If true, requests Head Lamp Status data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *headLampStatus;

Swift

var headLampStatus: (NSNumber & SDLBool)? { get set }

engineOilLife

A boolean value. If true, requests Engine Oil Life data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *engineOilLife;

Swift

var engineOilLife: (NSNumber & SDLBool)? { get set }

engineTorque

A boolean value. If true, requests Engine Torque data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *engineTorque;

Swift

var engineTorque: (NSNumber & SDLBool)? { get set }

accPedalPosition

A boolean value. If true, requests Acc Pedal Position data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *accPedalPosition;

Swift

var accPedalPosition: (NSNumber & SDLBool)? { get set }

steeringWheelAngle

A boolean value. If true, requests Steering Wheel Angle data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *steeringWheelAngle;

Swift

var steeringWheelAngle: (NSNumber & SDLBool)? { get set }

eCallInfo

A boolean value. If true, requests Emergency Call Info data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *eCallInfo;

Swift

var eCallInfo: (NSNumber & SDLBool)? { get set }

airbagStatus

A boolean value. If true, requests Air Bag Status data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *airbagStatus;

Swift

var airbagStatus: (NSNumber & SDLBool)? { get set }

emergencyEvent

A boolean value. If true, requests Emergency Event (if it occurred) data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *emergencyEvent;

Swift

var emergencyEvent: (NSNumber & SDLBool)? { get set }

clusterModeStatus

A boolean value. If true, requests Cluster Mode Status data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *clusterModeStatus;

Swift

var clusterModeStatus: (NSNumber & SDLBool)? { get set }

myKey

A boolean value. If true, requests MyKey data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *myKey;

Swift

var myKey: (NSNumber & SDLBool)? { get set }

electronicParkBrakeStatus

A boolean value. If true, requests Electronic Parking Brake status data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *electronicParkBrakeStatus;

Swift

var electronicParkBrakeStatus: (NSNumber & SDLBool)? { get set }

turnSignal

A boolean value. If true, requests Turn Signal data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *turnSignal;

Swift

var turnSignal: (NSNumber & SDLBool)? { get set }

cloudAppVehicleID

A boolean value. If true, requests the Cloud App Vehicle ID.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *cloudAppVehicleID;

Swift

var cloudAppVehicleID: (NSNumber & SDLBool)? { get set }

stabilityControlsStatus

A boolean value. If true, requests StabilityControlsStatus data.

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *stabilityControlsStatus;

Swift

var stabilityControlsStatus: (NSNumber & SDLBool)? { get set }

-setOEMCustomVehicleData:withVehicleDataState:

Sets the OEM custom vehicle data state for any given OEM custom vehicle data name.

Added in SmartDeviceLink 6.0

Objective-C

- (void)setOEMCustomVehicleData:(nonnull NSString *)vehicleDataName
           withVehicleDataState:(BOOL)vehicleDataState;

Swift

func setOEMCustomVehicleData(name vehicleDataName: String, state vehicleDataState: Bool)

Parameters

vehicleDataName

The name of the OEM custom vehicle data item.

vehicleDataState

A boolean value. If true, requests the OEM custom vehicle data item.

-getOEMCustomVehicleData:

Gets the OEM custom vehicle data value for any given OEM custom vehicle data name.

Added in SmartDeviceLink 6.0

Objective-C

- (nullable NSNumber<SDLBool> *)getOEMCustomVehicleData:
    (nonnull NSString *)vehicleDataName;

Swift

func getOEMCustomVehicleData(_ vehicleDataName: String) -> (NSNumber & SDLBool)?

Parameters

vehicleDataName

The name of the OEM custom vehicle data item.

Return Value

The state of an OEM custom vehicle data item for the given vehicle data name.

View on GitHub.com
Previous Section Next Section