View Source PorscheConnEx.Struct.Vehicle (porsche_conn_ex v0.1.0)

Structure containing information about a vehicle attached to an API account.

This is the structure returned by PorscheConnEx.Client.vehicles/1.

Fields

  • vin (string) — the 17-character Vehicle Identification Number
  • pcc? (boolean) — (presumably?) whether the vehicle has the Porsche Car Connect service
  • relationship (string) — the user's relationship to the vehicle
    • only known value is "OWNER"
  • model_description (string) — the vehicle model description, e.g. "Taycan GTS"
  • model_type (string) — the internal code for the model, e.g. "Y1ADE1"
  • model_year (integer) — the vehicle model year
  • exterior_color (string) — the vehicle colour by name, e.g. "vulkangraumetallic/vulkangraumetallic"
  • exterior_color_hex (string) — the vehicle colour by its HTML RGB hex code
  • spin_enabled? (boolean) — unknown
  • login_method — (presumably?) how the vehicle logged in to the user's account
  • ota_active? — (presumably?) whether the vehicle is receiving over-the-air updates
  • attributes (map of string => string) — extra vehicle metadata
    • if the vehicle has a nickname set, this will appear as "licenseplate" => nickname
  • pending_relationship_termination_at (unknown) - nil for me, but likely a DateTime?

Summary

Types

@type t() :: %PorscheConnEx.Struct.Vehicle{
  attributes: %{optional(binary()) => binary()},
  exterior_color: binary(),
  exterior_color_hex: binary(),
  login_method: binary(),
  model_description: binary(),
  model_type: binary(),
  model_year: integer(),
  ota_active?: boolean(),
  pcc?: boolean(),
  pending_relationship_termination_at: any(),
  relationship: binary(),
  spin_enabled?: boolean(),
  valid_from: DateTime.t(),
  vin: binary()
}