go-volvo's Introduction

Go-Volvo

A simple Go API client for Volvo's APIs

Very much work in progress. Hoping to create a small, simple API client for Go.

Getting Started

Get the Volvo Go API Client as a new module in your project:

go get github.com/jakeisonline/go-volvo

Import the package into your project:

import "github.com/jakeisonline/go-volvo/api"

Initialise a new API client:

client := api.NewClient("YourApiToken")
client.setAccessToken("YourAccessToken")

Now, make a call to an endpoint of your choice:

resp, err := client.Call("vehicles", "")
if err != nil {
  fmt.Print(err)
} else {
  body, err := io.ReadAll(resp.Body)
  if err != nil {
    fmt.Print(err)
  }
  defer resp.Body.Close()

  var response *api.VehiclesResponse
  api.UnmarshalAndCheck(body, &response)
  fmt.Println(response.Data)
}

Roadmap

Spec vs. Actual Responses

The official Volvo docs are great, and have been invaluable for this project. I have noted a few what appear to be errors in the documentation, however.

/connected-vehicle/v2/vehicles/{vin}/doors documents carLocked named object being returned, but actual object name is centralLock
/connected-vehicle/v2/vehicles/{vin}/statistics documents averageFuelConsumptionAutomatic and averageEnergyConsumptionAutomatic named objects, but these are seemingly never returned
/connected-vehicle/v2/vehicles/{vin}/vehicle documents interiorImageURL named object being returned, but actual object name is internalImageUrl
/connected-vehicle/v2/vehicles/{vin}/diagnostics documents serviceTrigger named object being returned, but this seemingly never returns. Additionally, washerFluidLevelWarning returns but is not documented
/connected-vehicle/v2/vehicles/{vin}/windows returns a sunroof objects, which is not documented

Recommend Projects