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

SubscribeVehicleDataResponse Class Reference

Constructors

Instance Methods

Constructors

new SubscribeVehicleDataResponse(parameters)

Initalizes an instance of SubscribeVehicleDataResponse.

Instance Methods

subscribeVehicleDataResponse.getAccPedalPosition() ⇒ VehicleDataResult

Get the AccPedalPosition

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_ACC_PEDAL_POSITION value

subscribeVehicleDataResponse.getAirbagStatus() ⇒ VehicleDataResult

Get the AirbagStatus

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_AIRBAG_STATUS value

subscribeVehicleDataResponse.getBeltStatus() ⇒ VehicleDataResult

Get the BeltStatus

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_BELT_STATUS value

subscribeVehicleDataResponse.getBodyInformation() ⇒ VehicleDataResult

Get the BodyInformation

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_BODY_INFORMATION value

subscribeVehicleDataResponse.getCloudAppVehicleID() ⇒ VehicleDataResult

Get the CloudAppVehicleID

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_CLOUD_APP_VEHICLE_ID value

subscribeVehicleDataResponse.getClusterModes() ⇒ VehicleDataResult

Get the ClusterModes

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_CLUSTER_MODES value

subscribeVehicleDataResponse.getDeviceStatus() ⇒ VehicleDataResult

Get the DeviceStatus

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_DEVICE_STATUS value

subscribeVehicleDataResponse.getDriverBraking() ⇒ VehicleDataResult

Get the DriverBraking

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_DRIVER_BRAKING value

subscribeVehicleDataResponse.getECallInfo() ⇒ VehicleDataResult

Get the ECallInfo

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_E_CALL_INFO value

subscribeVehicleDataResponse.getElectronicParkBrakeStatus() ⇒ VehicleDataResult

Get the ElectronicParkBrakeStatus

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_ELECTRONIC_PARK_BRAKE_STATUS value

subscribeVehicleDataResponse.getEmergencyEvent() ⇒ VehicleDataResult

Get the EmergencyEvent

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_EMERGENCY_EVENT value

subscribeVehicleDataResponse.getEngineOilLife() ⇒ VehicleDataResult

Get the EngineOilLife

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_ENGINE_OIL_LIFE value

subscribeVehicleDataResponse.getEngineTorque() ⇒ VehicleDataResult

Get the EngineTorque

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_ENGINE_TORQUE value

subscribeVehicleDataResponse.getExternalTemperature() ⇒ VehicleDataResult

Get the ExternalTemperature

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_EXTERNAL_TEMPERATURE value

subscribeVehicleDataResponse.getFuelLevel() ⇒ VehicleDataResult

Get the FuelLevel

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_FUEL_LEVEL value

subscribeVehicleDataResponse.getFuelLevel_State() ⇒ VehicleDataResult

Get the FuelLevel_State

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_FUEL_LEVEL_STATE value

subscribeVehicleDataResponse.getFuelRange() ⇒ VehicleDataResult

Get the FuelRange

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_FUEL_RANGE value

subscribeVehicleDataResponse.getGps() ⇒ VehicleDataResult

Get the Gps

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_GPS value

subscribeVehicleDataResponse.getHeadLampStatus() ⇒ VehicleDataResult

Get the HeadLampStatus

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_HEAD_LAMP_STATUS value

subscribeVehicleDataResponse.getInstantFuelConsumption() ⇒ VehicleDataResult

Get the InstantFuelConsumption

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_INSTANT_FUEL_CONSUMPTION value

subscribeVehicleDataResponse.getMyKey() ⇒ VehicleDataResult

Get the MyKey

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_MY_KEY value

subscribeVehicleDataResponse.getOEMCustomVehicleData(vehicleDataName) ⇒ VehicleDataResult

Gets a VehicleData value for the vehicle data item.

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

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

subscribeVehicleDataResponse.getOdometer() ⇒ VehicleDataResult

Get the Odometer

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_ODOMETER value

subscribeVehicleDataResponse.getPrndl() ⇒ VehicleDataResult

Get the Prndl

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_PRNDL value

subscribeVehicleDataResponse.getRpm() ⇒ VehicleDataResult

Get the Rpm

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_RPM value

subscribeVehicleDataResponse.getSpeed() ⇒ VehicleDataResult

Get the Speed

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_SPEED value

subscribeVehicleDataResponse.getSteeringWheelAngle() ⇒ VehicleDataResult

Get the SteeringWheelAngle

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_STEERING_WHEEL_ANGLE value

subscribeVehicleDataResponse.getTirePressure() ⇒ VehicleDataResult

Get the TirePressure

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_TIRE_PRESSURE value

subscribeVehicleDataResponse.getTurnSignal() ⇒ VehicleDataResult

Get the TurnSignal

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_TURN_SIGNAL value

subscribeVehicleDataResponse.getWiperStatus() ⇒ VehicleDataResult

Get the WiperStatus

Kind: Instance method of SubscribeVehicleDataResponse
Returns: VehicleDataResult - the KEY_WIPER_STATUS value

