id

package
v0.0.0-...-e05b1bb Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 19, 2023 License: MIT Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	ActionCharge         = "charging"
	ActionChargeStart    = "start"
	ActionChargeStop     = "stop"
	ActionChargeSettings = "settings" // body: targetSOC_pct

	ActionClimatisation      = "climatisation"
	ActionClimatisationStart = "start"
	ActionClimatisationStop  = "stop"
)

Actions and action values

View Source 
const BaseURL = "https://emea.bff.cariad.digital/vehicle/v1"

BaseURL is the API base url

View Source 
const LoginURL = cariad.BaseURL + "/user-login/v1/authorize"

Variables

View Source 
var AuthParams = url.Values{
	"response_type": {"code id_token token"},
	"client_id":     {"a24fba63-34b3-4d43-b181-942111e6bda8@apps_vw-dilab_com"},
	"redirect_uri":  {"weconnect://authenticated"},
	"scope":         {"openid profile badge cars vin"},
}

Functions

This section is empty.

Types

type API 

type API struct {
	*request.Helper
}

API is an api.Vehicle implementation for VW ID cars

func NewAPI 

func NewAPI(log *util.Logger, ts oauth2.TokenSource) *API

NewAPI creates a new vehicle

func (*API) Action 

func (v *API) Action(vin, action, value string) error

Action implements vehicle actions

func (*API) Any 

func (v *API) Any(uri, vin string) (interface{}, error)

Any implements any api response

func (*API) Status 

func (v *API) Status(vin string) (res Status, err error)

Status implements the /status response. It is callers responsibility to check for embedded (partial) errors.

func (*API) Vehicles 

func (v *API) Vehicles() ([]Vehicle, error)

Vehicles implements the /vehicles response

type EngineRangeStatus 

type EngineRangeStatus struct {
	Type             string `json:"type"`
	CurrentSOCPct    int    `json:"currentSOC_pct"`
	RemainingRangeKm int    `json:"remainingRange_km"`
}

EngineRangeStatus is the engine range status

type FuelStatus 

type FuelStatus struct {
	RangeStatus struct {
		Value struct {
			CarCapturedTimestamp Timestamp         `json:"carCapturedTimestamp"`
			CarType              string            `json:"carType"`
			PrimaryEngine        EngineRangeStatus `json:"primaryEngine"`
			SecondaryEngine      EngineRangeStatus `json:"secondaryEngine"`
			TotalRangeKm         int               `json:"totalRange_km"`
		} `json:"value"`
	} `json:"rangeStatus"`
}

FuelStatus is the engine range status

func (*FuelStatus) EngineRangeStatus 

func (f *FuelStatus) EngineRangeStatus(typ string) (EngineRangeStatus, error)

type Provider 

type Provider struct {
	// contains filtered or unexported fields
}

Provider is an api.Vehicle implementation for VW ID cars

func NewProvider 

func NewProvider(api *API, vin string, cache time.Duration) *Provider

NewProvider creates a vehicle api provider

func (*Provider) Climater 

func (v *Provider) Climater() (bool, error)

Climater implements the api.VehicleClimater interface

func (*Provider) FinishTime 

func (v *Provider) FinishTime() (time.Time, error)

FinishTime implements the api.VehicleFinishTimer interface

func (*Provider) Odometer 

func (v *Provider) Odometer() (float64, error)

Odometer implements the api.VehicleOdometer interface

func (*Provider) Range 

func (v *Provider) Range() (int64, error)

Range implements the api.VehicleRange interface

func (*Provider) Soc 

func (v *Provider) Soc() (float64, error)

Soc implements the api.Vehicle interface

func (*Provider) StartCharge 

func (v *Provider) StartCharge() error

StartCharge implements the api.VehicleChargeController interface

func (*Provider) Status 

func (v *Provider) Status() (api.ChargeStatus, error)

Status implements the api.ChargeState interface

func (*Provider) StopCharge 

func (v *Provider) StopCharge() error

StopCharge implements the api.VehicleChargeController interface

func (*Provider) TargetSoc 

func (v *Provider) TargetSoc() (float64, error)

TargetSoc implements the api.SocLimiter interface

func (*Provider) WakeUp 

