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

SubscribeVehicleData Class Reference

Constructors

Instance Methods

Constructors

new SubscribeVehicleData(parameters)

Initalizes an instance of SubscribeVehicleData.

Instance Methods

subscribeVehicleData.getAccPedalPosition() ⇒ Boolean

Get the AccPedalPosition

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_ACC_PEDAL_POSITION value

subscribeVehicleData.getAirbagStatus() ⇒ Boolean

Get the AirbagStatus

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_AIRBAG_STATUS value

subscribeVehicleData.getBeltStatus() ⇒ Boolean

Get the BeltStatus

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_BELT_STATUS value

subscribeVehicleData.getBodyInformation() ⇒ Boolean

Get the BodyInformation

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_BODY_INFORMATION value

subscribeVehicleData.getCloudAppVehicleID() ⇒ Boolean

Get the CloudAppVehicleID

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_CLOUD_APP_VEHICLE_ID value

subscribeVehicleData.getClusterModeStatus() ⇒ Boolean

Get the ClusterModeStatus

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_CLUSTER_MODE_STATUS value

subscribeVehicleData.getDeviceStatus() ⇒ Boolean

Get the DeviceStatus

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_DEVICE_STATUS value

subscribeVehicleData.getDriverBraking() ⇒ Boolean

Get the DriverBraking

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_DRIVER_BRAKING value

subscribeVehicleData.getECallInfo() ⇒ Boolean

Get the ECallInfo

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_E_CALL_INFO value

subscribeVehicleData.getElectronicParkBrakeStatus() ⇒ Boolean

Get the ElectronicParkBrakeStatus

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_ELECTRONIC_PARK_BRAKE_STATUS value

subscribeVehicleData.getEmergencyEvent() ⇒ Boolean

Get the EmergencyEvent

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_EMERGENCY_EVENT value

subscribeVehicleData.getEngineOilLife() ⇒ Boolean

Get the EngineOilLife

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_ENGINE_OIL_LIFE value

subscribeVehicleData.getEngineTorque() ⇒ Boolean

Get the EngineTorque

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_ENGINE_TORQUE value

subscribeVehicleData.getExternalTemperature() ⇒ Boolean

Get the ExternalTemperature

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_EXTERNAL_TEMPERATURE value

subscribeVehicleData.getFuelLevel() ⇒ Boolean

Get the FuelLevel

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_FUEL_LEVEL value

subscribeVehicleData.getFuelLevel_State() ⇒ Boolean

Get the FuelLevel_State

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_FUEL_LEVEL_STATE value

subscribeVehicleData.getFuelRange() ⇒ Boolean

Get the FuelRange

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_FUEL_RANGE value

subscribeVehicleData.getGps() ⇒ Boolean

Get the Gps

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_GPS value

subscribeVehicleData.getHeadLampStatus() ⇒ Boolean

Get the HeadLampStatus

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_HEAD_LAMP_STATUS value

subscribeVehicleData.getInstantFuelConsumption() ⇒ Boolean

Get the InstantFuelConsumption

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_INSTANT_FUEL_CONSUMPTION value

subscribeVehicleData.getMyKey() ⇒ Boolean

Get the MyKey

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_MY_KEY value

subscribeVehicleData.getOdometer() ⇒ Boolean

Get the Odometer

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_ODOMETER value

subscribeVehicleData.getOemCustomVehicleData(vehicleDataName) ⇒ [Boolean, null]

Gets a boolean value for OEM Custom VehicleData.

Kind: Instance method of SubscribeVehicleData
Returns: [Boolean, null] - Whether or not to subscribe to the data.

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

subscribeVehicleData.getPrndl() ⇒ Boolean

Get the Prndl

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_PRNDL value

subscribeVehicleData.getRpm() ⇒ Boolean

Get the Rpm

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_RPM value

subscribeVehicleData.getSpeed() ⇒ Boolean

Get the Speed

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_SPEED value

subscribeVehicleData.getSteeringWheelAngle() ⇒ Boolean

Get the SteeringWheelAngle

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_STEERING_WHEEL_ANGLE value

subscribeVehicleData.getTirePressure() ⇒ Boolean

Get the TirePressure

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_TIRE_PRESSURE value

subscribeVehicleData.getTurnSignal() ⇒ Boolean

Get the TurnSignal

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_TURN_SIGNAL value

subscribeVehicleData.getWiperStatus() ⇒ Boolean

Get the WiperStatus

Kind: Instance method of SubscribeVehicleData
Returns: Boolean - the KEY_WIPER_STATUS value

