Skip to content

Instantly share code, notes, and snippets.

@kevinvaldek

kevinvaldek/hm-rest-auto-api-v2.yml

Created May 24, 2019 08:22
Show Gist options
  • Save kevinvaldek/10fb9fab33892404e97095e48484ecb5 to your computer and use it in GitHub Desktop.
Save kevinvaldek/10fb9fab33892404e97095e48484ecb5 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
hm-rest-auto-api-v2.yml
info:
title: HM REST Auto API
description: "High Mobility REST Auto API Level 10 specification"
version: 2.0.0
swagger: '2.0'
host: sandbox.rest-api.high-mobility.com
basePath: /v2
paths:
/capabilities:
get:
tags:
- Capabilities
summary: Get the vehicle capabilities
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: An array of Capabilities
schema:
type: object
properties:
capabilities:
type: array
items:
$ref: '#/definitions/Capability'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- capabilities.read
/dashboard_lights:
get:
tags:
- Dashboard Lights
summary: Get the dashboard lights state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Dashboard Lights state
schema:
$ref: '#/definitions/DashboardLights'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- dashboard-lights.read
/diagnostics:
get:
tags:
- Diagnostics
summary: Get the vehicle diagnostics state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Diagnostics State
schema:
$ref: '#/definitions/DiagnosticsState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- diagnostics.read
/firmware_version:
get:
tags:
- Firmware Version
summary: Get the vehicle firmware version
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Firmware Version
schema:
$ref: '#/definitions/FirmwareVersion'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
/historical:
get:
tags:
- Historical
summary: Get historical states.
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: query
name: capabilityIdentifier
description: Capability identifier
required: true
schema:
$ref: '#/definitions/CapabilityIdentifier'
- in: query
name: startDate
description: Start date
schema:
type: string
format: date-time
example: '2018-04-12T23:00:50.52Z'
- in: query
name: endDate
description: End date
schema:
type: string
format: date-time
example: '2018-04-12T23:10:50.52Z'
responses:
'200':
description: Historical States
schema:
$ref: '#/definitions/HistoricalStates'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- vehicle-status.read
/hood:
get:
tags:
- Hood
summary: Get hood state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Hood state
schema:
$ref: '#/definitions/HoodState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- hood.read
/light_conditions:
get:
tags:
- Light Conditions
summary: Get the vehicle measured light conditions
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Light Conditions
schema:
$ref: '#/definitions/LightConditions'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- environment.read
/location:
get:
tags:
- Vehicle Location
summary: Get the vehicle location
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Vehicle Location
schema:
$ref: '#/definitions/VehicleLocation'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- vehicle-location.read
/maintenance:
get:
tags:
- Maintenance
summary: Get the vehicle maintenance state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Maintenance State
schema:
$ref: '#/definitions/MaintenanceState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- diagnostics.read
/mobile:
get:
tags:
- Mobile
summary: Get mobile state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Mobile state
schema:
$ref: '#/definitions/MobileState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- mobile.read
/offroad:
get:
tags:
- Offroad
summary: Get the offroad data state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Offroad State
schema:
$ref: '#/definitions/OffroadState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- offroad.read
/race:
get:
tags:
- Race
summary: Get the racing data state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Race State
schema:
$ref: '#/definitions/RaceState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- race.read
/seats:
get:
tags:
- Seats
summary: Get the seats state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: An array of Seats
schema:
$ref: '#/definitions/SeatsState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- seats.read
/tachograph:
get:
tags:
- Tachograph
summary: Get the tachograph state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Tachograph State
schema:
$ref: '#/definitions/TachographState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- tachograph.read
/time:
get:
tags:
- Vehicle Time
summary: Get the vehicle local time
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Vehicle Time
schema:
$ref: '#/definitions/VehicleTime'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- vehicle-time.read
/usage:
get:
tags:
- Usage
summary: Get usage state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Usage State
schema:
$ref: '#/definitions/Usage'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- usage.read
/vehicle_status:
get:
tags:
- Vehicle Status
summary: Get the vehicle status
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Vehicle Status
schema:
$ref: '#/definitions/VehicleStatus'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- vehicle-status.read
/weather_conditions:
get:
tags:
- Weather Conditions
summary: Get the vehicle measured weather conditions
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Weather Conditions
schema:
$ref: '#/definitions/WeatherConditions'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- environment.read
/browser/load:
post:
tags:
- Browser
summary: Load an URL in the headunit browser
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: URL
schema:
$ref: '#/definitions/LoadURL'
required: true
responses:
'200':
description: OK
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- headunit.write
/charging:
get:
tags:
- Charging
summary: Get the vehicle charge state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Charge State
schema:
$ref: '#/definitions/ChargeState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- charge.read
/charging/start:
put:
tags:
- Charging
summary: Start the charging process
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Charge State
schema:
$ref: '#/definitions/ChargeState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- charge.write
/charging/stop:
put:
tags:
- Charging
summary: Stop the charging process
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Charge State
schema:
$ref: '#/definitions/ChargeState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- charge.write
/charging/limit:
put:
tags:
- Charging
summary: Set the vehicle charging limit
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: Charge Limit
schema:
$ref: '#/definitions/SetChargeLimit'
required: true
responses:
'200':
description: Charge State
schema:
$ref: '#/definitions/ChargeState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- charge.write
/charging/port/open:
put:
tags:
- Charging
summary: Open the vehicle charge port
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Charge State
schema:
$ref: '#/definitions/ChargeState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- charge.write
/charging/port/close:
put:
tags:
- Charging
summary: Close the vehicle charge port
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Charge State
schema:
$ref: '#/definitions/ChargeState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- charge.write
/charging/mode:
put:
tags:
- Charging
summary: Set the vehicle charge mode
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: chargeMode
schema:
$ref: '#/definitions/SetChargeMode'
required: true
responses:
'200':
description: Charge State
schema:
$ref: '#/definitions/ChargeState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- charge.write
/charging/timers:
put:
tags:
- Charging
summary: >-
Set the charge timer of the car. The message can include one of the
different timer types or all.
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: Charge Timers
schema:
type: array
items:
$ref: '#/definitions/SetChargeTimer'
required: true
responses:
'200':
description: Charge State
schema:
$ref: '#/definitions/ChargeState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- charge.write
/charging/charging_current_times_reduction:
put:
tags:
- Charging
summary: Set reduction times for charging-current
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: Charging-current reduction times
schema:
type: array
items:
$ref: '#/definitions/SetReductionTime'
required: true
responses:
'200':
description: Charge State
schema:
$ref: '#/definitions/ChargeState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- charge.write
/chassis_settings:
get:
tags:
- Chassis Settings
summary: Get the chassis settings
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Chassis Settings
schema:
$ref: '#/definitions/ChassisSettings'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- chassis-settings.read
/chassis_settings/driving_mode:
put:
tags:
- Chassis Settings
summary: Update the chassis driving mode
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: Driving Mode
schema:
$ref: '#/definitions/SetDrivingMode'
required: true
responses:
'200':
description: Chassis Settings
schema:
$ref: '#/definitions/ChassisSettings'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- chassis-settings.write
/chassis_settings/sport_chrono/start:
put:
tags:
- Chassis Settings
summary: Start Sport Chrono
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Chassis Settings
schema:
$ref: '#/definitions/ChassisSettings'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- chassis-settings.write
/chassis_settings/sport_chrono/stop:
put:
tags:
- Chassis Settings
summary: Stop Sport Chrono
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Chassis Settings
schema:
$ref: '#/definitions/ChassisSettings'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- chassis-settings.write
/chassis_settings/sport_chrono/reset:
put:
tags:
- Chassis Settings
summary: Reset Sport Chrono
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Chassis Settings
schema:
$ref: '#/definitions/ChassisSettings'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- chassis-settings.write
/chassis_settings/spring_rates/front_axle:
put:
tags:
- Chassis Settings
summary: Set the front axle spring rate
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: SpringRate to be set
schema:
$ref: '#/definitions/SetSpringRate'
responses:
'200':
description: Chassis Settings
schema:
$ref: '#/definitions/ChassisSettings'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- chassis-settings.write
/chassis_settings/spring_rates/rear_axle:
put:
tags:
- Chassis Settings
summary: Set the rear axle spring rate
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: SpringRate to be set
schema:
$ref: '#/definitions/SetSpringRate'
responses:
'200':
description: Chassis Settings
schema:
$ref: '#/definitions/ChassisSettings'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- chassis-settings.write
/chassis_settings/position:
put:
tags:
- Chassis Settings
summary: Set the chassis position
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: Chassis Position
schema:
$ref: '#/definitions/SetChassisPosition'
required: true
responses:
'200':
description: Chassis Settings
schema:
$ref: '#/definitions/ChassisSettings'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- chassis-settings.write
/climate:
get:
tags:
- Climate
summary: Get the vehicle climate state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Climate State
schema:
$ref: '#/definitions/ClimateState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- climate.read
/climate/hvac_weekday_starting_times:
put:
tags:
- Climate
summary: >-
Set the HVAC (Heating, ventilation, and air conditioning) automated
starting times.
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: HVAC weekday starting times
required: true
schema:
$ref: '#/definitions/SetHvacWeekdayStartingTimes'
responses:
'200':
description: Climate State
schema:
$ref: '#/definitions/ClimateState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- climate.write
/climate/hvac/start:
put:
tags:
- Climate
summary: Start the HVAC system to reach driver and passenger set temperatures.
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Climate State
schema:
$ref: '#/definitions/ClimateState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- climate.write
/climate/hvac/stop:
put:
tags:
- Climate
summary: Stop the HVAC system to reach driver and passenger set temperatures.
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Climate State
schema:
$ref: '#/definitions/ClimateState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- climate.write
/climate/defogging/start:
put:
tags:
- Climate
summary: Manually start defogging.
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Climate State
schema:
$ref: '#/definitions/ClimateState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- climate.write
/climate/defogging/stop:
put:
tags:
- Climate
summary: Manually stop defogging.
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Climate State
schema:
$ref: '#/definitions/ClimateState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- climate.write
/climate/defrosting/start:
put:
tags:
- Climate
summary: Manually start defrosting.
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Climate State
schema:
$ref: '#/definitions/ClimateState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- climate.write
/climate/defrosting/stop:
put:
tags:
- Climate
summary: Manually stop defrosting.
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Climate State
schema:
$ref: '#/definitions/ClimateState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- climate.write
/climate/ionising/start:
put:
tags:
- Climate
summary: Manually start ionising.
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Climate State
schema:
$ref: '#/definitions/ClimateState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- climate.write
/climate/ionising/stop:
put:
tags:
- Climate
summary: Manually stop ionising.
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Climate State
schema:
$ref: '#/definitions/ClimateState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- climate.write
/climate/temperature_settings:
put:
tags:
- Climate
summary: Set the preferred temperature settings.
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: 'Set preferred driver, passenger and rear temperature settings.'
schema:
$ref: '#/definitions/SetTemperatureSettings'
required: true
responses:
'200':
description: Climate State
schema:
$ref: '#/definitions/ClimateState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- climate.write
/cruise_control:
get:
tags:
- Cruise Control
summary: Get the cruise control state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Cruise Control State
schema:
$ref: '#/definitions/CruiseControlState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- cruise-control.read
/cruise_control/activate:
put:
tags:
- Cruise Control
summary: Activate cruise control
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: Target speed to be set
schema:
$ref: '#/definitions/SetCruiseControlSpeed'
responses:
'200':
description: Cruise Control State
schema:
$ref: '#/definitions/CruiseControlState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- cruise-control.write
/cruise_control/deactivate:
put:
tags:
- Cruise Control
summary: Deactivate cruise control
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Cruise Control State
schema:
$ref: '#/definitions/CruiseControlState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- cruise-control.read
/doors:
get:
tags:
- Door Locks
summary: Get the vehicle doors state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Doors state
schema:
$ref: '#/definitions/LockState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- door-locks.read
/doors/unlock:
put:
tags:
- Door Locks
summary: Lock the vehicle doors
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Doors state
schema:
$ref: '#/definitions/LockState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- door-locks.write
/doors/lock:
put:
tags:
- Door Locks
summary: Lock the vehicle doors
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Doors state
schema:
$ref: '#/definitions/LockState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- door-locks.write
/engine:
get:
tags:
- Engine
summary: Get the engine ignition state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Ignition State
schema:
$ref: '#/definitions/IgnitionState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- engine.read
/engine/on:
put:
tags:
- Engine
summary: Turn on engine ignition
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Ignition State
schema:
$ref: '#/definitions/IgnitionState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- engine.write
/engine/off:
put:
tags:
- Engine
summary: Turn off engine ignition
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Ignition State
schema:
$ref: '#/definitions/IgnitionState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- engine.write
/fueling/gas_flap:
get:
tags:
- Fueling
summary: Get the gas flap state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Gas Flap State
schema:
$ref: '#/definitions/GasFlapState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- fueling.read
/fueling/gas_flap/control:
put:
tags:
- Fueling
summary: Control the gas flap
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: Gas Flap State
schema:
$ref: '#/definitions/SetGasFlapState'
required: true
responses:
'200':
description: Gas Flap State
schema:
$ref: '#/definitions/GasFlapState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- fueling.write
/graphics/display:
post:
tags:
- Graphics
summary: Display an image in the headunit
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: ImageURL
schema:
$ref: '#/definitions/DisplayImage'
required: true
responses:
'200':
description: OK
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- headunit.write
/home_charger:
get:
tags:
- Home Charger
summary: Get the home charger state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Home Charger State
schema:
$ref: '#/definitions/HomeChargerState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- home-charger.read
/home_charger/charge_current:
put:
tags:
- Home Charger
summary: Set the charger charge current
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: Charge Current
schema:
$ref: '#/definitions/SetChargeCurrent'
required: true
responses:
'200':
description: Home Charger State
schema:
$ref: '#/definitions/HomeChargerState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- home-charger.write
/home_charger/price_tariffs:
put:
tags:
- Home Charger
summary: Set the charger price tariffs
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: An array of Price Tariffs
required: true
schema:
$ref: '#/definitions/SetPriceTariffs'
responses:
'200':
description: Home Charger State
schema:
$ref: '#/definitions/HomeChargerState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- home-charger.write
/home_charger/solar/activate:
put:
tags:
- Home Charger
summary: Activate solar charging
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Home Charger State
schema:
$ref: '#/definitions/HomeChargerState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- home-charger.write
/home_charger/solar/deactivate:
put:
tags:
- Home Charger
summary: Deactivate solar charging
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Home Charger State
schema:
$ref: '#/definitions/HomeChargerState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- home-charger.write
/home_charger/wifi_hotspot/enable:
put:
tags:
- Home Charger
summary: Enable the charger Wi-Fi hotspot
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Home Charger State
schema:
$ref: '#/definitions/HomeChargerState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- home-charger.write
/home_charger/wifi_hotspot/disable:
put:
tags:
- Home Charger
summary: Disable the charger Wi-Fi hotspot
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Home Charger State
schema:
$ref: '#/definitions/HomeChargerState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- home-charger.write
/home_charger/authenticate:
put:
tags:
- Home Charger
summary: Authenticate the charging session.
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Home Charger State
schema:
$ref: '#/definitions/HomeChargerState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- home-charger.write
/home_charger/expire:
put:
tags:
- Home Charger
summary: Expire the charging session.
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Home Charger State
schema:
$ref: '#/definitions/HomeChargerState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- home-charger.write
/honk_horn_flash_lights/flashers:
get:
tags:
- Honk Horn & Flash Lights
summary: Get the flashers state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Flashers State
schema:
$ref: '#/definitions/FlashersState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- honk-horn-flash-lights.read
/honk_horn_flash_lights:
put:
tags:
- Honk Horn & Flash Lights
summary: Honk the horn or flash the lights
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: Honking and flashing config
schema:
type: object
properties:
honkHorn:
type: number
description: How many seconds to honk
example: 2
flashLights:
type: number
description: How many times to flash
example: 3
responses:
'200':
description: OK
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- honk-horn-flash-lights.write
/honk_horn_flash_lights/emergency/activate:
put:
tags:
- Honk Horn & Flash Lights
summary: Activate the emergency flashers
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Flashers State
schema:
$ref: '#/definitions/FlashersState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- honk-horn-flash-lights.write
/honk_horn_flash_lights/emergency/deactivate:
put:
tags:
- Honk Horn & Flash Lights
summary: Dectivate the emergency flashers
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Flashers State
schema:
$ref: '#/definitions/FlashersState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- honk-horn-flash-lights.write
/lights:
get:
tags:
- Lights
summary: Get the vehicle lights state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Lights State
schema:
$ref: '#/definitions/LightsState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- lights.read
/lights/control:
put:
tags:
- Lights
summary: Control the lights
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: Lights State
schema:
$ref: '#/definitions/LightsState'
required: true
responses:
'200':
description: Lights State
schema:
$ref: '#/definitions/LightsState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- lights.write
/messages/received:
post:
tags:
- Messaging
summary: Notify the vehicle about a received message
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: TextMessage
schema:
$ref: '#/definitions/TextMessage'
required: true
responses:
'200':
description: OK
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- headunit.write
/navi/destination:
get:
tags:
- Navi Destination
summary: Get the navigation system destination
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Navi Destination
schema:
$ref: '#/definitions/NaviDestination'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- navi-destination.read
put:
tags:
- Navi Destination
summary: Set the destination of the navigation system
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: Navi Destination
schema:
$ref: '#/definitions/SetNaviDestination'
required: true
responses:
'200':
description: Navi Destination
schema:
$ref: '#/definitions/NaviDestination'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- navi-destination.write
/notifications/send:
post:
tags:
- Notifications
summary: Send a notification to be displayed
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: Notification
schema:
$ref: '#/definitions/Notification'
required: true
responses:
'200':
description: OK
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- headunit.write
/notifications/clear:
post:
tags:
- Notifications
summary: Clear the latest notification
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: OK
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- headunit.write
/parking_brake:
get:
tags:
- Parking Brake
summary: Get the parking brake state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Parking Brake State
schema:
$ref: '#/definitions/ParkingBrakeState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- parking-brake.read
/parking_brake/activate:
put:
tags:
- Parking Brake
summary: Activate the parking brake
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Parking Brake State
schema:
$ref: '#/definitions/ParkingBrakeState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- parking-brake.write
/parking_brake/inactivate:
put:
tags:
- Parking Brake
summary: Inactivate the parking brake
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Parking Brake State
schema:
$ref: '#/definitions/ParkingBrakeState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- parking-brake.write
/parking_ticket:
get:
tags:
- Parking Ticket
summary: Get the current parking ticket
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Parking Ticket
schema:
$ref: '#/definitions/ParkingTicket'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- parking-ticket.read
/parking_ticket/start:
put:
tags:
- Parking Ticket
summary: Start parking with a new ticket
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: Start Parking
schema:
$ref: '#/definitions/StartParking'
required: true
responses:
'200':
description: Parking Ticket
schema:
$ref: '#/definitions/ParkingTicket'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- parking-ticket.write
/parking_ticket/end:
put:
tags:
- Parking Ticket
summary: End the current parking ticket
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Parking Ticket
schema:
$ref: '#/definitions/ParkingTicket'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- parking-ticket.write
/power_takeoff:
get:
tags:
- Power Take-Off
summary: Get the power take-off state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Power Take-Off State
schema:
$ref: '#/definitions/PowerTakeoffState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- power-takeoff.read
/power_takeoff/activate:
put:
tags:
- Power Take-Off
summary: Activate power take-off
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Power Take-Off State
schema:
$ref: '#/definitions/PowerTakeoffState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- power-takeoff.write
/power_takeoff/deactivate:
put:
tags:
- Power Take-Off
summary: Deactivate power take-off
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Power Take-Off State
schema:
$ref: '#/definitions/PowerTakeoffState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- power-takeoff.write
/rooftop:
get:
tags:
- Rooftop Control
summary: Get the rooftop state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Rooftop State
schema:
$ref: '#/definitions/RooftopState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- rooftop-control.read
/rooftop/control:
put:
tags:
- Rooftop Control
summary: Control the rooftop dimming and open position
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: Control RooftopState
schema:
$ref: '#/definitions/SetRooftopState'
required: true
responses:
'200':
description: Rooftop State
schema:
$ref: '#/definitions/RooftopState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- rooftop-control.write
/start_stop:
get:
tags:
- Start-Stop
summary: Get the start-stop state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Start-Stop State
schema:
$ref: '#/definitions/StartStopState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- start-stop.read
/start_stop/activate:
put:
tags:
- Start-Stop
summary: Activate the Start-Stop system of the engine
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Start-Stop State
schema:
$ref: '#/definitions/StartStopState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- start-stop.write
/start_stop/deactivate:
put:
tags:
- Start-Stop
summary: Deactivate the Start-Stop system of the engine
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Start-Stop State
schema:
$ref: '#/definitions/StartStopState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- start-stop.write
/text_input:
put:
tags:
- TextMessage
summary: Send text message
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: Text message
schema:
$ref: '#/definitions/TextMessage'
required: true
responses:
'200':
description: OK
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- headunit.write
/theft_alarm:
get:
tags:
- Theft Alarm
summary: Get the theft alarm state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Theft Alarm State
schema:
$ref: '#/definitions/TheftAlarmState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- theft-alarm.read
/theft_alarm/unarm:
put:
tags:
- Theft Alarm
summary: Unarm the vehicle theft alarm
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Theft Alarm State
schema:
$ref: '#/definitions/TheftAlarmState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- theft-alarm.write
/theft_alarm/arm:
put:
tags:
- Theft Alarm
summary: Arm the vehicle theft alarm
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Theft Alarm State
schema:
$ref: '#/definitions/TheftAlarmState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- theft-alarm.write
/theft_alarm/trigger:
put:
tags:
- Theft Alarm
summary: Trigger the vehicle theft alarm
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Theft Alarm State
schema:
$ref: '#/definitions/TheftAlarmState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- theft-alarm.write
/trunk:
get:
tags:
- Trunk Access
summary: Get the vehicle trunk state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Trunk State
schema:
$ref: '#/definitions/TrunkState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- trunk-access.read
/trunk/unlock:
put:
tags:
- Trunk Access
summary: Unlock the trunk
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Trunk State
schema:
$ref: '#/definitions/TrunkState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- trunk-access.write
/trunk/lock:
put:
tags:
- Trunk Access
summary: Lock the trunk
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Trunk State
schema:
$ref: '#/definitions/TrunkState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- trunk-access.write
/trunk/open:
put:
tags:
- Trunk Access
summary: Open the trunk
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Trunk State
schema:
$ref: '#/definitions/TrunkState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- trunk-access.write
/trunk/close:
put:
tags:
- Trunk Access
summary: Close the trunk
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Trunk State
schema:
$ref: '#/definitions/TrunkState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- trunk-access.write
/valet_mode:
get:
tags:
- Valet Mode
summary: Get the vehicle valet mode
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Valet Mode
schema:
$ref: '#/definitions/ValetMode'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- valet-mode.read
/valet_mode/activate:
put:
tags:
- Valet Mode
summary: Activate the valet mode
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Valet Mode
schema:
$ref: '#/definitions/ValetMode'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- valet-mode.write
/valet_mode/deactivate:
put:
tags:
- Valet Mode
summary: Deactivate the valet mode
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Valet Mode
schema:
$ref: '#/definitions/ValetMode'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- valet-mode.write
/video_handover:
post:
tags:
- Video Handover
summary: Hand over video playback to the vehicle screen
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: VideoHandover
schema:
$ref: '#/definitions/VideoHandover'
required: true
responses:
'200':
description: OK
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- headunit.write
/wifi:
get:
tags:
- Wi-Fi
summary: Get the vehicle Wi-Fi state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Wi-Fi State
schema:
$ref: '#/definitions/WiFiState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- wi-fi.read
/wifi/connect:
put:
tags:
- Wi-Fi
summary: Connect vehicle to a Wi-Fi network
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: Connect Wi-Fi
schema:
$ref: '#/definitions/ConnectNetwork'
required: true
responses:
'200':
description: Wi-Fi State
schema:
$ref: '#/definitions/WiFiState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- wi-fi.write
/wifi/forget:
put:
tags:
- Wi-Fi
summary: Forget a Wi-Fi network
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: Forget Wi-Fi Network
schema:
$ref: '#/definitions/ForgetNetwork'
required: true
responses:
'200':
description: Wi-Fi State
schema:
$ref: '#/definitions/WiFiState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- wi-fi.write
/wifi/enable:
put:
tags:
- Wi-Fi
summary: Enable Wi-Fi
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Wi-Fi State
schema:
$ref: '#/definitions/WiFiState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- wi-fi.write
/wifi/disable:
put:
tags:
- Wi-Fi
summary: Disable Wi-Fi
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Wi-Fi State
schema:
$ref: '#/definitions/WiFiState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- wi-fi.write
/windows:
get:
tags:
- Windows
summary: Get the windows state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: An array of Windows
schema:
$ref: '#/definitions/WindowsState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- windows.read
/windows/control:
put:
tags:
- Windows
summary: Control the vehicle windows
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: Array of Windows to be controlled
schema:
$ref: '#/definitions/ControlWindows'
required: true
responses:
'200':
description: An array of Windows
schema:
$ref: '#/definitions/WindowsState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- windows.write
/windscreen:
get:
tags:
- Windscreen
summary: Get the windscreen state
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
responses:
'200':
description: Windscreen State
schema:
$ref: '#/definitions/WindscreenState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- windscreen.read
/windscreen/damage:
put:
tags:
- Windscreen
summary: Set the windscreen damage.
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: Windscreen damage
schema:
$ref: '#/definitions/SetWindscreenDamage'
required: true
responses:
'200':
description: Windscreen State
schema:
$ref: '#/definitions/WindscreenState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- windscreen.write
/windscreen/replacement:
put:
tags:
- Windscreen
summary: Set windscreen replacement.
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: Wimdscreen replacement
schema:
$ref: '#/definitions/SetWindscreenReplacement'
required: true
responses:
'200':
description: Windscreen State
schema:
$ref: '#/definitions/WindscreenState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- windscreen.write
/windscreen/wipers:
put:
tags:
- Windscreen
summary: Control windscreen wipers.
produces:
- application/json
parameters:
- $ref: '#/parameters/authorizationParam'
- in: body
name: body
description: Windscreen wipers
schema:
$ref: '#/definitions/SetWindscreenWipers'
required: true
responses:
'200':
description: Windscreen State
schema:
$ref: '#/definitions/WindscreenState'
'400':
$ref: '#/definitions/Error400'
'401':
$ref: '#/definitions/Error401'
'403':
$ref: '#/definitions/Error403'
'408':
$ref: '#/definitions/Error408'
security:
- owner_auth:
- windscreen.write
definitions:
Capability:
type: object
properties:
capabilityIdentifier:
type: string
enum:
- browser
- capabilities
- charging
- chassis_settings
- climate
- cruise_control
- dashboard_lights
- diagnostics
- door_locks
- engine
- firmware_version
- fueling
- graphics
- historical
- home_charger
- honk_horn_flash_lights
- hood
- light_conditions
- lights
- maintenance
- messaging
- mobile
- multi_command
- navi_destination
- notifications
- offroad
- parking_brake
- parking_ticket
- power_takeoff
- race
- rooftop_control
- seats
- start_stop
- tachograph
- text_input
- theft_alarm
- trunk
- usage
- valet_mode
- vehicle_location
- vehicle_status
- vehicle_time
- video_handover
- wake_up
- weather_conditions
- wi_fi
- windows
- windscreen
example: charging
supportedMessageTypes:
type: array
items:
description: Array of message type identifiers
type: enum
enum:
- load_url
- get_capabilities
- get_capability
- get_charge_state
- start_stop_charging
- set_charge_limit
- open_close_charging_port
- set_charge_mode
- set_charging_timers
- set_reduction_of_charging_current_times
- get_chassis_settings
- set_driving_mode
- start_stop_sports_chrono
- set_spring_rates
- set_chassis_position
- get_climate_state
- change_starting_times
- start_stop_hvac
- start_stop_defogging
- start_stop_defrosting
- start_stop_ionising
- set_temperature_settings
- get_cruise_control_state
- activate_deactivate_cruise_control
- get_dashboard_lights
- get_diagnostics_state
- get_lock_state
- lock_unlock_doors
- get_ignition_state
- turn_ignition_on_off
- get_firmware_version
- get_gas_flap_state
- control_gas_flap
- display_image
- get_states
- get_home_charger_state
- set_charge_current
- set_price_tariffs
- activate_deactivate_solar_charging
- enable_disable_wi_fi_hotspot
- authenticate_expire
- get_flashers_state
- honk_flash
- activate_deactivate_emergency_flashers
- get_hood_state
- get_light_conditions
- get_lights_state
- control_lights
- get_maintenance_state
- message_received
- get_mobile_state
- multi_command
- get_navi_destination
- set_navi_destination
- notification
- clear_notification
- notification_action
- get_offroad_state
- get_parking_brake_state
- set_parking_brake
- get_parking_ticket
- start_parking
- end_parking
- get_power_takeoff_state
- activate_deactivate_power_takeoff
- get_race_state
- get_rooftop_state
- control_rooftop
- get_seats_state
- get_start_stop_state
- activate_deactivate_start_stop
- get_tachograph_state
- text_input
- get_theft_alarm_state
- set_theft_alarm_state
- get_trunk_state
- control_trunk
- get_usage
- get_valet_mode
- activate_deactivate_valet_mode
- get_vehicle_location
- get_vehicle_status
- get_vehicle_time
- video_handover
- wake_up
- get_weather_conditions
- get_wi_fi_state
- connect_to_network
- forget_network
- enable_disable_wi_fi
- get_windows_state
- control_windows
- get_windscreen_state
- set_windscreen_damage
- set_windscreen_replacement_needed
- control_wipers
example: get_charge_state
Capabilities:
type: object
properties:
capability:
description: Capability
$ref: '#/definitions/Capability'
DepartureTimes:
type: object
properties:
value:
type: object
properties:
activeState:
type: string
enum:
- inactive
- active
example: inactive
hour:
type: number
format: integer
example: 16
description: Value between 0 and 23
minute:
type: number
format: integer
example: 32
description: Value between 0 and 59
ReductionTimes:
type: object
properties:
value:
type: object
properties:
startStop:
type: string
enum:
- start
- stop
example: start
hour:
type: number
format: integer
example: 17
description: Value between 0 and 23
minute:
type: number
format: integer
example: 33
description: Value between 0 and 59
Timers:
type: object
properties:
value:
type: object
properties:
timerType:
type: string
enum:
- preferred_start_time
- preferred_end_time
- departure_date
example: preferred_start_time
date:
type: number
format: integer
example: 0
description: Milliseconds since UNIX Epoch time
ChargeState:
type: object
properties:
estimatedRange:
type: object
properties:
value:
type: number
format: integer
example: 1
description: Estimated range in km
batteryLevel:
type: object
properties:
value:
type: number
format: double
example: 0.5
description: Battery level percentage between 0.0-1.0
batteryCurrentAC:
type: object
properties:
value:
type: number
format: float
example: -1.5007858276367188
description: Battery current in 4-bytes per IEEE 754
batteryCurrentDC:
type: object
properties:
value:
type: number
format: float
example: -1.5007858276367188
description: Battery current in 4-bytes per IEEE 754
batteryVoltageAC:
type: object
properties:
value:
type: number
format: float
example: 385.568359375
description: Charger voltage in 4-bytes per IEEE 754
batteryVoltageDC:
type: object
properties:
value:
type: number
format: float
example: -1.5007858276367188
description: Charger voltage in 4-bytes per IEEE 754
chargeLimit:
type: object
properties:
value:
type: number
format: double
example: 0.9
description: Charge limit percentage between 0.0-1.0
timeToCompleteCharge:
type: object
properties:
value:
type: number
format: integer
example: 60
description: Time until charging completed in minutes
chargingRateKW:
type: object
properties:
value:
type: number
format: float
example: 6.011810302734375
description: >-
Charge rate in kW represented as 4-bytes per IEEE 754, when
charging
chargePortState:
type: object
properties:
value:
type: string
enum:
- closed
- open
example: closed
chargeMode:
type: object
properties:
value:
type: string
enum:
- immediate
- timer_based
- inductive
example: immediate
maxChargingCurrent:
type: object
properties:
value:
type: number
format: float
example: 24.0980224609375
description: Maximum charging current in 4-bytes per IEEE 754
plugType:
type: object
properties:
value:
type: string
enum:
- type_1
- type_2
- ccs
- chademo
example: type_1
chargingWindowChosen:
type: object
properties:
value:
type: string
enum:
- not_chosen
- chosen
example: not_chosen
departureTimes:
type: array
items:
description: DepartureTimes
$ref: '#/definitions/DepartureTimes'
reductionTimes:
type: array
items:
description: ReductionTimes
$ref: '#/definitions/ReductionTimes'
batteryTemperature:
type: object
properties:
value:
type: number
format: float
example: 96.05029296875
description: Battery temperature in Celsius in 4-bytes per IEEE 754
timers:
type: array
items:
description: Timers
$ref: '#/definitions/Timers'
pluggedIn:
type: object
properties:
value:
type: string
enum:
- disconnected
- plugged_in
example: disconnected
chargingState:
type: object
properties:
value:
type: string
enum:
- not_charging
- charging
- charging_complete
- initialising
- charging_paused
- charging_error
example: not_charging
CurrentSpringRates:
type: object
properties:
value:
type: object
properties:
axle:
type: string
enum:
- front_axle
- rear_axle
example: front_axle
value:
type: number
format: integer
example: 21
description: The suspension spring rate in N/mm
MaximumSpringRates:
type: object
properties:
value:
type: object
properties:
axle:
type: string
enum:
- front_axle
- rear_axle
example: front_axle
value:
type: number
format: integer
example: 37
description: The maximum possible value for the spring rate
MinimumSpringRates:
type: object
properties:
value:
type: object
properties:
axle:
type: string
enum:
- front_axle
- rear_axle
example: front_axle
value:
type: number
format: integer
example: 16
description: The minimum possible value for the spring rate
ChassisSettings:
type: object
properties:
drivingMode:
type: object
properties:
value:
type: string
enum:
- regular
- eco
- sport
- sport_plus
example: regular
sportChrono:
type: object
properties:
value:
type: string
enum:
- inactive
- active
example: inactive
currentSpringRates:
type: array
items:
description: CurrentSpringRates
$ref: '#/definitions/CurrentSpringRates'
maximumSpringRates:
type: array
items:
description: MaximumSpringRates
$ref: '#/definitions/MaximumSpringRates'
minimumSpringRates:
type: array
items:
description: MinimumSpringRates
$ref: '#/definitions/MinimumSpringRates'
currentChassisPosition:
type: object
properties:
value:
type: number
format: integer
example: 25
description: The chassis position in mm calculated from the lowest point
maximumChassisPosition:
type: object
properties:
value:
type: number
format: integer
example: 55
description: null
minimumChassisPosition:
type: object
properties:
value:
type: number
format: integer
example: 228
description: The minimum possible value for the chassis position
HvacWeekdayStartingTimes:
type: object
properties:
value:
type: object
properties:
weekday:
type: string
enum:
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
- sunday
- automatic
example: monday
hour:
type: number
format: integer
example: 18
description: Value between 0 and 23
minute:
type: number
format: integer
example: 30
description: Value between 0 and 59
ClimateState:
type: object
properties:
insideTemperature:
type: object
properties:
value:
type: number
format: float
example: 24.0745849609375
description: The inside temperature in celsius per IEEE 754 formatting
outsideTemperature:
type: object
properties:
value:
type: number
format: float
example: 24.0316162109375
description: The outside temperature in celsius per IEEE 754 formatting
driverTemperatureSetting:
type: object
properties:
value:
type: number
format: float
example: 24.0843505859375
description: The driver temperature setting in celsius per IEEE 754 formatting
passengerTemperatureSetting:
type: object
properties:
value:
type: number
format: float
example: 24.0843505859375
description: >-
The passenger temperature setting in celsius per IEEE 754
formatting
hvacState:
type: object
properties:
value:
type: string
enum:
- inactive
- active
example: inactive
defoggingState:
type: object
properties:
value:
type: string
enum:
- inactive
- active
example: inactive
defrostingState:
type: object
properties:
value:
type: string
enum:
- inactive
- active
example: inactive
ionisingState:
type: object
properties:
value:
type: string
enum:
- inactive
- active
example: inactive
defrostingTemperature:
type: object
properties:
value:
type: number
format: float
example: 24.0843505859375
description: >-
The defrosting temperature setting in celsius per IEEE 754
formatting
hvacWeekdayStartingTimes:
type: array
items:
description: HvacWeekdayStartingTimes
$ref: '#/definitions/HvacWeekdayStartingTimes'
rearTemperatureSetting:
type: object
properties:
value:
type: number
format: float
example: 24.0843505859375
description: The rear temperature in celsius per IEEE 754 formatting
CruiseControlState:
type: object
properties:
cruiseControl:
type: object
properties:
value:
type: string
enum:
- inactive
- active
example: inactive
limiter:
type: object
properties:
value:
type: string
enum:
- not_set
- higher_speed_requested
- lower_speed_requested
- speed_fixed
example: not_set
targetSpeed:
type: object
properties:
value:
type: number
format: integer
example: 0
description: The target speed in km/h
acc:
type: object
properties:
value:
type: string
enum:
- inactive
- active
example: inactive
accTargetSpeed:
type: object
properties:
value:
type: number
format: integer
example: 0
description: The target speed in km/h of the Adaptive Cruise Control
DashboardLights:
type: object
properties:
dashboardLights:
type: object
properties:
value:
type: object
properties:
lightName:
type: string
enum:
- high_beam
- low_beam
- hazard_warning
- brake_failure
- hatch_open
- fuel_level
- engine_coolant_temperature
- battery_charging_condition
- engine_oil
- position_lights
- front_fog_light
- rear_fog_light
- park_heating
- engine_indicator
- service_call
- transmission_fluid_temperature
- transmission_failure
- anti_lock_brake_failure
- worn_brake_linings
- windscreen_washer_fluid
- tire_failure
- engine_oil_level
- engine_coolant_level
- steering_failure
- esc_indication
- brake_lights
- adblue_level
- fuel_filter_diff_pressure
- seat_belt
- advanced_braking
- acc
- trailer_connected
- airbag
- esc_switched_off
- lane_departure_warning_off
example: high_beam
state:
type: string
enum:
- inactive
- info
- yellow
- red
example: inactive
CheckControlMessages:
type: object
properties:
value:
type: object
properties:
id:
type: number
format: integer
example: 0
description: Check Control Message identifier
remainingMinutes:
type: number
format: integer
example: 0
description: Remaining time of the message in minutes
textSize:
type: number
format: integer
example: 0
description: Size of the text
text:
type: string
example: Check engine
description: CCM text bytes formatted in UTF-8
statusSize:
type: number
format: integer
example: 5
description: Size of the status
status:
type: string
example: Alert
description: CCM status bytes formatted in UTF-8
TirePressures:
type: object
properties:
value:
type: object
properties:
location:
type: string
enum:
- front_left
- front_right
- rear_right
- rear_left
example: front_left
pressure:
type: number
format: float
example: 6.002410888671875
description: Tire pressure in BAR formatted in 4-bytes per IEEE 754
TireTemperatures:
type: object
properties:
value:
type: object
properties:
location:
type: string
enum:
- front_left
- front_right
- rear_right
- rear_left
example: front_left
temperature:
type: number
format: float
example: 96.06396484375
description: Tire temperature in BAR formatted in 4-bytes per IEEE 754
WheelRpms:
type: object
properties:
value:
type: object
properties:
location:
type: string
enum:
- front_left
- front_right
- rear_right
- rear_left
example: front_left
rpm:
type: number
format: integer
example: 2
description: The RPM measured at this wheel
TroubleCodes:
type: object
properties:
value:
type: object
properties:
occurences:
type: number
format: integer
example: 2
description: Number of occurences
idSize:
type: number
format: integer
example: 7
description: Size of the ID string
id:
type: string
example: C1116FA
description: ID bytes formatted in UTF-8
ecuIdSize:
type: number
format: integer
example: 9
description: Size of the ECU ID string
ecuId:
type: string
example: RDU_212FR
description: ECU ID bytes formatted in UTF-8
statusSize:
type: number
format: integer
example: 7
description: Size of the status string
status:
type: string
example: PENDING
description: Status bytes formatted in UTF-8
DiagnosticsState:
type: object
properties:
mileage:
type: object
properties:
value:
type: number
format: integer
example: 0
description: The car mileage (odometer) in km
engineOilTemperature:
type: object
properties:
value:
type: number
format: integer
example: 0
description: 'Engine oil temperature in Celsius, whereas can be negative'
speed:
type: object
properties:
value:
type: number
format: integer
example: 0
description: 'The vehicle speed in km/h, whereas can be negative'
engineRPM:
type: object
properties:
value:
type: number
format: integer
example: 9
description: Engine RPM (revolutions per minute)
fuelLevel:
type: object
properties:
value:
type: number
format: double
example: 0.9
description: Fuel level percentage between 0.0-1.0
estimatedRange:
type: object
properties:
value:
type: number
format: integer
example: 1
description: Estimated range (with combustion engine)
washerFluidLevel:
type: object
properties:
value:
type: string
enum:
- low
- filled
example: low
batteryVoltage:
type: object
properties:
value:
type: number
format: float
example: 24.0316162109375
description: Battery voltage per IEEE 754 formatting
adblueLevel:
type: object
properties:
value:
type: number
format: float
example: 1.5000228881835938
description: >-
AdBlue level in liters formatted in 4-bytes per IEEE 754
formatting
distanceSinceReset:
type: object
properties:
value:
type: number
format: integer
example: 5
description: The distance driven in km since reset
distanceSinceStart:
type: object
properties:
value:
type: number
format: integer
example: 0
description: The distance driven in km since trip start
fuelVolume:
type: object
properties:
value:
type: number
format: float
example: 96.02880859375
description: >-
The fuel volume measured in liters formatted in 4-bytes per IEEE
754 formatting
antiLockBraking:
type: object
properties:
value:
type: string
enum:
- inactive
- active
example: inactive
engineCoolantTemperature:
type: object
properties:
value:
type: number
format: integer
example: 0
description: 'Engine coolant temperature in Celsius, whereas can be negative'
engineTotalOperatingHours:
type: object
properties:
value:
type: number
format: float
example: 1541.8671875
description: The accumulated time of engine operation per IEEE 754 formatting
engineTotalFuelConsumption:
type: object
properties:
value:
type: number
format: float
example: 24683.875
description: >-
The accumulated lifespan fuel consumption in liters per IEEE 754
formatting
brakeFluidLevel:
type: object
properties:
value:
type: string
enum:
- low
- filled
example: low
engineTorque:
type: object
properties:
value:
type: number
format: double
example: 0.2
description: Current engine torque percentage between 0.0-1.0
engineLoad:
type: object
properties:
value:
type: number
format: double
example: 0.1
description: Current engine load percentage between 0.0-1.0
wheelBasedSpeed:
type: object
properties:
value:
type: number
format: integer
example: 0
description: >-
The vehicle speed in km/h measured at the wheel base, whereas can
be negative
batteryLevel:
type: object
properties:
value:
type: number
format: double
example: 0.56
description: 'Battery level in %, value between 0.0 and 1.0'
checkControlMessages:
type: array
items:
description: CheckControlMessages
$ref: '#/definitions/CheckControlMessages'
tirePressures:
type: array
items:
description: TirePressures
$ref: '#/definitions/TirePressures'
tireTemperatures:
type: array
items:
description: TireTemperatures
$ref: '#/definitions/TireTemperatures'
wheelRpms:
type: array
items:
description: WheelRpms
$ref: '#/definitions/WheelRpms'
troubleCodes:
type: array
items:
description: TroubleCodes
$ref: '#/definitions/TroubleCodes'
mileageMeters:
type: object
properties:
value:
type: number
format: integer
example: 0
description: The car mileage (odometer) in meters
InsideLocks:
type: object
properties:
value:
type: object
properties:
doorLocation:
type: string
enum:
- front_left
- front_right
- rear_right
- rear_left
- all
example: front_left
lockState:
type: string
enum:
- unlocked
- locked
example: unlocked
Locks:
type: object
properties:
value:
type: object
properties:
doorLocation:
type: string
enum:
- front_left
- front_right
- rear_right
- rear_left
- all
example: front_left
lockState:
type: string
enum:
- unlocked
- locked
example: unlocked
Positions:
type: object
properties:
value:
type: object
properties:
doorLocation:
type: string
enum:
- front_left
- front_right
- rear_right
- rear_left
- all
example: front_left
position:
type: string
enum:
- closed
- open
example: closed
LockState:
type: object
properties:
insideLocks:
type: array
items:
description: InsideLocks
$ref: '#/definitions/InsideLocks'
locks:
type: array
items:
description: Locks
$ref: '#/definitions/Locks'
positions:
type: array
items:
description: Positions
$ref: '#/definitions/Positions'
IgnitionState:
type: object
properties:
ignition:
type: object
properties:
value:
type: string
enum:
- false
- true
example: false
accessoriesIgnition:
type: object
properties:
value:
type: string
enum:
- false
- true
example: false
HmkitVersion:
type: object
properties:
value:
type: object
properties:
versionMajor:
type: number
format: integer
example: 1
description: HMKit version major number
versionMinor:
type: number
format: integer
example: 15
description: HMKit version minor number
versionPatch:
type: number
format: integer
example: 33
description: HMKit version patch number
FirmwareVersion:
type: object
properties:
HMKitVersion:
description: HmkitVersion
$ref: '#/definitions/HmkitVersion'
HMKitBuildName:
type: object
properties:
value:
type: string
example: btstack-uart
description: HMKit version build name bytes formatted in UTF-8
applicationVersion:
type: object
properties:
value:
type: string
example: v1.5-prod
description: Application version bytes formatted in UTF-8
GasFlapState:
type: object
properties:
gasFlapLock:
type: object
properties:
value:
type: string
enum:
- unlocked
- locked
example: unlocked
gasFlapPosition:
type: object
properties:
value:
type: string
enum:
- closed
- open
example: closed
States:
type: object
properties:
states:
type: array
items:
description: A state of the vehicle
type: object
Coordinates:
type: object
properties:
value:
type: object
properties:
latitude:
type: number
format: double
example: 52.520008
description: Latitude in 8-bytes per IEEE 754
longitude:
type: number
format: double
example: 13.404954
description: Longitude in 8-bytes per IEEE 754
PriceTariffs:
type: object
properties:
value:
type: object
properties:
pricingType:
type: string
enum:
- starting_fee
- per_minute
- per_kwh
example: starting_fee
price:
type: number
format: float
example: 6.017669677734375
description: The price in 4-bytes per IEEE 754
currencySize:
type: number
format: integer
example: 3
description: Size of the currency string
currency:
type: string
example: EUR
description: >-
The currency alphabetic code per ISO 4217 or crypto currency
symbol
HomeChargerState:
type: object
properties:
charging:
type: object
properties:
value:
type: string
enum:
- disconnected
- plugged_in
- charging
example: disconnected
authenticationMechanism:
type: object
properties:
value:
type: string
enum:
- pin
- app
example: pin
plugType:
type: object
properties:
value:
type: string
enum:
- type_1
- type_2
- ccs
- chademo
example: type_1
chargingPower:
type: object
properties:
value:
type: number
format: float
example: 24.0277099609375
description: Charging power in kW formatted in 4-bytes per IEEE 754
solarCharging:
type: object
properties:
value:
type: string
enum:
- deactivated
- activated
example: deactivated
hotspotEnabled:
type: object
properties:
value:
type: string
enum:
- disabled
- enabled
example: disabled
hotspotSSID:
type: object
properties:
value:
type: string
example: Charger 7612
description: The Wi-Fi Hotspot SSID formatted in UTF-8
wiFiHotspotSecurity:
type: object
properties:
value:
type: string
enum:
- none
- wep
- wpa
- wpa2_personal
example: none
wiFiHotspotPassword:
type: object
properties:
value:
type: string
example: ZW3vARNUBe
description: The Wi-Fi Hotspot password formatted in UTF-8
authenticationState:
type: object
properties:
value:
type: string
enum:
- unauthenticated
- authenticated
example: unauthenticated
chargeCurrentDc:
type: object
properties:
value:
type: number
format: float
example: 1.5000228881835938
description: The charge current (DC) per IEEE 754
maximumChargeCurrent:
type: object
properties:
value:
type: number
format: float
example: 1.5039291381835938
description: The maximum possible charge current per IEEE 754
minimumChargeCurrent:
type: object
properties:
value:
type: number
format: float
example: 1.7632684311639463e-38
description: The minimal possible charge current per IEEE 754
coordinates:
description: Coordinates
$ref: '#/definitions/Coordinates'
priceTariffs:
type: array
items:
description: PriceTariffs
$ref: '#/definitions/PriceTariffs'
FlashersState:
type: object
properties:
flashers:
type: object
properties:
value:
type: string
enum:
- inactive
- emergency_flasher_active
- left_flasher_active
- right_flasher_active
example: inactive
HoodState:
type: object
properties:
position:
type: object
properties:
value:
type: string
enum:
- closed
- open
- intermediate
example: closed
LightConditions:
type: object
properties:
outsideLight:
type: object
properties:
value:
type: number
format: float
example: 98737.5
description: 'Measured outside illuminance in lux, formatted as IEEE 754 decimal'
insideLight:
type: object
properties:
value:
type: number
format: float
example: 0.37598228454589844
description: 'Measured inside illuminance in lux, formatted as IEEE 754 decimal'
FogLights:
type: object
properties:
value:
type: object
properties:
fogLightLocation:
type: string
enum:
- front
- rear
example: front
fogLightState:
type: string
enum:
- inactive
- active
example: inactive
ReadingLamps:
type: object
properties:
value:
type: object
properties:
readingLampLocation:
type: string
enum:
- front_left
- front_right
- rear_right
- rear_left
example: front_left
readingLampState:
type: string
enum:
- inactive
- active
example: inactive
InteriorLights:
type: object
properties:
value:
type: object
properties:
interiorLightLocation:
type: string
enum:
- front
- rear
example: front
interiorLightState:
type: string
enum:
- inactive
- active
example: inactive
LightsState:
type: object
properties:
frontExteriorLight:
type: string
enum:
- inactive
- active
- active_with_full_beam
- dlr
- automatic
example: inactive
rearExteriorLight:
type: string
enum:
- inactive
- active
example: inactive
ambientLight:
type: string
example: '#ccff88'
description: The ambient light hex string
reverseLight:
type: string
enum:
- inactive
- active
example: inactive
emergencyBrakeLight:
type: string
enum:
- inactive
- active
example: inactive
fogLights:
description: FogLights
type: object
properties:
fogLightLocation:
type: string
enum:
- front
- rear
example: front
fogLightState:
type: string
enum:
- inactive
- active
example: inactive
readingLamps:
description: ReadingLamps
type: object
properties:
readingLampLocation:
type: string
enum:
- front_left
- front_right
- rear_right
- rear_left
example: front_left
readingLampState:
type: string
enum:
- inactive
- active
example: inactive
interiorLights:
description: InteriorLights
type: object
properties:
interiorLightLocation:
type: string
enum:
- front
- rear
example: front
interiorLightState:
type: string
enum:
- inactive
- active
example: inactive
ConditionBasedServices:
type: object
properties:
value:
type: object
properties:
year:
type: number
format: integer
example: 19
description: 'Value between 0 and 99, which corresponds to 2000-2099'
month:
type: number
format: integer
example: 5
description: Value between 1 and 12
identifier:
type: number
format: integer
example: 0
description: CBS identifier
dueStatus:
type: string
enum:
- ok
- pending
- overdue
example: ok
textSize:
type: number
format: integer
example: 0
description: Size of the CBS text
text:
type: string
example: Brake fluid
description: CBS text bytes formatted in UTF-8
descriptionSize:
type: number
format: integer
example: 0
description: Size of the description string
description:
type: string
example: Next change at specified date at the latest.
description: Description bytes formatted in UTF-8
MaintenanceState:
type: object
properties:
daysToNextService:
type: object
properties:
value:
type: number
format: integer
example: 1
description: >-
Number of days until next servicing of the car, whereas negative
is overdue
kilometersToNextService:
type: object
properties:
value:
type: number
format: integer
example: 0
description: The amount of kilometers until next servicing of the car
cbsReportsCount:
type: object
properties:
value:
type: number
format: integer
example: 3
description: The number of CBS reports
monthsToExhaustInpection:
type: object
properties:
value:
type: number
format: integer
example: 5
description: Number of months until exhaust inspection
teleserviceAvailability:
type: object
properties:
value:
type: string
enum:
- pending
- idle
- succesful
- error
example: pending
serviceDistanceThreshold:
type: object
properties:
value:
type: number
format: integer
example: 1
description: Distance threshold for Service
serviceTimeThreshold:
type: object
properties:
value:
type: number
format: integer
example: 4
description: 'Time threshold, in weeks, for Service'
automaticTeleserviceCallDate:
type: object
properties:
value:
type: string
format: date-time
example: '2018-04-12T23:21:50.52Z'
teleserviceBatteryCallDate:
type: object
properties:
value:
type: string
format: date-time
example: '2018-04-12T23:21:50.52Z'
nextInspectionDate:
type: object
properties:
value:
type: string
format: date-time
example: '2018-04-12T23:21:50.52Z'
conditionBasedServices:
description: ConditionBasedServices
$ref: '#/definitions/ConditionBasedServices'
brakeFluidChangeDate:
type: object
properties:
value:
type: string
format: date-time
example: '2018-04-12T23:21:50.52Z'
MobileState:
type: object
properties:
connection:
type: object
properties:
value:
type: string
enum:
- disconnected
- connected
example: disconnected
'':
type: object
properties:
text:
type: object
properties:
value:
type: string
example: Open Garage
description: 'Text for the notification, bytes in UTF8.'
actionItems:
description: ActionItems
$ref: '#/definitions/ActionItems'
receivedAction:
type: object
properties:
value:
type: number
format: integer
example: 42
description: null
NaviDestination:
type: object
properties:
coordinates:
description: Coordinates
$ref: '#/definitions/Coordinates'
destinationName:
type: object
properties:
value:
type: string
example: Berlin
description: Destination name bytes formatted in UTF-8
ActionItems:
type: object
properties:
value:
type: object
properties:
identifier:
type: number
format: integer
example: 27
description: null
name:
type: string
example: Open
description: 'Name of the action, bytes in UTF8.'
OffroadState:
type: object
properties:
routeIncline:
type: object
properties:
value:
type: number
format: integer
example: 0
description: >-
The route elevation incline in degrees, which is a negative number
for decline
wheelSuspension:
type: object
properties:
value:
type: number
format: double
example: 0.5
description: >-
The wheel suspension level percentage, whereas 0.0 is no
suspension and 1.0 maximum suspension
ParkingBrakeState:
type: object
properties:
parkingBrake:
type: object
properties:
value:
type: string
enum:
- inactive
- active
example: inactive
ParkingTicket:
type: object
properties:
parkingTicketState:
type: object
properties:
value:
type: string
enum:
- ended
- started
example: ended
operatorName:
type: object
properties:
value:
type: string
example: Berlin Parking
description: Operator Name bytes formatted in UTF-8
operatorTicketID:
type: object
properties:
value:
type: string
example: '64894233'
description: Operator Ticket ID bytes formatted in UTF-8
ticketStartTime:
type: object
properties:
value:
type: string
format: date-time
example: '2018-04-12T23:20:50.52Z'
description: The time that parking was started
ticketEndTime:
type: object
properties:
value:
type: string
format: date-time
example: '2018-04-12T23:21:50.52Z'
description: The time that parking was ended
PowerTakeoffState:
type: object
properties:
powerTakeoff:
type: object
properties:
value:
type: string
enum:
- inactive
- active
example: inactive
powerTakeoffEngaged:
type: object
properties:
value:
type: string
enum:
- not_engaged
- engaged
example: not_engaged
Accelerations:
type: object
properties:
value:
type: object
properties:
type:
type: string
enum:
- longitudinal_acceleration
- lateral_acceleration
- front_lateral_acceleration
- rear_lateral_acceleration
example: longitudinal_acceleration
gForce:
type: number
format: float
example: 1.5028610229492188
description: The accelaration in g-force per IEEE 754
BrakeTorqueVectorings:
type: object
properties:
value:
type: object
properties:
axle:
type: string
enum:
- front_axle
- rear_axle
example: front_axle
vectoring:
type: string
enum:
- inactive
- active
example: inactive
RaceState:
type: object
properties:
accelerations:
type: array
items:
description: Accelerations
$ref: '#/definitions/Accelerations'
understeering:
type: object
properties:
value:
type: number
format: double
example: 0.19
description: >-
The understeering percentage between 0.0-1.0 whereas up to 0.2
(20%) is considered OK, up to 0.3 (30%) marginal, over 30%
critical
oversteering:
type: object
properties:
value:
type: number
format: double
example: 0
description: >-
The oversteering percentage between 0.0-1.0 whereas up to 0.2
(20%) is considered OK, up to 30% marginal, over 30% critical
gasPedalPosition:
type: object
properties:
value:
type: number
format: double
example: 0.98
description: >-
The gas pedal position between 0.0-1.0, whereas 1.0 (100%) is full
throttle
steeringAngle:
type: object
properties:
value:
type: number
format: integer
example: 10
description: >-
The steering angle in degrees, whereas 0 degrees is straight
ahead, positive number to the right and negative number to the
left
brakePressure:
type: object
properties:
value:
type: number
format: float
example: 24.0784912109375
description: 'Brake pressure in bar, whereas 100bar is max value, full brake'
yawRate:
type: object
properties:
value:
type: number
format: float
example: 6.026092529296875
description: 'Yaw rate in degrees per second [°/s] per IEEE 754 formatting'
rearSuspensionSteering:
type: object
properties:
value:
type: number
format: integer
example: 3
description: Rear suspension steering in degrees
electronicStabilityProgram:
type: object
properties:
value:
type: string
enum:
- inactive
- active
example: inactive
brakeTorqueVectorings:
type: array
items:
description: BrakeTorqueVectorings
$ref: '#/definitions/BrakeTorqueVectorings'
gearMode:
type: object
properties:
value:
type: string
enum:
- manual
- park
- reverse
- neutral
- drive
- low_gear
- sport
example: manual
selectedGear:
type: object
properties:
value:
type: number
format: integer
example: 4
description: 'The selected gear value, if any'
brakePedalPosition:
type: object
properties:
value:
type: number
format: double
example: 0
description: >-
The brake pedal position between 0.0-1.0, wheras 1.0 (100%) is
full brakes
brakePedalSwitch:
type: object
properties:
value:
type: string
enum:
- inactive
- active
example: inactive
clutchPedalSwitch:
type: object
properties:
value:
type: string
enum:
- inactive
- active
example: inactive
acceleratorPedalIdleSwitch:
type: object
properties:
value:
type: string
enum:
- inactive
- active
example: inactive
acceleratorPedalKickdownSwitch:
type: object
properties:
value:
type: string
enum:
- inactive
- active
example: inactive
vehicleMoving:
type: object
properties:
value:
type: string
enum:
- not_moving
- moving
example: not_moving
RooftopState:
type: object
properties:
dimming:
type: object
properties:
value:
type: number
format: double
example: 1
description: Percentage value between 0.0-1.0 whereas 1.0 is opaque
position:
type: object
properties:
value:
type: number
format: double
example: 0
description: Percentage value between 0.0-1.0 whereas 1.0 is fully open
convertibleRoofState:
type: object
properties:
value:
type: string
enum:
- closed
- open
- emergency_locked
- closed_secured
- open_secured
- hard_top_mounted
- intermediate_position
- loading_position
- loading_position_immediate
example: closed
sunroofTiltState:
type: object
properties:
value:
type: string
enum:
- closed
- tilted
- half_tilted
example: closed
sunroofState:
type: object
properties:
value:
type: string
enum:
- closed
- open
- intermediate
example: closed
PersonsDetected:
type: object
properties:
value:
type: object
properties:
seatLocation:
type: string
enum:
- front_left
- front_right
- rear_right
- rear_left
- rear_center
example: front_left
personDetected:
type: string
enum:
- not_detected
- detected
example: not_detected
SeatbeltsFastened:
type: object
properties:
value:
type: object
properties:
seatLocation:
type: string
enum:
- front_left
- front_right
- rear_right
- rear_left
- rear_center
example: front_left
seatbeltFastened:
type: string
enum:
- not_fastened
- fastened
example: not_fastened
SeatsState:
type: object
properties:
personsDetected:
type: array
items:
description: PersonsDetected
$ref: '#/definitions/PersonsDetected'
seatbeltsFastened:
type: array
items:
description: SeatbeltsFastened
$ref: '#/definitions/SeatbeltsFastened'
StartStopState:
type: object
properties:
startStop:
type: object
properties:
value:
type: string
enum:
- inactive
- active
example: inactive
DriversWorkingStates:
type: object
properties:
value:
type: object
properties:
driverNumber:
type: number
format: integer
example: 1
description: The driver number
workingState:
type: string
enum:
- resting
- driver_available
- working
- driving
example: resting
DriversTimeStates:
type: object
properties:
value:
type: object
properties:
driverNumber:
type: number
format: integer
example: 1
description: The driver number
timeState:
type: string
enum:
- normal
- 15_min_before_4
- 4_reached
- 15_min_before_9
- 9_reached
- 15_min_before_16
- 16_reached
example: normal
DriversCards:
type: object
properties:
value:
type: object
properties:
driverNumber:
type: number
format: integer
example: 1
description: The driver number
card:
type: string
enum:
- not_present
- present
example: not_present
TachographState:
type: object
properties:
driversWorkingStates:
type: array
items:
description: DriversWorkingStates
$ref: '#/definitions/DriversWorkingStates'
driversTimeStates:
type: array
items:
description: DriversTimeStates
$ref: '#/definitions/DriversTimeStates'
driversCards:
type: array
items:
description: DriversCards
$ref: '#/definitions/DriversCards'
vehicleMotion:
type: object
properties:
value:
type: string
enum:
- not_detected
- detected
example: not_detected
vehicleOverspeed:
type: object
properties:
value:
type: string
enum:
- no_overspeed
- overspeed
example: no_overspeed
vehicleDirection:
type: object
properties:
value:
type: string
enum:
- forward
- reverse
example: forward
vehicleSpeed:
type: object
properties:
value:
type: number
format: integer
example: 0
description: The tachograph vehicle speed in km/h
TheftAlarmState:
type: object
properties:
theftAlarm:
type: object
properties:
value:
type: string
enum:
- not_armed
- armed
- triggered
example: not_armed
TrunkState:
type: object
properties:
trunkLock:
type: object
properties:
value:
type: string
enum:
- unlocked
- locked
example: unlocked
trunkPosition:
type: object
properties:
value:
type: string
enum:
- closed
- open
example: closed
DrivingModesActivationPeriods:
type: object
properties:
value:
type: object
properties:
drivingMode:
type: string
enum:
- regular
- eco
- sport
- sportPlus
- ecoPlus
example: regular
period:
type: number
format: double
example: 0.6
description: '% value from 0.0 to 1.0 of the period used for the driving mode'
DrivingModeEnergyConsumption:
type: object
properties:
value:
type: object
properties:
drivingMode:
type: string
enum:
- regular
- eco
- sport
- sportPlus
- ecoPlus
example: regular
consumption:
type: number
format: float
example: 96.00927734375
description: Energy consumption in the driving mode in kWh
Usage:
type: object
properties:
averageWeeklyDistance:
type: object
properties:
value:
type: number
format: integer
example: 2
description: Average weekly distance in km
averageWeeklyDistanceLongRun:
type: object
properties:
value:
type: number
format: integer
example: 2
description: 'Average weekyl distance, over long term, in km'
accelerationEvaluation:
type: object
properties:
value:
type: number
format: double
example: 0.7
description: Acceleration evaluation in % from 0.0 to 1.0
drivingStyleEvaluation:
type: object
properties:
value:
type: number
format: double
example: 0.7
description: Driving style's evaluation in % from 0.0 to 1.0
drivingModesActivationPeriods:
description: DrivingModesActivationPeriods
$ref: '#/definitions/DrivingModesActivationPeriods'
drivingModeEnergyConsumption:
description: DrivingModeEnergyConsumption
$ref: '#/definitions/DrivingModeEnergyConsumption'
lastTripEnergyConsumption:
type: object
properties:
value:
type: number
format: float
example: 96.39599609375
description: Energy consumption in the last trip in kWh
lastTripFuelConsumption:
type: object
properties:
value:
type: number
format: float
example: 24.0882568359375
description: Fuel consumption in the last trip in L
mileageAfterLastTrip:
type: object
properties:
value:
type: number
format: integer
example: 71
description: Mileage after the last trip in km
lastTripElectricPortion:
type: object
properties:
value:
type: number
format: double
example: 0.7
description: Portion of the last trip used in electric mode between 0.0-1.0
lastTripAverageEnergyRecuperation:
type: object
properties:
value:
type: number
format: float
example: 6.022186279296875
description: 'Energy recuperation rate for last trip, in kWh / 100 km'
lastTripBatteryRemaining:
type: object
properties:
value:
type: number
format: double
example: 0.5
description: Battery % remaining after last trip between 0.0-1.0
lastTripDate:
type: object
properties:
value:
type: number
format: integer
example: 0
description: Milliseconds since UNIX Epoch time
averageFuelConsumption:
type: object
properties:
value:
type: number
format: float
example: 6.025482177734375
description: Average fuel consumption in liters/100km per IEEE 754 formatting
currentFuelConsumption:
type: object
properties:
value:
type: number
format: float
example: 6.029388427734375
description: Current fuel consumption in liters/100km per IEEE 754 formatting
ValetMode:
type: object
properties:
valetMode:
type: object
properties:
value:
type: string
enum:
- deactivated
- activated
example: deactivated
VehicleLocation:
type: object
properties:
coordinates:
description: Coordinates
$ref: '#/definitions/Coordinates'
heading:
type: object
properties:
value:
type: number
format: double
example: 13.370123
description: Heading in 8-bytes per IEEE 754
altitude:
type: object
properties:
value:
type: number
format: double
example: 133.5
description: >-
Altitude in meters above the WGS 84 reference ellipsoid per double
precision IEEE 754 formatting
VehicleStatus:
type: object
properties:
vin:
type: object
properties:
value:
type: string
example: JF2SHBDC7CH451869
description: The unique Vehicle Identification Number
powertrain:
type: object
properties:
value:
type: string
enum:
- unknown
- all_electric
- combustion_engine
- phev
- hydrogen
- hydrogen_hybrid
example: unknown
modelName:
type: object
properties:
value:
type: string
example: Type X
description: The car model name bytes formatted in UTF-8
name:
type: object
properties:
value:
type: string
example: My Car
description: The car name (nickname) bytes formatted in UTF-8
licensePlate:
type: object
properties:
value:
type: string
example: ABC123
description: The license plate bytes formatted in UTF-8
salesDesignation:
type: object
properties:
value:
type: string
example: Package+
description: The sales designation of the model formatted in UTF-8
modelYear:
type: object
properties:
value:
type: number
format: integer
example: 7
description: The car model manufacturing year number
colorName:
type: object
properties:
value:
type: string
example: Estoril Blau
description: The color name formatted in UTF-8
powerInKw:
type: object
properties:
value:
type: number
format: integer
example: 0
description: The power of the car measured in kw
numberOfDoors:
type: object
properties:
value:
type: number
format: integer
example: 5
description: The number of doors
numberOfSeats:
type: object
properties:
value:
type: number
format: integer
example: 5
description: The number of seats
engineVolume:
type: object
properties:
value:
type: number
format: float
example: 6.003997802734375
description: The engine volume displacement in liters per IEEE 754 formatting
engineMaxTorque:
type: object
properties:
value:
type: number
format: integer
example: 0
description: The maximum engine torque in Nm
gearbox:
type: object
properties:
value:
type: string
enum:
- manual
- automatic
- semi_automatic
example: manual
displayUnit:
type: object
properties:
value:
type: string
enum:
- km
- miles
example: km
driverSeatLocation:
type: object
properties:
value:
type: string
enum:
- left
- right
- center
example: left
equipments:
type: object
properties:
value:
type: string
example: Parking sensors
description: Equipment that the vehicle is equipped with
brand:
type: object
properties:
value:
type: string
example: Tesla
description: The car brand bytes formatted in UTF-8
state:
type: array
items:
description: State
$ref: '#/definitions/State'
VehicleTime:
type: object
properties:
vehicleTime:
type: object
properties:
value:
type: string
format: date-time
example: '2018-04-12T23:20:50.52Z'
description: The vehicle local time
WeatherConditions:
type: object
properties:
rainIntensity:
type: object
properties:
value:
type: number
format: double
example: 1
description: >-
Measured raining intensity percentage, whereas 0.0 is no rain and
1.0 (100%) is maximum rain
WiFiState:
type: object
properties:
wifiEnabled:
type: object
properties:
value:
type: string
enum:
- disabled
- enabled
example: disabled
networkConnected:
type: object
properties:
value:
type: string
enum:
- disconnected
- connected
example: disconnected
networkSSID:
type: object
properties:
value:
type: string
example: HOME
description: The network SSID formatted in UTF-8
networkSecurity:
type: object
properties:
value:
type: string
enum:
- none
- wep
- wpa
- wpa2_personal
example: none
WindowsOpenPercentages:
type: object
properties:
value:
type: object
properties:
windowLocation:
type: string
enum:
- front_left
- front_right
- rear_right
- rear_left
- hatch
example: front_left
openPercentage:
type: number
format: double
example: 0.56
description: Value between 0.0 and 1.0
WindowsPositions:
type: object
properties:
value:
type: object
properties:
windowLocation:
type: string
enum:
- front_left
- front_right
- rear_right
- rear_left
- hatch
example: front_left
windowPosition:
type: string
enum:
- closed
- open
- intermediate
example: closed
WindowsState:
type: object
properties:
windowsOpenPercentages:
type: array
items:
description: WindowsOpenPercentages
$ref: '#/definitions/WindowsOpenPercentages'
windowsPositions:
type: array
items:
description: WindowsPositions
$ref: '#/definitions/WindowsPositions'
WindscreenState:
type: object
properties:
wipers:
type: object
properties:
value:
type: string
enum:
- inactive
- active
- automatic
example: inactive
wipersIntensity:
type: object
properties:
value:
type: string
enum:
- level_0
- level_1
- level_2
- level_3
example: level_0
windscreenDamage:
type: object
properties:
value:
type: string
enum:
- no_impact_detected
- impact_but_no_damage_detected
- damage_smaller_than_1_inch
- damage_larger_than_1_inch
example: no_impact_detected
windscreenZoneMatrix:
description: WindscreenSizeMatrix
$ref: '#/definitions/WindscreenSizeMatrix'
windscreenDamageZone:
description: WindscreenPositionMatrix
$ref: '#/definitions/WindscreenPositionMatrix'
windscreenNeedsReplacement:
type: object
properties:
value:
type: string
enum:
- unknown
- no_replacement_needed
- replacement_needed
example: unknown
windscreenDamageConfidence:
type: object
properties:
value:
type: number
format: double
example: 0.95
description: >-
Percentage between 0.0-1.0, confidence of damage detection. Zero
if no impact detected.
windscreenDamageDetectionTime:
type: object
properties:
value:
type: string
format: date-time
example: '2018-04-12T23:20:50.52Z'
description: The time that the damage was detected
VideoHandover:
type: object
properties:
videoURL:
type: string
example: 'https://www.youtube.com/watch?v=yWVB7U6mX2Y'
description: 'The URL of the video stream, formatted in UTF-8'
startingSecond:
type: number
format: integer
example: 90
description: The second from where the video should be started from
screen:
type: string
enum:
- front
- rear
example: rear
TextMessage:
type: object
properties:
handle:
type: string
example: '@twitter'
description: The sender handle like username or phone number
text:
type: string
example: Keep your eyes on the road at all times.
description: The text content in UTF-8
SetNaviDestination:
type: object
properties:
coordinates:
description: Coordinates
type: object
properties:
latitude:
type: number
format: double
example: 52.520008
description: Latitude in 8-bytes per IEEE 754
longitude:
type: number
format: double
example: 13.404954
description: Longitude in 8-bytes per IEEE 754
destinationName:
type: string
example: Berlin
description: Destination name bytes formatted in UTF-8
Notification:
type: object
properties:
text:
type: string
example: 'Your plans for the evening: free'
description: The text to be displayed or read to the driver
SetChargeTimer:
type: object
properties:
timerType:
type: string
enum:
- preferred_start_time
- preferred_end_time
- departure_time
example: preferred_start_time
time:
type: string
format: date-time
example: '2018-04-12T23:20:50.52Z'
description: The time for this timer
SetReductionTime:
type: object
properties:
startStop:
type: string
enum:
- start
- stop
example: start
hour:
type: number
format: integer
example: 17
description: Value between 0 and 23
minute:
type: number
format: integer
example: 33
description: Value between 0 and 59
SetDrivingMode:
type: object
properties:
drivingMode:
type: string
enum:
- regular
- eco
- sport
- sport_plus
example: sport
SetSpringRate:
type: object
properties:
springRate:
type: number
format: integer
example: 25
description: The suspension spring rate in N/mm
SetWindscreenWipers:
type: object
properties:
wipersState:
type: string
enum:
- inactive
- active
- automatic
example: inactive
wipersIntensity:
type: string
enum:
- level_0
- level_1
- level_2
- level_3
example: level_0
WindscreenSizeMatrix:
type: object
properties:
rows:
type: number
format: integer
example: 4
description: The row number
columns:
type: number
format: integer
example: 3
description: The column number
WindscreenPositionMatrix:
type: object
properties:
row:
type: number
format: integer
example: 4
description: The row number
column:
type: number
format: integer
example: 3
description: The column number
StartParking:
type: object
properties:
operatorName:
type: string
example: Berlin Parking
description: 'The parking operator name, formatted in UTF-8'
operatorTicketID:
type: string
example: '64894233'
description: 'The parking operator ticket ID, formatted in UTF-8'
ticketStartTime:
type: string
format: date-time
example: '2018-04-12T23:20:50.52Z'
description: The start time of the ticket
SetRooftopState:
type: object
properties:
dimming:
type: number
format: double
example: 1
description: Percentage value between 0.0-1.0 whereas 1.0 is opaque
position:
type: number
format: double
example: 0
description: Percentage value between 0.0-1.0 whereas 1.0 is fully open
convertibleRoofState:
type: string
enum:
- closed
- open
- emergency_locked
- closed_secured
- open_secured
- hard_top_mounted
- intermediate_position
- loading_position
- loading_position_immediate
example: closed
sunroofTiltState:
type: string
enum:
- closed
- tilted
- half_tilted
example: closed
sunroofState:
type: string
enum:
- closed
- open
- intermediate
example: closed
ConnectNetwork:
type: object
properties:
networkSSID:
type: string
example: HOME
description: The network SSID
networkSecurity:
type: string
enum:
- none
- wep
- wpa
- wpa2_personal
example: wpa
description: The network security being used
networkPassword:
type: string
example: '********'
description: The network password
ForgetNetwork:
type: object
properties:
networkSSID:
type: string
example: HOME
description: The network SSID
ControlWindows:
type: object
properties:
windowsOpenPercentages:
type: array
items:
type: object
properties:
windowLocation:
type: string
enum:
- front_left
- front_right
- rear_right
- rear_left
- hatch
example: front_left
openPercentage:
type: number
format: double
example: 0.56
description: Value between 0.0 and 1.0
windowsPositions:
type: array
items:
type: object
properties:
windowLocation:
type: string
enum:
- front_left
- front_right
- rear_right
- rear_left
- hatch
example: front_left
windowPosition:
type: string
enum:
- close
- open
- intermediate
example: close
LoadURL:
type: object
properties:
url:
type: string
example: 'https://google.com'
description: 'The URL to be loaded, formatted in UTF-8'
DisplayImage:
type: object
properties:
imageURL:
type: string
example: 'https://goo.gl/VyU1ip'
description: 'The image URL to be displayed, formatted in UTF-8'
SetChargeCurrent:
type: object
properties:
chargeCurrent:
type: number
format: float
example: 0.5
description: The charger current
SetChassisPosition:
type: object
properties:
chassisPosition:
type: number
format: integer
example: 25
description: The chassis position in mm calculated from the lowest point
SetChargeLimit:
type: object
properties:
chargeLimit:
type: number
format: integer
example: 90
description: The charge limit as percentage between 0-100%
SetChargeMode:
type: object
properties:
chargeMode:
type: string
example: 90
description: The charge limit as percentage between 0-100%
enum:
- immediate
- timer_based
AutoHVACActive:
type: object
properties:
hour:
type: number
format: integer
example: 7
description: Starting hour
minute:
type: number
format: integer
example: 30
description: Starting minute
state:
type: string
enum:
- active
- inactive
SetHvacWeekdayStartingTimes:
type: object
properties:
weekdayStartingTimes:
type: array
items:
type: object
properties:
weekday:
type: string
enum:
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
- sunday
- automatic
example: monday
hour:
type: number
format: integer
example: 18
description: Value between 0 and 23
minute:
type: number
format: integer
example: 30
description: Value between 0 and 59
SetTemperatureSettings:
type: object
properties:
driverTemperatureSetting:
type: number
format: float
example: 20.5
passengerTemperatureSetting:
type: number
format: float
example: 20.5
rearTemperatureSetting:
type: number
format: float
example: 20.5
SetCruiseControlSpeed:
type: object
properties:
targetSpeed:
type: number
format: integer
example: 60
description: The target speed in km/h
SetGasFlapState:
type: object
properties:
gasFlapLock:
type: string
enum:
- unlocked
- locked
example: unlocked
gasFlapPosition:
type: string
enum:
- closed
- open
example: closed
SetWindscreenReplacement:
type: object
properties:
windscreenReplacement:
type: string
enum:
- unknown
- no_replacement_needed
- replacement_needed
example: unknown
SetWindscreenDamage:
type: object
properties:
damage:
type: string
enum:
- no_impact_detected
- impact_but_no_damage_detected
- damage_smaller_than_1_inch
- damage_larger_than_1_inch
example: no_impact_detected
damageZoneRow:
type: number
format: integer
example: 4
description: The row number
damageZoneColumn:
type: number
format: integer
example: 3
description: The column number
SetPriceTariffs:
type: object
properties:
priceTariffs:
type: array
items:
$ref: '#/definitions/PriceTariff'
PriceTariff:
type: object
properties:
pricingType:
type: string
enum:
- starting_fee
- per_minute
- per_kwh
example: starting_fee
price:
type: number
format: float
example: 5
description: The price in 4-bytes per IEEE 754
currency:
type: string
example: EUR
description: The currency alphabetic code per ISO 4217 or crypto currency symbol
State:
type: object
properties:
capabilityIdentifier:
$ref: '#/definitions/CapabilityIdentifier'
state:
type: object
description: The state of the capability
HistoricalStates:
type: object
properties:
states:
type: array
items:
description: State
$ref: '#/definitions/State'
GetHistoricalStates:
type: object
properties:
capabilityIdentifier:
$ref: '#/definitions/CapabilityIdentifier'
startDate:
type: string
format: date-time
example: '2018-04-12T23:10:50.52Z'
description: States starting time
endDate:
type: string
format: date-time
example: '2018-04-12T23:20:50.52Z'
description: States end time
CapabilityIdentifier:
type: string
enum:
- browser
- capabilities
- charging
- chassis_settings
- climate
- cruise_control
- dashboard_lights
- diagnostics
- door_locks
- engine
- firmware_version
- fueling
- graphics
- historical
- home_charger
- honk_horn_flash_lights
- hood
- light_conditions
- lights
- maintenance
- messaging
- mobile
- navi_destination
- notifications
- offroad
- parking_brake
- parking_ticket
- power_takeoff
- race
- rooftop_control
- seats
- start_stop
- tachograph
- text_input
- theft_alarm
- trunk
- usage
- valet_mode
- vehicle_location
- vehicle_status
- vehicle_time
- video_handover
- wake_up
- weather_conditions
- wi_fi
- windows
- windscreen
example: charging
Error400:
type: object
properties:
errorCode:
type: number
format: integer
example: 400
failureType:
type: string
enum:
- unsupported_capability
- incorrect_state
- invalid_command
- other
example: unsupported_capability
failureDescription:
type: string
example: Capability not supported by this vehicle
description: Failure description formatted in UTF-8
Error401:
type: object
properties:
errorCode:
type: number
format: integer
example: 401
failureType:
type: string
enum:
- auth_header_missing
- other
example: auth_header_missing
failureDescription:
type: string
example: Missing authentication header
description: Failure description formatted in UTF-8
Error403:
type: object
properties:
errorCode:
type: number
format: integer
example: 403
failureType:
type: string
enum:
- auth_header_invalid
- other
example: auth_header_invalid
failureDescription:
type: string
example: Invalid authentication header
description: Failure description formatted in UTF-8
Error408:
type: object
properties:
errorCode:
type: number
format: integer
example: 408
failureType:
type: string
enum:
- request_timeout
- vehicle_asleep
- charger_asleep
- other
example: vehicle_asleep
failureDescription:
type: string
example: Vehicle Asleep
description: Failure description formatted in UTF-8
responses: {}
parameters:
authorizationParam:
name: Authorization
in: header
required: true
type: string
securityDefinitions:
owner_auth:
type: oauth2
authorizationUrl: 'https://developers.high-mobility.com/hm_cloud/o/{org_oem}/oauth'
flow: implicit
scopes:
capabilities.read: Allowed to get car capabilities
vehicle-status.read: Allowed to get vehicle status
diagnostics.read: Allowed to get diagnostics and maintenance state
door-locks.read: Allowed to get the lock state
door-locks.write: Allowed to lock or unlock the car
engine.read: Allowed to get the ignition state
engine.write: Allowed to turn on/off the engine
trunk-access.read: Allowed to get the trunk state
trunk-access.write: Allowed to open/close or lock/unlock the trunk
trunk-access.limited: >-
If the access to the trunk is limited to one time, whereas a 0 means
unlimited
wake-up.write: Allowed to wake up the car
charge.read: Allowed to get the charge state
charge.write: >-
Allowed to start/stop charging, set the charge limit, open/close charge
port
climate.read: Allowed to get the climate state
climate.write: Allowed to set climate profile and start/stop HVAC
lights.read: Allowed to get the lights state
lights.write: Allowed to control lights
windows.write: Allowed to open/close windows
rooftop-control.read: Allowed to get the rooftop state
rooftop-control.write: Allowed to control the rooftop
windscreen.read: Allowed to get the windscreen state
windscreen.write: Allowed to set the windscreen damage
honk-horn-flash-lights.write: Allowed to honk the horn and flash lights and activate emergency flasher
headunit.write: >-
Allowed to send notifications, messages, videos, URLs, images and text
input to the headunit
remote-control.read: Allowed to get the control mode
remote-control.write: Allowed to remote control the car
valet-mode.read: Allowed to get the valet mode
valet-mode.write: Allowed to set the valet mode
valet-mode.active: Only allowed to use the car in valet mode
fueling.write: Allowed to open the car gas flap
heart-rate.write: Allowed to send the heart rate to the car
driver-fatigue.read: Allowed to get driver fatigue warnings
vehicle-location.read: Allowed to get the vehicle location
navi-destination.write: Allowed to set the navigation destination
theft-alarm.read: Allowed to get the theft alarm state
theft-alarm.write: Allowed to set the theft alarm
parking-ticket.read: Allowed to get the parking ticket
parking-ticket.write: Allowed to start/end parking
keyfob-position.read: Allowed to get the keyfob position
headunit.read: Allowed to receive notifications and messages from the headunit
vehicle-time.read: Allowed to get the vehicle local time
windows.read: Allowed to get the windows state
honk-horn-flash-lights.read: Allowed to get the flasher state
navi-destination.read: Allowed to get the navigation destination
race.read: Allowed to get the race state
offroad.read: Allowed to get the offroad state
chassis-settings.read: Allowed to get the chassis settings
chassis-settings.write: Allowed to set the chassis settings
seats.read: Allowed to get the seats state
seats.write: Allowed to control the seats
parking-brake.read: Allowed to get the parking brake state
parking-brake.write: Allowed to set the parking brake
environment.read: Allowed to get light and weather conditions
fueling.read: Allowed to get the gas flap state
wi-fi.read: Allowed to get the Wi-Fi state
wi-fi.write: Allowed to enable/disable Wi-Fi and manage networks
home-charger.read: Allowed to get the home charger state
home-charger.write: Allowed to control the home charger
dashboard-lights.read: Allowed to get the dashboard lights
cruise-control.read: Allowed to get the cruise control state
cruise-control.write: Allowed to set the cruise control
start-stop.read: Allowed to get the start-stop state
start-stop.write: Allowed to set the start-stop state
tachograph.read: Allowed to get the tachograph state
power-takeoff.read: Allowed to get the power take-off state
power-takeoff.write: Allowed to set the power take-off
usage.read: Allowed to get the usage state
mobile.read: Allowed to get the mobile state
hood.read: Allowed to get the hood state
tags: []
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment