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

GetVehicleDataResponse Class Reference

Constructors

Instance Methods

Constructors

new GetVehicleDataResponse(parameters)

Initalizes an instance of GetVehicleDataResponse.

Instance Methods

getVehicleDataResponse.getAccPedalPosition() ⇒ Number

Get the AccPedalPosition

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

getVehicleDataResponse.getAirbagStatus() ⇒ AirbagStatus

Get the AirbagStatus

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

getVehicleDataResponse.getBeltStatus() ⇒ BeltStatus

Get the BeltStatus

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

getVehicleDataResponse.getBodyInformation() ⇒ BodyInformation

Get the BodyInformation

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

getVehicleDataResponse.getCloudAppVehicleID() ⇒ String

Get the CloudAppVehicleID

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

getVehicleDataResponse.getClusterModeStatus() ⇒ ClusterModeStatus

Get the ClusterModeStatus

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

getVehicleDataResponse.getDeviceStatus() ⇒ DeviceStatus

Get the DeviceStatus

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

getVehicleDataResponse.getDriverBraking() ⇒ VehicleDataEventStatus

Get the DriverBraking

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

getVehicleDataResponse.getECallInfo() ⇒ ECallInfo

Get the ECallInfo

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

getVehicleDataResponse.getElectronicParkBrakeStatus() ⇒ ElectronicParkBrakeStatus

Get the ElectronicParkBrakeStatus

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

getVehicleDataResponse.getEmergencyEvent() ⇒ EmergencyEvent

Get the EmergencyEvent

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

getVehicleDataResponse.getEngineOilLife() ⇒ Number

Get the EngineOilLife

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

getVehicleDataResponse.getEngineTorque() ⇒ Number

Get the EngineTorque

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

getVehicleDataResponse.getExternalTemperature() ⇒ Number

Get the ExternalTemperature

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

getVehicleDataResponse.getFuelLevel() ⇒ Number

Get the FuelLevel

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

getVehicleDataResponse.getFuelLevel_State() ⇒ ComponentVolumeStatus

Get the FuelLevel_State

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

getVehicleDataResponse.getFuelRange() ⇒ Array.<FuelRange>

Get the FuelRange

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

getVehicleDataResponse.getGps() ⇒ GPSData

Get the Gps

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

getVehicleDataResponse.getHeadLampStatus() ⇒ HeadLampStatus

Get the HeadLampStatus

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

getVehicleDataResponse.getInstantFuelConsumption() ⇒ Number

Get the InstantFuelConsumption

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

getVehicleDataResponse.getMyKey() ⇒ MyKey

Get the MyKey

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

getVehicleDataResponse.getOEMCustomVehicleData(vehicleDataName) ⇒ Object

Gets a VehicleData value for the vehicle data item.

Kind: Instance method of GetVehicleDataResponse
Returns: Object - The value associated with the custom vehicle data.

ParamTypeDescription
vehicleDataName String The key associated with the custom vehicle data.

getVehicleDataResponse.getOdometer() ⇒ Number

Get the Odometer

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

getVehicleDataResponse.getPrndl() ⇒ PRNDL

Get the Prndl

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

getVehicleDataResponse.getRpm() ⇒ Number

Get the Rpm

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

getVehicleDataResponse.getSpeed() ⇒ Number

Get the Speed

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

getVehicleDataResponse.getSteeringWheelAngle() ⇒ Number

Get the SteeringWheelAngle

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

getVehicleDataResponse.getTirePressure() ⇒ TireStatus

Get the TirePressure

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

getVehicleDataResponse.getTurnSignal() ⇒ TurnSignal

Get the TurnSignal

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

getVehicleDataResponse.getVin() ⇒ String

Get the Vin

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

getVehicleDataResponse.getWiperStatus() ⇒ WiperStatus

Get the WiperStatus

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

getVehicleDataResponse.setAccPedalPosition(position) ⇒ GetVehicleDataResponse

Set the AccPedalPosition

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

ParamTypeDescription
position Number Accelerator pedal position (percentage depressed) - The desired AccPedalPosition.

getVehicleDataResponse.setAirbagStatus(status) ⇒ GetVehicleDataResponse

Set the AirbagStatus

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

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

getVehicleDataResponse.setBeltStatus(status) ⇒ GetVehicleDataResponse

Set the BeltStatus

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

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

getVehicleDataResponse.setBodyInformation(information) ⇒ GetVehicleDataResponse

Set the BodyInformation

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

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

getVehicleDataResponse.setCloudAppVehicleID(id) ⇒ GetVehicleDataResponse

Set the CloudAppVehicleID

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

ParamTypeDescription
id String Parameter used by cloud apps to identify a head unit - The desired CloudAppVehicleID.

getVehicleDataResponse.setClusterModeStatus(status) ⇒ GetVehicleDataResponse

Set the ClusterModeStatus

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

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

getVehicleDataResponse.setDeviceStatus(status) ⇒ GetVehicleDataResponse

Set the DeviceStatus

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

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

