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
OnVehicleData

OnVehicleData Class Reference

Constructors

Instance Methods

Constructors

new OnVehicleData(parameters)

Initalizes an instance of OnVehicleData.

Instance Methods

onVehicleData.getAccPedalPosition() ⇒ Number

Get the AccPedalPosition

Kind: Instance method of OnVehicleData
Returns: Number - the KEY_ACC_PEDAL_POSITION value

onVehicleData.getAirbagStatus() ⇒ AirbagStatus

Get the AirbagStatus

Kind: Instance method of OnVehicleData
Returns: AirbagStatus - the KEY_AIRBAG_STATUS value

onVehicleData.getBeltStatus() ⇒ BeltStatus

Get the BeltStatus

Kind: Instance method of OnVehicleData
Returns: BeltStatus - the KEY_BELT_STATUS value

onVehicleData.getBodyInformation() ⇒ BodyInformation

Get the BodyInformation

Kind: Instance method of OnVehicleData
Returns: BodyInformation - the KEY_BODY_INFORMATION value

onVehicleData.getCloudAppVehicleID() ⇒ String

Get the CloudAppVehicleID

Kind: Instance method of OnVehicleData
Returns: String - the KEY_CLOUD_APP_VEHICLE_ID value

onVehicleData.getClusterModeStatus() ⇒ ClusterModeStatus

Get the ClusterModeStatus

Kind: Instance method of OnVehicleData
Returns: ClusterModeStatus - the KEY_CLUSTER_MODE_STATUS value

onVehicleData.getDeviceStatus() ⇒ DeviceStatus

Get the DeviceStatus

Kind: Instance method of OnVehicleData
Returns: DeviceStatus - the KEY_DEVICE_STATUS value

onVehicleData.getDriverBraking() ⇒ VehicleDataEventStatus

Get the DriverBraking

Kind: Instance method of OnVehicleData
Returns: VehicleDataEventStatus - the KEY_DRIVER_BRAKING value

onVehicleData.getECallInfo() ⇒ ECallInfo

Get the ECallInfo

Kind: Instance method of OnVehicleData
Returns: ECallInfo - the KEY_E_CALL_INFO value

onVehicleData.getElectronicParkBrakeStatus() ⇒ ElectronicParkBrakeStatus

Get the ElectronicParkBrakeStatus

Kind: Instance method of OnVehicleData
Returns: ElectronicParkBrakeStatus - the KEY_ELECTRONIC_PARK_BRAKE_STATUS value

onVehicleData.getEmergencyEvent() ⇒ EmergencyEvent

Get the EmergencyEvent

Kind: Instance method of OnVehicleData
Returns: EmergencyEvent - the KEY_EMERGENCY_EVENT value

onVehicleData.getEngineOilLife() ⇒ Number

Get the EngineOilLife

Kind: Instance method of OnVehicleData
Returns: Number - the KEY_ENGINE_OIL_LIFE value

onVehicleData.getEngineTorque() ⇒ Number

Get the EngineTorque

Kind: Instance method of OnVehicleData
Returns: Number - the KEY_ENGINE_TORQUE value

onVehicleData.getExternalTemperature() ⇒ Number

Get the ExternalTemperature

Kind: Instance method of OnVehicleData
Returns: Number - the KEY_EXTERNAL_TEMPERATURE value

onVehicleData.getFuelLevel() ⇒ Number

Get the FuelLevel

Kind: Instance method of OnVehicleData
Returns: Number - the KEY_FUEL_LEVEL value

onVehicleData.getFuelLevel_State() ⇒ ComponentVolumeStatus

Get the FuelLevel_State

Kind: Instance method of OnVehicleData
Returns: ComponentVolumeStatus - the KEY_FUEL_LEVEL_STATE value

onVehicleData.getFuelRange() ⇒ Array.<FuelRange>

Get the FuelRange

Kind: Instance method of OnVehicleData
Returns: Array.<FuelRange> - the KEY_FUEL_RANGE value

onVehicleData.getGearStatus() ⇒ GearStatus

Get the GearStatus

Kind: Instance method of OnVehicleData
Returns: GearStatus - the KEY_GEAR_STATUS value

onVehicleData.getGps() ⇒ GPSData

Get the Gps

Kind: Instance method of OnVehicleData
Returns: GPSData - the KEY_GPS value

onVehicleData.getHandsOffSteering() ⇒ Boolean

Get the HandsOffSteering

Kind: Instance method of OnVehicleData
Returns: Boolean - the KEY_HANDS_OFF_STEERING value

onVehicleData.getHeadLampStatus() ⇒ HeadLampStatus

Get the HeadLampStatus

Kind: Instance method of OnVehicleData
Returns: HeadLampStatus - the KEY_HEAD_LAMP_STATUS value

onVehicleData.getInstantFuelConsumption() ⇒ Number

Get the InstantFuelConsumption

Kind: Instance method of OnVehicleData
Returns: Number - the KEY_INSTANT_FUEL_CONSUMPTION value

