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
SDLOnVehicleData

SDLOnVehicleData Class Reference

Section Contents

Overview

Callback for the periodic and non periodic vehicle data read function.

Since SmartDeviceLink 2.0

-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 setting all possible values on vehicle data items.

Objective-C

- (nonnull instancetype)
                  initWithGps:(nullable SDLGPSData *)gps
                        speed:(nullable NSNumber<SDLFloat> *)speed
                          rpm:(nullable NSNumber<SDLUInt> *)rpm
       instantFuelConsumption:
           (nullable NSNumber<SDLFloat> *)instantFuelConsumption
                    fuelRange:(nullable NSArray<SDLFuelRange *> *)fuelRange
          externalTemperature:(nullable NSNumber<SDLFloat> *)externalTemperature
                   turnSignal:(nullable SDLTurnSignal)turnSignal
                          vin:(nullable NSString *)vin
                   gearStatus:(nullable SDLGearStatus *)gearStatus
                 tirePressure:(nullable SDLTireStatus *)tirePressure
                     odometer:(nullable NSNumber<SDLUInt> *)odometer
                   beltStatus:(nullable SDLBeltStatus *)beltStatus
              bodyInformation:(nullable SDLBodyInformation *)bodyInformation
                 deviceStatus:(nullable SDLDeviceStatus *)deviceStatus
                driverBraking:(nullable SDLVehicleDataEventStatus)driverBraking
                  wiperStatus:(nullable SDLWiperStatus)wiperStatus
               headLampStatus:(nullable SDLHeadLampStatus *)headLampStatus
                 engineTorque:(nullable NSNumber<SDLFloat> *)engineTorque
             accPedalPosition:(nullable NSNumber<SDLFloat> *)accPedalPosition
           steeringWheelAngle:(nullable NSNumber<SDLFloat> *)steeringWheelAngle
                engineOilLife:(nullable NSNumber<SDLFloat> *)engineOilLife
    electronicParkBrakeStatus:
        (nullable SDLElectronicParkBrakeStatus)electronicParkBrakeStatus
            cloudAppVehicleID:(nullable NSString *)cloudAppVehicleID
      stabilityControlsStatus:
          (nullable SDLStabilityControlsStatus *)stabilityControlsStatus
                    eCallInfo:(nullable SDLECallInfo *)eCallInfo
                 airbagStatus:(nullable SDLAirbagStatus *)airbagStatus
               emergencyEvent:(nullable SDLEmergencyEvent *)emergencyEvent
            clusterModeStatus:(nullable SDLClusterModeStatus *)clusterModeStatus
                        myKey:(nullable SDLMyKey *)myKey
             handsOffSteering:(nullable NSNumber<SDLBool> *)handsOffSteering
                 windowStatus:
                     (nullable NSArray<SDLWindowStatus *> *)windowStatus;

Swift

init(gps: SDLGPSData?, speed: (NSNumber & SDLFloat)?, rpm: (NSNumber & SDLUInt)?, instantFuelConsumption: (NSNumber & SDLFloat)?, fuelRange: [SDLFuelRange]?, externalTemperature: (NSNumber & SDLFloat)?, turnSignal: SDLTurnSignal?, vin: String?, gearStatus: SDLGearStatus?, tirePressure: SDLTireStatus?, odometer: (NSNumber & SDLUInt)?, beltStatus: SDLBeltStatus?, bodyInformation: SDLBodyInformation?, deviceStatus: SDLDeviceStatus?, driverBraking: SDLVehicleDataEventStatus?, wiperStatus: SDLWiperStatus?, headLampStatus: SDLHeadLampStatus?, engineTorque: (NSNumber & SDLFloat)?, accPedalPosition: (NSNumber & SDLFloat)?, steeringWheelAngle: (NSNumber & SDLFloat)?, engineOilLife: (NSNumber & SDLFloat)?, electronicParkBrakeStatus: SDLElectronicParkBrakeStatus?, cloudAppVehicleID: String?, stabilityControlsStatus: SDLStabilityControlsStatus?, eCallInfo: SDLECallInfo?, airbagStatus: SDLAirbagStatus?, emergencyEvent: SDLEmergencyEvent?, clusterModeStatus: SDLClusterModeStatus?, myKey: SDLMyKey?, handsOffSteering: (NSNumber & SDLBool)?, windowStatus: [SDLWindowStatus]?)

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 SDLOnVehicleData object

gearStatus

See GearStatus

@since SDL 7.0

Objective-C

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

Swift

var gearStatus: SDLGearStatus? { get set }

gps

The car current GPS coordinates

Objective-C

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

Swift

var gps: SDLGPSData? { get set }

speed

The vehicle speed in kilometers per hour

Objective-C

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

Swift

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

rpm

The number of revolutions per minute of the engine.

Objective-C

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

Swift

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

fuelLevel

The fuel level in the tank (percentage)

Objective-C

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

Swift

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

fuelLevel_State

The fuel level state

Objective-C

