AutoApi.CustomType (auto_api v13.2.0) View Source

Retrieves custom types specifications

Link to this section Summary

Types

Link to this section Types

Specs

acceleration() :: %{
  direction: :longitudinal | :lateral | :front_lateral | :rear_lateral,
  acceleration: AutoApi.UnitType.acceleration()
}
Link to this type

acceleration_duration()

View Source

Specs

acceleration_duration() :: %{
  direction: :longitudinal | :lateral,
  type: :regular | :positive_outlier | :negative_outlier,
  duration: AutoApi.UnitType.duration()
}
Link to this type

accelerator_duration()

View Source

Specs

accelerator_duration() :: %{
  pedal_position_threshold: percentage(),
  duration: AutoApi.UnitType.duration()
}

Specs

action_item() :: %{id: integer(), name: String.t()}
Link to this type

active_selected_state()

View Source

Specs

active_selected_state() :: :inactive_selected | :inactive_not_selected | :active

Specs

active_state() :: :inactive | :active

Specs

address_component() :: %{
  type:
    :city
    | :country
    | :country_short
    | :district
    | :postal_code
    | :street
    | :state_province
    | :other,
  value: String.t()
}

Specs

availability() :: %{
  update_rate:
    :trip_high
    | :trip
    | :trip_start_end
    | :trip_end
    | :unknown
    | :not_available
    | :on_change,
  rate_limit: AutoApi.UnitType.frequency(),
  applies_per: :app | :vehicle
}

Specs

axle() :: :front | :rear
Link to this type

brake_service_due_date()

View Source

Specs

brake_service_due_date() :: %{axle: axle(), due_date: DateTime.t()}
Link to this type

brake_service_remaining_distance()

View Source

Specs

brake_service_remaining_distance() :: %{
  axle: axle(),
  distance: AutoApi.UnitType.length()
}
Link to this type

brake_service_status()

View Source

Specs

brake_service_status() :: %{axle: axle(), status: service_status()}
Link to this type

brake_torque_vectoring()

View Source

Specs

brake_torque_vectoring() :: %{axle: axle(), state: active_state()}

Specs

capability_state() :: binary()

Specs

charging_cost() :: %{
  currency: String.t(),
  calculated_charging_cost: float() | integer(),
  calculated_savings: float() | integer(),
  simulated_immediate_charging_cost: float() | integer()
}

Specs

charging_location() :: %{
  municipality: String.t(),
  formatted_address: String.t(),
  street_address: String.t()
}

Specs

charging_point() :: %{
  city: String.t(),
  postal_code: String.t(),
  street: String.t(),
  provider: String.t()
}
Link to this type

charging_restriction()

View Source

Specs

charging_restriction() :: %{
  active: active_state(),
  limit: :max | :reduced | :min
}
Link to this type

check_control_message()

View Source

Specs

check_control_message() :: %{
  id: integer(),
  remaining_time: AutoApi.UnitType.duration(),
  text: String.t(),
  status: String.t()
}
Link to this type

condition_based_service()

View Source

Specs

condition_based_service() :: %{
  year: integer(),
  month: integer(),
  id: integer(),
  due_status: :ok | :pending | :overdue,
  text: String.t(),
  description: String.t()
}
Link to this type

confirmed_trouble_code()

View Source

Specs

confirmed_trouble_code() :: %{
  id: String.t(),
  ecu_address: String.t(),
  ecu_variant_name: String.t(),
  status: String.t()
}

Specs

connection_state() :: :disconnected | :connected

Specs

coordinates() :: %{
  latitude: float() | integer(),
  longitude: float() | integer()
}

Specs

crash_incident() :: %{
  location: :front | :lateral | :rear,
  severity: :very_high | :high | :medium | :low | :unknown,
  repairs: :unknown | :needed | :not_needed
}

Specs