onVehicleData.getMyKey() ⇒ MyKey

Get the MyKey

Kind: Instance method of OnVehicleData
Returns: MyKey - the KEY_MY_KEY value

onVehicleData.getOdometer() ⇒ Number

Get the Odometer

Kind: Instance method of OnVehicleData
Returns: Number - the KEY_ODOMETER value

onVehicleData.getPrndl() ⇒ PRNDL

Get the Prndl

Kind: Instance method of OnVehicleData
Returns: PRNDL - the KEY_PRNDL value

onVehicleData.getRpm() ⇒ Number

Get the Rpm

Kind: Instance method of OnVehicleData
Returns: Number - the KEY_RPM value

onVehicleData.getSpeed() ⇒ Number

Get the Speed

Kind: Instance method of OnVehicleData
Returns: Number - the KEY_SPEED value

onVehicleData.getStabilityControlsStatus() ⇒ StabilityControlsStatus

Get the StabilityControlsStatus

Kind: Instance method of OnVehicleData
Returns: StabilityControlsStatus - the KEY_STABILITY_CONTROLS_STATUS value

onVehicleData.getSteeringWheelAngle() ⇒ Number

Get the SteeringWheelAngle

Kind: Instance method of OnVehicleData
Returns: Number - the KEY_STEERING_WHEEL_ANGLE value

onVehicleData.getTirePressure() ⇒ TireStatus

Get the TirePressure

Kind: Instance method of OnVehicleData
Returns: TireStatus - the KEY_TIRE_PRESSURE value

onVehicleData.getTurnSignal() ⇒ TurnSignal

Get the TurnSignal

Kind: Instance method of OnVehicleData
Returns: TurnSignal - the KEY_TURN_SIGNAL value

onVehicleData.getVin() ⇒ String

Get the Vin

Kind: Instance method of OnVehicleData
Returns: String - the KEY_VIN value

onVehicleData.getWindowStatus() ⇒ Array.<WindowStatus>

Get the WindowStatus

Kind: Instance method of OnVehicleData
Returns: Array.<WindowStatus> - the KEY_WINDOW_STATUS value

onVehicleData.getWiperStatus() ⇒ WiperStatus

Get the WiperStatus

Kind: Instance method of OnVehicleData
Returns: WiperStatus - the KEY_WIPER_STATUS value

onVehicleData.setAccPedalPosition(position) ⇒ OnVehicleData

Set the AccPedalPosition

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
position Number Accelerator pedal position (percentage depressed) - The desired AccPedalPosition. {'num_min_value': 0.0, 'num_max_value': 100.0}

onVehicleData.setAirbagStatus(status) ⇒ OnVehicleData

Set the AirbagStatus

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
status AirbagStatus The status of the air bags - The desired AirbagStatus.

onVehicleData.setBeltStatus(status) ⇒ OnVehicleData

Set the BeltStatus

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
status BeltStatus The status of the seat belts - The desired BeltStatus.

onVehicleData.setBodyInformation(information) ⇒ OnVehicleData

Set the BodyInformation

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
information BodyInformation The body information including power modes - The desired BodyInformation.

onVehicleData.setCloudAppVehicleID(id) ⇒ OnVehicleData

Set the CloudAppVehicleID

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
id String Parameter used by cloud apps to identify a head unit - The desired CloudAppVehicleID. {'string_min_length': 1}

onVehicleData.setClusterModeStatus(status) ⇒ OnVehicleData

Set the ClusterModeStatus

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
status ClusterModeStatus The status modes of the cluster - The desired ClusterModeStatus.

onVehicleData.setDeviceStatus(status) ⇒ OnVehicleData

Set the DeviceStatus

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
status DeviceStatus The device status including signal and battery strength - The desired DeviceStatus.

onVehicleData.setDriverBraking(braking) ⇒ OnVehicleData

Set the DriverBraking

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
braking VehicleDataEventStatus The status of the brake pedal - The desired DriverBraking.

onVehicleData.setECallInfo(info) ⇒ OnVehicleData

Set the ECallInfo

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
info ECallInfo Emergency Call notification and confirmation data - The desired ECallInfo.

onVehicleData.setElectronicParkBrakeStatus(status) ⇒ OnVehicleData

Set the ElectronicParkBrakeStatus

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
status ElectronicParkBrakeStatus The status of the park brake as provided by Electric Park Brake (EPB) system. - The desired ElectronicParkBrakeStatus.

onVehicleData.setEmergencyEvent(event) ⇒ OnVehicleData

Set the EmergencyEvent

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
event EmergencyEvent Information related to an emergency event (and if it occurred) - The desired EmergencyEvent.

onVehicleData.setEngineOilLife(life) ⇒ OnVehicleData

Set the EngineOilLife

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
life Number The estimated percentage of remaining oil life of the engine. - The desired EngineOilLife. {'num_min_value': 0.0, 'num_max_value': 100.0}