getVehicleDataResponse.setDriverBraking(braking) ⇒ GetVehicleDataResponse

Set the DriverBraking

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

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

getVehicleDataResponse.setECallInfo(info) ⇒ GetVehicleDataResponse

Set the ECallInfo

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

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

getVehicleDataResponse.setElectronicParkBrakeStatus(status) ⇒ GetVehicleDataResponse

Set the ElectronicParkBrakeStatus

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

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

getVehicleDataResponse.setEmergencyEvent(event) ⇒ GetVehicleDataResponse

Set the EmergencyEvent

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

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

getVehicleDataResponse.setEngineOilLife(life) ⇒ GetVehicleDataResponse

Set the EngineOilLife

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

ParamTypeDescription
life Number The estimated percentage of remaining oil life of the engine. - The desired EngineOilLife.

getVehicleDataResponse.setEngineTorque(torque) ⇒ GetVehicleDataResponse

Set the EngineTorque

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

ParamTypeDescription
torque Number Torque value for engine (in Nm) on non-diesel variants - The desired EngineTorque.

getVehicleDataResponse.setExternalTemperature(temperature) ⇒ GetVehicleDataResponse

Set the ExternalTemperature

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

ParamTypeDescription
temperature Number The external temperature in degrees celsius - The desired ExternalTemperature.

getVehicleDataResponse.setFuelLevel(level) ⇒ GetVehicleDataResponse

Set the FuelLevel

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

ParamTypeDescription
level Number The fuel level in the tank (percentage) - The desired FuelLevel.

getVehicleDataResponse.setFuelLevel_State(level_state) ⇒ GetVehicleDataResponse

Set the FuelLevel_State

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

ParamTypeDescription
level_state ComponentVolumeStatus The fuel level state - The desired FuelLevel_State.

getVehicleDataResponse.setFuelRange(range) ⇒ GetVehicleDataResponse

Set the FuelRange

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

ParamTypeDescription
range Array.<FuelRange> The estimate range in KM the vehicle can travel based on fuel level and consumption - The desired FuelRange.

getVehicleDataResponse.setGps(gps) ⇒ GetVehicleDataResponse

Set the Gps

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

ParamTypeDescription
gps GPSData See GPSData - The desired Gps.

getVehicleDataResponse.setHeadLampStatus(status) ⇒ GetVehicleDataResponse

Set the HeadLampStatus

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

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

getVehicleDataResponse.setInstantFuelConsumption(consumption) ⇒ GetVehicleDataResponse

Set the InstantFuelConsumption

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

ParamTypeDescription
consumption Number The instantaneous fuel consumption in microlitres - The desired InstantFuelConsumption.

getVehicleDataResponse.setMyKey(key) ⇒ GetVehicleDataResponse

Set the MyKey

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

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

getVehicleDataResponse.setOdometer(odometer) ⇒ GetVehicleDataResponse

Set the Odometer

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

ParamTypeDescription
odometer Number Odometer in km - The desired Odometer.

getVehicleDataResponse.setOemCustomVehicleData(vehicleDataName, vehicleDataState) ⇒ GetVehicleDataResponse

Sets a value for OEM Custom VehicleData.

Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - The class instance to support method chaining.

ParamTypeDescription
vehicleDataName String The key associated with the custom vehicle data.
vehicleDataState Object The value associated with the custom vehicle data.

getVehicleDataResponse.setPrndl(prndl) ⇒ GetVehicleDataResponse

Set the Prndl

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

ParamTypeDescription
prndl PRNDL See PRNDL - The desired Prndl.

getVehicleDataResponse.setRpm(rpm) ⇒ GetVehicleDataResponse

Set the Rpm

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

ParamTypeDescription
rpm Number The number of revolutions per minute of the engine - The desired Rpm.

getVehicleDataResponse.setSpeed(speed) ⇒ GetVehicleDataResponse

Set the Speed

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

ParamTypeDescription
speed Number The vehicle speed in kilometers per hour - The desired Speed.

getVehicleDataResponse.setSteeringWheelAngle(angle) ⇒ GetVehicleDataResponse

Set the SteeringWheelAngle

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

ParamTypeDescription
angle Number Current angle of the steering wheel (in deg) - The desired SteeringWheelAngle.

getVehicleDataResponse.setTirePressure(pressure) ⇒ GetVehicleDataResponse

Set the TirePressure

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

ParamTypeDescription
pressure TireStatus See TireStatus - The desired TirePressure.

getVehicleDataResponse.setTurnSignal(signal) ⇒ GetVehicleDataResponse

Set the TurnSignal

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

ParamTypeDescription
signal TurnSignal See TurnSignal - The desired TurnSignal.

getVehicleDataResponse.setVin(vin) ⇒ GetVehicleDataResponse

Set the Vin

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

ParamTypeDescription
vin String Vehicle identification number - The desired Vin.

getVehicleDataResponse.setWiperStatus(status) ⇒ GetVehicleDataResponse

Set the WiperStatus

Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - 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