dashboard_light() :: %{
  name:
    :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
    | :air_filter_minder
    | :air_suspension_ride_control_fault
    | :all_wheel_drive_disabled
    | :anti_theft
    | :blind_spot_detection
    | :charge_system_fault
    | :check_fuel_cap
    | :check_fuel_fill_inlet
    | :check_fuel_filter
    | :dc_temp_warning
    | :dc_warning_status
    | :diesel_engine_idle_shutdown
    | :diesel_engine_warning
    | :diesel_exhaust_fluid_system_fault
    | :diesel_exhaust_over_temp
    | :diesel_exhaust_fluid_quality
    | :diesel_filter_regeneration
    | :diesel_particulate_filter
    | :diesel_pre_heat
    | :electric_trailer_brake_connection
    | :ev_battery_cell_max_volt_warning
    | :ev_battery_cell_min_volt_warning
    | :ev_battery_charge_energy_storage_warning
    | :ev_battery_high_level_warning
    | :ev_battery_high_temperature_warning
    | :ev_battery_insulation_resist_warning
    | :ev_battery_jump_level_warning
    | :ev_battery_low_level_warning
    | :ev_battery_max_volt_veh_energy_warning
    | :ev_battery_min_volt_veh_energy_warning
    | :ev_battery_over_charge_warning
    | :ev_battery_poor_cell_warning
    | :ev_battery_temp_diff_warning
    | :forward_collision_warning
    | :fuel_door_open
    | :hill_descent_control_fault
    | :hill_start_assist_warning
    | :hv_interlocking_status_warning
    | :lighting_system_failure
    | :malfunction_indicator
    | :motor_controller_temp_warning
    | :park_aid_malfunction
    | :passive_entry_passive_start
    | :powertrain_malfunction
    | :restraints_indicator_warning
    | :start_stop_engine_warning
    | :traction_control_disabled
    | :traction_control_active
    | :traction_motor_temp_warning
    | :tire_pressure_monitor_system_warning
    | :water_in_fuel
    | :tire_warning_front_right
    | :tire_warning_front_left
    | :tire_warning_rear_right
    | :tire_warning_rear_left
    | :tire_warning_system_error
    | :battery_low_warning
    | :brake_fluid_warning
    | :active_hood_fault
    | :active_spoiler_fault
    | :adjust_tire_pressure
    | :steering_lock_alert
    | :anti_pollution_failure_engine_start_impossible
    | :anti_pollution_system_failure
    | :anti_reverse_system_failing
    | :auto_parking_brake
    | :automatic_braking_deactive
    | :automatic_braking_system_fault
    | :automatic_lights_settings_failure
    | :keyfob_battery_alarm
    | :trunk_open
    | :check_reversing_lamp
    | :crossing_line_system_alert_failure
    | :dipped_beam_headlamps_front_left_failure
    | :dipped_beam_headlamps_front_right_failure
    | :directional_headlamps_failure
    | :directional_light_failure
    | :dsg_failing
    | :electric_mode_not_available
    | :electronic_lock_failure
    | :engine_control_system_failure
    | :engine_oil_pressure_alert
    | :esp_failure
    | :excessive_oil_temperature
    | :tire_front_left_flat
    | :tire_front_right_flat
    | :tire_rear_left_flat
    | :tire_rear_right_flat
    | :fog_light_front_left_failure
    | :fog_light_front_right_failure
    | :fog_light_rear_left_failure
    | :fog_light_rear_right_failure
    | :fog_light_front_fault
    | :door_front_left_open
    | :door_front_left_open_high_speed
    | :tire_front_left_not_monitored
    | :door_front_right_open
    | :door_front_right_open_high_speed
    | :tire_front_right_not_monitored
    | :headlights_left_failure
    | :headlights_right_failure
    | :hybrid_system_fault
    | :hybrid_system_fault_repaired_vehicle
    | :hydraulic_pressure_or_brake_fuild_insufficient
    | :lane_departure_fault
    | :limited_visibility_aids_camera
    | :tire_pressure_low
    | :maintenance_date_exceeded
    | :maintenance_odometer_exceeded
    | :other_failing_system
    | :parking_brake_control_failing
    | :parking_space_measuring_system_failure
    | :place_gear_to_parking
    | :power_steering_assitance_failure
    | :power_steering_failure
    | :preheating_deactivated_battery_too_low
    | :preheating_deactivated_fuel_level_too_low
    | :preheating_deactivated_battery_set_the_clock
    | :fog_light_rear_fault
    | :door_rear_left_open
    | :door_rear_left_open_high_speed
    | :tire_rear_left_not_monitored
    | :door_rear_right_open
    | :door_rear_right_open_high_speed
    | :tire_rear_right_not_monitored
    | :screen_rear_open
    | :retractable_roof_mechanism_fault
    | :reverse_light_left_failure
    | :reverse_light_right_failure
    | :risk_of_ice
    | :roof_operation_impossible_apply_parking_break
    | :roof_operation_impossible_apply_start_engine
    | :roof_operation_impossible_temperature_too_high
    | :seatbelt_passenger_front_right_unbuckled
    | :seatbelt_passenger_rear_left_unbuckled
    | :seatbelt_passenger_rear_center_unbuckled
    | :seatbelt_passenger_rear_right_unbuckled
    | :battery_secondary_low
    | :shock_sensor_failing
    | :side_lights_front_left_failure
    | :side_lights_front_right_failure
    | :side_lights_rear_left_failure
    | :side_lights_rear_right_failure
    | :spare_wheel_fitter_driving_aids_deactivated
    | :speed_control_failure
    | :stop_light_left_failure
    | :stop_light_right_failure
    | :suspension_failure
    | :suspension_failure_reduce_speed
    | :suspension_fault_limited_to_90kmh
    | :tire_pressure_sensor_failure
    | :trunk_open_high_speed
    | :trunk_window_open
    | :turn_signal_front_left_failure
    | :turn_signal_front_right_failure
    | :turn_signal_rear_left_failure
    | :turn_signal_rear_right_failure
    | :tire_under_inflation
    | :wheel_pressure_fault
    | :oil_change_warning
    | :inspection_warning
    | :diesel_oil_filter_water_presence
    | :engine_drag_torque_control_failure,
  state: on_off_state()
}

