Subaru Solterra vehicle integration

Author: Valeriano Manassero

templates/definition/vehicle/subaru.yaml

@@ -0,0 +1,26 @@
+template: subaru
+products:
+  - brand: Subaru
+requirements:
+  description:
+    de: |
+      Benötigt Subaru Connected Services Account.
+    en: |
+      Requires Subaru Connected Services Account.
+params:
+  - preset: vehicle-common
+  - name: user
+    required: true
+  - name: password
+    required: true
+  - name: vin
+    example: JF...
+  - name: cache
+    default: 15m
+render: |
+  type: subaru
+  {{ include "vehicle-common" . }}
+  user: {{ .user }}
+  password: {{ .password }}
+  vin: {{ .vin }}
+  cache: {{ .cache }}

vehicle/subaru.go

@@ -0,0 +1,60 @@
+package vehicle
+
+import (
+	"fmt"
+	"time"
+
+	"github.com/evcc-io/evcc/api"
+	"github.com/evcc-io/evcc/util"
+	"github.com/evcc-io/evcc/vehicle/subaru"
+)
+
+// Subaru is an api.Vehicle implementation for Subaru cars
+type Subaru struct {
+	*embed
+	*subaru.Provider
+}
+
+func init() {
+	registry.Add("subaru", NewSubaruFromConfig)
+}
+
+// NewSubaruFromConfig creates a new vehicle
+func NewSubaruFromConfig(other map[string]interface{}) (api.Vehicle, error) {
+	cc := struct {
+		embed               `mapstructure:",squash"`
+		User, Password, VIN string
+		Cache               time.Duration
+	}{
+		Cache: interval,
+	}
+
+	if err := util.DecodeOther(other, &cc); err != nil {
+		return nil, err
+	}
+
+	if cc.User == "" || cc.Password == "" {
+		return nil, api.ErrMissingCredentials
+	}
+
+	v := &Subaru{
+		embed: &cc.embed,
+	}
+
+	log := util.NewLogger("subaru").Redact(cc.User, cc.Password, cc.VIN)
+	identity := subaru.NewIdentity(log)
+
+	err := identity.Login(cc.User, cc.Password)
+	if err != nil {
+		return v, fmt.Errorf("login failed: %w", err)
+	}
+
+	api := subaru.NewAPI(log, identity)
+
+	cc.VIN, err = ensureVehicle(cc.VIN, api.Vehicles)
+	if err == nil {
+		v.Provider = subaru.NewProvider(api, cc.VIN, cc.Cache)
+	}
+
+	return v, err
+}

vehicle/subaru/api.go

