NumberAirbagStatusBeltStatusBodyInformationClimateDataStringClusterModeStatusDeviceStatusVehicleDataEventStatusECallInfoElectronicParkBrakeStatusEmergencyEventNumberNumberNumberNumberComponentVolumeStatusArray.<FuelRange>GearStatusGPSDataBooleanHeadLampStatusNumberMyKeyObjectNumberPRNDLNumberSeatOccupancyNumberStabilityControlsStatusNumberTireStatusTurnSignalStringArray.<WindowStatus>WiperStatusGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseGetVehicleDataResponseInitializes an instance of GetVehicleDataResponse.
NumberGet the AccPedalPosition
Kind: Instance method of GetVehicleDataResponse
Returns: Number - the KEY_ACC_PEDAL_POSITION value
AirbagStatusGet the AirbagStatus
Kind: Instance method of GetVehicleDataResponse
Returns: AirbagStatus - the KEY_AIRBAG_STATUS value
BeltStatusGet the BeltStatus
Kind: Instance method of GetVehicleDataResponse
Returns: BeltStatus - the KEY_BELT_STATUS value
BodyInformationGet the BodyInformation
Kind: Instance method of GetVehicleDataResponse
Returns: BodyInformation - the KEY_BODY_INFORMATION value
ClimateDataGet the ClimateData
Kind: Instance method of GetVehicleDataResponse
Returns: ClimateData - the KEY_CLIMATE_DATA value
StringGet the CloudAppVehicleID
Kind: Instance method of GetVehicleDataResponse
Returns: String - the KEY_CLOUD_APP_VEHICLE_ID value
ClusterModeStatusGet the ClusterModeStatus
Kind: Instance method of GetVehicleDataResponse
Returns: ClusterModeStatus - the KEY_CLUSTER_MODE_STATUS value
DeviceStatusGet the DeviceStatus
Kind: Instance method of GetVehicleDataResponse
Returns: DeviceStatus - the KEY_DEVICE_STATUS value
VehicleDataEventStatusGet the DriverBraking
Kind: Instance method of GetVehicleDataResponse
Returns: VehicleDataEventStatus - the KEY_DRIVER_BRAKING value
ECallInfoGet the ECallInfo
Kind: Instance method of GetVehicleDataResponse
Returns: ECallInfo - the KEY_E_CALL_INFO value
ElectronicParkBrakeStatusGet the ElectronicParkBrakeStatus
Kind: Instance method of GetVehicleDataResponse
Returns: ElectronicParkBrakeStatus - the KEY_ELECTRONIC_PARK_BRAKE_STATUS value
EmergencyEventGet the EmergencyEvent
Kind: Instance method of GetVehicleDataResponse
Returns: EmergencyEvent - the KEY_EMERGENCY_EVENT value
NumberGet the EngineOilLife
Kind: Instance method of GetVehicleDataResponse
Returns: Number - the KEY_ENGINE_OIL_LIFE value
NumberGet the EngineTorque
Kind: Instance method of GetVehicleDataResponse
Returns: Number - the KEY_ENGINE_TORQUE value
NumberGet the ExternalTemperature
Kind: Instance method of GetVehicleDataResponse
Returns: Number - the KEY_EXTERNAL_TEMPERATURE value
NumberGet the FuelLevel
Kind: Instance method of GetVehicleDataResponse
Returns: Number - the KEY_FUEL_LEVEL value
ComponentVolumeStatusGet the FuelLevel_State
Kind: Instance method of GetVehicleDataResponse
Returns: ComponentVolumeStatus - the KEY_FUEL_LEVEL_STATE value
Array.<FuelRange>Get the FuelRange
Kind: Instance method of GetVehicleDataResponse
Returns: Array.<FuelRange> - the KEY_FUEL_RANGE value
GearStatusGet the GearStatus
Kind: Instance method of GetVehicleDataResponse
Returns: GearStatus - the KEY_GEAR_STATUS value
GPSDataGet the Gps
Kind: Instance method of GetVehicleDataResponse
Returns: GPSData - the KEY_GPS value
BooleanGet the HandsOffSteering
Kind: Instance method of GetVehicleDataResponse
Returns: Boolean - the KEY_HANDS_OFF_STEERING value
HeadLampStatusGet the HeadLampStatus
Kind: Instance method of GetVehicleDataResponse
Returns: HeadLampStatus - the KEY_HEAD_LAMP_STATUS value
NumberGet the InstantFuelConsumption
Kind: Instance method of GetVehicleDataResponse
Returns: Number - the KEY_INSTANT_FUEL_CONSUMPTION value
MyKeyGet the MyKey
Kind: Instance method of GetVehicleDataResponse
Returns: MyKey - the KEY_MY_KEY value
ObjectGets a VehicleData value for the vehicle data item.
Kind: Instance method of GetVehicleDataResponse
Returns: Object - The value associated with the custom vehicle data.
| Param | Type | Description |
|---|---|---|
| vehicleDataName | String |
The key associated with the custom vehicle data. |
NumberGet the Odometer
Kind: Instance method of GetVehicleDataResponse
Returns: Number - the KEY_ODOMETER value
PRNDLGet the Prndl
Kind: Instance method of GetVehicleDataResponse
Returns: PRNDL - the KEY_PRNDL value
NumberGet the Rpm
Kind: Instance method of GetVehicleDataResponse
Returns: Number - the KEY_RPM value
SeatOccupancyGet the SeatOccupancy
Kind: Instance method of GetVehicleDataResponse
Returns: SeatOccupancy - the KEY_SEAT_OCCUPANCY value
NumberGet the Speed
Kind: Instance method of GetVehicleDataResponse
Returns: Number - the KEY_SPEED value
StabilityControlsStatusGet the StabilityControlsStatus
Kind: Instance method of GetVehicleDataResponse
Returns: StabilityControlsStatus - the KEY_STABILITY_CONTROLS_STATUS value
NumberGet the SteeringWheelAngle
Kind: Instance method of GetVehicleDataResponse
Returns: Number - the KEY_STEERING_WHEEL_ANGLE value
TireStatusGet the TirePressure
Kind: Instance method of GetVehicleDataResponse
Returns: TireStatus - the KEY_TIRE_PRESSURE value
TurnSignalGet the TurnSignal
Kind: Instance method of GetVehicleDataResponse
Returns: TurnSignal - the KEY_TURN_SIGNAL value
StringGet the Vin
Kind: Instance method of GetVehicleDataResponse
Returns: String - the KEY_VIN value
Array.<WindowStatus>Get the WindowStatus
Kind: Instance method of GetVehicleDataResponse
Returns: Array.<WindowStatus> - the KEY_WINDOW_STATUS value
WiperStatusGet the WiperStatus
Kind: Instance method of GetVehicleDataResponse
Returns: WiperStatus - the KEY_WIPER_STATUS value
GetVehicleDataResponseSet the AccPedalPosition
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - 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} |
GetVehicleDataResponseSet the AirbagStatus
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| status | AirbagStatus |
The status of the air bags - The desired AirbagStatus. |
GetVehicleDataResponseSet the BeltStatus
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| status | BeltStatus |
The status of the seat belts - The desired BeltStatus. |
GetVehicleDataResponseSet the BodyInformation
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| information | BodyInformation |
The body information including power modes - The desired BodyInformation. |
GetVehicleDataResponseSet the ClimateData
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| data | ClimateData |
See ClimateData - The desired ClimateData. |
GetVehicleDataResponseSet the CloudAppVehicleID
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - 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} |
GetVehicleDataResponseSet the ClusterModeStatus
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| status | ClusterModeStatus |
The status modes of the cluster - The desired ClusterModeStatus. |
GetVehicleDataResponseSet the DeviceStatus
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| status | DeviceStatus |
The device status including signal and battery strength - The desired DeviceStatus. |
GetVehicleDataResponseSet the DriverBraking
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| braking | VehicleDataEventStatus |
The status of the brake pedal - The desired DriverBraking. |
GetVehicleDataResponseSet the ECallInfo
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| info | ECallInfo |
Emergency Call notification and confirmation data - The desired ECallInfo. |
GetVehicleDataResponseSet the ElectronicParkBrakeStatus
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - 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. |
GetVehicleDataResponseSet the EmergencyEvent
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| event | EmergencyEvent |
Information related to an emergency event (and if it occurred) - The desired EmergencyEvent. |
GetVehicleDataResponseSet the EngineOilLife
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - 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} |
GetVehicleDataResponseSet the EngineTorque
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - 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} |
GetVehicleDataResponseSet the ExternalTemperature
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - 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} |
GetVehicleDataResponseSet the FuelLevel
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - 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} |
GetVehicleDataResponseSet the FuelLevel_State
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - 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. |
GetVehicleDataResponseSet the FuelRange
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - 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} |
GetVehicleDataResponseSet the GearStatus
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| status | GearStatus |
See GearStatus - The desired GearStatus. |
GetVehicleDataResponseSet the Gps
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| gps | GPSData |
See GPSData - The desired Gps. |
GetVehicleDataResponseSet the HandsOffSteering
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| steering | Boolean |
To indicate whether driver hands are off the steering wheel - The desired HandsOffSteering. |
GetVehicleDataResponseSet the HeadLampStatus
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| status | HeadLampStatus |
Status of the head lamps - The desired HeadLampStatus. |
GetVehicleDataResponseSet the InstantFuelConsumption
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - 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} |
GetVehicleDataResponseSet the MyKey
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| key | MyKey |
Information related to the MyKey feature - The desired MyKey. |
GetVehicleDataResponseSet the Odometer
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - 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} |
GetVehicleDataResponseSets a value for OEM Custom VehicleData.
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - The class instance to support method chaining.
| Param | Type | Description |
|---|---|---|
| vehicleDataName | String |
The key associated with the custom vehicle data. |
| vehicleDataState | Object |
The value associated with the custom vehicle data. |
GetVehicleDataResponseSet the Prndl
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - 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. |
GetVehicleDataResponseSet the Rpm
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - 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} |
GetVehicleDataResponseSet the SeatOccupancy
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| occupancy | SeatOccupancy |
See SeatOccupancy - The desired SeatOccupancy. |
GetVehicleDataResponseSet the Speed
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - 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} |
GetVehicleDataResponseSet the StabilityControlsStatus
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| status | StabilityControlsStatus |
See StabilityControlsStatus - The desired StabilityControlsStatus. |
GetVehicleDataResponseSet the SteeringWheelAngle
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - 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} |
GetVehicleDataResponseSet the TirePressure
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| pressure | TireStatus |
See TireStatus - The desired TirePressure. |
GetVehicleDataResponseSet the TurnSignal
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| signal | TurnSignal |
See TurnSignal - The desired TurnSignal. |
GetVehicleDataResponseSet the Vin
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - 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} |
GetVehicleDataResponseSet the WindowStatus
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - 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} |
GetVehicleDataResponseSet the WiperStatus
Kind: Instance method of GetVehicleDataResponse
Returns: GetVehicleDataResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| status | WiperStatus |
The status of the wipers - The desired WiperStatus. |