Specs

departure_time() :: %{state: active_state(), time: time()}

Specs

detected() :: :not_detected | :detected
Link to this type

diesel_exhaust_filter_status()

View Source

Specs

diesel_exhaust_filter_status() :: %{
  status: :unknown | :normal_operation | :overloaded | :at_limit | :over_limit,
  component:
    :unknown
    | :exhaust_filter
    | :diesel_particulate_filter
    | :overboost_code_regulator
    | :off_board_regeneration,
  cleaning: :unknown | :in_progress | :complete | :interrupted
}

Specs

distance_over_time() :: %{
  distance: AutoApi.UnitType.length(),
  time: AutoApi.UnitType.duration()
}

Specs

door_position() :: %{
  location: :front_left | :front_right | :rear_right | :rear_left | :all,
  position: position()
}

Specs

driver_card_present() :: %{
  driver_number: integer(),
  card_present: :not_present | :present
}

Specs

driver_time_state() :: %{
  driver_number: integer(),
  time_state:
    :normal
    | :fifteen_min_before_four
    | :four_reached
    | :fifteen_min_before_nine
    | :nine_reached
    | :fifteen_min_before_sixteen
    | :sixteen_reached
}
Link to this type

driver_working_state()

View Source

Specs

driver_working_state() :: %{
  driver_number: integer(),
  working_state: :resting | :driver_available | :working | :driving
}

Specs

driving_mode() :: :regular | :eco | :sport | :sport_plus | :eco_plus | :comfort
Link to this type

driving_mode_activation_period()

View Source

Specs

driving_mode_activation_period() :: %{
  driving_mode: driving_mode(),
  period: percentage()
}
Link to this type

driving_mode_energy_consumption()

View Source

Specs

driving_mode_energy_consumption() :: %{
  driving_mode: driving_mode(),
  consumption: AutoApi.UnitType.energy()
}

Specs

driving_mode_phev() ::
  :not_in_traction
  | :in_charge
  | :full_electric
  | :hybrid_serial
  | :thermic
  | :hybrid_parallel
Link to this type

eco_driving_threshold()

View Source

Specs

eco_driving_threshold() :: %{type: :zero | :one, value: float() | integer()}

Specs

enabled_state() :: :disabled | :enabled

Specs

engine_type() ::
  :unknown
  | :all_electric
  | :combustion_engine
  | :phev
  | :hydrogen
  | :hydrogen_hybrid
  | :petrol
  | :electric
  | :gas
  | :diesel
  | :gasoline
  | :cng
  | :lpg
  | :hybrid

Specs

failure() :: %{
  reason:
    :rate_limit
    | :execution_timeout
    | :format_error
    | :unauthorised
    | :unknown
    | :pending
    | :oem_error
    | :privacy_mode_active,
  description: String.t()
}

Specs

fluid_level() :: :low | :filled | :very_low | :normal | :high | :very_high

Specs

grade() :: :excellent | :normal | :warning

Specs

hmkit_version() :: %{major: integer(), minor: integer(), patch: integer()}

Specs

ignition_state() :: :lock | :off | :accessory | :on | :start

Specs

key_value() :: %{key: String.t(), value: String.t()}
Link to this type

