AutoApi.UsageState (auto_api v13.2.0) View Source
Usage state
Link to this section Summary
Functions
Callback implementation for AutoApi.State.base/0
.
Build state based on binary value
Convenience function to build the State properties.
Parse state to bin
Link to this section Types
Specs
brand() :: :unknown | :abarth | :alfaromeo | :alpine | :audi | :bmw | :cadillac | :chevrolet | :chrysler | :citroen | :cupra | :dacia | :dodge | :ds | :fiat | :ford | :honda | :hyundai | :iveco | :jaguar | :jeep | :kia | :lancia | :land_rover | :lexus | :man | :mazda | :mercedes_benz | :mini | :mitsubishi | :nissan | :opel | :peugeot | :porsche | :renault | :seat | :skoda | :smart | :subaru | :toyota | :volkswagen | :volvo_cars | :emulator
Specs
last_trip_date() :: DateTime.t()
Specs
nonce() :: binary()
Specs
t() :: %AutoApi.UsageState{ acceleration_durations: AutoApi.State.multiple_property(AutoApi.CustomType.acceleration_duration()), acceleration_evaluation: AutoApi.State.property(AutoApi.CustomType.percentage()), average_fuel_consumption: AutoApi.State.property(AutoApi.UnitType.fuel_efficiency()), average_speed: AutoApi.State.property(AutoApi.UnitType.speed()), average_speed_last_trip: AutoApi.State.property(AutoApi.UnitType.speed()), average_speed_since_reset: AutoApi.State.property(AutoApi.UnitType.speed()), average_weekly_distance: AutoApi.State.property(AutoApi.UnitType.length()), average_weekly_distance_long_run: AutoApi.State.property(AutoApi.UnitType.length()), braking_evaluation: AutoApi.State.property(AutoApi.CustomType.percentage()), brand: AutoApi.State.property( :unknown | :abarth | :alfaromeo | :alpine | :audi | :bmw | :cadillac | :chevrolet | :chrysler | :citroen | :cupra | :dacia | :dodge | :ds | :fiat | :ford | :honda | :hyundai | :iveco | :jaguar | :jeep | :kia | :lancia | :land_rover | :lexus | :man | :mazda | :mercedes_benz | :mini | :mitsubishi | :nissan | :opel | :peugeot | :porsche | :renault | :seat | :skoda | :smart | :subaru | :toyota | :volkswagen | :volvo_cars | :emulator ), current_fuel_consumption: AutoApi.State.property(AutoApi.UnitType.fuel_efficiency()), distance_over_time: AutoApi.State.property(AutoApi.CustomType.distance_over_time()), driving_duration_last_trip: AutoApi.State.property(AutoApi.UnitType.duration()), driving_duration_since_reset: AutoApi.State.property(AutoApi.UnitType.duration()), driving_modes_activation_periods: AutoApi.State.multiple_property( AutoApi.CustomType.driving_mode_activation_period() ), driving_modes_energy_consumptions: AutoApi.State.multiple_property( AutoApi.CustomType.driving_mode_energy_consumption() ), driving_style_evaluation: AutoApi.State.property(AutoApi.CustomType.percentage()), eco_score_bonus_range: AutoApi.State.property(AutoApi.UnitType.length()), eco_score_constant: AutoApi.State.property(AutoApi.CustomType.percentage()), eco_score_free_wheel: AutoApi.State.property(AutoApi.CustomType.percentage()), eco_score_total: AutoApi.State.property(AutoApi.CustomType.percentage()), electric_consumption_average: AutoApi.State.property(AutoApi.UnitType.energy_efficiency()), electric_consumption_rate_since_reset: AutoApi.State.property(AutoApi.UnitType.energy_efficiency()), electric_consumption_rate_since_start: AutoApi.State.property(AutoApi.UnitType.energy_efficiency()), electric_distance_last_trip: AutoApi.State.property(AutoApi.UnitType.length()), electric_distance_since_reset: AutoApi.State.property(AutoApi.UnitType.length()), electric_duration_last_trip: AutoApi.State.property(AutoApi.UnitType.duration()), electric_duration_since_reset: AutoApi.State.property(AutoApi.UnitType.duration()), fuel_consumption_rate_last_trip: AutoApi.State.property(AutoApi.UnitType.fuel_efficiency()), fuel_consumption_rate_since_reset: AutoApi.State.property(AutoApi.UnitType.fuel_efficiency()), fuel_distance_last_trip: AutoApi.State.property(AutoApi.UnitType.length()), fuel_distance_since_reset: AutoApi.State.property(AutoApi.UnitType.length()), last_trip_average_energy_recuperation: AutoApi.State.property(AutoApi.UnitType.energy_efficiency()), last_trip_battery_remaining: AutoApi.State.property(AutoApi.CustomType.percentage()), last_trip_date: AutoApi.State.property(DateTime.t()), last_trip_electric_portion: AutoApi.State.property(AutoApi.CustomType.percentage()), last_trip_energy_consumption: AutoApi.State.property(AutoApi.UnitType.energy()), last_trip_fuel_consumption: AutoApi.State.property(AutoApi.UnitType.volume()), late_night_grade: AutoApi.State.property(AutoApi.CustomType.grade()), mileage_after_last_trip: AutoApi.State.property(AutoApi.UnitType.length()), nonce: AutoApi.State.property(binary()), odometer_after_last_trip: AutoApi.State.property(AutoApi.UnitType.length()), rapid_acceleration_grade: AutoApi.State.property(AutoApi.CustomType.grade()), rapid_deceleration_grade: AutoApi.State.property(AutoApi.CustomType.grade()), recuperation_power: AutoApi.State.property(AutoApi.UnitType.power()), safety_driving_score: AutoApi.State.property(AutoApi.CustomType.percentage()), timestamp: AutoApi.State.property(DateTime.t()), trip_meters: AutoApi.State.multiple_property(AutoApi.CustomType.trip_meter()), vehicle_signature: AutoApi.State.property(binary()), vin: AutoApi.State.property(String.t()) }
Specs
timestamp() :: DateTime.t()
Specs
vehicle_signature() :: binary()
Specs
vin() :: String.t()
Link to this section Functions
Specs
base() :: t()
Callback implementation for AutoApi.State.base/0
.
Specs
Build state based on binary value
iex> bin = <<17, 0, 11, 1, 0, 8, 63, 229, 112, 163, 215, 10, 61, 113>> iex> AutoApi.UsageState.from_bin(bin) %AutoApi.UsageState{safety_driving_score: %AutoApi.Property{data: 0.67}}
Specs
Convenience function to build the State properties.
See AutoApi.State.put/3
.
Examples
iex> state_base = AutoApi.DiagnosticsState.base()
iex> odometer = %{value: 10_921, unit: :kilometers}
iex> state_1 = AutoApi.DiagnosticsState.put(state_base, :odometer, data: odometer)
iex> state_2 = AutoApi.State.put(state_base, :odometer, data: odometer)
iex> state_1 === state_2
true
Specs
Parse state to bin
iex> state = %AutoApi.UsageState{safety_driving_score: %AutoApi.Property{data: 0.67}} iex> AutoApi.UsageState.to_bin(state) <<17, 0, 11, 1, 0, 8, 63, 229, 112, 163, 215, 10, 61, 113>>