@property (nonatomic, strong, nullable) SDLComponentVolumeStatus fuelLevel_State;

Swift

var fuelLevel_State: SDLComponentVolumeStatus? { get set }

fuelRange

The estimate range in KM the vehicle can travel based on fuel level and consumption

Optional, Array of length 0 - 100, of SDLFuelRange

Objective-C

@property (nonatomic, strong, nullable) NSArray<SDLFuelRange *> *fuelRange;

Swift

var fuelRange: [SDLFuelRange]? { get set }

instantFuelConsumption

The instantaneous fuel consumption in microlitres

Objective-C

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

Swift

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

externalTemperature

The external temperature in degrees celsius.

Objective-C

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

Swift

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

vin

The Vehicle Identification Number

Objective-C

@property (nonatomic, strong, nullable) NSString *vin;

Swift

var vin: String? { get set }

prndl

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

@deprecated @since SDL 7.0.0

Objective-C

@property (nonatomic, strong, nullable) SDLPRNDL prndl;

Swift

var prndl: SDLPRNDL? { get set }

tirePressure

The current pressure warnings for the user’s vehicle

Objective-C

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

Swift

var tirePressure: SDLTireStatus? { get set }

odometer

Odometer reading in km

Objective-C

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

Swift

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

beltStatus

The status of the seat belts

Objective-C

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

Swift

var beltStatus: SDLBeltStatus? { get set }

bodyInformation

The body information including power modes

Objective-C

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

Swift

var bodyInformation: SDLBodyInformation? { get set }

deviceStatus

The IVI system status including signal and battery strength

Objective-C

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

Swift

var deviceStatus: SDLDeviceStatus? { get set }

driverBraking

The status of the brake pedal

Objective-C

@property (nonatomic, strong, nullable) SDLVehicleDataEventStatus driverBraking;

Swift

var driverBraking: SDLVehicleDataEventStatus? { get set }

windowStatus

See WindowStatus {“array_min_size”: 0, “array_max_size”: 100}

@since SDL 7.0

Objective-C

@property (nonatomic, strong, nullable) NSArray<SDLWindowStatus *> *windowStatus;

Swift

var windowStatus: [SDLWindowStatus]? { get set }

wiperStatus

The status of the wipers

Objective-C

@property (nonatomic, strong, nullable) SDLWiperStatus wiperStatus;

Swift

var wiperStatus: SDLWiperStatus? { 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

Status of the head lamps

Objective-C

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

Swift

var headLampStatus: SDLHeadLampStatus? { get set }

engineOilLife

The estimated percentage (0% - 100%) of remaining oil life of the engine

Objective-C

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

Swift

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

engineTorque

Torque value for engine (in Nm) on non-diesel variants

Objective-C

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

Swift

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

accPedalPosition

Accelerator pedal position (percentage depressed)

Objective-C

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

Swift

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

steeringWheelAngle

Current angle of the steering wheel (in deg)

Objective-C

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

Swift

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

eCallInfo

Emergency Call notification and confirmation data

Objective-C

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

Swift

var eCallInfo: SDLECallInfo? { get set }

airbagStatus

The status of the air bags

Objective-C

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

Swift

var airbagStatus: SDLAirbagStatus? { get set }

emergencyEvent

Information related to an emergency event (and if it occurred)

Objective-C

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

Swift

var emergencyEvent: SDLEmergencyEvent? { get set }

clusterModeStatus

The status modes of the cluster

Objective-C

@property (nonatomic, strong, nullable) SDLClusterModeStatus *clusterModeStatus;

Swift

var clusterModeStatus: SDLClusterModeStatus? { get set }

myKey

Information related to the MyKey feature

Objective-C

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

Swift

var myKey: SDLMyKey? { get set }

electronicParkBrakeStatus

The status of the electronic parking brake

Objective-C

@property (nonatomic, strong, nullable) SDLElectronicParkBrakeStatus electronicParkBrakeStatus;

Swift

var electronicParkBrakeStatus: SDLElectronicParkBrakeStatus? { get set }

stabilityControlsStatus

See StabilityControlsStatus

Objective-C

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

Swift

var stabilityControlsStatus: SDLStabilityControlsStatus? { get set }

turnSignal

The status of the turn signal

Objective-C

@property (nonatomic, strong, nullable) SDLTurnSignal turnSignal;

Swift

var turnSignal: SDLTurnSignal? { get set }

cloudAppVehicleID

The cloud app vehicle ID

Objective-C

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

Swift

var cloudAppVehicleID: String? { 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:(nonnull NSObject *)vehicleDataState;

Swift

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

Parameters

vehicleDataName

The name of the OEM custom vehicle data item.

vehicleDataState

An object containing the OEM custom vehicle data item.

-getOEMCustomVehicleData:

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

Added in SmartDeviceLink 6.0

Objective-C

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

Swift

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

Parameters

vehicleDataName

The name of the OEM custom vehicle data item.

Return Value

An OEM custom vehicle data object for the given vehicle data name.

View on GitHub.com
Previous Section Next Section