onVehicleData.setEngineTorque(torque) ⇒ OnVehicleData

Set the EngineTorque

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
torque Number Torque value for engine (in Nm) on non-diesel variants - The desired EngineTorque. {'num_min_value': -1000.0, 'num_max_value': 2000.0}

onVehicleData.setExternalTemperature(temperature) ⇒ OnVehicleData

Set the ExternalTemperature

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
temperature Number The external temperature in degrees celsius - The desired ExternalTemperature. {'num_min_value': -40.0, 'num_max_value': 100.0}

onVehicleData.setFuelLevel(level) ⇒ OnVehicleData

Set the FuelLevel

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
level Number The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec 7.0, please see fuelRange. - The desired FuelLevel. {'num_min_value': -6.0, 'num_max_value': 106.0}

onVehicleData.setFuelLevel_State(level_state) ⇒ OnVehicleData

Set the FuelLevel_State

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
level_state ComponentVolumeStatus The fuel level state. This parameter is deprecated starting RPC Spec 7.0, please see fuelRange. - The desired FuelLevel_State.

onVehicleData.setFuelRange(range) ⇒ OnVehicleData

Set the FuelRange

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
range Array.<FuelRange> The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details. - The desired FuelRange. {'array_min_size': 0, 'array_max_size': 100}

onVehicleData.setGearStatus(status) ⇒ OnVehicleData

Set the GearStatus

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
status GearStatus See GearStatus - The desired GearStatus.

onVehicleData.setGps(gps) ⇒ OnVehicleData

Set the Gps

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
gps GPSData See GPSData - The desired Gps.

onVehicleData.setHandsOffSteering(steering) ⇒ OnVehicleData

Set the HandsOffSteering

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
steering Boolean To indicate whether driver hands are off the steering wheel - The desired HandsOffSteering.

onVehicleData.setHeadLampStatus(status) ⇒ OnVehicleData

Set the HeadLampStatus

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
status HeadLampStatus Status of the head lamps - The desired HeadLampStatus.

onVehicleData.setInstantFuelConsumption(consumption) ⇒ OnVehicleData

Set the InstantFuelConsumption

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
consumption Number The instantaneous fuel consumption in microlitres - The desired InstantFuelConsumption. {'num_min_value': 0.0, 'num_max_value': 25575.0}

onVehicleData.setMyKey(key) ⇒ OnVehicleData

Set the MyKey

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
key MyKey Information related to the MyKey feature - The desired MyKey.

onVehicleData.setOdometer(odometer) ⇒ OnVehicleData

Set the Odometer

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
odometer Number Odometer in km - The desired Odometer. {'num_min_value': 0, 'num_max_value': 17000000}

onVehicleData.setPrndl(prndl) ⇒ OnVehicleData

Set the Prndl

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
prndl PRNDL See PRNDL. This parameter is deprecated and it is now covered in `gearStatus` - The desired Prndl.

onVehicleData.setRpm(rpm) ⇒ OnVehicleData

Set the Rpm

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
rpm Number The number of revolutions per minute of the engine - The desired Rpm. {'num_min_value': 0, 'num_max_value': 20000}

onVehicleData.setSpeed(speed) ⇒ OnVehicleData

Set the Speed

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
speed Number The vehicle speed in kilometers per hour - The desired Speed. {'num_min_value': 0.0, 'num_max_value': 700.0}

onVehicleData.setStabilityControlsStatus(status) ⇒ OnVehicleData

Set the StabilityControlsStatus

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
status StabilityControlsStatus See StabilityControlsStatus - The desired StabilityControlsStatus.

onVehicleData.setSteeringWheelAngle(angle) ⇒ OnVehicleData

Set the SteeringWheelAngle

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
angle Number Current angle of the steering wheel (in deg) - The desired SteeringWheelAngle. {'num_min_value': -2000.0, 'num_max_value': 2000.0}

onVehicleData.setTirePressure(pressure) ⇒ OnVehicleData

Set the TirePressure

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
pressure TireStatus See TireStatus - The desired TirePressure.

onVehicleData.setTurnSignal(signal) ⇒ OnVehicleData

Set the TurnSignal

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
signal TurnSignal See TurnSignal - The desired TurnSignal.

onVehicleData.setVin(vin) ⇒ OnVehicleData

Set the Vin

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
vin String Vehicle identification number. - The desired Vin. {'string_min_length': 1, 'string_max_length': 17}

onVehicleData.setWindowStatus(status) ⇒ OnVehicleData

Set the WindowStatus

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
status Array.<WindowStatus> See WindowStatus - The desired WindowStatus. {'array_min_size': 0, 'array_max_size': 100}

onVehicleData.setWiperStatus(status) ⇒ OnVehicleData

Set the WiperStatus

Kind: Instance method of OnVehicleData
Returns: OnVehicleData - The class instance for method chaining.

ParamTypeDescription
status WiperStatus The status of the wipers - The desired WiperStatus.
View on GitHub.com
Previous Section Next Section