Number
AirbagStatus
BeltStatus
BodyInformation
ClimateData
String
ClusterModeStatus
DeviceStatus
VehicleDataEventStatus
ECallInfo
ElectronicParkBrakeStatus
EmergencyEvent
Number
Number
Number
Number
ComponentVolumeStatus
Array.<FuelRange>
GearStatus
GPSData
Boolean
HeadLampStatus
Number
MyKey
Number
PRNDL
Number
SeatOccupancy
Number
StabilityControlsStatus
Number
TireStatus
TurnSignal
String
Array.<WindowStatus>
WiperStatus
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
OnVehicleData
Number
Get the AccPedalPosition
Kind: Instance method of OnVehicleData
Returns: Number
- the KEY_ACC_PEDAL_POSITION value
AirbagStatus
Get the AirbagStatus
Kind: Instance method of OnVehicleData
Returns: AirbagStatus
- the KEY_AIRBAG_STATUS value
BeltStatus
Get the BeltStatus
Kind: Instance method of OnVehicleData
Returns: BeltStatus
- the KEY_BELT_STATUS value
BodyInformation
Get the BodyInformation
Kind: Instance method of OnVehicleData
Returns: BodyInformation
- the KEY_BODY_INFORMATION value
ClimateData
Get the ClimateData
Kind: Instance method of OnVehicleData
Returns: ClimateData
- the KEY_CLIMATE_DATA value
String
Get the CloudAppVehicleID
Kind: Instance method of OnVehicleData
Returns: String
- the KEY_CLOUD_APP_VEHICLE_ID value
ClusterModeStatus
Get the ClusterModeStatus
Kind: Instance method of OnVehicleData
Returns: ClusterModeStatus
- the KEY_CLUSTER_MODE_STATUS value
DeviceStatus
Get the DeviceStatus
Kind: Instance method of OnVehicleData
Returns: DeviceStatus
- the KEY_DEVICE_STATUS value
VehicleDataEventStatus
Get the DriverBraking
Kind: Instance method of OnVehicleData
Returns: VehicleDataEventStatus
- the KEY_DRIVER_BRAKING value
ECallInfo
Get the ECallInfo
Kind: Instance method of OnVehicleData
Returns: ECallInfo
- the KEY_E_CALL_INFO value
ElectronicParkBrakeStatus
Get the ElectronicParkBrakeStatus
Kind: Instance method of OnVehicleData
Returns: ElectronicParkBrakeStatus
- the KEY_ELECTRONIC_PARK_BRAKE_STATUS value
EmergencyEvent
Get the EmergencyEvent
Kind: Instance method of OnVehicleData
Returns: EmergencyEvent
- the KEY_EMERGENCY_EVENT value
Number
Get the EngineOilLife
Kind: Instance method of OnVehicleData
Returns: Number
- the KEY_ENGINE_OIL_LIFE value
Number
Get the EngineTorque
Kind: Instance method of OnVehicleData
Returns: Number
- the KEY_ENGINE_TORQUE value
Number
Get the ExternalTemperature
Kind: Instance method of OnVehicleData
Returns: Number
- the KEY_EXTERNAL_TEMPERATURE value
Number
Get the FuelLevel
Kind: Instance method of OnVehicleData
Returns: Number
- the KEY_FUEL_LEVEL value
ComponentVolumeStatus
Get the FuelLevel_State
Kind: Instance method of OnVehicleData
Returns: ComponentVolumeStatus
- the KEY_FUEL_LEVEL_STATE value
Array.<FuelRange>
Get the FuelRange
Kind: Instance method of OnVehicleData
Returns: Array.<FuelRange>
- the KEY_FUEL_RANGE value
GearStatus
Get the GearStatus
Kind: Instance method of OnVehicleData
Returns: GearStatus
- the KEY_GEAR_STATUS value
GPSData
Get the Gps
Kind: Instance method of OnVehicleData
Returns: GPSData
- the KEY_GPS value
Boolean
Get the HandsOffSteering
Kind: Instance method of OnVehicleData
Returns: Boolean
- the KEY_HANDS_OFF_STEERING value
HeadLampStatus
Get the HeadLampStatus
Kind: Instance method of OnVehicleData
Returns: HeadLampStatus
- the KEY_HEAD_LAMP_STATUS value
Number
Get the InstantFuelConsumption
Kind: Instance method of OnVehicleData
Returns: Number
- the KEY_INSTANT_FUEL_CONSUMPTION value
MyKey
Get the MyKey
Kind: Instance method of OnVehicleData
Returns: MyKey
- the KEY_MY_KEY value
Number
Get the Odometer
Kind: Instance method of OnVehicleData
Returns: Number
- the KEY_ODOMETER value
PRNDL
Get the Prndl
Kind: Instance method of OnVehicleData
Returns: PRNDL
- the KEY_PRNDL value
Number
Get the Rpm
Kind: Instance method of OnVehicleData
Returns: Number
- the KEY_RPM value
SeatOccupancy
Get the SeatOccupancy
Kind: Instance method of OnVehicleData
Returns: SeatOccupancy
- the KEY_SEAT_OCCUPANCY value
Number
Get the Speed
Kind: Instance method of OnVehicleData
Returns: Number
- the KEY_SPEED value
StabilityControlsStatus
Get the StabilityControlsStatus
Kind: Instance method of OnVehicleData
Returns: StabilityControlsStatus
- the KEY_STABILITY_CONTROLS_STATUS value
Number
Get the SteeringWheelAngle
Kind: Instance method of OnVehicleData
Returns: Number
- the KEY_STEERING_WHEEL_ANGLE value
TireStatus
Get the TirePressure
Kind: Instance method of OnVehicleData
Returns: TireStatus
- the KEY_TIRE_PRESSURE value
TurnSignal
Get the TurnSignal
Kind: Instance method of OnVehicleData
Returns: TurnSignal
- the KEY_TURN_SIGNAL value
String
Get the Vin
Kind: Instance method of OnVehicleData
Returns: String
- the KEY_VIN value
Array.<WindowStatus>
Get the WindowStatus
Kind: Instance method of OnVehicleData
Returns: Array.<WindowStatus>
- the KEY_WINDOW_STATUS value
WiperStatus
Get the WiperStatus
Kind: Instance method of OnVehicleData
Returns: WiperStatus
- the KEY_WIPER_STATUS value
OnVehicleData
Set the AccPedalPosition
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
position | Number |
Accelerator pedal position (percentage depressed) - The desired AccPedalPosition. {'num_min_value': 0.0, 'num_max_value': 100.0} |
OnVehicleData
Set the AirbagStatus
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
status | AirbagStatus |
The status of the air bags - The desired AirbagStatus. |
OnVehicleData
Set the BeltStatus
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
status | BeltStatus |
The status of the seat belts - The desired BeltStatus. |
OnVehicleData
Set the BodyInformation
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
information | BodyInformation |
The body information including power modes - The desired BodyInformation. |
OnVehicleData
Set the ClimateData
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
data | ClimateData |
See ClimateData - The desired ClimateData. |
OnVehicleData
Set the CloudAppVehicleID
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
id | String |
Parameter used by cloud apps to identify a head unit - The desired CloudAppVehicleID. {'string_min_length': 1} |
OnVehicleData
Set the ClusterModeStatus
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
status | ClusterModeStatus |
The status modes of the cluster - The desired ClusterModeStatus. |
OnVehicleData
Set the DeviceStatus
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
status | DeviceStatus |
The device status including signal and battery strength - The desired DeviceStatus. |
OnVehicleData
Set the DriverBraking
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
braking | VehicleDataEventStatus |
The status of the brake pedal - The desired DriverBraking. |
OnVehicleData
Set the ECallInfo
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
info | ECallInfo |
Emergency Call notification and confirmation data - The desired ECallInfo. |
OnVehicleData
Set the ElectronicParkBrakeStatus
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
status | ElectronicParkBrakeStatus |
The status of the park brake as provided by Electric Park Brake (EPB) system. - The desired ElectronicParkBrakeStatus. |
OnVehicleData
Set the EmergencyEvent
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
event | EmergencyEvent |
Information related to an emergency event (and if it occurred) - The desired EmergencyEvent. |
OnVehicleData
Set the EngineOilLife
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
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
Set the EngineTorque
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
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
Set the ExternalTemperature
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
temperature | Number |
The external temperature in degrees celsius. This parameter is deprecated starting RPC Spec 7.1, please see climateData. - The desired ExternalTemperature. {'num_min_value': -40.0, 'num_max_value': 100.0} |
OnVehicleData
Set the FuelLevel
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
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
Set the FuelLevel_State
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
level_state | ComponentVolumeStatus |
The fuel level state. This parameter is deprecated starting RPC Spec 7.0, please see fuelRange. - The desired FuelLevel_State. |
OnVehicleData
Set the FuelRange
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
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
Set the GearStatus
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
status | GearStatus |
See GearStatus - The desired GearStatus. |
OnVehicleData
Set the Gps
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
gps | GPSData |
See GPSData - The desired Gps. |
OnVehicleData
Set the HandsOffSteering
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
steering | Boolean |
To indicate whether driver hands are off the steering wheel - The desired HandsOffSteering. |
OnVehicleData
Set the HeadLampStatus
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
status | HeadLampStatus |
Status of the head lamps - The desired HeadLampStatus. |
OnVehicleData
Set the InstantFuelConsumption
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
consumption | Number |
The instantaneous fuel consumption in microlitres - The desired InstantFuelConsumption. {'num_min_value': 0.0, 'num_max_value': 25575.0} |
OnVehicleData
Set the MyKey
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
key | MyKey |
Information related to the MyKey feature - The desired MyKey. |
OnVehicleData
Set the Odometer
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
odometer | Number |
Odometer in km - The desired Odometer. {'num_min_value': 0, 'num_max_value': 17000000} |
OnVehicleData
Set the Prndl
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
prndl | PRNDL |
See PRNDL. This parameter is deprecated and it is now covered in `gearStatus` - The desired Prndl. |
OnVehicleData
Set the Rpm
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
rpm | Number |
The number of revolutions per minute of the engine - The desired Rpm. {'num_min_value': 0, 'num_max_value': 20000} |
OnVehicleData
Set the SeatOccupancy
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
occupancy | SeatOccupancy |
See SeatOccupancy - The desired SeatOccupancy. |
OnVehicleData
Set the Speed
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
speed | Number |
The vehicle speed in kilometers per hour - The desired Speed. {'num_min_value': 0.0, 'num_max_value': 700.0} |
OnVehicleData
Set the StabilityControlsStatus
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
status | StabilityControlsStatus |
See StabilityControlsStatus - The desired StabilityControlsStatus. |
OnVehicleData
Set the SteeringWheelAngle
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
angle | Number |
Current angle of the steering wheel (in deg) - The desired SteeringWheelAngle. {'num_min_value': -2000.0, 'num_max_value': 2000.0} |
OnVehicleData
Set the TirePressure
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
pressure | TireStatus |
See TireStatus - The desired TirePressure. |
OnVehicleData
Set the TurnSignal
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
signal | TurnSignal |
See TurnSignal - The desired TurnSignal. |
OnVehicleData
Set the Vin
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
vin | String |
Vehicle identification number. - The desired Vin. {'string_min_length': 1, 'string_max_length': 17} |
OnVehicleData
Set the WindowStatus
Kind: Instance method of OnVehicleData
Returns: OnVehicleData
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
status | Array.<WindowStatus> |
See WindowStatus - The desired WindowStatus. {'array_min_size': 0, 'array_max_size': 100} |