@@ -0,0 +1,96 @@
+package subaru
+
+import (
+	"crypto/hmac"
+	"crypto/sha256"
+	"encoding/hex"
+	"fmt"
+	"net/http"
+	"time"
+
+	"github.com/evcc-io/evcc/util"
+	"github.com/evcc-io/evcc/util/request"
+	"golang.org/x/oauth2"
+)
+
+const (
+	BaseUrl                  = "https://b2c-login.toyota-europe.com"
+	ApiBaseUrl               = "https://ctpa-oneapi.tceu-ctp-prd.toyotaconnectedeurope.io"
+	AccessTokenPath          = "oauth2/realms/root/realms/alliance-subaru/access_token"
+	AuthenticationPath       = "json/realms/root/realms/alliance-subaru/authenticate?authIndexType=service&authIndexValue=oneapp"
+	AuthorizationPath        = "oauth2/realms/root/realms/alliance-subaru/authorize?client_id=8c4921b0b08901fef389ce1af49c4e10.subaru.com&scope=openid+profile+write&response_type=code&redirect_uri=com.subaru.oneapp:/oauth2Callback&code_challenge=plain&code_challenge_method=plain"
+	VehicleGuidPath          = "v2/vehicle/guid"
+	RemoteElectricStatusPath = "v1/global/remote/electric/status"
+	ApiKey                   = "tTZipv6liF74PwMfk9Ed68AQ0bISswwf3iHQdqcF"
+	ClientRefKey             = "2.17.0"
+)
+
+type API struct {
+	*request.Helper
+	log       *util.Logger
+	identity  *Identity
+	clientRef string
+}
+
+func NewAPI(log *util.Logger, identity *Identity) *API {
+	v := &API{
+		Helper:   request.NewHelper(log),
+		log:      log,
+		identity: identity,
+	}
+
+	v.Timeout = 120 * time.Second
+
+	// replace client transport with authenticated transport
+	v.Transport = &oauth2.Transport{
+		Source: identity,
+		Base:   v.Transport,
+	}
+
+	// create HMAC digest for x-client-ref header
+	h := hmac.New(sha256.New, []byte(ClientRefKey))
+	h.Write([]byte(v.identity.uuid))
+	v.clientRef = hex.EncodeToString(h.Sum(nil))
+
+	return v
+}
+
+func (v *API) Vehicles() ([]string, error) {
+	uri := fmt.Sprintf("%s/%s", ApiBaseUrl, VehicleGuidPath)
+
+	req, err := request.New(http.MethodGet, uri, nil, map[string]string{
+		"Accept":       request.JSONContent,
+		"x-guid":       v.identity.uuid,
+		"x-api-key":    ApiKey,
+		"x-client-ref": v.clientRef,
+		"x-appversion": ClientRefKey,
+		"X-Appbrand":   "S",
+	})
+	var resp Vehicles
+	if err == nil {
+		err = v.DoJSON(req, &resp)
+	}
+	var vehicles []string
+	for _, v := range resp.Payload {
+		vehicles = append(vehicles, v.VIN)
+	}
+	return vehicles, err
+}
+
+func (v *API) Status(vin string) (Status, error) {
+	uri := fmt.Sprintf("%s/%s", ApiBaseUrl, RemoteElectricStatusPath)
+
+	req, err := request.New(http.MethodGet, uri, nil, map[string]string{
+		"Accept":       request.JSONContent,
+		"x-guid":       v.identity.uuid,
+		"x-api-key":    ApiKey,
+		"x-client-ref": v.clientRef,
+		"x-appversion": ClientRefKey,
+		"vin":          vin,
+	})
+	var status Status
+	if err == nil {
+		err = v.DoJSON(req, &status)
+	}
+	return status, err
+}

vehicle/subaru/api_test.go

@@ -0,0 +1,48 @@
+//go:build integration
+// +build integration
+
+package subaru
+
+import (
+	"fmt"
+	"os"
+	"testing"
+
+	"github.com/evcc-io/evcc/util"
+	"github.com/stretchr/testify/require"
+)
+
+func TestAPI(t *testing.T) {
+	// Skip if no credentials provided
+	user := os.Getenv("SUBARU_USER")
+	password := os.Getenv("SUBARU_PASSWORD")
+	if user == "" || password == "" {
+		t.Skip("SUBARU_USER or SUBARU_PASSWORD not set")
+	}
+
+	// Create and login identity
+	util.LogLevel("trace", nil) // Enable trace logging
+	log := util.NewLogger("test")
+	identity := NewIdentity(log)
+	err := identity.Login(user, password)
+	require.NoError(t, err)
+
+	// Create API client
+	api := NewAPI(log, identity)
+
+	// Test Vehicles method
+	vehicles, err := api.Vehicles()
+	require.NoError(t, err)
+	fmt.Printf("Vehicles: %+v\n", vehicles)
+	require.NotEmpty(t, vehicles, "expected at least one vehicle")
+
+	for _, vin := range vehicles {
+		require.NotEmpty(t, vin, "expected non-empty VIN")
+	}
+
+	// Test Status method for first vehicle
+	status, err := api.Status(vehicles[0])
+	require.NoError(t, err)
+	require.NotNil(t, status)
+	fmt.Printf("Vehicle status: %+v\n", status)
+}