lane_keep_assist_state()

View Source

Specs

lane_keep_assist_state() :: %{location: :left | :right, state: active_state()}

Specs

light() :: %{location: location_longitudinal(), state: active_state()}

Specs

location() :: :front_left | :front_right | :rear_right | :rear_left
Link to this type

location_longitudinal()

View Source

Specs

location_longitudinal() :: :front | :rear

Specs

location_wheel() ::
  :front_left
  | :front_right
  | :rear_right
  | :rear_left
  | :rear_right_outer
  | :rear_left_outer
  | :spare

Specs

lock() :: %{location: location(), lock_state: lock_state()}

Specs

lock_safety() :: :safe | :unsafe

Specs

lock_state() :: :unlocked | :locked

Specs

muted() :: :not_muted | :muted

Specs

network_security() :: :none | :wep | :wpa | :wpa2_personal
Link to this type

oem_trouble_code_value()

View Source

Specs

oem_trouble_code_value() :: %{id: String.t(), key_value: key_value()}

Specs

on_off_state() :: :off | :on

Specs

park_assist() :: %{
  location: location_longitudinal(),
  alarm: active_state(),
  muted: muted()
}

Specs

percentage() :: float() | integer()

Specs

person_detected() :: %{location: seat_location(), detected: detected()}

Specs

position() :: :closed | :open

Specs

price_tariff() :: %{
  pricing_type: :starting_fee | :per_minute | :per_kwh,
  price: float() | integer(),
  currency: String.t()
}

Specs

reading_lamp() :: %{location: location(), state: active_state()}

Specs

reduction_time() :: %{start_stop: start_stop(), time: time()}

Specs

rgb_colour() :: %{red: integer(), green: integer(), blue: integer()}

Specs

seat_location() ::
  :front_left
  | :front_right
  | :rear_right
  | :rear_left
  | :rear_center
  | :driver
  | :passenger

Specs

seatbelt_state() :: %{
  location: seat_location(),
  fastened_state: :not_fastened | :fastened
}

Specs

service_status() :: :ok | :warning | :critical

Specs

spring_rate() :: %{axle: axle(), spring_rate: AutoApi.UnitType.torque()}

Specs

start_stop() :: :start | :stop
Link to this type

supported_capability()

View Source

Specs

supported_capability() :: %{
  capability_id: integer(),
  supported_property_ids: binary()
}

Specs

temperature_extreme() :: %{
  extreme: :highest | :lowest,
  temperature: AutoApi.UnitType.temperature()
}

Specs

time() :: %{hour: integer(), minute: integer()}

Specs

timer() :: %{
  timer_type: :preferred_start_time | :preferred_end_time | :departure_date,
  date: DateTime.t()
}

Specs

tire_pressure() :: %{
  location: location_wheel(),
  pressure: AutoApi.UnitType.pressure()
}
Link to this type

tire_pressure_status()

View Source

Specs

tire_pressure_status() :: %{
  location: location_wheel(),
  status: :normal | :low | :alert | :soft | :deflation
}

Specs

tire_temperature() :: %{
  location: location_wheel(),
  temperature: AutoApi.UnitType.temperature()
}

Specs

triggered() :: :not_triggered | :triggered

Specs

trip_meter() :: %{id: integer(), distance: AutoApi.UnitType.length()}

Specs

trouble_code() :: %{
  occurrences: integer(),
  id: String.t(),
  ecu_id: String.t(),
  status: String.t(),
  system: :unknown | :body | :chassis | :powertrain | :network
}

Specs

webhook() :: %{
  available: :unavailable | :available,
  event: AutoApi.Event.event()
}

Specs

weekday() ::
  :monday
  | :tuesday
  | :wednesday
  | :thursday
  | :friday
  | :saturday
  | :sunday
  | :automatic

Specs

weekday_time() :: %{weekday: weekday(), time: time()}

Specs

wheel_rpm() :: %{
  location: location_wheel(),
  rpm: AutoApi.UnitType.angular_velocity()
}

Specs

window_location() ::
  :front_left | :front_right | :rear_right | :rear_left | :hatch
Link to this type

window_open_percentage()

View Source

Specs

window_open_percentage() :: %{
  location: window_location(),
  open_percentage: percentage()
}

Specs

window_position() :: %{
  location: window_location(),
  position: :closed | :open | :intermediate
}

Specs

zone() :: %{horizontal: integer(), vertical: integer()}

Link to this section Functions