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
SDLSubscribeVehicleDataResponse

SDLSubscribeVehicleDataResponse Class Reference

Section Contents

Overview

Response to SDLSubscribeVehicleData

Since SmartDeviceLink 2.0

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

Convenience init for setting all possible values on vehicle data items.

Objective-C

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

Swift

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

Parameters

gps

- gps

speed

- speed

rpm

- rpm

instantFuelConsumption

- instantFuelConsumption

fuelRange

- fuelRange

externalTemperature

- externalTemperature

turnSignal

- turnSignal

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

clusterModes

- clusterModes

myKey

- myKey

handsOffSteering

- handsOffSteering

windowStatus

- windowStatus

Return Value

A SDLSubscribeVehicleDataResponse object

gearStatus

See GearStatus

@since SDL 7.0

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *gearStatus;

Swift

var gearStatus: SDLVehicleDataResult? { get set }

gps

The result of requesting to subscribe to the GPSData.

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *gps;

Swift

var gps: SDLVehicleDataResult? { get set }

speed

The result of requesting to subscribe to the vehicle speed in kilometers per hour.

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *speed;

Swift

var speed: SDLVehicleDataResult? { get set }

rpm

The result of requesting to subscribe to the number of revolutions per minute of the engine.

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *rpm;

Swift

var rpm: SDLVehicleDataResult? { get set }

fuelLevel

The result of requesting to subscribe to the fuel level in the tank (percentage)

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *fuelLevel;

Swift

var fuelLevel: SDLVehicleDataResult? { get set }

fuelLevel_State

The result of requesting to subscribe to the fuel level state.

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *fuelLevel_State;

Swift

var fuelLevel_State: SDLVehicleDataResult? { get set }

fuelRange

The result of requesting to subscribe to the fuel range.

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *fuelRange;

Swift

var fuelRange: SDLVehicleDataResult? { get set }

instantFuelConsumption

The result of requesting to subscribe to the instantaneous fuel consumption in microlitres.

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *instantFuelConsumption;

Swift

var instantFuelConsumption: SDLVehicleDataResult? { get set }

externalTemperature

The result of requesting to subscribe to the external temperature in degrees celsius.

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *externalTemperature;

Swift

var externalTemperature: SDLVehicleDataResult? { 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) SDLVehicleDataResult *prndl;

Swift

var prndl: SDLVehicleDataResult? { get set }

tirePressure

The result of requesting to subscribe to the tireStatus.

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *tirePressure;

Swift

var tirePressure: SDLVehicleDataResult? { get set }

odometer

The result of requesting to subscribe to the odometer in km.

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *odometer;

Swift

var odometer: SDLVehicleDataResult? { get set }

beltStatus

The result of requesting to subscribe to the status of the seat belts.

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *beltStatus;

Swift

var beltStatus: SDLVehicleDataResult? { get set }

bodyInformation

The result of requesting to subscribe to the body information including power modes.

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *bodyInformation;

Swift

var bodyInformation: SDLVehicleDataResult? { get set }

deviceStatus

The result of requesting to subscribe to the device status including signal and battery strength.

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *deviceStatus;

Swift

var deviceStatus: SDLVehicleDataResult? { get set }

driverBraking

The result of requesting to subscribe to the status of the brake pedal.

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *driverBraking;

Swift

var driverBraking: SDLVehicleDataResult? { get set }

windowStatus

See WindowStatus

@since SDL 7.0

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *windowStatus;

Swift

var windowStatus: SDLVehicleDataResult? { get set }

wiperStatus

The result of requesting to subscribe to the status of the wipers.

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *wiperStatus;

Swift

var wiperStatus: SDLVehicleDataResult? { get set }

handsOffSteering

To indicate whether driver hands are off the steering wheel

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *handsOffSteering;

Swift

var handsOffSteering: SDLVehicleDataResult? { get set }

headLampStatus

The result of requesting to subscribe to the status of the head lamps.

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *headLampStatus;

Swift

var headLampStatus: SDLVehicleDataResult? { get set }

engineOilLife

The result of requesting to subscribe to the estimated percentage of remaining oil life of the engine.

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *engineOilLife;

Swift

var engineOilLife: SDLVehicleDataResult? { get set }

engineTorque

The result of requesting to subscribe to the torque value for engine (in Nm) on non-diesel variants.

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *engineTorque;

Swift

var engineTorque: SDLVehicleDataResult? { get set }

accPedalPosition

The result of requesting to subscribe to the accelerator pedal position (percentage depressed)

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *accPedalPosition;

Swift

var accPedalPosition: SDLVehicleDataResult? { get set }

stabilityControlsStatus

See StabilityControlsStatus

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *stabilityControlsStatus;

Swift

var stabilityControlsStatus: SDLVehicleDataResult? { get set }

steeringWheelAngle

The result of requesting to subscribe to the current angle of the steering wheel (in deg)

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *steeringWheelAngle;

Swift

var steeringWheelAngle: SDLVehicleDataResult? { get set }

eCallInfo

The result of requesting to subscribe to the emergency call info

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *eCallInfo;

Swift

var eCallInfo: SDLVehicleDataResult? { get set }

airbagStatus

The result of requesting to subscribe to the airbag status

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *airbagStatus;

Swift

var airbagStatus: SDLVehicleDataResult? { get set }

emergencyEvent

The result of requesting to subscribe to the emergency event

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *emergencyEvent;

Swift

var emergencyEvent: SDLVehicleDataResult? { get set }

clusterModes

The result of requesting to subscribe to the cluster modes

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *clusterModes;

Swift

var clusterModes: SDLVehicleDataResult? { get set }

myKey

The result of requesting to subscribe to the myKey status

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *myKey;

Swift

var myKey: SDLVehicleDataResult? { get set }

electronicParkBrakeStatus

The result of requesting to subscribe to the electronic parking brake status

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *electronicParkBrakeStatus;

Swift

var electronicParkBrakeStatus: SDLVehicleDataResult? { get set }

turnSignal

The result of requesting to subscribe to the turn signal

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *turnSignal;

Swift

var turnSignal: SDLVehicleDataResult? { get set }

cloudAppVehicleID

The result of requesting to subscribe to the cloud app vehicle ID

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataResult *cloudAppVehicleID;

Swift

var cloudAppVehicleID: SDLVehicleDataResult? { get set }

-setOEMCustomVehicleData:withVehicleDataState:

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

Added SmartDeviceLink 6.0

Objective-C

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

Swift

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

Parameters

vehicleDataName

The name of the OEM custom vehicle data item.

vehicleDataState

SDLVehicleDataResult object containing custom data type and result code information.

-getOEMCustomVehicleData:

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

Added SmartDeviceLink 6.0

Objective-C

- (nullable SDLVehicleDataResult *)getOEMCustomVehicleData:
    (nonnull NSString *)vehicleDataName;

Swift

func getOEMCustomVehicleData(_ vehicleDataName: String) -> SDLVehicleDataResult?

Parameters

vehicleDataName

The name of the OEM custom vehicle data item.

Return Value

SDLVehicleDataResult An object containing custom data type and result code information.

View on GitHub.com
Previous Section Next Section