Fix recharge caching while using multiple cars

.github/workflows/build_image.yml

@@ -11,7 +11,7 @@ name: Create and publish a Docker image
 
 on:
   release:
-    types: [created]
+    types: [created, edited]
   workflow_dispatch:
   
 env:

README.md

@@ -3,19 +3,28 @@
 This component establishes a connection between the newer AAOS Volvo cars and Home Assistant via MQTT.<br>
 Maybe this component works also with other Volvo cars. Please try out the native Volvo [integration](https://www.home-assistant.io/integrations/volvooncall/) before using this component! If the native component doesn't work for your car, try this mqtt bridge.
 
+## Confirmed working with
+-  Volvo XC40 BEV (2023)
+
+Please let me know if your car works with this addon so I can expand the list!
+
 ## Setup
 
 Just install this addon with the following command.
 Please note to fill in your settings inside the environment variables.
 
-`docker run -e CONF_updateInterval=300 -e CONF_babelLocale='de' -e CONF_mqtt='@json {"broker": "", "username": "", "password": ""}' -e CONF_volvoData='@json {"username": "", "password": "", "vin": "", "vccapikey": ""}' -e TZ='Europe/Berlin' --name volvo2mqtt ghcr.io/dielee/volvo2mqtt:main`
+`docker run --pull=always -e CONF_updateInterval=300 -e CONF_babelLocale='de' -e CONF_mqtt='@json {"broker": "", "username": "", "password": ""}' -e CONF_volvoData='@json {"username": "", "password": "", "vin": "", "vccapikey": ""}' -e TZ='Europe/Berlin' --name volvo2mqtt ghcr.io/dielee/volvo2mqtt:latest`
 
 Here is what every option means:
 
 | Name                 |   Type    |   Default    | Description                                                     |
 | -------------------- | :-------: | :----------: | --------------------------------------------------------------- |
-| `updateInterval`     | `int`     | **required** | Updateintervall in seconds.                                     |
+| `updateInterval`     | `int`     | **required** | Update intervall in seconds.                                     |
 | `babelLocale`        | `string`  | **required** | Locale for date Format                                          |
 | `mqtt`               | `json`    | **required** | Broker = Mqtt Broker IP / Username and Passwort are optional!   |
-| `volvoData`          | `json`    | **required** | Username and password are required. Car vin is optional. If no vin is provided, the system will always use the first vehicle in API. Vccapi key is your api key from [here](https://developer.volvocars.com/account/).                                   |
+| `volvoData`          | `json`    | **required** | Username and password are required. Car vin can be a single vin or a list of multiple vins like `["vin1", "vin2"]`. If no vin is provided, <b>ALL</b> of your vehicles will be used. Vccapi key is your api key from [here](https://developer.volvocars.com/account/).                                   |
 | `TZ`                 | `string`  |              | Container timezone eg "Europe/Berlin" |
+
+If you like my work:
+
+<a href="https://www.buymeacoffee.com/dielee" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>

const.py

@@ -1,3 +1,5 @@
+VERSION = "v1.0.5"
+
 OAUTH_URL = "https://volvoid.eu.volvocars.com/as/token.oauth2"
 VEHICLES_URL = "https://api.volvocars.com/connected-vehicle/v1/vehicles"
 VEHICLE_DETAILS_URL = "https://api.volvocars.com/connected-vehicle/v1/vehicles/{0}"

main.py

@@ -1,7 +1,9 @@
 from volvo import authorize
 from mqtt import update_loop, connect
+from const import VERSION
 
 if __name__ == '__main__':
+    print("Starting volvo2mqtt version " + VERSION)
     authorize()
     connect()
     update_loop()

mqtt.py

@@ -6,7 +6,7 @@ import threading
 from datetime import datetime
 from babel.dates import format_datetime
 from config import settings
-from const import VEHICLE_DETAILS_URL,CLIMATE_START_URL, CLIMATE_STOP_URL, CAR_LOCK_URL, \
+from const import VEHICLE_DETAILS_URL, CLIMATE_START_URL, CLIMATE_STOP_URL, CAR_LOCK_URL, \
             CAR_UNLOCK_URL, supported_sensors, supported_buttons, supported_switches, supported_locks
 
 
@@ -74,138 +74,141 @@ def update_loop():
     while True:
         print("Sending mqtt update...")
         update_car_data()
+        print("Mqtt update done. Next run in " + str(settings["updateInterval"]) + " seconds.")
         time.sleep(settings["updateInterval"])
 
 
 def update_car_data():
     global last_data_update
     last_data_update = format_datetime(datetime.now(), format="medium", locale=settings["babelLocale"])
-    for lock in supported_locks:
-        state = volvo.api_call(lock["url"], "GET", lock["id"])
-        mqtt_client.publish(
-            f"homeassistant/lock/{volvo.vin}_{lock['id']}/state",
-            state
-        )
+    for vin in volvo.vins:
+        for lock in supported_locks:
+            state = volvo.api_call(lock["url"], "GET", vin, lock["id"])
+            mqtt_client.publish(
+                f"homeassistant/lock/{vin}_{lock['id']}/state",
+                state
+            )
 
-    for switch in supported_switches:
-        if switch["id"] == "climate_status":
-            state = assumed_climate_state
-        else:
-            state = "OFF"
+        for switch in supported_switches:
+            if switch["id"] == "climate_status":
+                state = assumed_climate_state
+            else:
+                state = "OFF"
 
-        mqtt_client.publish(
-            f"homeassistant/switch/{volvo.vin}_{switch['id']}/state",
-            state
-        )
+            mqtt_client.publish(
+                f"homeassistant/switch/{vin}_{switch['id']}/state",
+                state
+            )
 
-    for sensor in supported_sensors:
-        if sensor["id"] == "last_data_update":
-            state = last_data_update
-        else:
-            state = volvo.api_call(sensor["url"], "GET", sensor["id"])
-        mqtt_client.publish(
-            f"homeassistant/sensor/{volvo.vin}_{sensor['id']}/state",
-            state
-        )
+        for sensor in supported_sensors:
+            if sensor["id"] == "last_data_update":
+                state = last_data_update
+            else:
+                state = volvo.api_call(sensor["url"], "GET", vin, sensor["id"])
+            mqtt_client.publish(
+                f"homeassistant/sensor/{vin}_{sensor['id']}/state",
+                state
+            )
 
 
 def create_ha_devices():
-    car_details = volvo.api_call(VEHICLE_DETAILS_URL, "GET")
+    for vin in volvo.vins:
+        car_details = volvo.api_call(VEHICLE_DETAILS_URL, "GET", vin)
 
-    for button in supported_buttons:
-        command_topic = f"homeassistant/button/{volvo.vin}_{button['id']}/command"
-        config = {
-                    "name": button['name'],
-                    "object_id": button['id'],
-                    "schema": "state",
-                    "icon": f"mdi:{button['icon']}",
-                    "state_topic": f"homeassistant/button/{volvo.vin}_{button['id']}/state",
-                    "command_topic": command_topic,
-                    "device": {
-                        "identifiers": ["volvoAAOS2mqtt"],
-                        "manufacturer": "Volvo",
-                        "model": car_details['descriptions']['model'],
-                        "name": f"{car_details['descriptions']['model']} ({car_details['modelYear']}) - {volvo.vin}",
-                    },
-                    "unique_id": f"volvoAAOS2mqtt_{volvo.vin}_{button['id']}",
-                }
-        mqtt_client.publish(
-            f"homeassistant/button/volvoAAOS2mqtt/{volvo.vin}_{button['id']}/config",
-            json.dumps(config),
-        )
-        subscribed_topics.append(command_topic)
-        mqtt_client.subscribe(command_topic)
+        for button in supported_buttons:
+            command_topic = f"homeassistant/button/{vin}_{button['id']}/command"
+            config = {
+                        "name": button['name'],
+                        "object_id": button['id'],
+                        "schema": "state",
+                        "icon": f"mdi:{button['icon']}",
+                        "state_topic": f"homeassistant/button/{vin}_{button['id']}/state",
+                        "command_topic": command_topic,
+                        "device": {
+                            "identifiers": [f"volvoAAOS2mqtt_{vin}"],
+                            "manufacturer": "Volvo",
+                            "model": car_details['descriptions']['model'],
+                            "name": f"{car_details['descriptions']['model']} ({car_details['modelYear']}) - {vin}",
+                        },
+                        "unique_id": f"volvoAAOS2mqtt_{vin}_{button['id']}",
+                    }
+            mqtt_client.publish(
+                f"homeassistant/button/volvoAAOS2mqtt/{vin}_{button['id']}/config",
+                json.dumps(config),
+            )
+            subscribed_topics.append(command_topic)
+            mqtt_client.subscribe(command_topic)
 
-    for lock in supported_locks:
-        command_topic = f"homeassistant/lock/{volvo.vin}_{lock['id']}/command"
-        config = {
-                    "name": lock['name'],
-                    "object_id": lock['id'],
-                    "schema": "state",
-                    "icon": f"mdi:{lock['icon']}",
-                    "state_topic": f"homeassistant/lock/{volvo.vin}_{lock['id']}/state",
-                    "command_topic": command_topic,
-                    "optimistic": False,
-                    "device": {
-                        "identifiers": ["volvoAAOS2mqtt"],
-                        "manufacturer": "Volvo",
-                        "model": car_details['descriptions']['model'],
-                        "name": f"{car_details['descriptions']['model']} ({car_details['modelYear']}) - {volvo.vin}",
-                    },
-                    "unique_id": f"volvoAAOS2mqtt_{volvo.vin}_{lock['id']}",
-                }
-        mqtt_client.publish(
-            f"homeassistant/lock/volvoAAOS2mqtt/{volvo.vin}_{lock['id']}/config",
-            json.dumps(config),
-        )
-        subscribed_topics.append(command_topic)
-        mqtt_client.subscribe(command_topic)
+        for lock in supported_locks:
+            command_topic = f"homeassistant/lock/{vin}_{lock['id']}/command"
+            config = {
+                        "name": lock['name'],
+                        "object_id": lock['id'],
+                        "schema": "state",
+                        "icon": f"mdi:{lock['icon']}",
+                        "state_topic": f"homeassistant/lock/{vin}_{lock['id']}/state",
+                        "command_topic": command_topic,
+                        "optimistic": False,
+                        "device": {
+                            "identifiers": [f"volvoAAOS2mqtt_{vin}"],
+                            "manufacturer": "Volvo",
+                            "model": car_details['descriptions']['model'],
+                            "name": f"{car_details['descriptions']['model']} ({car_details['modelYear']}) - {vin}",
+                        },
+                        "unique_id": f"volvoAAOS2mqtt_{vin}_{lock['id']}",
+                    }
+            mqtt_client.publish(
+                f"homeassistant/lock/volvoAAOS2mqtt/{vin}_{lock['id']}/config",
+                json.dumps(config),
+            )
+            subscribed_topics.append(command_topic)
+            mqtt_client.subscribe(command_topic)
 
-    for switch in supported_switches:
-        command_topic = f"homeassistant/switch/{volvo.vin}_{switch['id']}/command"
-        config = {
-                    "name": switch['name'],
-                    "object_id": switch['id'],
-                    "schema": "state",
-                    "icon": f"mdi:{switch['icon']}",
-                    "state_topic": f"homeassistant/switch/{volvo.vin}_{switch['id']}/state",
-                    "command_topic": command_topic,
-                    "optimistic": False,
-                    "device": {
-                        "identifiers": ["volvoAAOS2mqtt"],
-                        "manufacturer": "Volvo",
-                        "model": car_details['descriptions']['model'],
-                        "name": f"{car_details['descriptions']['model']} ({car_details['modelYear']}) - {volvo.vin}",
-                    },
-                    "unique_id": f"volvoAAOS2mqtt_{volvo.vin}_{switch['id']}",
-                }
-        mqtt_client.publish(
-            f"homeassistant/switch/volvoAAOS2mqtt/{volvo.vin}_{switch['id']}/config",
-            json.dumps(config),
-        )
-        subscribed_topics.append(command_topic)
-        mqtt_client.subscribe(command_topic)
+        for switch in supported_switches:
+            command_topic = f"homeassistant/switch/{vin}_{switch['id']}/command"
+            config = {
+                        "name": switch['name'],
+                        "object_id": switch['id'],
+                        "schema": "state",
+                        "icon": f"mdi:{switch['icon']}",
+                        "state_topic": f"homeassistant/switch/{vin}_{switch['id']}/state",
+                        "command_topic": command_topic,
+                        "optimistic": False,
+                        "device": {
+                            "identifiers": [f"volvoAAOS2mqtt_{vin}"],
+                            "manufacturer": "Volvo",
+                            "model": car_details['descriptions']['model'],
+                            "name": f"{car_details['descriptions']['model']} ({car_details['modelYear']}) - {vin}",
+                        },
+                        "unique_id": f"volvoAAOS2mqtt_{vin}_{switch['id']}",
+                    }
+            mqtt_client.publish(
+                f"homeassistant/switch/volvoAAOS2mqtt/{vin}_{switch['id']}/config",
+                json.dumps(config),
+            )
+            subscribed_topics.append(command_topic)
+            mqtt_client.subscribe(command_topic)
 
-    for sensor in supported_sensors:
-        config = {
-                    "name": sensor['name'],
-                    "object_id": sensor['id'],
-                    "schema": "state",
-                    "icon": f"mdi:{sensor['icon']}",
-                    "state_topic": f"homeassistant/sensor/{volvo.vin}_{sensor['id']}/state",
-                    "device": {
-                        "identifiers": ["volvoAAOS2mqtt"],
-                        "manufacturer": "Volvo",
-                        "model": car_details['descriptions']['model'],
-                        "name": f"{car_details['descriptions']['model']} ({car_details['modelYear']}) - {volvo.vin}",
-                    },
-                    "unique_id": f"volvoAAOS2mqtt_{volvo.vin}_{sensor['id']}",
-                }
-        if "unit" in sensor:
-            config["unit_of_measurement"] = sensor["unit"]
+        for sensor in supported_sensors:
+            config = {
+                        "name": sensor['name'],
+                        "object_id": sensor['id'],
+                        "schema": "state",
+                        "icon": f"mdi:{sensor['icon']}",
+                        "state_topic": f"homeassistant/sensor/{vin}_{sensor['id']}/state",
+                        "device": {
+                            "identifiers": [f"volvoAAOS2mqtt_{vin}"],
+                            "manufacturer": "Volvo",
+                            "model": car_details['descriptions']['model'],
+                            "name": f"{car_details['descriptions']['model']} ({car_details['modelYear']}) - {vin}",
+                        },
+                        "unique_id": f"volvoAAOS2mqtt_{vin}_{sensor['id']}",
+                    }
+            if "unit" in sensor:
+                config["unit_of_measurement"] = sensor["unit"]
 
-        mqtt_client.publish(
-            f"homeassistant/sensor/volvoAAOS2mqtt/{volvo.vin}_{sensor['id']}/config",
-            json.dumps(config),
-        )
+            mqtt_client.publish(
+                f"homeassistant/sensor/volvoAAOS2mqtt/{vin}_{sensor['id']}/config",
+                json.dumps(config),
+            )
     time.sleep(2)

requirements.txt

@@ -1,5 +1,4 @@
 requests~=2.29.0
 dynaconf~=3.1.12
 paho-mqtt~=1.6.1
-pytz~=2023.3
 Babel~=2.12.1

volvo.py

@@ -15,7 +15,7 @@ session.headers = {
 
 token_expires_at: datetime
 refresh_token = None
-vin = ""
+vins = []
 recharge_response = {}
 recharge_last_update = None
 
@@ -42,7 +42,7 @@ def authorize():
         token_expires_at = datetime.now() + timedelta(seconds=(data["expires_in"] - 30))
         refresh_token = data["refresh_token"]
 
-        get_vehicle()
+        get_vehicles()
     else:
         message = auth.json()
         raise Exception(message["error_description"])
@@ -71,25 +71,31 @@ def refresh_auth():
         refresh_token = data["refresh_token"]
 
 
-def get_vehicle():
-    global vin
+def get_vehicles():
+    global vins
     if not settings.volvoData["vin"]:
         vehicles = session.get(VEHICLES_URL)
         if vehicles.status_code == 200:
             data = vehicles.json()
             if len(data["data"]) > 0:
-                vin = data["data"][0]["vin"]
+                for vehicle in data["data"]:
+                    vins.append(vehicle["vin"])
             else:
-                print("No vehicle in account " + settings.volvoData["username"] + " found.")
+                raise Exception("No vehicle in account " + settings.volvoData["username"] + " found.")
         else:
-            print("Error getting Vehicles " + str(vehicles.status_code))
+            raise Exception("Error getting vehicles: " + str(vehicles.status_code))
     else:
-        vin = settings.volvoData["vin"]
+        if isinstance(settings.volvoData["vin"], list):
+            # If setting is a list, copy
+            vins = settings.volvoData["vin"]
+        else:
+            # If setting is a string, append to list
+            vins.append(settings.volvoData["vin"])
 
-    if not vin:
+    if len(vins) == 0:
         raise Exception("No vehicle found, exiting application!")
     else:
-        print("Vin: " + vin + " found!")
+        print("Vin: " + str(vins) + " found!")
 
 
 def disable_climate():
@@ -97,30 +103,30 @@ def disable_climate():
     mqtt.update_car_data()
 
 
-def api_call(url, method, sensor_id=None):
+def api_call(url, method, vin, sensor_id=None):
     global token_expires_at
     if datetime.now() >= token_expires_at:
         refresh_auth()
 
-    global vin, recharge_response, recharge_last_update
+    global recharge_response, recharge_last_update
     if url == RECHARGE_STATUS_URL:
         # Minimize API calls for recharge API
         if not bool(recharge_response):
             # No API Data cached, get fresh data from API
             print("Starting " + method + " call against " + url)
             response = session.get(url.format(vin), timeout=15)
-            recharge_response = response
+            recharge_response[vin] = response
             recharge_last_update = datetime.now()
         else:
             if (datetime.now() - recharge_last_update).total_seconds() >= settings["updateInterval"]:
                 # Old Data in Cache, updateing
                 print("Starting " + method + " call against " + url)
                 response = session.get(url.format(vin), timeout=15)
-                recharge_response = response
+                recharge_response[vin] = response
                 recharge_last_update = datetime.now()
             else:
                 # Data is up do date, returning cached data
-                response = recharge_response
+                response = recharge_response[vin]
     elif method == "GET":
         print("Starting " + method + " call against " + url)
         response = session.get(url.format(vin), timeout=15)
@@ -141,7 +147,10 @@ def api_call(url, method, sensor_id=None):
         else:
             print("API Call failed. Status Code: " + str(response.status_code) + ". Error: " + response.text)
         return ""
+    return parse_api_data(url, data, sensor_id)
 
+
+def parse_api_data(url, data, sensor_id=None):
     if url == VEHICLE_DETAILS_URL:
         return data["data"]
     elif sensor_id == "battery_charge_level":