Bug fixes, missing commands and endpoints

README.md

@@ -1,12 +1,13 @@
 # TeslaBleHttpProxy
 
-TeslaBleHttpProxy is a program written in Go that receives HTTP requests and forwards them via Bluetooth to a Tesla vehicle. The program can, for example, be easily used together with [evcc](/~https://github.com/evcc-io/evcc).
+TeslaBleHttpProxy is a program written in Go that receives HTTP requests and forwards them via Bluetooth to a Tesla vehicle. The program can, for example, be easily used together with [evcc](/~https://github.com/evcc-io/evcc) or [TeslaBle2Mqtt](/~https://github.com/Lenart12/TeslaBle2Mqtt).
 
 The program stores the received requests in a queue and processes them one by one. This ensures that only one Bluetooth connection to the vehicle is established at a time.
 
 ## Table of Contents
 
 - [How to install](#how-to-install)
+  - [Home assistant addon](#home-assistant-addon)
   - [Docker compose](#docker-compose)
   - [Build yourself](#build-yourself)
 - [Generate key for vehicle](#generate-key-for-vehicle)
@@ -18,7 +19,14 @@ The program stores the received requests in a queue and processes them one by on
 
 ## How to install
 
-You can either compile and use the Go program yourself or install it in a Docker container. ([detailed instruction](docs/installation.md))
+You can either compile and use the Go program yourself or install it as a Home assistant addon or in a Docker container. ([detailed instruction](docs/installation.md))
+
+### Home assistant addon
+
+This proxy is availabile in the [TeslaBle2Mqtt-addon](/~https://github.com/Lenart12/TeslaBle2Mqtt-addon) repository, included as part of `TeslaBle2Mqtt` addon or as a standalone `TeslaBleHttpProxy` addon.
+
+[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=/~https://github.com/Lenart12/TeslaBle2Mqtt-addon)
+
 
 ### Docker compose
 
@@ -30,7 +38,7 @@ services:
     image: wimaha/tesla-ble-http-proxy
     container_name: tesla-ble-http-proxy
     environment:
-      - cacheMaxAge=30 # Optional, but recommended to set this to anything more than 0 if you are using the vehicle data
+      - cacheMaxAge=5 # Optional, but recommended to set this to anything more than 0 if you are using the vehicle data
     volumes:
       - ~/TeslaBleHttpProxy/key:/key
       - /var/run/dbus:/var/run/dbus
@@ -54,7 +62,29 @@ Download the code and save it in a folder named 'TeslaBleHttpProxy'. From there,
 
 ```
 go build .
-./TeslaBleHttpProxy
+./TeslaBleHttpProxy -h
+usage: TeslaBleHttpProxy [-h|--help] [-l|--logLevel "<value>"]
+                         [-b|--httpListenAddress "<value>"] [-s|--scanTimeout
+                         <integer>] [-c|--cacheMaxAge <integer>] [-k|--keys
+                         "<value>"] [-d|--dashboardBaseUrl "<value>"]
+                         [-a|--apiBaseUrl "<value>"]
+
+                         Proxy for Tesla BLE commands over HTTP
+
+Arguments:
+
+  -h  --help               Print help information
+  -l  --logLevel           Log level (DEBUG, INFO, WARN, ERROR, FATAL).
+                           Default: INFO
+  -b  --httpListenAddress  HTTP bind address. Default: :8080
+  -s  --scanTimeout        Time in seconds to scan for BLE beacons during
+                           device scan (0 = max). Default: 1
+  -c  --cacheMaxAge        Time in seconds for Cache-Control header (0 = no
+                           cache). Default: 5
+  -k  --keys               Path to public and private keys. Default: key
+  -d  --dashboardBaseUrl   Base URL for dashboard (Useful if the proxy is
+                           behind a reverse proxy). Default: 
+  -a  --apiBaseUrl         Base URL for proxying API commands. Default: 
 ```
 
 Please remember to create an empty folder called `key` where the keys can be stored later.
@@ -120,24 +150,9 @@ If you want to use this proxy only for commands, and not for vehicle data, you c
 
 ### Vehicle Commands
 
-The program uses the same interfaces as the Tesla [Fleet API](https://developer.tesla.com/docs/fleet-api#vehicle-commands). Currently, the following requests are supported: 
-
-- wake_up
-- charge_start
-- charge_stop
-- set_charging_amps
-- set_charge_limit
-- auto_conditioning_start
-- auto_conditioning_stop
-- charge_port_door_open
-- charge_port_door_close
-- flash_lights
-- honk_horn
-- door_lock
-- door_unlock
-- set_sentry_mode
-
-By default, the program will return immediately after sending the command to the vehicle. If you want to wait for the command to complete, you can set the `wait` parameter to `true`.
+The program uses the same interfaces as the Tesla [Fleet API](https://developer.tesla.com/docs/fleet-api#vehicle-commands). Currently, most commands are supported.
+
+By default, the program will return immediately after sending the command to the vehicle. If you want to wait for the command to complete, you can set the `wait` parameter to `true` (`charge_start?wait=true`).
 
 #### Example Request
 
@@ -177,20 +192,56 @@ If you want to receive specific data, you can add the endpoints to the request.
 
 This is recommended if you want to receive data frequently, since it will reduce the time it takes to receive the data.
 
+All of the supported endpoints are:
+- charge_schedule_data
+- charge_state
+- climate_state
+- closures_state
+- drive_state
+- location_data
+- media_detail
+- media
+- parental_controls
+- preconditioning_schedule_data
+- software_update
+- tire_pressure
+
 ### Body Controller State
 
 The body controller state is fetched from the vehicle and returnes the state of the body controller. The request does not wake up the vehicle. The following information is returned:
-
-- `vehicleLockState`
+- `closure_statuses`	
+  - `charge_port`
+    - `CLOSURESTATE_CLOSED`
+    - `CLOSURESTATE_OPEN`
+    - `CLOSURESTATE_AJAR`
+    - `CLOSURESTATE_UNKNOWN`
+    - `CLOSURESTATE_FAILED_UNLATCH`
+    - `CLOSURESTATE_OPENING`
+    - `CLOSURESTATE_CLOSING`
+  - `front_driver_door`
+    - ...
+  - `front_passenger_door`
+    - ...
+  - `front_trunk`
+    - ...
+  - `rear_driver_door`
+    - ...
+  - `rear_passenger_door`
+    - ...
+  - `rear_trunk`
+    - ...
+  - `tonneau`
+    - ...
+- `vehicle_lock_state`
   - `VEHICLELOCKSTATE_UNLOCKED`
   - `VEHICLELOCKSTATE_LOCKED`
   - `VEHICLELOCKSTATE_INTERNAL_LOCKED`
   - `VEHICLELOCKSTATE_SELECTIVE_UNLOCKED`
-- `vehicleSleepStatus`
+- `vehicle_sleep_status`
   - `VEHICLE_SLEEP_STATUS_UNKNOWN`
   - `VEHICLE_SLEEP_STATUS_AWAKE`
   - `VEHICLE_SLEEP_STATUS_ASLEEP`
-- `userPresence`
+- `user_presence`
   - `VEHICLE_USER_PRESENCE_UNKNOWN`
   - `VEHICLE_USER_PRESENCE_NOT_PRESENT`
   - `VEHICLE_USER_PRESENCE_PRESENT`
@@ -200,4 +251,14 @@ The body controller state is fetched from the vehicle and returnes the state of
 *(All requests with method GET.)*
 
 Get body controller state:
-`http://localhost:8080/api/1/vehicles/{VIN}/body_controller_state`
+`http://localhost:8080/api/proxy/1/vehicles/{VIN}/body_controller_state`
+
+### Connection status
+
+Get BLE connection status of the vehicle
+`GET http://localhost:8080/api/proxy/1/vehicles/LRWYGCFSXPC882647/connection_status`
+- `address`
+- `connectable`
+- `local_name`
+- `operated`
+- `rssi`

config/config.go

@@ -1,9 +1,11 @@
 package config
 
 import (
+	"fmt"
+	"net/url"
 	"os"
-	"strconv"
 
+	"github.com/akamensky/argparse"
 	"github.com/charmbracelet/log"
 )
 
@@ -13,41 +15,74 @@ var PrivateKeyFile = "key/private.pem"
 type Config struct {
 	LogLevel          string
 	HttpListenAddress string
-	CacheMaxAge       int // Seconds to cache BLE responses
+	ScanTimeout       int    // Seconds to scan for BLE beacons during device scan (0 = max)
+	CacheMaxAge       int    // Seconds to cache BLE responses
+	DashboardBaseURL  string // Base URL for proxying dashboard (Useful if the proxy is behind a reverse proxy)
+	ApiBaseUrl        string // Base URL for proxying BLE commands (Useful if the proxy is behind a reverse proxy)
 }
 
 var AppConfig *Config
 
 func LoadConfig() *Config {
-	envLogLevel := os.Getenv("logLevel")
-	if envLogLevel == "debug" {
-		log.SetLevel(log.DebugLevel)
-		log.Debug("LogLevel set to debug")
+	parser := argparse.NewParser("TeslaBleHttpProxy", "Proxy for Tesla BLE commands over HTTP")
+	logLevel := parser.String("l", "logLevel", &argparse.Options{Help: "Log level (DEBUG, INFO, WARN, ERROR, FATAL)", Default: "INFO", Validate: func(args []string) error {
+		if _, err := log.ParseLevel(args[0]); err != nil {
+			return err
+		}
+		return nil
+	}})
+	httpListenAddress := parser.String("b", "httpListenAddress", &argparse.Options{Help: "HTTP bind address", Default: ":8080", Validate: func(args []string) error {
+		// Check if the proxy host is a valid URL
+		url, err := url.Parse(fmt.Sprintf("//%s", args[0]))
+		if err != nil {
+			return fmt.Errorf("invalid bind address (%s)", err)
+		}
+		if url.Path != "" {
+			return fmt.Errorf("bind address must not contain a path or scheme")
+		}
+		return nil
+	}})
+	scanTimeout := parser.Int("s", "scanTimeout", &argparse.Options{Help: "Time in seconds to scan for BLE beacons during device scan (0 = max)", Default: 1})
+	cacheMaxAge := parser.Int("c", "cacheMaxAge", &argparse.Options{Help: "Time in seconds for Cache-Control header (0 = no cache)", Default: 5})
+	keys := parser.String("k", "keys", &argparse.Options{Help: "Path to public and private keys", Default: "key", Validate: func(args []string) error {
+		f, err := os.Stat(args[0])
+		if err != nil {
+			return fmt.Errorf("failed to find keys directory (%s)", err)
+		}
+		if !f.IsDir() {
+			return fmt.Errorf("keys is not a directory")
+		}
+		return nil
+	}})
+	dashboardBaseUrl := parser.String("d", "dashboardBaseUrl", &argparse.Options{Help: "Base URL for dashboard (Useful if the proxy is behind a reverse proxy)", Default: ""})
+	apiBaseUrl := parser.String("a", "apiBaseUrl", &argparse.Options{Help: "Base URL for proxying API commands", Default: ""})
+	// Inject environment variables as command line arguments
+	args := os.Args
+	for _, arg := range parser.GetArgs() {
+		if arg.GetPositional() || arg.GetLname() == "help" {
+			continue
+		}
+		osArg := os.Getenv(arg.GetLname())
+		if osArg != "" {
+			args = append(args, fmt.Sprintf("--%s=%s", arg.GetLname(), osArg))
+		}
 	}
-	if envLogLevel == "" {
-		envLogLevel = "info"
-	}
-
-	addr := os.Getenv("httpListenAddress")
-	if addr == "" {
-		addr = ":8080"
-	}
-	log.Info("TeslaBleHttpProxy", "httpListenAddress", addr)
 
-	cacheMaxAge := os.Getenv("cacheMaxAge")
-	if cacheMaxAge == "" {
-		cacheMaxAge = "0" // default value
-	}
-	cacheMaxAgeInt, err := strconv.Atoi(cacheMaxAge)
+	err := parser.Parse(args)
 	if err != nil {
-		log.Error("Invalid cacheMaxAge value, using default (0)", "error", err)
-		cacheMaxAgeInt = 0
+		log.Fatal("Failed to parse arguments", "error", err)
 	}
 
+	PublicKeyFile = fmt.Sprintf("%s/public.pem", *keys)
+	PrivateKeyFile = fmt.Sprintf("%s/private.pem", *keys)
+
 	return &Config{
-		LogLevel:          envLogLevel,
-		HttpListenAddress: addr,
-		CacheMaxAge:       cacheMaxAgeInt,
+		LogLevel:          *logLevel,
+		HttpListenAddress: *httpListenAddress,
+		ScanTimeout:       *scanTimeout,
+		CacheMaxAge:       *cacheMaxAge,
+		DashboardBaseURL:  *dashboardBaseUrl,
+		ApiBaseUrl:        *apiBaseUrl,
 	}
 }
 

docs/environment_variables.md

@@ -4,16 +4,32 @@ You can optionally set environment variables to override the default behavior.
 
 ## logLevel
 
-This is the log level. Options: debug (Default: info)
+This is the log level. Options: debug (Default: INFO)
 
 ## cacheMaxAge
 
-This is the number of seconds to cache the BLE responses for vehicle data and body controller state. If set to 0, the cache is disabled. (Default: 0)
+This is the value that will be set in Cache-Control header for vehicle data and body controller state responses. If set to 0, the cache is disabled. (Default: 5)
 
 ## httpListenAddress
 
 This is the address and port to listen for HTTP requests. (Default: :8080)
 
+## keys
+
+Path to public and private keys. (Default: key)
+
+## dashboardBaseUrl
+
+Base URL for dashboard (Useful if the proxy is behind a reverse proxy). (Default: empty)  
+
+## apiBaseUrl
+
+Base URL for proxying API commands. (Default: empty)
+
+> [!NOTE]
+> It will adjust its base path depending on the `X-Ingress-Path` and `X-Forwarded-Prefix`
+> headers, regardless of what either of the base url is set to.
+
 # Example
 
 ## Docker compose
@@ -33,5 +49,10 @@ This will set the log level to debug, the cache max age to 30 seconds, and the H
 You can also set the environment variables in the command line when starting the program. Example:
 
 ```
-logLevel=debug cacheMaxAge=30 httpListenAddress=:5687 ./TeslaBleHttpProxy
+./TeslaBleHttpProxy --logLevel=debug --cacheMaxAge=30 --httpListenAddress=:5687
 ```
+
+## Caution
+
+> [!WARNING]
+> If you set both environment variables and command line options for the same setting, you will see the error `[command] can only be present once`

go.mod

@@ -5,11 +5,12 @@ go 1.23.3
 require (
 	github.com/charmbracelet/log v0.4.0
 	github.com/gorilla/mux v1.8.1
-	github.com/teslamotors/vehicle-command v0.2.1
+	github.com/teslamotors/vehicle-command v0.3.3-0.20250128004836-ebad42aaa852
 )
 
 require (
 	github.com/JuulLabs-OSS/cbgo v0.0.2 // indirect
+	github.com/akamensky/argparse v1.4.0 // indirect
 	github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
 	github.com/charmbracelet/lipgloss v0.12.1 // indirect
 	github.com/charmbracelet/x/ansi v0.1.4 // indirect
@@ -33,7 +34,3 @@ require (
 	golang.org/x/sys v0.24.0 // indirect
 	google.golang.org/protobuf v1.34.2 // indirect
 )
-
-replace github.com/teslamotors/vehicle-command => github.com/wimaha/vehicle-command v0.0.4
-
-replace github.com/go-ble/ble => github.com/wimaha/ble_BleConnectFix v0.0.0-20240822192426-3f74826c1268

go.sum

@@ -2,6 +2,8 @@ github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03
 github.com/JuulLabs-OSS/cbgo v0.0.1/go.mod h1:L4YtGP+gnyD84w7+jN66ncspFRfOYB5aj9QSXaFHmBA=
 github.com/JuulLabs-OSS/cbgo v0.0.2 h1:gCDyT0+EPuI8GOFyvAksFcVD2vF4CXBAVwT6uVnD9oo=
 github.com/JuulLabs-OSS/cbgo v0.0.2/go.mod h1:L4YtGP+gnyD84w7+jN66ncspFRfOYB5aj9QSXaFHmBA=
+github.com/akamensky/argparse v1.4.0 h1:YGzvsTqCvbEZhL8zZu2AiA5nq805NZh75JNj4ajn1xc=
+github.com/akamensky/argparse v1.4.0/go.mod h1:S5kwC7IuDcEr5VeXtGPRVZ5o/FdhcMlQz4IZQuw64xA=
 github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k=
 github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8=
 github.com/charmbracelet/lipgloss v0.12.1 h1:/gmzszl+pedQpjCOH+wFkZr/N90Snz40J/NR7A0zQcs=
@@ -16,6 +18,8 @@ github.com/cronokirby/saferith v0.33.0/go.mod h1:QKJhjoqUtBsXCAVEjw38mFqoi7DebT7
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/go-ble/ble v0.0.0-20240122180141-8c5522f54333 h1:bQK6D51cNzMSTyAf0HtM30V2IbljHTDam7jru9JNlJA=
+github.com/go-ble/ble v0.0.0-20240122180141-8c5522f54333/go.mod h1:fFJl/jD/uyILGBeD5iQ8tYHrPlJafyqCJzAyTHNJ1Uk=
 github.com/go-logfmt/logfmt v0.6.0 h1:wGYYu3uicYdqXVgoYbvnkrPVXkuLM1p1ifugDMEdRi4=
 github.com/go-logfmt/logfmt v0.6.0/go.mod h1:WYhtIu8zTZfxdn5+rREduYbwxfcBr/Vr6KEVveWlfTs=
 github.com/golang-jwt/jwt/v5 v5.2.1 h1:OuVbFODueb089Lh128TAcimifWaLhJwVflnrgM17wHk=
@@ -67,6 +71,8 @@ github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81P
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
 github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+github.com/teslamotors/vehicle-command v0.3.3-0.20250128004836-ebad42aaa852 h1:TrYeM7qS2mB80Zl8T+xqlzxNG6dEmpRaK6oPrDGQBIo=
+github.com/teslamotors/vehicle-command v0.3.3-0.20250128004836-ebad42aaa852/go.mod h1:ZVR0KE8v3IrQUJAuBrxKkRjPZOVI0oxEqBj8x1eFpDQ=
 github.com/urfave/cli v1.22.2/go.mod h1:Gos4lmkARVdJ6EkW0WaNv/tZAAMe9V7XWyB60NtXRu0=
 github.com/wimaha/ble_BleConnectFix v0.0.0-20240822192426-3f74826c1268 h1:36sDJ2qts2oT/Fy/Wi6MR15C+LHl2+ZUzLp6UaqhS9c=
 github.com/wimaha/ble_BleConnectFix v0.0.0-20240822192426-3f74826c1268/go.mod h1:fFJl/jD/uyILGBeD5iQ8tYHrPlJafyqCJzAyTHNJ1Uk=