subscribeVehicleData.setAccPedalPosition(position) ⇒ SubscribeVehicleData

Set the AccPedalPosition

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

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

subscribeVehicleData.setAirbagStatus(status) ⇒ SubscribeVehicleData

Set the AirbagStatus

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

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

subscribeVehicleData.setBeltStatus(status) ⇒ SubscribeVehicleData

Set the BeltStatus

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

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

subscribeVehicleData.setBodyInformation(information) ⇒ SubscribeVehicleData

Set the BodyInformation

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

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

subscribeVehicleData.setCloudAppVehicleID(id) ⇒ SubscribeVehicleData

Set the CloudAppVehicleID

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

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

subscribeVehicleData.setClusterModeStatus(status) ⇒ SubscribeVehicleData

Set the ClusterModeStatus

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

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

subscribeVehicleData.setDeviceStatus(status) ⇒ SubscribeVehicleData

Set the DeviceStatus

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

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

subscribeVehicleData.setDriverBraking(braking) ⇒ SubscribeVehicleData

Set the DriverBraking

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

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

subscribeVehicleData.setECallInfo(info) ⇒ SubscribeVehicleData

Set the ECallInfo

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

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

subscribeVehicleData.setElectronicParkBrakeStatus(status) ⇒ SubscribeVehicleData

Set the ElectronicParkBrakeStatus

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

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

subscribeVehicleData.setEmergencyEvent(event) ⇒ SubscribeVehicleData

Set the EmergencyEvent

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

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

subscribeVehicleData.setEngineOilLife(life) ⇒ SubscribeVehicleData

Set the EngineOilLife

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

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

subscribeVehicleData.setEngineTorque(torque) ⇒ SubscribeVehicleData

Set the EngineTorque

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

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

subscribeVehicleData.setExternalTemperature(temperature) ⇒ SubscribeVehicleData

Set the ExternalTemperature

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

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

subscribeVehicleData.setFuelLevel(level) ⇒ SubscribeVehicleData

Set the FuelLevel

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

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

subscribeVehicleData.setFuelLevel_State(level_state) ⇒ SubscribeVehicleData

Set the FuelLevel_State

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

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

subscribeVehicleData.setFuelRange(range) ⇒ SubscribeVehicleData

Set the FuelRange

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

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

subscribeVehicleData.setGps(gps) ⇒ SubscribeVehicleData

Set the Gps

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

ParamTypeDescription
gps Boolean See GPSData - The desired Gps.

subscribeVehicleData.setHeadLampStatus(status) ⇒ SubscribeVehicleData

Set the HeadLampStatus

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

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

subscribeVehicleData.setInstantFuelConsumption(consumption) ⇒ SubscribeVehicleData

Set the InstantFuelConsumption

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

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

subscribeVehicleData.setMyKey(key) ⇒ SubscribeVehicleData

Set the MyKey

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

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

subscribeVehicleData.setOdometer(odometer) ⇒ SubscribeVehicleData

Set the Odometer

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

ParamTypeDescription
odometer Boolean Odometer in km - The desired Odometer.

subscribeVehicleData.setOemCustomVehicleData(vehicleDataName, vehicleDataState) ⇒ SubscribeVehicleData

Sets a boolean value for OEM Custom VehicleData.

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

ParamTypeDescription
vehicleDataName String The key associated with the custom vehicle data.
vehicleDataState Boolean Whether or not to subscribe to the data.

subscribeVehicleData.setPrndl(prndl) ⇒ SubscribeVehicleData

Set the Prndl

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

ParamTypeDescription
prndl Boolean See PRNDL - The desired Prndl.

subscribeVehicleData.setRpm(rpm) ⇒ SubscribeVehicleData

Set the Rpm

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

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

subscribeVehicleData.setSpeed(speed) ⇒ SubscribeVehicleData

Set the Speed

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

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

subscribeVehicleData.setSteeringWheelAngle(angle) ⇒ SubscribeVehicleData

Set the SteeringWheelAngle

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

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

subscribeVehicleData.setTirePressure(pressure) ⇒ SubscribeVehicleData

Set the TirePressure

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

ParamTypeDescription
pressure Boolean See TireStatus - The desired TirePressure.

subscribeVehicleData.setTurnSignal(signal) ⇒ SubscribeVehicleData

Set the TurnSignal

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

ParamTypeDescription
signal Boolean See TurnSignal - The desired TurnSignal.

subscribeVehicleData.setWiperStatus(status) ⇒ SubscribeVehicleData

Set the WiperStatus

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

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