func (v *Provider) WakeUp() error

WakeUp implements the api.Resurrector interface

type Status 

type Status struct {
	Access *struct {
		AccessStatus struct {
			Value struct {
				OverallStatus        string    `json:"overallStatus"`
				CarCapturedTimestamp Timestamp `json:"carCapturedTimestamp"`
				Doors                []struct {
					Name   string   `json:"name"`
					Status []string `json:"status"`
				} `json:"doors"`
				Windows []struct {
					Name   string   `json:"name"`
					Status []string `json:"status"`
				} `json:"windows"`
				DoorLockStatus string `json:"doorLockStatus"`
			} `json:"value"`
		} `json:"accessStatus"`
	} `json:"access"`
	Automation *struct {
		ClimatisationTimer struct {
			Value struct {
				Timers []struct {
					ID             int  `json:"id"`
					Enabled        bool `json:"enabled"`
					RecurringTimer struct {
						StartTime   string `json:"startTime"`
						RecurringOn struct {
							Mondays    bool `json:"mondays"`
							Tuesdays   bool `json:"tuesdays"`
							Wednesdays bool `json:"wednesdays"`
							Thursdays  bool `json:"thursdays"`
							Fridays    bool `json:"fridays"`
							Saturdays  bool `json:"saturdays"`
							Sundays    bool `json:"sundays"`
						} `json:"recurringOn"`
					} `json:"recurringTimer,omitempty"`
					SingleTimer struct {
						StartDateTime Timestamp `json:"startDateTime"`
					} `json:"singleTimer,omitempty"`
				} `json:"timers"`
				CarCapturedTimestamp Timestamp `json:"carCapturedTimestamp"`
				TimeInCar            string    `json:"timeInCar"`
			} `json:"value"`
		} `json:"climatisationTimer"`
		ChargingProfiles *struct {
			Value struct {
				CarCapturedTimestamp Timestamp     `json:"carCapturedTimestamp"`
				TimeInCar            string        `json:"timeInCar"`
				Profiles             []interface{} `json:"profiles"`
			} `json:"value"`
		} `json:"chargingProfiles"`
	} `json:"automation"`
	UserCapabilities *struct {
		CapabilitiesStatus struct {
			Value []struct {
				ID                   string    `json:"id"`
				UserDisablingAllowed bool      `json:"userDisablingAllowed"`
				ExpirationDate       Timestamp `json:"expirationDate,omitempty"`
				Status               []int     `json:"status,omitempty"`
			} `json:"value"`
		} `json:"capabilitiesStatus"`
	} `json:"userCapabilities"`
	Charging *struct {
		BatteryStatus struct {
			Value struct {
				CarCapturedTimestamp    Timestamp `json:"carCapturedTimestamp"`
				CurrentSOCPct           int       `json:"currentSOC_pct"`
				CruisingRangeElectricKm int       `json:"cruisingRangeElectric_km"`
			} `json:"value"`
		} `json:"batteryStatus"`
		ChargingStatus struct {
			Value struct {
				CarCapturedTimestamp               Timestamp `json:"carCapturedTimestamp"`
				RemainingChargingTimeToCompleteMin int       `json:"remainingChargingTimeToComplete_min"`
				ChargingState                      string    `json:"chargingState"` // readyForCharging/off
				ChargeMode                         string    `json:"chargeMode"`    // invalid
				ChargePowerKW                      float64   `json:"chargePower_kW"`
				ChargeRateKmph                     float64   `json:"chargeRate_kmph"`
				ChargeType                         string    `json:"chargeType"`
				ChargingSettings                   string    `json:"chargingSettings"`
			} `json:"value"`
		} `json:"chargingStatus"`
		ChargingSettings struct {
			Value struct {
				CarCapturedTimestamp        Timestamp `json:"carCapturedTimestamp"`
				MaxChargeCurrentAC          string    `json:"maxChargeCurrentAC"` // reduced, maximum
				AutoUnlockPlugWhenCharged   string    `json:"autoUnlockPlugWhenCharged"`
				AutoUnlockPlugWhenChargedAC string    `json:"autoUnlockPlugWhenChargedAC"`
				TargetSOCPct                int       `json:"targetSOC_pct"`
			} `json:"value"`
		} `json:"chargingSettings"`
		PlugStatus struct {
			Value struct {
				CarCapturedTimestamp Timestamp `json:"carCapturedTimestamp"`
				PlugConnectionState  string    `json:"plugConnectionState"` // connected, disconnected
				PlugLockState        string    `json:"plugLockState"`       // locked, unlocked
				ExternalPower        string    `json:"externalPower"`
				LedColor             string    `json:"ledColor"`
			} `json:"value"`
		} `json:"plugStatus"`
		ChargeMode struct {
			Value struct {
				PreferredChargeMode  string   `json:"preferredChargeMode"`
				AvailableChargeModes []string `json:"availableChargeModes"`
			} `json:"value"`
		} `json:"chargeMode"`
		ChargingCareSettings struct {
			Value struct {
				BatteryCareMode string `json:"batteryCareMode"`
			} `json:"value"`
		} `json:"chargingCareSettings"`
	} `json:"charging"`
	Climatisation *struct {
		ClimatisationStatus struct {
			Value struct {
				CarCapturedTimestamp          Timestamp `json:"carCapturedTimestamp"`
				RemainingClimatisationTimeMin int       `json:"remainingClimatisationTime_min"`
				ClimatisationState            string    `json:"climatisationState"` // off
			} `json:"value"`
		} `json:"climatisationStatus"` // may be temporarily not available
		ClimatisationSettings struct {
			Value struct {
				CarCapturedTimestamp  Timestamp `json:"carCapturedTimestamp"`
				TargetTemperatureC    float64   `json:"targetTemperature_C"`
				TargetTemperatureF    float64   `json:"targetTemperature_F"`
				UnitInCar             string    `json:"unitInCar"`
				ClimatizationAtUnlock bool      `json:"climatizationAtUnlock"` // ClimatizationAtUnlock?
				WindowHeatingEnabled  bool      `json:"windowHeatingEnabled"`
				ZoneFrontLeftEnabled  bool      `json:"zoneFrontLeftEnabled"`
				ZoneFrontRightEnabled bool      `json:"zoneFrontRightEnabled"`
			} `json:"value"`
		} `json:"climatisationSettings"`
		WindowHeatingStatus struct {
			Value struct {
				CarCapturedTimestamp Timestamp `json:"carCapturedTimestamp"`
				WindowHeatingStatus  []struct {
					WindowLocation     string `json:"windowLocation"`
					WindowHeatingState string `json:"windowHeatingState"`
				} `json:"windowHeatingStatus"`
			} `json:"value"`
		} `json:"windowHeatingStatus"`
	} `json:"climatisation"`
	ClimatisationTimers *struct {
		ClimatisationTimersStatus struct {
			Value struct {
				Timers []struct {
					ID             int  `json:"id"`
					Enabled        bool `json:"enabled"`
					RecurringTimer struct {
						StartTime   string `json:"startTime"`
						RecurringOn struct {
							Mondays    bool `json:"mondays"`
							Tuesdays   bool `json:"tuesdays"`
							Wednesdays bool `json:"wednesdays"`
							Thursdays  bool `json:"thursdays"`
							Fridays    bool `json:"fridays"`
							Saturdays  bool `json:"saturdays"`
							Sundays    bool `json:"sundays"`
						} `json:"recurringOn"`
					} `json:"recurringTimer,omitempty"`
					SingleTimer struct {
						StartDateTime Timestamp `json:"startDateTime"`
					} `json:"singleTimer"`
				} `json:"timers"`
				CarCapturedTimestamp Timestamp `json:"carCapturedTimestamp"`
				TimeInCar            string    `json:"timeInCar"`
			} `json:"value"`
		} `json:"climatisationTimersStatus"`
	} `json:"climatisationTimers"`
	VehicleLights *struct {
		LightsStatus struct {
			Value struct {
				CarCapturedTimestamp Timestamp `json:"carCapturedTimestamp"`
				Lights               []struct {
					Name   string `json:"name"`
					Status string `json:"status"`
				} `json:"lights"`
			} `json:"value"`
		} `json:"lightsStatus"`
	} `json:"vehicleLights"`
	Measurements *struct {
		RangeStatus struct {
			Value struct {
				CarCapturedTimestamp Timestamp `json:"carCapturedTimestamp"`
				ElectricRange        float64   `json:"electricRange"`
			} `json:"value"`
		} `json:"rangeStatus"`
		OdometerStatus struct {
			Value struct {
				CarCapturedTimestamp Timestamp `json:"carCapturedTimestamp"`
				Odometer             float64   `json:"odometer"`
			} `json:"value"`
		} `json:"odometerStatus"`
	} `json:"measurements"`
	FuelStatus *FuelStatus `json:"fuelStatus"`
	Readiness  *struct {
		ReadinessStatus struct {
			Value struct {
				ConnectionState struct {
					IsOnline                  bool   `json:"isOnline"`
					IsActive                  bool   `json:"isActive"`
					BatteryPowerLevel         string `json:"batteryPowerLevel"`
					DailyPowerBudgetAvailable bool   `json:"dailyPowerBudgetAvailable"`
				} `json:"connectionState"`
				ConnectionWarning struct {
					InsufficientBatteryLevelWarning bool `json:"insufficientBatteryLevelWarning"`
					DailyPowerBudgetWarning         bool `json:"dailyPowerBudgetWarning"`
				} `json:"connectionWarning"`
			} `json:"value"`
		} `json:"readinessStatus"`
	} `json:"readiness"`
	VehicleHealthWarnings *struct {
		WarningLights struct {
			Value struct {
				CarCapturedTimestamp Timestamp     `json:"carCapturedTimestamp"`
				MileageKm            int           `json:"mileage_km"`
				WarningLights        []interface{} `json:"warningLights"`
			} `json:"value"`
		} `json:"warningLights"`
	} `json:"vehicleHealthWarnings"`
	ChargingTimers *struct {
		ChargingTimersStatus struct {
			Value struct {
				CarCapturedTimestamp Timestamp `json:"carCapturedTimestamp"`
				TimeInCar            string    `json:"timeInCar"`
				Timers               []struct {
					ID             int  `json:"id"`
					Enabled        bool `json:"enabled"`
					Climatisation  bool `json:"climatisation"`
					RecurringTimer struct {
						DepartureTime  string   `json:"departureTime"`
						RepetitionDays []string `json:"repetitionDays"`
					} `json:"recurringTimer"`
				} `json:"timers"`
			} `json:"value"`
		} `json:"chargingTimersStatus"`
	} `json:"chargingTimers"`
	ChargingProfiles *struct {
		ChargingProfilesStatus struct {
			Value struct {
				CarCapturedTimestamp Timestamp `json:"carCapturedTimestamp"`
				TimeInCar            string    `json:"timeInCar"`
				Profiles             []struct {
					ID                 int    `json:"id"`
					Name               string `json:"name"`
					MaxChargingCurrent string `json:"maxChargingCurrent"`
					MinSOCPct          int    `json:"minSOC_pct"`
					TargetSOCPct       int    `json:"targetSOC_pct"`
					Options            struct {
						AutoUnlockPlugWhenCharged string `json:"autoUnlockPlugWhenCharged"`
					} `json:"options"`
					PreferredChargingTimes []struct {
						ID        int    `json:"id"`
						Enabled   bool   `json:"enabled"`
						StartTime string `json:"startTime"`
						EndTime   string `json:"endTime"`
					} `json:"preferredChargingTimes"`
					Timers        []interface{} `json:"timers"`
					MinSOCEnabled bool          `json:"minSOC_enabled"`
				} `json:"profiles"`
			} `json:"value"`
		} `json:"chargingProfilesStatus"`
	} `json:"chargingProfiles"`
}

Status is the /status api

type Timestamp 

type Timestamp struct {
	time.Time
}

Timestamp implements JSON unmarshal

func (*Timestamp) UnmarshalJSON 

func (ct *Timestamp) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes string timestamp into time.Time

type Vehicle 

type Vehicle struct {
	VIN      string
	Model    string
	Nickname string
}

Vehicle is the api vehicle

type Vehicles 

type Vehicles struct {
	Data []Vehicle
}

Vehicles is the /vehicles api

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.