subscribeVehicleDataResponse.setAccPedalPosition(position) ⇒ SubscribeVehicleDataResponse

Set the AccPedalPosition

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

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

subscribeVehicleDataResponse.setAirbagStatus(status) ⇒ SubscribeVehicleDataResponse

Set the AirbagStatus

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

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

subscribeVehicleDataResponse.setBeltStatus(status) ⇒ SubscribeVehicleDataResponse

Set the BeltStatus

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

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

subscribeVehicleDataResponse.setBodyInformation(information) ⇒ SubscribeVehicleDataResponse

Set the BodyInformation

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

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

subscribeVehicleDataResponse.setCloudAppVehicleID(id) ⇒ SubscribeVehicleDataResponse

Set the CloudAppVehicleID

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

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

subscribeVehicleDataResponse.setClusterModes(modes) ⇒ SubscribeVehicleDataResponse

Set the ClusterModes

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

ParamTypeDescription
modes VehicleDataResult The status modes of the cluster - The desired ClusterModes.

subscribeVehicleDataResponse.setDeviceStatus(status) ⇒ SubscribeVehicleDataResponse

Set the DeviceStatus

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

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

subscribeVehicleDataResponse.setDriverBraking(braking) ⇒ SubscribeVehicleDataResponse

Set the DriverBraking

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

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

subscribeVehicleDataResponse.setECallInfo(info) ⇒ SubscribeVehicleDataResponse

Set the ECallInfo

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

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

subscribeVehicleDataResponse.setElectronicParkBrakeStatus(status) ⇒ SubscribeVehicleDataResponse

Set the ElectronicParkBrakeStatus

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

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

subscribeVehicleDataResponse.setEmergencyEvent(event) ⇒ SubscribeVehicleDataResponse

Set the EmergencyEvent

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

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

subscribeVehicleDataResponse.setEngineOilLife(life) ⇒ SubscribeVehicleDataResponse

Set the EngineOilLife

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

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

subscribeVehicleDataResponse.setEngineTorque(torque) ⇒ SubscribeVehicleDataResponse

Set the EngineTorque

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

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

subscribeVehicleDataResponse.setExternalTemperature(temperature) ⇒ SubscribeVehicleDataResponse

Set the ExternalTemperature

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

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

subscribeVehicleDataResponse.setFuelLevel(level) ⇒ SubscribeVehicleDataResponse

Set the FuelLevel

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

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

subscribeVehicleDataResponse.setFuelLevel_State(level_state) ⇒ SubscribeVehicleDataResponse

Set the FuelLevel_State

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

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

subscribeVehicleDataResponse.setFuelRange(range) ⇒ SubscribeVehicleDataResponse

Set the FuelRange

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

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

subscribeVehicleDataResponse.setGps(gps) ⇒ SubscribeVehicleDataResponse

Set the Gps

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

ParamTypeDescription
gps VehicleDataResult See GPSData - The desired Gps.

subscribeVehicleDataResponse.setHeadLampStatus(status) ⇒ SubscribeVehicleDataResponse

Set the HeadLampStatus

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

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

subscribeVehicleDataResponse.setInstantFuelConsumption(consumption) ⇒ SubscribeVehicleDataResponse

Set the InstantFuelConsumption

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

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

subscribeVehicleDataResponse.setMyKey(key) ⇒ SubscribeVehicleDataResponse

Set the MyKey

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

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

subscribeVehicleDataResponse.setOdometer(odometer) ⇒ SubscribeVehicleDataResponse

Set the Odometer

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

ParamTypeDescription
odometer VehicleDataResult Odometer in km - The desired Odometer.

subscribeVehicleDataResponse.setOemCustomVehicleData(vehicleDataName, vehicleDataState) ⇒ SubscribeVehicleDataResponse

Sets a value for OEM Custom VehicleData.

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

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

subscribeVehicleDataResponse.setPrndl(prndl) ⇒ SubscribeVehicleDataResponse

Set the Prndl

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

ParamTypeDescription
prndl VehicleDataResult See PRNDL - The desired Prndl.

subscribeVehicleDataResponse.setRpm(rpm) ⇒ SubscribeVehicleDataResponse

Set the Rpm

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

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

subscribeVehicleDataResponse.setSpeed(speed) ⇒ SubscribeVehicleDataResponse

Set the Speed

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

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

subscribeVehicleDataResponse.setSteeringWheelAngle(angle) ⇒ SubscribeVehicleDataResponse

Set the SteeringWheelAngle

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

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

subscribeVehicleDataResponse.setTirePressure(pressure) ⇒ SubscribeVehicleDataResponse

Set the TirePressure

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

ParamTypeDescription
pressure VehicleDataResult See TireStatus - The desired TirePressure.

subscribeVehicleDataResponse.setTurnSignal(signal) ⇒ SubscribeVehicleDataResponse

Set the TurnSignal

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

ParamTypeDescription
signal VehicleDataResult See TurnSignal - The desired TurnSignal.

subscribeVehicleDataResponse.setWiperStatus(status) ⇒ SubscribeVehicleDataResponse

Set the WiperStatus

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

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