jlr

Documentation

Index

• Constants
• type API
  • func NewAPI(log *util.Logger, device string, ts oauth2.TokenSource) *API
  • func (v *API) AuthenticateVinService(vin, user, service string) (PinResponse, error)
  • func (v *API) ChargeAction(vin, user string, start bool) error
  • func (v *API) Position(vin string) (PositionResponse, error)
  • func (v *API) Status(vin string) (StatusResponse, error)
  • func (v *API) User(name string) (User, error)
  • func (v *API) Vehicles(user string) ([]string, error)
• type ActionResponse
• type Identity
  • func NewIdentity(log *util.Logger, user, password, device string) *Identity
  • func (v *Identity) Login() (Token, error)
  • func (v *Identity) RefreshToken(token *oauth2.Token) (*oauth2.Token, error)
• type KeyValue
• type KeyValueList
  • func (l KeyValueList) FloatVal(key string) (float64, error)
  • func (l KeyValueList) IntVal(key string) (int64, error)
  • func (l KeyValueList) StringVal(key string) (string, error)
• type PinResponse
• type PositionResponse
• type Provider
  • func NewProvider(api *API, vin, user string, cache time.Duration) *Provider
  • func (v *Provider) FinishTime() (time.Time, error)
  • func (v *Provider) Odometer() (float64, error)
  • func (v *Provider) Position() (float64, float64, error)
  • func (v *Provider) Range() (int64, error)
  • func (v *Provider) Soc() (float64, error)
  • func (v *Provider) StartCharge() error
  • func (v *Provider) Status() (api.ChargeStatus, error)
  • func (v *Provider) StopCharge() error
• type StatusResponse
• type Token
• type User
• type Vehicle
• type VehiclesResponse

Constants

const (
	IF9_BASE_URL  = "https://if9.prod-row.jlrmotor.com/if9/jlr"
	IFOP_BASE_URL = "https://ifop.prod-row.jlrmotor.com/ifop/jlr"
)

const IFAS_BASE_URL = "https://ifas.prod-row.jlrmotor.com/ifas/jlr"

Types

type API

type API struct {
	*request.Helper
}

API is the Jaguar/Landrover api client

func NewAPI

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

NewAPI creates a new api client

func (*API) AuthenticateVinService

func (v *API) AuthenticateVinService(vin, user, service string) (PinResponse, error)

func (*API) ChargeAction

func (v *API) ChargeAction(vin, user string, start bool) error

func (*API) Position

func (v *API) Position(vin string) (PositionResponse, error)

Position returns the vehicle position

func (*API) Status

func (v *API) Status(vin string) (StatusResponse, error)

Status returns the vehicle status

func (*API) User

func (v *API) User(name string) (User, error)

func (*API) Vehicles

func (v *API) Vehicles(user string) ([]string, error)

type ActionResponse

type ActionResponse struct {
	FailureDescription string
}

type Identity

type Identity struct {
	*request.Helper

	oauth2.TokenSource
	// contains filtered or unexported fields
}

func NewIdentity

func NewIdentity(log *util.Logger, user, password, device string) *Identity

NewIdentity creates Fiat identity

func (*Identity) Login

func (v *Identity) Login() (Token, error)

Login authenticates with username/password

func (*Identity) RefreshToken

func (v *Identity) RefreshToken(token *oauth2.Token) (*oauth2.Token, error)

RefreshToken implements oauth.TokenRefresher

type KeyValue

type KeyValue struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

type KeyValueList

type KeyValueList []KeyValue

func (KeyValueList) FloatVal

func (l KeyValueList) FloatVal(key string) (float64, error)

func (KeyValueList) IntVal

func (l KeyValueList) IntVal(key string) (int64, error)

func (KeyValueList) StringVal

func (l KeyValueList) StringVal(key string) (string, error)

type PinResponse

type PinResponse struct {
	Token string
}

type PositionResponse

type PositionResponse struct {
	Position struct {
		Latitude        float64
		Longitude       float64
		Timestamp       string
		Speed           float64
		Heading         float64
		PositionQuality interface{}
	}
}

type Provider

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

func NewProvider

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

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) Position

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

Position implements the api.VehiclePosition 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.Battery 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

type StatusResponse

type StatusResponse struct {
	VehicleStatus struct {
		CoreStatus KeyValueList
		EvStatus   KeyValueList
	}
}

type Token

type Token struct {
	AuthToken string `json:"authorization_token"`
	ExpiresIn int    `json:"expires_in,string"`
	oauth2.Token
}

type User

type User struct {
	HomeMarket string `json:"homeMarket"`
	UserId     string `json:"userId"`
}

type Vehicle

type Vehicle struct {
	UserId string `json:"userId"`
	VIN    string `json:"vin"`
	Role   string `json:"role"`
}

type VehiclesResponse

type VehiclesResponse struct {
	Vehicles []Vehicle
}