Rework api data handling

Update Energy availability in README.md

.gitignore

@@ -1 +1,3 @@
-.idea
+.idea
+venv
+src/settings.dev.json

Dockerfile

@@ -11,7 +11,7 @@ COPY requirements.txt .
 RUN pip install -r requirements.txt
 
 # copy the content of the local src directory to the working directory
-COPY / .
+COPY /src .
 
 # command to run on container start
-CMD [ "python", "-u", "./main.py" ]
+CMD [ "python", "-u", "./main.py" ]

README.md

@@ -3,23 +3,50 @@
 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
+- XC40 BEV (2023)
+- V60 T8 PHEV (2023)
+- C40 PHEV (2023)
+- C40 PHEV (2022)
+- XC90 T8 PHEV (2023)
+- XC60 PHEV (2023)
+
+Please let me know if your car works with this addon so I can expand the list!
+
+## Supported features
+- Lock/unlock car
+- Start/stop climate
+- Sensor "Battery Charge Level"
+- Sensor "Electric Range"
+- Sensor "Charging System Status"
+- Sensor "Estimated Charging Finish Time"
+- Multiple cars
+
+NOTE: Energy status currently available only for cars in the Europe / Middle East / Africa regions. [source](https://developer.volvocars.com/apis/energy/v1/overview/#availability)
+
 ## Setup
+<b>Docker:</b>
 
 Just install this addon with the following command.
 Please note to fill in your settings inside the environment variables.
 
-`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`
+`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`
+
+<b>HA Add-On:</b><br>
+
+[![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%3A%2F%2Fgithub.com%2FDielee%2Fvolvo2mqtt)
 
 Here is what every option means:
 
 | Name                 |   Type    |   Default    | Description                                                     |
 | -------------------- | :-------: | :----------: | --------------------------------------------------------------- |
-| `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 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/).                                   |
+| `CONF_updateInterval`     | `int`     | **required** | Update intervall in seconds.                                     |
+| `CONF_babelLocale`        | `string`  | **required** | Select your country from this [list](https://www.ibm.com/docs/en/radfws/9.7?topic=overview-locales-code-pages-supported). "Locale name" is the column you need!                                        |
+| `CONF_mqtt`               | `json`    | **required** | Broker = Mqtt Broker IP / Username and Passwort are optional!   |
+| `CONF_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 REQUIRED. Get your Vccapi key from [here](https://developer.volvocars.com/account/).                                   |
+| `CONF_debug`              | `string`  |              | Debug option (true/false) - optional! |
 | `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>
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/U7U8MFXCF)

config.py

@@ -1,6 +0,0 @@
-from dynaconf import Dynaconf
-
-settings = Dynaconf(
-    envvar_prefix="CONF",
-    settings_files=["settings.json"],
-)

const.py

@@ -1,36 +0,0 @@
-VERSION = "v1.0.2.1"
-
-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}"
-WINDOW_STATUS_URL = "https://api.volvocars.com/connected-vehicle/v1/vehicles/{0}/windows"
-CLIMATE_START_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/commands/climatization-start"
-CLIMATE_STOP_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/commands/climatization-stop"
-CAR_LOCK_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/doors"
-CAR_LOCK_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/commands/lock"
-CAR_UNLOCK_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/commands/unlock"
-RECHARGE_STATUS_URL = "https://api.volvocars.com/energy/v1/vehicles/{0}/recharge-status"
-
-charging_system_states = {"CHARGING_SYSTEM_CHARGING": "Charging", "CHARGING_SYSTEM_IDLE": "Idle",
-                          "CHARGING_SYSTEM_FAULT": "Fault", "CHARGING_SYSTEM_UNSPECIFIED": "UNSPECIFIED"}
-
-supported_sensors = [
-                        {"name": "Battery Charge Level", "id": "battery_charge_level", "unit": "%", "icon": "car-battery", "url": RECHARGE_STATUS_URL},
-                        {"name": "Electric Range", "id": "electric_range", "unit": "km", "icon": "map-marker-distance", "url": RECHARGE_STATUS_URL},
-                        {"name": "Estimated Charging Time", "id": "estimated_charging_time", "unit": "minutes", "icon": "timer-sync-outline", "url": RECHARGE_STATUS_URL},
-                        {"name": "Charging System Status", "id": "charging_system_status", "icon": "ev-plug-ccs2", "url": RECHARGE_STATUS_URL},
-                        {"name": "Estimated Charging Finish Time", "id": "estimated_charging_finish_time", "icon": "timer-sync-outline", "url": RECHARGE_STATUS_URL},
-                        {"name": "Last Data Update", "id": "last_data_update", "icon": "timer", "url": ""}
-]
-
-supported_switches = [
-                        {"name": "Air Conditioning", "id": "climate_status", "icon": "air-conditioner"},
-]
-
-supported_locks = [
-                        {"name": "Lock state", "id": "lock_status", "icon": "lock", "url": CAR_LOCK_STATE_URL}
-]
-
-supported_buttons = [
-                        {"name": "Update Data", "id": "update_data", "icon": "update", "url": ""}
-]

container_config.json

@@ -1,8 +0,0 @@
-{
-	"name": "volvoaaos2mqtt",
-  	"ports": {},
-    "env": {"TZ": "Europe/Amsterdam"},
-	"volumes": [
-		"/home/dockerhost/volvoAAOS2mqtt/settings.json:/volvoAAOS2mqtt/settings.json"
-	]
-}

repository.yaml

@@ -0,0 +1,3 @@
+name: volvo2mqtt
+url: https://github.com/Dielee/volvo2mqtt
+maintainer: Linus Dietz (Dielee)

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

src/Dockerfile

@@ -0,0 +1,20 @@
+ARG BUILD_FROM
+FROM $BUILD_FROM
+
+# Install requirements for add-on
+RUN apk add --no-cache python3 bash py3-pip
+
+# set the working directory in the container
+WORKDIR /volvoAAOS2mqtt
+
+# download requirements.txt
+RUN wget https://raw.githubusercontent.com/Dielee/volvo2mqtt/main/requirements.txt
+
+# install dependencies
+RUN pip install -r requirements.txt
+
+# copy the content of the local src directory to the working directory
+COPY / .
+
+# command to run on container start
+CMD [ "python", "-u", "./main.py" ]

src/apparmor.txt

@@ -0,0 +1,64 @@
+#include <tunables/global>
+
+profile volvo2mqtt flags=(attach_disconnected,mediate_deleted) {
+  #include <abstractions/base>
+
+  # Capabilities
+  file,
+  signal (send) set=(kill,term,int,hup,cont),
+
+  # S6-Overlay
+  /init ix,
+  /bin/** ix,
+  /usr/bin/** ix,
+  /run/{s6,s6-rc*,service}/** ix,
+  /package/** ix,
+  /command/** ix,
+  /etc/services.d/** rwix,
+  /etc/cont-init.d/** rwix,
+  /etc/cont-finish.d/** rwix,
+  /run/{,**} rwk,
+  /dev/tty rw,
+
+  # Bashio
+  /usr/lib/bashio/** ix,
+  /tmp/** rwk,
+
+  # Access to options.json and other files within your addon
+  /data/** rw,
+
+  # Start new profile for service
+  /usr/bin/myprogram cx -> myprogram,
+
+  profile myprogram flags=(attach_disconnected,mediate_deleted) {
+    #include <abstractions/base>
+
+    # Receive signals from S6-Overlay
+    signal (receive) peer=*_ADDON_SLUG,
+
+    # Access to options.json and other files within your addon
+    /data/** rw,
+
+    # Access to mapped volumes specified in config.json
+    /share/** rw,
+
+    # Access required for service functionality
+    /usr/bin/myprogram r,
+    /bin/bash rix,
+    /bin/echo ix,
+    /etc/passwd r,
+    /dev/tty rw,
+
+    # Allow outbound MQTT communication
+    network tcp,
+    network inet stream,
+    network inet dgram,
+    network inet6 stream,
+    network inet6 dgram,
+
+    # Add any additional MQTT-related rules if needed
+    # For example, if you're using the paho-mqtt library
+    /usr/bin/python3 cx -> paho.mqtt,
+    /usr/lib/python3.11/site-packages/paho/mqtt/** r,
+  }
+}

src/config.py

@@ -0,0 +1,6 @@
+from dynaconf import Dynaconf
+
+settings = Dynaconf(
+    envvar_prefix="CONF",
+    settings_files=["settings.json", "/data/options.json", "settings.dev.json"],
+)

src/config.yaml

@@ -0,0 +1,39 @@
+name: "Volvo2Mqtt"
+description: "Volvo AAOS MQTT bridge"
+version: "1.2.1"
+slug: "volvo2mqtt"
+init: false
+url: "https://github.com/Dielee/volvo2mqtt"
+apparmor: true
+options:
+  updateInterval: 300
+  babelLocale: null
+  debug: false
+  mqtt:
+    broker: null
+    username: ""
+    password: ""
+  volvoData:
+    username: null
+    password: null
+    vin: ""
+    vccapikey: null
+schema:
+  updateInterval: int(10,)
+  babelLocale: str
+  debug: bool
+  mqtt:
+    broker: str
+    username: str?
+    password: str?
+  volvoData:
+    username: str
+    password: str
+    vin: str?
+    vccapikey: str
+arch:
+  - aarch64
+  - amd64
+  - armhf
+  - armv7
+  - i386

src/const.py

@@ -0,0 +1,56 @@
+from config import settings
+
+VERSION = "v1.2.1"
+
+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}"
+WINDOWS_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/windows"
+CLIMATE_START_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/commands/climatization-start"
+CLIMATE_STOP_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/commands/climatization-stop"
+LOCK_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/doors"
+CAR_LOCK_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/commands/lock"
+CAR_UNLOCK_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/commands/unlock"
+RECHARGE_STATE_URL = "https://api.volvocars.com/energy/v1/vehicles/{0}/recharge-status"
+ODOMETER_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/odometer"
+LOCATION_STATE_URL = "https://api.volvocars.com/location/v1/vehicles/{0}/location"
+
+charging_system_states = {"CHARGING_SYSTEM_CHARGING": "Charging", "CHARGING_SYSTEM_IDLE": "Idle",
+                          "CHARGING_SYSTEM_FAULT": "Fault", "CHARGING_SYSTEM_UNSPECIFIED": "Unspecified"}
+
+supported_sensors = [
+                        {"name": "Battery Charge Level", "id": "battery_charge_level", "unit": "%", "icon": "car-battery", "url": RECHARGE_STATE_URL},
+                        {"name": "Electric Range", "id": "electric_range", "unit": "km" if settings["babelLocale"] != "en_US" else "mi", "icon": "map-marker-distance", "url": RECHARGE_STATE_URL},
+                        {"name": "Estimated Charging Time", "id": "estimated_charging_time", "unit": "minutes", "icon": "timer-sync-outline", "url": RECHARGE_STATE_URL},
+                        {"name": "Charging System Status", "id": "charging_system_status", "icon": "ev-plug-ccs2", "url": RECHARGE_STATE_URL},
+                        {"name": "Estimated Charging Finish Time", "id": "estimated_charging_finish_time", "icon": "timer-sync-outline", "url": RECHARGE_STATE_URL},
+                        {"name": "Odometer", "id": "odometer", "unit": "km" if settings["babelLocale"] != "en_US" else "mi", "icon": "counter", "url": ODOMETER_STATE_URL},
+                        {"name": "Last Data Update", "id": "last_data_update", "icon": "timer", "url": ""},
+                        {"name": "Window Front Left", "id": "window_front_left", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
+                        {"name": "Window Front Right", "id": "window_front_right", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
+                        {"name": "Window Rear Left", "id": "window_rear_left", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
+                        {"name": "Window Rear Right", "id": "window_rear_right", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
+                        {"name": "Door Front Left", "id": "door_front_left", "icon": "car-door-lock", "url": LOCK_STATE_URL},
+                        {"name": "Door Front Right", "id": "door_front_right", "icon": "car-door-lock", "url": LOCK_STATE_URL},
+                        {"name": "Door Rear Left", "id": "door_rear_left", "icon": "car-door-lock", "url": LOCK_STATE_URL},
+                        {"name": "Door Rear Right", "id": "door_rear_right", "icon": "car-door-lock", "url": LOCK_STATE_URL},
+                        {"name": "Tailgate", "id": "tailgate", "icon": "car-door-lock", "url": LOCK_STATE_URL},
+                        {"name": "Engine Hood", "id": "engine_hood", "icon": "car-door-lock", "url": LOCK_STATE_URL},
+                        {"name": "Tank Lid", "id": "tank_lid", "icon": "car-door-lock", "url": LOCK_STATE_URL}
+]
+
+supported_switches = [
+                        {"name": "Air Conditioning", "id": "climate_status", "icon": "air-conditioner"},
+]
+
+supported_locks = [
+                        {"name": "Lock state", "id": "lock_status", "icon": "lock", "url": LOCK_STATE_URL}
+]
+
+supported_buttons = [
+                        {"name": "Force Update Data", "id": "update_data", "icon": "update", "url": ""}
+]
+
+supported_device_trackers = [
+                        {"name": "Location", "id": "location", "icon": "map-marker-radius", "url": LOCATION_STATE_URL}
+]

src/mqtt.py

@@ -2,18 +2,21 @@ import time
 import paho.mqtt.client as mqtt
 import json
 import volvo
-import threading
+from threading import Thread, Timer
 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, \
-            CAR_UNLOCK_URL, supported_sensors, supported_buttons, supported_switches, supported_locks
+from const import CLIMATE_START_URL, CLIMATE_STOP_URL, CAR_LOCK_URL, \
+            CAR_UNLOCK_URL, supported_sensors, supported_buttons, supported_switches, \
+            supported_locks, supported_device_trackers
+
 
 
 mqtt_client: mqtt.Client
 subscribed_topics = []
-assumed_climate_state = "OFF"
+assumed_climate_state = {}
 last_data_update = None
+climate_timer: Timer
 
 
 def connect():
@@ -42,31 +45,36 @@ def on_disconnect(client, userdata,  rc):
 
 def on_message(client, userdata, msg):
     if msg.topic in subscribed_topics:
+        vin = msg.topic.split('/')[2].split('_')[0]
         payload = msg.payload.decode("UTF-8")
         if "climate_status" in msg.topic:
-            global assumed_climate_state
+            global assumed_climate_state, climate_timer
             if payload == "ON":
-                api_thread = threading.Thread(target=volvo.api_call, args=(CLIMATE_START_URL, "POST", ))
+                api_thread = Thread(target=volvo.api_call, args=(CLIMATE_START_URL, "POST", vin))
                 api_thread.start()
-                assumed_climate_state = "ON"
+                assumed_climate_state[vin] = "ON"
                 # Starting timer to disable climate after 30 mins
-                threading.Timer(30 * 60, volvo.disable_climate).start()
+                climate_timer = Timer(1 * 60, volvo.disable_climate, (vin, ))
+                climate_timer.start()
                 update_car_data()
             elif payload == "OFF":
-                api_thread = threading.Thread(target=volvo.api_call, args=(CLIMATE_STOP_URL, "POST", ))
+                api_thread = Thread(target=volvo.api_call, args=(CLIMATE_STOP_URL, "POST", vin))
                 api_thread.start()
-                assumed_climate_state = "OFF"
+                assumed_climate_state[vin] = "OFF"
+                # Stop timer if active
+                if climate_timer.is_alive():
+                    climate_timer.cancel()
                 update_car_data()
         elif "lock_status" in msg.topic:
             if payload == "LOCK":
-                volvo.api_call(CAR_LOCK_URL, "POST")
+                volvo.api_call(CAR_LOCK_URL, "POST", vin)
                 update_car_data()
             elif payload == "UNLOCK":
-                volvo.api_call(CAR_UNLOCK_URL, "POST")
+                volvo.api_call(CAR_UNLOCK_URL, "POST", vin)
                 update_car_data()
         elif "update_data" in msg.topic:
             if payload == "PRESS":
-                update_car_data()
+                update_car_data(True)
 
 
 def update_loop():
@@ -74,15 +82,23 @@ 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():
+def update_car_data(force_update=False):
     global last_data_update
     last_data_update = format_datetime(datetime.now(), format="medium", locale=settings["babelLocale"])
     for vin in volvo.vins:
+        for device_tracker in supported_device_trackers:
+            state = volvo.api_call(device_tracker["url"], "GET", vin, device_tracker["id"], force_update)
+            mqtt_client.publish(
+                f"homeassistant/device_tracker/{vin}_{device_tracker['id']}/attributes",
+                json.dumps(state)
+            )
+
         for lock in supported_locks:
-            state = volvo.api_call(lock["url"], "GET", vin, lock["id"])
+            state = volvo.api_call(lock["url"], "GET", vin, lock["id"], force_update)
             mqtt_client.publish(
                 f"homeassistant/lock/{vin}_{lock['id']}/state",
                 state
@@ -90,7 +106,7 @@ def update_car_data():
 
         for switch in supported_switches:
             if switch["id"] == "climate_status":
-                state = assumed_climate_state
+                state = assumed_climate_state[vin]
             else:
                 state = "OFF"
 
@@ -103,7 +119,7 @@ def update_car_data():
             if sensor["id"] == "last_data_update":
                 state = last_data_update
             else:
-                state = volvo.api_call(sensor["url"], "GET", vin, sensor["id"])
+                state = volvo.api_call(sensor["url"], "GET", vin, sensor["id"], force_update)
             mqtt_client.publish(
                 f"homeassistant/sensor/{vin}_{sensor['id']}/state",
                 state
@@ -112,23 +128,34 @@ def update_car_data():
 
 def create_ha_devices():
     for vin in volvo.vins:
-        car_details = volvo.api_call(VEHICLE_DETAILS_URL, "GET", vin)
+        device = volvo.get_vehicle_details(vin)
+
+        for device_tracker in supported_device_trackers:
+            config = {
+                        "name": device_tracker['name'],
+                        "object_id": f"volvo_{vin}_{device_tracker['id']}",
+                        "schema": "state",
+                        "icon": f"mdi:{device_tracker['icon']}",
+                        "state_topic": f"homeassistant/device_tracker/{vin}_{device_tracker['id']}/state",
+                        "device": device,
+                        "unique_id": f"volvoAAOS2mqtt_{vin}_{device_tracker['id']}",
+                        "json_attributes_topic": f"homeassistant/device_tracker/{vin}_{device_tracker['id']}/attributes"
+                    }
+            mqtt_client.publish(
+                f"homeassistant/device_tracker/volvoAAOS2mqtt/{vin}_{device_tracker['id']}/config",
+                json.dumps(config),
+            )
 
         for button in supported_buttons:
             command_topic = f"homeassistant/button/{vin}_{button['id']}/command"
             config = {
                         "name": button['name'],
-                        "object_id": button['id'],
+                        "object_id": f"volvo_{vin}_{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}",
-                        },
+                        "device": device,
                         "unique_id": f"volvoAAOS2mqtt_{vin}_{button['id']}",
                     }
             mqtt_client.publish(
@@ -142,18 +169,13 @@ def create_ha_devices():
             command_topic = f"homeassistant/lock/{vin}_{lock['id']}/command"
             config = {
                         "name": lock['name'],
-                        "object_id": lock['id'],
+                        "object_id": f"volvo_{vin}_{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}",
-                        },
+                        "device": device,
                         "unique_id": f"volvoAAOS2mqtt_{vin}_{lock['id']}",
                     }
             mqtt_client.publish(
@@ -167,18 +189,13 @@ def create_ha_devices():
             command_topic = f"homeassistant/switch/{vin}_{switch['id']}/command"
             config = {
                         "name": switch['name'],
-                        "object_id": switch['id'],
+                        "object_id": f"volvo_{vin}_{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}",
-                        },
+                        "device": device,
                         "unique_id": f"volvoAAOS2mqtt_{vin}_{switch['id']}",
                     }
             mqtt_client.publish(
@@ -191,16 +208,11 @@ def create_ha_devices():
         for sensor in supported_sensors:
             config = {
                         "name": sensor['name'],
-                        "object_id": sensor['id'],
+                        "object_id": f"volvo_{vin}_{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}",
-                        },
+                        "device": device,
                         "unique_id": f"volvoAAOS2mqtt_{vin}_{sensor['id']}",
                     }
             if "unit" in sensor:

src/translations/en.yaml

@@ -0,0 +1,16 @@
+configuration:
+  updateInterval:
+    name: Update intervall
+    description: Time to wait between data pulls
+  babelLocale:
+    name: Babel locale
+    description: Select your country code or take a look at the GitHub repo for more infos!
+  debug:
+    name: API debug mode
+    description: Enable Volvo API debug, normaly this can stay off
+  mqtt:
+    name: MQTT Broker settings
+    description: Broker is your mqtt broker IP eg "192.168.0.1". Mqtt username and password are optional.
+  volvoData:
+    name: Volvo APP credentials
+    description: You have to enter your Volvo app credentials. The username is normally your email, and the password is the password you use for your Volvo app. The vin can stay empty. The Add-On will use any vin inside your Volvo account. VCCAPI key is required and comes from your Volvo developer account. Take a look at the GitHub repo for more information!

src/volvo.py

@@ -0,0 +1,317 @@
+import requests
+from datetime import datetime, timedelta
+import mqtt
+from config import settings
+from babel.dates import format_datetime
+from const import charging_system_states, CLIMATE_START_URL, \
+    OAUTH_URL, VEHICLES_URL, VEHICLE_DETAILS_URL, RECHARGE_STATE_URL, \
+    WINDOWS_STATE_URL, LOCK_STATE_URL
+
+session = requests.Session()
+session.headers = {
+                "vcc-api-key": settings["volvoData"]["vccapikey"],
+                "content-type": "application/json",
+                "accept": "*/*"
+}
+
+token_expires_at: datetime
+refresh_token = None
+vins = []
+recharge_cached_api_response = {}
+recharge_api_last_update = {}
+window_cached_api_response = {}
+window_api_last_update = {}
+door_cached_api_response = {}
+door_api_last_update = {}
+
+
+def authorize():
+    headers = {
+                "authorization": "Basic aDRZZjBiOlU4WWtTYlZsNnh3c2c1WVFxWmZyZ1ZtSWFEcGhPc3kxUENhVXNpY1F0bzNUUjVrd2FKc2U0QVpkZ2ZJZmNMeXc=",
+                "content-type": "application/x-www-form-urlencoded",
+                "accept": "application/json"
+    }
+
+    body = {
+            "username": settings.volvoData["username"],
+            "password": settings.volvoData["password"],
+            "grant_type": "password",
+            "scope": "openid email profile care_by_volvo:financial_information:invoice:read care_by_volvo:financial_information:payment_method care_by_volvo:subscription:read customer:attributes customer:attributes:write order:attributes vehicle:attributes tsp_customer_api:all conve:brake_status conve:climatization_start_stop conve:command_accessibility conve:commands conve:diagnostics_engine_status conve:diagnostics_workshop conve:doors_status conve:engine_status conve:environment conve:fuel_status conve:honk_flash conve:lock conve:lock_status conve:navigation conve:odometer_status conve:trip_statistics conve:tyre_status conve:unlock conve:vehicle_relation conve:warnings conve:windows_status energy:battery_charge_level energy:charging_connection_status energy:charging_system_status energy:electric_range energy:estimated_charging_time energy:recharge_status vehicle:attributes"
+    }
+    auth = requests.post(OAUTH_URL, data=body, headers=headers)
+    if auth.status_code == 200:
+        data = auth.json()
+        session.headers.update({'authorization': "Bearer " + data["access_token"]})
+
+        global token_expires_at, refresh_token
+        token_expires_at = datetime.now() + timedelta(seconds=(data["expires_in"] - 30))
+        refresh_token = data["refresh_token"]
+
+        get_vehicles()
+    else:
+        message = auth.json()
+        raise Exception(message["error_description"])
+
+
+def refresh_auth():
+    print("Refreshing credentials")
+    global refresh_token
+    headers = {
+                "authorization": "Basic aDRZZjBiOlU4WWtTYlZsNnh3c2c1WVFxWmZyZ1ZtSWFEcGhPc3kxUENhVXNpY1F0bzNUUjVrd2FKc2U0QVpkZ2ZJZmNMeXc=",
+                "content-type": "application/x-www-form-urlencoded",
+                "accept": "application/json"
+    }
+
+    body = {
+            "grant_type": "refresh_token",
+            "refresh_token": refresh_token
+    }
+    auth = requests.post(OAUTH_URL, data=body, headers=headers)
+    if auth.status_code == 200:
+        data = auth.json()
+        session.headers.update({'authorization': "Bearer " + data["access_token"]})
+
+        global token_expires_at
+        token_expires_at = datetime.now() + timedelta(seconds=(data["expires_in"] - 30))
+        refresh_token = data["refresh_token"]
+
+
+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:
+                for vehicle in data["data"]:
+                    vins.append(vehicle["vin"])
+            else:
+                raise Exception("No vehicle in account " + settings.volvoData["username"] + " found.")
+        else:
+            raise Exception("Error getting vehicles: " + str(vehicles.status_code))
+    else:
+        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 len(vins) == 0:
+        raise Exception("No vehicle found, exiting application!")
+    else:
+        initialize_climate(vins)
+        print("Vin: " + str(vins) + " found!")
+
+
+def get_vehicle_details(vin):
+    response = session.get(VEHICLE_DETAILS_URL.format(vin), timeout=15)
+    if response.status_code == 200:
+        data = response.json()["data"]
+        if "debug" in settings:
+            if settings["debug"]:
+                print(response.text)
+        device = {
+                            "identifiers": [f"volvoAAOS2mqtt_{vin}"],
+                            "manufacturer": "Volvo",
+                            "model": data['descriptions']['model'],
+                            "name": f"{data['descriptions']['model']} ({data['modelYear']}) - {vin}",
+                 }
+    elif response.status_code == 500 and not settings.volvoData["vin"]:
+        # Workaround for some cars that are not returning vehicle details
+        device = {
+                            "identifiers": [f"volvoAAOS2mqtt_{vin}"],
+                            "manufacturer": "Volvo",
+                            "model": vin,
+                            "name": f"Volvo - {vin}",
+                 }
+    else:
+        raise Exception("Getting vehicle details failed. Status Code: " + str(response.status_code) +
+                        ". Error: " + response.text)
+
+    return device
+
+
+def initialize_climate(vins):
+    for vin in vins:
+        mqtt.assumed_climate_state[vin] = "OFF"
+
+
+def disable_climate(vin):
+    print("Turning climate off by timer!")
+    mqtt.assumed_climate_state[vin] = "OFF"
+    mqtt.update_car_data()
+
+
+def api_call(url, method, vin, sensor_id=None, force_update=False):
+    global token_expires_at
+    if datetime.now() >= token_expires_at:
+        refresh_auth()
+
+    if url == RECHARGE_STATE_URL:
+        # Minimize API calls for recharge state
+        response = pull_recharge_api(url, method, vin, force_update)
+    elif url == WINDOWS_STATE_URL:
+        # Minimize API calls for window state
+        response = pull_window_api(url, method, vin, force_update)
+    elif url == LOCK_STATE_URL:
+        # Minimize API calls for door state
+        response = pull_door_api(url, method, vin, force_update)
+    elif method == "GET":
+        print("Starting " + method + " call against " + url)
+        response = session.get(url.format(vin), timeout=15)
+    elif method == "POST":
+        print("Starting " + method + " call against " + url)
+        response = session.post(url.format(vin), timeout=20)
+    else:
+        print("Unkown method posted: " + method + ". Returning nothing")
+        return ""
+
+    if response.status_code == 200:
+        data = response.json()
+        if "debug" in settings:
+            if settings["debug"]:
+                print(response.text)
+    else:
+        if url == CLIMATE_START_URL and response.status_code == 503:
+            print("Car in use, cannot start pre climatization")
+            mqtt.assumed_climate_state = "OFF"
+            mqtt.update_car_data()
+        else:
+            print("API Call failed. Status Code: " + str(response.status_code) + ". Error: " + response.text)
+        return ""
+    state = parse_api_data(data, sensor_id)
+    if not state:
+        return ""
+    else:
+        return state
+
+
+
+def pull_door_api(url, method, vin, force_update=False):
+    global door_cached_api_response, door_api_last_update
+    if not vin in door_cached_api_response or force_update:
+        # No API Data for vin cached, get fresh data from API
+        print("Starting " + method + " call against " + url)
+        response = session.get(url.format(vin), timeout=15)
+        door_cached_api_response[vin] = response
+        door_api_last_update[vin] = datetime.now()
+    else:
+        if (datetime.now() - door_api_last_update[vin]).total_seconds() >= settings["updateInterval"]:
+            # Old Data in Cache, updating
+            print("Starting " + method + " call against " + url)
+            response = session.get(url.format(vin), timeout=15)
+            door_cached_api_response[vin] = response
+            door_api_last_update[vin] = datetime.now()
+        else:
+            # Data is up do date, returning cached data
+            response = door_cached_api_response[vin]
+    return response
+
+
+def pull_window_api(url, method, vin, force_update=False):
+    global window_cached_api_response, window_api_last_update
+    if not vin in window_cached_api_response or force_update:
+        # No API Data for vin cached, get fresh data from API
+        print("Starting " + method + " call against " + url)
+        response = session.get(url.format(vin), timeout=15)
+        window_cached_api_response[vin] = response
+        window_api_last_update[vin] = datetime.now()
+    else:
+        if (datetime.now() - window_api_last_update[vin]).total_seconds() >= settings["updateInterval"]:
+            # Old Data in Cache, updating
+            print("Starting " + method + " call against " + url)
+            response = session.get(url.format(vin), timeout=15)
+            window_cached_api_response[vin] = response
+            window_api_last_update[vin] = datetime.now()
+        else:
+            # Data is up do date, returning cached data
+            response = window_cached_api_response[vin]
+    return response
+
+
+def pull_recharge_api(url, method, vin, force_update=False):
+    global recharge_cached_api_response, recharge_api_last_update
+    if not vin in recharge_cached_api_response or force_update:
+        # No API Data for vin cached, get fresh data from API
+        print("Starting " + method + " call against " + url)
+        response = session.get(url.format(vin), timeout=15)
+        recharge_cached_api_response[vin] = response
+        recharge_api_last_update[vin] = datetime.now()
+    else:
+        if (datetime.now() - recharge_api_last_update[vin]).total_seconds() >= settings["updateInterval"]:
+            # Old Data in Cache, updating
+            print("Starting " + method + " call against " + url)
+            response = session.get(url.format(vin), timeout=15)
+            recharge_cached_api_response[vin] = response
+            recharge_api_last_update[vin] = datetime.now()
+        else:
+            # Data is up do date, returning cached data
+            response = recharge_cached_api_response[vin]
+    return response
+
+
+def parse_api_data(data, sensor_id=None):
+    if sensor_id == "battery_charge_level":
+        return data["data"].get("batteryChargeLevel").get("value")
+    elif sensor_id == "electric_range":
+        return data["data"].get("electricRange").get("value")
+    elif sensor_id == "charging_system_status":
+        if "chargingSystemStatus" in data["data"]:
+            return charging_system_states[data["data"].get("chargingSystemStatus").get("value")]
+        else:
+            return ""
+    elif sensor_id == "estimated_charging_time":
+        if "chargingSystemStatus" in data["data"]:
+            charging_system_state = charging_system_states[data["data"]["chargingSystemStatus"]["value"]]
+            if charging_system_state == "Charging":
+                return data["data"]["estimatedChargingTime"]["value"]
+            else:
+                return 0
+        else:
+            return ""
+    elif sensor_id == "estimated_charging_finish_time":
+        if "chargingSystemStatus" in data["data"]:
+            charging_system_state = charging_system_states[data["data"].get("chargingSystemStatus").get("value")]
+            if charging_system_state == "Charging":
+                charging_time = int(data["data"].get("estimatedChargingTime").get("value"))
+                charging_finished = datetime.now() + timedelta(minutes=charging_time)
+                return format_datetime(charging_finished, format="medium", locale=settings["babelLocale"])
+            else:
+                return None
+        else:
+            return None
+    elif sensor_id == "lock_status":
+        return data["data"].get("carLocked").get("value")
+    elif sensor_id == "odometer":
+        return data["data"].get("odometer").get("value")
+    elif sensor_id == "window_front_left":
+        return data["data"].get("frontLeftWindowOpen").get("value")
+    elif sensor_id == "window_front_right":
+        return data["data"].get("frontRightWindowOpen").get("value")
+    elif sensor_id == "window_rear_left":
+        return data["data"].get("rearLeftWindowOpen").get("value")
+    elif sensor_id == "window_rear_right":
+        return data["data"].get("rearRightWindowOpen").get("value")
+    elif sensor_id == "door_front_left":
+        return data["data"].get("frontLeftDoorOpen").get("value")
+    elif sensor_id == "door_front_right":
+        return data["data"].get("frontRightDoorOpen").get("value")
+    elif sensor_id == "door_rear_left":
+        return data["data"].get("rearLeftDoorOpen").get("value")
+    elif sensor_id == "door_rear_right":
+        return data["data"].get("rearRightDoorOpen").get("value")
+    elif sensor_id == "tailgate":
+        return data["data"].get("tailGateOpen").get("value")
+    elif sensor_id == "engine_hood":
+        return data["data"].get("hoodOpen").get("value")
+    elif sensor_id == "tank_lid":
+        return data["data"].get("tankLidOpen").get("value")
+    elif sensor_id == "location":
+        coordinates = {}
+        if "geometry" in data["data"]:
+            raw_data = data["data"].get("geometry").get("coordinates")
+            coordinates = {"longitude": raw_data[0], "latitude": raw_data[1], "gps_accuracy": 1}
+        return coordinates
+    else:
+        return ""

volvo.py

@@ -1,192 +0,0 @@
-import requests
-from datetime import datetime, timedelta
-import mqtt
-from config import settings
-from babel.dates import format_datetime
-from const import charging_system_states, CLIMATE_START_URL, \
-    OAUTH_URL, VEHICLES_URL, VEHICLE_DETAILS_URL, RECHARGE_STATUS_URL
-
-session = requests.Session()
-session.headers = {
-                "vcc-api-key": "",
-                "content-type": "application/json",
-                "accept": "*/*"
-}
-
-token_expires_at: datetime
-refresh_token = None
-vins = []
-recharge_response = {}
-recharge_last_update = None
-
-
-def authorize():
-    headers = {
-                "authorization": "Basic aDRZZjBiOlU4WWtTYlZsNnh3c2c1WVFxWmZyZ1ZtSWFEcGhPc3kxUENhVXNpY1F0bzNUUjVrd2FKc2U0QVpkZ2ZJZmNMeXc=",
-                "content-type": "application/x-www-form-urlencoded",
-                "accept": "application/json"
-    }
-
-    body = {
-            "username": settings.volvoData["username"],
-            "password": settings.volvoData["password"],
-            "grant_type": "password",
-            "scope": "openid email profile care_by_volvo:financial_information:invoice:read care_by_volvo:financial_information:payment_method care_by_volvo:subscription:read customer:attributes customer:attributes:write order:attributes vehicle:attributes tsp_customer_api:all conve:brake_status conve:climatization_start_stop conve:command_accessibility conve:commands conve:diagnostics_engine_status conve:diagnostics_workshop conve:doors_status conve:engine_status conve:environment conve:fuel_status conve:honk_flash conve:lock conve:lock_status conve:navigation conve:odometer_status conve:trip_statistics conve:tyre_status conve:unlock conve:vehicle_relation conve:warnings conve:windows_status energy:battery_charge_level energy:charging_connection_status energy:charging_system_status energy:electric_range energy:estimated_charging_time energy:recharge_status vehicle:attributes"
-    }
-    auth = requests.post(OAUTH_URL, data=body, headers=headers)
-    if auth.status_code == 200:
-        data = auth.json()
-        session.headers.update({'authorization': "Bearer " + data["access_token"]})
-
-        global token_expires_at, refresh_token
-        token_expires_at = datetime.now() + timedelta(seconds=(data["expires_in"] - 30))
-        refresh_token = data["refresh_token"]
-
-        session.headers.update({"vcc-api-key": settings["volvoData"]["vccapikey"]})
-        get_vehicles()
-    else:
-        message = auth.json()
-        raise Exception(message["error_description"])
-
-
-def refresh_auth():
-    print("Refreshing credentials")
-    global refresh_token
-    headers = {
-                "authorization": "Basic aDRZZjBiOlU4WWtTYlZsNnh3c2c1WVFxWmZyZ1ZtSWFEcGhPc3kxUENhVXNpY1F0bzNUUjVrd2FKc2U0QVpkZ2ZJZmNMeXc=",
-                "content-type": "application/x-www-form-urlencoded",
-                "accept": "application/json"
-    }
-
-    body = {
-            "grant_type": "refresh_token",
-            "refresh_token": refresh_token
-    }
-    auth = requests.post(OAUTH_URL, data=body, headers=headers)
-    if auth.status_code == 200:
-        data = auth.json()
-        session.headers.update({'authorization': "Bearer " + data["access_token"]})
-
-        global token_expires_at
-        token_expires_at = datetime.now() + timedelta(seconds=(data["expires_in"] - 30))
-        refresh_token = data["refresh_token"]
-
-
-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:
-                for vehicle in data["data"]:
-                    vins.append(vehicle["vin"])
-            else:
-                raise Exception("No vehicle in account " + settings.volvoData["username"] + " found.")
-        else:
-            raise Exception("Error getting vehicles: " + str(vehicles.status_code))
-    else:
-        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 len(vins) == 0:
-        raise Exception("No vehicle found, exiting application!")
-    else:
-        print("Vin: " + str(vins) + " found!")
-
-
-def disable_climate():
-    mqtt.assumed_climate_state = "OFF"
-    mqtt.update_car_data()
-
-
-def api_call(url, method, vin, sensor_id=None):
-    global token_expires_at
-    if datetime.now() >= token_expires_at:
-        refresh_auth()
-
-    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_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_last_update = datetime.now()
-            else:
-                # Data is up do date, returning cached data
-                response = recharge_response
-    elif method == "GET":
-        print("Starting " + method + " call against " + url)
-        response = session.get(url.format(vin), timeout=15)
-    elif method == "POST":
-        print("Starting " + method + " call against " + url)
-        response = session.post(url.format(vin), timeout=20)
-    else:
-        print("Unkown method posted: " + method + ". Returning nothing")
-        return ""
-
-    if response.status_code == 200:
-        data = response.json()
-    else:
-        if url == CLIMATE_START_URL and response.status_code == 503:
-            print("Car in use, cannot start pre climatization")
-            mqtt.assumed_climate_state = "OFF"
-            mqtt.update_car_data()
-        else:
-            print("API Call failed. Status Code: " + str(response.status_code) + ". Error: " + response.text)
-        return ""
-
-    if url == VEHICLE_DETAILS_URL:
-        return data["data"]
-    elif sensor_id == "battery_charge_level":
-        if "batteryChargeLevel" in data["data"]:
-            return data["data"]["batteryChargeLevel"]["value"]
-        else:
-            return ""
-    elif sensor_id == "electric_range":
-        if "electricRange" in data["data"]:
-            return data["data"]["electricRange"]["value"]
-        else:
-            return ""
-    elif sensor_id == "charging_system_status":
-        if "charging_system_status" in data["data"]:
-            return charging_system_states[data["data"]["chargingSystemStatus"]["value"]]
-        else:
-            return ""
-    elif sensor_id == "estimated_charging_time":
-        if "chargingSystemStatus" in data["data"]:
-            charging_system_state = charging_system_states[data["data"]["chargingSystemStatus"]["value"]]
-            if charging_system_state == "Charging":
-                return data["data"]["estimatedChargingTime"]["value"]
-            else:
-                return 0
-        else:
-            return ""
-    elif sensor_id == "estimated_charging_finish_time":
-        if "chargingSystemStatus" in data["data"]:
-            charging_system_state = charging_system_states[data["data"]["chargingSystemStatus"]["value"]]
-            if charging_system_state == "Charging":
-                charging_time = int(data["data"]["estimatedChargingTime"]["value"])
-                charging_finished = datetime.now() + timedelta(minutes=charging_time)
-                return format_datetime(charging_finished, format="medium", locale=settings["babelLocale"])
-            else:
-                return None
-        else:
-            return None
-    elif sensor_id == "lock_status":
-        return data["data"]["carLocked"]["value"]
-    else:
-        return ""