Add new charging system states #152

* Catch Volvo API not returning a valid json string #104

* Update changelog

.env.dist

@@ -0,0 +1,5 @@
+CONF_updateInterval=300
+CONF_babelLocale='de'
+CONF_mqtt='@json {"broker": "mqtt", "username": "", "password": ""}'
+CONF_volvoData='@json {"username": "", "password": "", "vin": "",   "vccapikey": ""}'
+TZ='Europe/Berlin'

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**:<br>
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**:<br>
+A clear and concise description of what you expected to happen.
+
+**Screenshots**:<br>
+If applicable, add screenshots to help explain your problem.
+
+**Version info**:<br>
+The version you are using and the method you are using (Docker container/HA Addon/Cloned repo)
+
+**Logs**:<br>
+Enable the debug option and upload your logfile here. <br>
+<b>If you are using the HA Addon the log location is `\\<Your HA Host IP>\addons\volvo2mqtt\log\volvo2mqtt.log`

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/stale.yml

@@ -0,0 +1,33 @@
+# This workflow warns and then closes issues and PRs that have had no activity for a specified amount of time.
+#
+# You can adjust the behavior by modifying this file.
+# For more information, see:
+# https://github.com/actions/stale
+name: Mark stale issues and pull requests
+
+on:
+  schedule:
+  - cron: '0 0 * * *'
+
+jobs:
+  stale:
+
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+
+    steps:
+    - uses: actions/stale@v5
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        days-before-issue-stale: 15
+        days-before-pr-stale: 45
+        days-before-issue-close: 5
+        days-before-pr-close: 10
+        stale-issue-message: 'This issue is stale because it has been open 15 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
+        stale-pr-message: 'This PR is stale because it has been open 20 days with no activity. Remove stale label or comment or this will be closed in 10 days.'
+        close-issue-message: 'This issue was closed because it has been stalled for 5 days with no activity.'
+        close-pr-message: 'This PR was closed because it has been stalled for 10 days with no activity.'
+        stale-issue-label: 'no-issue-activity'
+        stale-pr-label: 'no-pr-activity'

.gitignore

@@ -1 +1,6 @@
-.idea
+.idea
+venv
+src/settings.dev.json
+.env
+/src/volvo2mqtt.log
+/src/volvo2mqtt.log.1

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

@@ -1,25 +1,116 @@
 # Volvo2Mqtt
+![Supports aarch64 Architecture][aarch64-shield]
+![Supports amd64 Architecture][amd64-shield]
+![Supports armhf Architecture][armhf-shield]
+![Supports armv7 Architecture][armv7-shield]
+![Supports i386 Architecture][i386-shield]
+<br>
+![Project Maintenance][maintenance-shield]
+[![GitHub Release][releases-shield]][releases]
+[![GitHub Activity][commits-shield]][commits]
 
 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.
+<p>
+
+Home Assistant thread can be found [here](https://community.home-assistant.io/t/volvo2mqtt-connect-your-aaos-volvo/585699).
+
+<b>Important note: The Volvo api currently ONLY works in these [countries](https://developer.volvocars.com/terms-and-conditions/apis-supported-locations/)</b>
+
+If you like my work:<br>
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/U7U8MFXCF)
+
+## Confirmed working with
+- XC40 BEV (2024)
+- XC40 BEV (2023)
+- XC40 BEV (2022)
+- XC40 PHEV (2021)
+- V60 T8 PHEV (2023)
+- C40 BEV (2023)
+- C40 BEV (2022)
+- XC90 T8 PHEV (2023)
+- XC60 PHEV (2024)
+- XC60 PHEV (2023)
+- XC60 PHEV (2022)
+- XC90 PHEV T8 (2023)
+- XC90 PHEV T8 (2024)
+- XC90 B5 Mildhybrid (2024)
+- V90 PHEV T8 (2019)*
+- V90 PHEV T6 (2024)
+
+*only partly working
+
+Please let me know if your car works with this addon so I can expand the list!<br>
+
+
+## Supported features
+- Lock/unlock car
+- Start/stop climate
+- Sensor "Battery Charge Level"
+- Sensor "Electric Range"
+- Sensor "Charging System Status"
+- Sensor "Charging Connection Status" (partly broken since 2.10 car update)
+- Sensor "Estimated Charging Finish Time"
+- Sensor "Door Lock Status (All doors, tank lid, and engine hood)"
+- Sensor "Window Lock Status (All windows and sunroof - Thanks to @navet)"
+- Sensor "Engine Status"
+- Sensor "Odometer"
+- Sensor "Tire Status"
+- Sensor "Fuel Status"
+- Sensor "Average Fuel Consumption"
+- Sensor "Average Speed"
+- Sensor "Distance to Empty"
+- Sensor "Hours to Service"
+- Sensor "Distance to Service"
+- Sensor "Months to Service"
+- Sensor "Service warning status"
+- Sensor "Service warning trigger"
+- Car Device Tracker
+- 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 -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 -d --pull=always -e CONF_updateInterval=300 -e CONF_babelLocale='de' -e CONF_mqtt='@json {"broker": "", "username": "", "password": "", "port": 1883}' -e CONF_volvoData='@json {"username": "", "password": "", "vin": "", "vccapikey": ["key1", "key2"], "odometerMultiplier": 1, "averageSpeedDivider": 1, "averageFuelConsumptionMultiplier": 1}' -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** | Updateintervall 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/).                                   |
-| `TZ`                 | `string`  |              | Container timezone eg "Europe/Berlin" |
+| Environment Variable Name |   Type    | Json Option                           |   Default    | Description                                                     |
+| ------------------------- | :-------: | :-----------------------------------: | :----------: | --------------------------------------------------------------- |
+| `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`    | `broker`                              | **required** | Your MQTT Broker IP. Eg. 192.168.0.5.
+| `CONF_mqtt`               | `json`    | `port`                                | 1883         | Your MQTT Broker Port. If no value is given, port 1883 will be used.  |
+| `CONF_mqtt`               | `json`    | `username`                            | optional     | MQTT Username for your broker.
+| `CONF_mqtt`               | `json`    | `password`                            | optional     | MQTT Password for your broker.
+| `CONF_volvoData`          | `json`    | `username`                            | **required** | Normally your email address to login into the Volvo App.
+| `CONF_volvoData`          | `json`    | `password`                            | **required** | Your password to login into the Volvo App.
+| `CONF_volvoData`          | `json`    | `vin`                                 | optional     | A single VIN like "VIN1" or a list of VINs like "["VIN1", "VIN2"]". Leave this empty if you don't know your VIN. The addon will use every car that is tied to your account.
+| `CONF_volvoData`          | `json`    | `vccapikey`                           | **required** | VCCAPIKEY linked with your volvo developer account. Get your Vccapi key from [here](https://developer.volvocars.com/account/). <b>Starting version 1.8.0, it is possible to define multiple keys, like this: `["vccapikey1", "vccapikey2", "vccapikey3", "etc..."]`</b>
+| `CONF_volvoData`          | `json`    | `odometerMultiplier`                  | optional     | The multiplier value for the odometer value, as the volvo api delivers inconsistent data. For some cars this setting is 10, for some 1. Try what's right for your car. If you leave it empty, the multiplier will be 1.
+| `CONF_volvoData`          | `json`    | `averageSpeedDivider`                 | optional     | The divider value for the average speed value, as the volvo api delivers inconsistent data. For some cars this setting is 10, for some 1. Try what's right for your car. If you leave it empty, the divider will be 1.
+| `CONF_volvoData`          | `json`    | `averageFuelConsumptionMultiplier`    | optional     | The multiplier value for the average fuel consumption value, as the volvo api delivers inconsistent data. For some cars this setting is 10, for some 1. Try what's right for your car. If you leave it empty, the multiplier will be 1.
+| `CONF_debug`              | `string`  |                                       | optional     | Debug option (true/false). Normally you don't need this. |
+| `TZ`                      | `string`  |                                       | **required** | Container timezone eg "Europe/Berlin" from [here](https://docs.diladele.com/docker/timezones.html)|
 
-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>
+
+[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
+[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
+[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
+[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
+[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
+[releases]: https://github.com/Dielee/volvo2mqtt/releases
+[releases-shield]: https://img.shields.io/github/release/Dielee/volvo2mqtt.svg
+[maintenance-shield]: https://img.shields.io/maintenance/yes/2023.svg
+[commits-shield]: https://img.shields.io/github/commit-activity/y/Dielee/volvo2mqtt.svg
+[commits]: https://github.com/Dielee/volvo2mqtt/commits/main

config.py

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

const.py

@@ -1,34 +0,0 @@
-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"
-	]
-}

docker-compose.yml

@@ -0,0 +1,24 @@
+version: '3'
+services:
+  app:
+    build: .
+    env_file:
+      - .env
+    #    environment:
+    #      CONF_updateInterval: 300
+    #      CONF_babelLocale: 'de'
+    #      CONF_mqtt: '@json {"broker": "mqtt", "username": "", "password": ""}'
+    #      CONF_volvoData: '@json {"username": "", "password": "", "vin": "",   "vccapikey": ""}'
+    #      TZ: 'Europe/Berlin'
+    links:
+      - mqtt
+    depends_on:
+      - mqtt
+
+  mqtt:
+    container_name: mqtt
+    image: eclipse-mosquitto
+    expose:
+      - 1883
+    command: [ "/usr/sbin/mosquitto", "-c", "/mosquitto-no-auth.conf" ]
+

main.py

@@ -1,7 +0,0 @@
-from volvo import authorize
-from mqtt import update_loop, connect
-
-if __name__ == '__main__':
-    authorize()
-    connect()
-    update_loop()

mqtt.py

@@ -1,213 +0,0 @@
-import time
-import paho.mqtt.client as mqtt
-import json
-import volvo
-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, \
-            CAR_UNLOCK_URL, supported_sensors, supported_buttons, supported_switches, supported_locks
-
-
-mqtt_client: mqtt.Client
-subscribed_topics = []
-assumed_climate_state = "OFF"
-last_data_update = None
-
-
-def connect():
-    client = mqtt.Client("volvoAAOS2mqtt")
-    if settings["mqtt"]["username"] and settings["mqtt"]["password"]:
-        client.username_pw_set(settings["mqtt"]["username"], settings["mqtt"]["password"])
-    client.connect(settings["mqtt"]["broker"])
-    client.loop_start()
-    client.on_message = on_message
-    client.on_disconnect = on_disconnect
-    client.on_connect = on_connect
-
-    global mqtt_client
-    mqtt_client = client
-
-
-def on_connect(client, userdata, flags, rc):
-    if len(subscribed_topics) > 0:
-        for topic in subscribed_topics:
-            mqtt_client.subscribe(topic)
-
-
-def on_disconnect(client, userdata,  rc):
-    print("MQTT disconnected, reconnecting automatically")
-
-
-def on_message(client, userdata, msg):
-    if msg.topic in subscribed_topics:
-        payload = msg.payload.decode("UTF-8")
-        if "climate_status" in msg.topic:
-            global assumed_climate_state
-            if payload == "ON":
-                api_thread = threading.Thread(target=volvo.api_call, args=(CLIMATE_START_URL, "POST", ))
-                api_thread.start()
-                assumed_climate_state = "ON"
-                # Starting timer to disable climate after 30 mins
-                threading.Timer(30 * 60, volvo.disable_climate).start()
-                update_car_data()
-            elif payload == "OFF":
-                api_thread = threading.Thread(target=volvo.api_call, args=(CLIMATE_STOP_URL, "POST", ))
-                api_thread.start()
-                assumed_climate_state = "OFF"
-                update_car_data()
-        elif "lock_status" in msg.topic:
-            if payload == "LOCK":
-                volvo.api_call(CAR_LOCK_URL, "POST")
-                update_car_data()
-            elif payload == "UNLOCK":
-                volvo.api_call(CAR_UNLOCK_URL, "POST")
-                update_car_data()
-        elif "update_data" in msg.topic:
-            if payload == "PRESS":
-                update_car_data()
-
-
-def update_loop():
-    create_ha_devices()
-    while True:
-        print("Sending mqtt update...")
-        update_car_data()
-        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 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"
-
-            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", vin, sensor["id"])
-            mqtt_client.publish(
-                f"homeassistant/sensor/{vin}_{sensor['id']}/state",
-                state
-            )
-
-
-def create_ha_devices():
-    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/{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/{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/{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/{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/{vin}_{sensor['id']}/config",
-                json.dumps(config),
-            )
-    time.sleep(2)

repository.yaml

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

requirements.txt

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

settings.json

@@ -1,15 +0,0 @@
-{
-  "updateInterval": 300,
-  "babelLocale": "de",
-  "mqtt": {
-    "broker": "",
-    "username": "",
-    "password": ""
-  },
-  "volvoData": {
-    "username": "",
-    "password": "",
-    "vin": "",
-	"vccapikey": ""
-  }
-}

src/CHANGELOG.md

@@ -0,0 +1,267 @@
+## v1.8.23
+### 🚀 Features:
+
+- Add new charging system states #152
+
+## v1.8.22
+### 🚀 Features:
+
+- Change units to HA default #148
+
+## v1.8.21
+### 🐛 Bug Fixes:
+
+- Try to fix addon build #146
+
+## v1.8.20
+### 🐛 Bug Fixes:
+
+- Fix Addon crash if icon state is `UNKOWN`
+- Add `UNSPECIFIED` state for windows
+
+
+## v1.8.19
+### 🐛 Bug Fixes:
+
+- Fix Estimated Charging Time not changing to zero #133 
+
+## v1.8.18
+### 🐛 Bug Fixes:
+
+- Fix Backend State Sensor returning `null`
+
+## v1.8.17
+### 🚀 Features:
+
+- Move vehicle and vehicle details to v2 endpoint
+
+### 🐛 Bug Fixes:
+
+- Fix Battery Charge Level icon update
+
+## v1.8.16
+### 🚀 Features:
+
+- Add `Average energy consumption`, `Distance to empty battery` and `Washer fluid level` sensors
+- Support force update for `Backend state` Sensor
+- Use cached requests for fuel endpoint
+
+## v1.8.15
+### 🚀 Features:
+
+- Move `batteryChargeLevel` to the new v2 fuel endpoint
+- Add api backend status sensor
+
+## v1.8.14
+### 🐛 Bug Fixes:
+
+- Fix distance to empty sensor #127
+- Remove unused service warning trigger sensor
+
+## v1.8.13
+### 🐛 Bug Fixes:
+
+- Add "Time to Service" sensor #125<p>
+  <b>Breaking change: The "Months to Service" sensor will be automatically deleted.<br>
+  "Time to Service" contains this information now.
+
+## v1.8.12
+### 🐛 Bug Fixes:
+
+- Fix `AJAR` state for windows
+- Fix deprecation from `currentThread` to `current_thread`
+
+## v1.8.11
+### 🐛 Bug Fixes:
+
+- Remove old code from checks for running engine sensor
+- Move battery charge level sensor from v2 to v1, as v2 returns 404
+
+## v1.8.10
+### 🐛 Bug Fixes:
+
+- Add `AJAR` state for sunroof #123
+
+## v1.8.9
+### 🐛 Bug Fixes:
+
+- Fix api changes from volvo #121
+
+## v1.8.8
+### 🐛 Bug Fixes:
+
+- Fix json decode error, if volvo API returns a simple string #104
+
+## v1.8.7
+### 🚀 Features:
+
+- Add option to disable log completely #96 
+
+### 🐛 Bug Fixes:
+
+- Fix regex error for some mailaddresses #97
+
+## v1.8.6
+### 🚀 Features:
+
+- Add option to use multiple docker containers (with different logins) #93
+
+## v1.8.5
+### 🚀 Features:
+
+- Allow phone number as username #91
+
+## v1.8.4
+### 🚀 Features:
+
+- Optimize Addon configuration #90
+
+## v1.8.3
+### 🚀 Features:
+
+- Add `device_class: battery` for battery state sensors from BEV and PHEV 
+
+## v1.8.2
+### 🚀 Features:
+
+- Add `updateInterval` limit to prevent abuse (60 Seconds)
+- Add `vccapikey` limit to prevent abuse (3 Keys)
+- Optimize vcc api key change behaviour
+
+## v1.8.1
+### 🐛 Bug Fixes:
+
+- Fix app crash if `debug` is not set #86
+
+## v1.8.0
+### 🚀 Features:
+
+- <b>Breaking change: The `vccapikey` setting is now a list. It is possible to
+  add multiple VCCAPIKEYs. This will be helpful if you are extending your 10.000 call limit sometimes.
+  Change your vccapikey config like this:
+  
+  Old:
+  ```
+    "vccapikey": "vccapikey1" 
+  ```
+
+  New:
+  ```
+    vccapikey:
+      - vccapikey1
+      - vccapikey2
+      - vccapikey3
+      - etc.
+  ```
+  More information about this feature [here](https://github.com/Dielee/volvo2mqtt/issues/84).
+    </b>
+
+## v1.7.10
+### 🐛 Bug Fixes:
+
+- Fix application startup if using `en_US` or `en_GB` as locale
+
+## v1.7.9
+### 🚀 Features:
+
+- Added vehicle diagnostics sensors #75. Thanks to @aerrow5!
+
+## v1.7.8
+### 🐛 Bug Fixes:
+
+- Fix "Estimated Charging Finish Time" Sensor  
+
+## v1.7.7
+### 🚀 Features:
+
+- Added long term statistics for some sensors #68. Thanks to @bogdanbujdea!
+- Automatic redact sensitive data from debug log
+- Perpare for scheduler option (not yet ready)
+
+## v1.7.6
+### 🚀 Features:
+
+- Added support for interior and exterior images via the new [MQTT Image](https://www.home-assistant.io/integrations/image.mqtt/) entity. #62
+
+<b>NOTE: This feature is only available using homeassistant version 2023.7.1 or greater.</b>
+
+## v1.7.5
+### 🚀 Features:
+
+- Added support for `LOCKING` and `UNLOCKING` state (Lock entity)
+
+## v1.7.4
+### 🐛 Bug Fixes:
+
+- Fixed undocumented charging connection state `CONNECTION_STATUS_FAULT` '#57
+
+## v1.7.3
+### 🐛 Bug Fixes:
+
+- Fixed API changes from Volvo #53
+
+<b>ATTENTION: Volvo optimized their API. Maybe you have to set your odometer multiplier to 1. 
+Also check all the other multipliers!</b>
+## v1.7.2
+### 🐛 Bug Fixes:
+
+- Fixed "Engine State" can be "true" or "false", not "RUNNING" or "STOPPED" #47
+
+## v1.7.1
+### 🚀 Features:
+
+- Moved "Engine State" from "sensor" to the "binary_sensor" domain
+- Improved HA Add-On security level to 7
+
+<b>NOTE: The old "sensor" entity will be not deleted automatically. If you want to clean up your mqtt device, just delete it and restart the volvo2mqtt addon.
+</b>
+
+## v1.7.0
+### 🚀 Features:
+
+- Added MQTT autodiscovery for HA Add-On users
+- Added "Engine State" fallback endpoint for some cars (BEVs)
+- Added dynamic icons for "Engine State"
+- Turn off the pre-climate switch if "Engine State" changes to "RUNNING"
+
+<b>NOTE: The mqtt broker port is now a string. Just quote your port like this `port: "1883"`</b><br>
+<b>NOTE: If you want to switch to MQTT autodiscovery for the HA Add-On change your settings to: <br>
+![image](https://i.imgur.com/GBamhFn.png)</b>
+
+## v1.6.5
+### 🐛 Bug Fixes:
+
+- Fixed missing key in unit mappings for `en_US` and `en_GB` mapping
+
+## v1.6.4
+### 🚀 Features:
+
+- Added dynamic icons for lock, battery and window state #43 
+
+## v1.6.3
+### 🚀 Features:
+
+- Moved data source for "Distance to empty" from extended api to connected api
+
+## v1.6.2
+### 🚀 Features:
+
+- Moved print statements to logger
+- Added more debug logging
+- The full HA Addon log can now be found at your addon smb share `\\<Your HA IP>\addons\volvo2mqtt\log\volvo2mqtt.log`
+
+## v1.6.1
+### 🚀 Features:
+
+- Added "Washer Fluid Level" and "Distance to Empty" sensors #37 
+- Expanded climate control for better state sync with HA
+
+### 🐛 Bug Fixes:
+
+- Fixed wrong return values for not working endpoints
+- Fixed app crash on credential renewal timeout #39 
+
+## v1.6.0
+### 🚀 Features:
+
+- Added conversion from metric to imperial system for `en_US` and `en_GB` locale

src/Dockerfile

@@ -0,0 +1,21 @@
+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 --no-cache https://raw.githubusercontent.com/Dielee/volvo2mqtt/main/requirements.txt
+
+# install dependencies
+RUN pip install -r requirements.txt --break-system-packages
+
+# copy the content of the local src directory to the working directory
+COPY / .
+RUN chmod a+x /volvoAAOS2mqtt/run.sh
+
+# command to run on container start
+CMD [ "/volvoAAOS2mqtt/run.sh" ]

src/apparmor.txt

@@ -0,0 +1,66 @@
+#include <tunables/global>
+
+profile volvo2mqtt flags=(attach_disconnected,mediate_deleted) {
+  #include <abstractions/base>
+
+  # Capabilities
+  capability,
+  file,
+  signal (send) set=(kill,term,int,hup,cont),
+  network,
+
+  # 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,58 @@
+name: "Volvo2Mqtt"
+description: "Volvo AAOS MQTT bridge"
+version: "1.8.23"
+slug: "volvo2mqtt"
+init: false
+url: "https://github.com/Dielee/volvo2mqtt"
+apparmor: true
+codenotary: notary@home-assistant.io
+services:
+  - 'mqtt:need'
+map: 
+  - addons:rw
+options:
+  updateInterval: 300
+  babelLocale: null
+  TZ: null
+  debug: false
+  disable_logging: false
+  mqtt:
+    broker: "auto_broker"
+    port: "auto_port"
+    username: "auto_user"
+    password: "auto_password"
+  volvoData:
+    username: null
+    password: null
+    vin: ""
+    vccapikey:
+        - null
+    odometerMultiplier: 1
+    averageSpeedDivider: 1
+    averageFuelConsumptionMultiplier: 1
+schema:
+  updateInterval: int(60,)
+  babelLocale: str
+  TZ: match(^.+/.+$)
+  debug: bool
+  disable_logging: bool
+  mqtt:
+    broker: str
+    port: str
+    username: str?
+    password: str?
+  volvoData:
+    username: match(^([a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+)|(\+\d{5,20})$)
+    password: str
+    vin: str?
+    vccapikey:
+        - match(^\b\w{32}\b$)
+    odometerMultiplier: int(1,)
+    averageSpeedDivider: int(1,)
+    averageFuelConsumptionMultiplier: int(1,)
+arch:
+  - aarch64
+  - amd64
+  - armhf
+  - armv7
+  - i386

src/const.py

@@ -0,0 +1,136 @@
+from config import settings
+
+VERSION = "v1.8.23"
+
+OAUTH_URL = "https://volvoid.eu.volvocars.com/as/token.oauth2"
+VEHICLES_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles"
+VEHICLE_DETAILS_URL = "https://api.volvocars.com/connected-vehicle/v2/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"
+TYRE_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/tyres"
+ENGINE_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/engine-status"
+FUEL_BATTERY_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/fuel"
+STATISTICS_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/statistics"
+ENGINE_DIAGNOSTICS_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/engine"
+VEHICLE_DIAGNOSTICS_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/diagnostics"
+API_BACKEND_STATUS = "https://oip-dev-bff.euwest1.production.volvo.care/api/v1/backend-status"
+
+LENGTH_KILOMETERS = "km"
+SPEED_KILOMETERS_PER_HOUR = "km/h"
+TIME_MINUTES = "min"
+LENGTH_MILES = "mi"
+SPEED_MILES_PER_HOUR = "mph"
+VOLUME_LITERS = "L"
+ENERGY_KILO_WATT_HOUR = "kWh"
+TIME_HOURS = "h"
+TIME_MONTHS = "m"
+
+units = {
+            "en_GB": {
+                "divider": 1.60934,
+                "electric_range": {"unit": LENGTH_MILES},
+                "odometer": {"unit": LENGTH_MILES},
+                "average_speed": {"unit": SPEED_MILES_PER_HOUR},
+                "distance_to_empty": {"unit": LENGTH_MILES},
+                "distance_to_service": {"unit": LENGTH_MILES}
+            },
+            "en_US": {
+                "divider": 1.60934,
+                "electric_range": {"unit": LENGTH_MILES},
+                "odometer": {"unit": LENGTH_MILES},
+                "average_speed": {"unit": SPEED_MILES_PER_HOUR},
+                "distance_to_empty": {"unit": LENGTH_MILES},
+                "distance_to_service": {"unit": LENGTH_MILES}
+            }
+        }
+
+availability_topic = "volvoAAOS2mqtt/availability"
+
+charging_system_states = {"CHARGING_SYSTEM_CHARGING": "Charging", "CHARGING_SYSTEM_IDLE": "Idle",
+                          "CHARGING_SYSTEM_FAULT": "Fault", "CHARGING_SYSTEM_UNSPECIFIED": "Unspecified",
+                          "CHARGING_SYSTEM_DONE": "Done", "CHARGING_SYSTEM_SCHEDULED": "Scheduled"}
+
+charging_connection_states = {"CONNECTION_STATUS_DISCONNECTED": "Disconnected", "CONNECTION_STATUS_UNSPECIFIED": "Unspecified",
+                              "CONNECTION_STATUS_CONNECTED_DC": "Connected DC", "CONNECTION_STATUS_CONNECTED_AC": "Connected AC",
+                              "CONNECTION_STATUS_FAULT": "Fault"}
+
+window_states = {"CLOSED": "OFF", "OPEN": "ON", "UNSPECIFIED": "UNKNOWN", "AJAR": "ON"}
+door_states = {"CLOSED": "OFF", "OPEN": "ON", "UNSPECIFIED": "UNKNOWN", "AJAR": "ON"}
+engine_states = {"RUNNING": "ON", "STOPPED": "OFF", "true": "ON", "false": "OFF"}
+
+icon_states = {
+    "lock_status": {"UNLOCKED": "lock-open-alert", "LOCKED": "lock", "UNLOCKING": "lock-reset", "LOCKING": "lock-reset"},
+    "door_front_left": {"ON": "car-door", "OFF": "car-door-lock"},
+    "door_front_right": {"ON": "car-door", "OFF": "car-door-lock"},
+    "door_rear_left": {"ON": "car-door", "OFF": "car-door-lock"},
+    "door_rear_right": {"ON": "car-door", "OFF": "car-door-lock"},
+    "engine_state": {"ON": "engine-outline", "OFF": "engine-off-outline"},
+    "battery_charge_level": [
+                    {"from": 100, "to": 100, "icon": "battery"},
+                    {"from": 99, "to": 90, "icon": "battery-90"},
+                    {"from": 89, "to": 80, "icon": "battery-80"},
+                    {"from": 79, "to": 70, "icon": "battery-70"},
+                    {"from": 69, "to": 60, "icon": "battery-60"},
+                    {"from": 59, "to": 50, "icon": "battery-50"},
+                    {"from": 49, "to": 40, "icon": "battery-40"},
+                    {"from": 39, "to": 30, "icon": "battery-30"},
+                    {"from": 29, "to": 20, "icon": "battery-20"},
+                    {"from": 19, "to": 10, "icon": "battery-10"},
+                    {"from": 9, "to": 0, "icon": "battery-alert-variant-outline"},
+    ]
+}
+
+supported_entities = [
+                        {"name": "Battery Charge Level", "domain": "sensor", "device_class": "battery", "id": "battery_charge_level", "unit": "%", "icon": "car-battery", "url": RECHARGE_STATE_URL, "state_class": "measurement"},
+                        {"name": "Battery Charge Level", "domain": "sensor", "device_class": "battery", "id": "battery_charge_level", "unit": "%", "icon": "car-battery", "url": FUEL_BATTERY_STATE_URL, "state_class": "measurement"},
+                        {"name": "Electric Range", "domain": "sensor", "id": "electric_range", "unit": LENGTH_KILOMETERS if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["electric_range"]["unit"], "icon": "map-marker-distance", "url": RECHARGE_STATE_URL, "state_class": "measurement"},
+                        {"name": "Estimated Charging Time", "domain": "sensor", "id": "estimated_charging_time", "unit": TIME_MINUTES, "icon": "timer-sync-outline", "url": RECHARGE_STATE_URL, "state_class": "measurement"},
+                        {"name": "Charging System Status", "domain": "sensor", "id": "charging_system_status", "icon": "ev-station", "url": RECHARGE_STATE_URL},
+                        {"name": "Charging Connection Status", "domain": "sensor", "id": "charging_connection_status", "icon": "ev-plug-ccs2", "url": RECHARGE_STATE_URL},
+                        {"name": "Estimated Charging Finish Time", "domain": "sensor", "id": "estimated_charging_finish_time", "icon": "timer-sync-outline", "url": RECHARGE_STATE_URL},
+                        {"name": "Odometer", "domain": "sensor", "id": "odometer", "unit": LENGTH_KILOMETERS if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["odometer"]["unit"], "icon": "counter", "url": ODOMETER_STATE_URL, "state_class":"total_increasing"},
+                        {"name": "Last Data Update", "domain": "sensor", "id": "last_data_update", "icon": "timer", "url": ""},
+                        {"name": "Active schedules", "domain": "sensor", "id": "active_schedules", "icon": "timer", "url": ""},
+                        {"name": "Window Front Left", "domain": "binary_sensor", "device_class": "window", "id": "window_front_left", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
+                        {"name": "Window Front Right", "domain": "binary_sensor", "device_class": "window", "id": "window_front_right", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
+                        {"name": "Window Rear Left", "domain": "binary_sensor", "device_class": "window", "id": "window_rear_left", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
+                        {"name": "Window Rear Right", "domain": "binary_sensor", "device_class": "window", "id": "window_rear_right", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
+                        {"name": "Door Front Left", "domain": "binary_sensor", "device_class": "door", "id": "door_front_left", "icon": "car-door-lock", "url": LOCK_STATE_URL},
+                        {"name": "Door Front Right", "domain": "binary_sensor", "device_class": "door", "id": "door_front_right", "icon": "car-door-lock", "url": LOCK_STATE_URL},
+                        {"name": "Door Rear Left", "domain": "binary_sensor", "device_class": "door", "id": "door_rear_left", "icon": "car-door-lock", "url": LOCK_STATE_URL},
+                        {"name": "Door Rear Right", "domain": "binary_sensor", "device_class": "door", "id": "door_rear_right", "icon": "car-door-lock", "url": LOCK_STATE_URL},
+                        {"name": "Tailgate", "domain": "binary_sensor", "device_class": "door", "id": "tailgate", "icon": "car-door-lock", "url": LOCK_STATE_URL},
+                        {"name": "Engine Hood", "domain": "binary_sensor", "device_class": "door", "id": "engine_hood", "icon": "car-door-lock", "url": LOCK_STATE_URL},
+                        {"name": "Tank Lid", "domain": "binary_sensor", "device_class": "door", "id": "tank_lid", "icon": "car-door-lock", "url": LOCK_STATE_URL},
+                        {"name": "Sunroof", "domain": "binary_sensor", "device_class": "door", "id": "sunroof", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
+                        {"name": "Air Conditioning", "domain": "switch", "id": "climate_status", "icon": "air-conditioner"},
+                        {"name": "Lock state", "domain": "lock", "id": "lock_status", "icon": "lock", "url": LOCK_STATE_URL},
+                        {"name": "Force Update Data", "domain": "button", "id": "update_data", "icon": "update", "url": ""},
+                        {"name": "Location", "domain": "device_tracker", "id": "location", "icon": "map-marker-radius", "url": LOCATION_STATE_URL},
+                        {"name": "Tire Front Left", "domain": "sensor", "id": "tyre_front_left", "icon": "car-tire-alert", "url": TYRE_STATE_URL},
+                        {"name": "Tire Front Right", "domain": "sensor", "id": "tyre_front_right", "icon": "car-tire-alert", "url": TYRE_STATE_URL},
+                        {"name": "Tire Rear Left", "domain": "sensor", "id": "tyre_rear_left", "icon": "car-tire-alert", "url": TYRE_STATE_URL},
+                        {"name": "Tire Rear Right", "domain": "sensor", "id": "tyre_rear_right", "icon": "car-tire-alert", "url": TYRE_STATE_URL},
+                        {"name": "Engine State", "domain": "binary_sensor", "device_class": "running", "id": "engine_state", "icon": "engine", "url": ENGINE_STATE_URL},
+                        {"name": "Fuel Level", "domain": "sensor", "id": "fuel_level", "unit": VOLUME_LITERS, "icon": "fuel", "url": FUEL_BATTERY_STATE_URL, "state_class": "measurement"},
+                        {"name": "Average Fuel Consumption", "domain": "sensor", "id": "average_fuel_consumption", "unit": VOLUME_LITERS, "icon": "fuel", "url": STATISTICS_URL},
+                        {"name": "Average Energy Consumption", "domain": "sensor", "id": "average_energy_consumption", "unit": ENERGY_KILO_WATT_HOUR, "icon": "car-electric", "url": STATISTICS_URL},
+                        {"name": "Distance to Empty Tank", "domain": "sensor", "id": "distance_to_empty_tank", "unit": LENGTH_KILOMETERS if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["distance_to_empty"]["unit"], "icon": "map-marker-distance", "url": STATISTICS_URL, "state_class": "measurement"},
+                        {"name": "Distance to Empty Battery", "domain": "sensor", "id": "distance_to_empty_battery", "unit": LENGTH_KILOMETERS if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["distance_to_empty"]["unit"], "icon": "map-marker-distance", "url": STATISTICS_URL, "state_class": "measurement"},
+                        {"name": "Average Speed", "domain": "sensor", "id": "average_speed", "unit": SPEED_KILOMETERS_PER_HOUR if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["average_speed"]["unit"], "icon": "speedometer", "url": STATISTICS_URL, "state_class": "measurement"},
+                        {"name": "Hours to Service", "domain": "sensor", "id": "hours_to_service", "unit": TIME_HOURS, "icon": "wrench-clock", "url": VEHICLE_DIAGNOSTICS_URL},
+                        {"name": "Distance to Service", "domain": "sensor", "id": "km_to_service", "unit": LENGTH_KILOMETERS if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["distance_to_service"]["unit"], "icon": "wrench-clock", "url": VEHICLE_DIAGNOSTICS_URL},
+                        {"name": "Time to Service", "domain": "sensor", "id": "time_to_service", "icon": "wrench-clock", "url": VEHICLE_DIAGNOSTICS_URL},
+                        {"name": "Service warning status", "domain": "sensor", "id": "service_warning_status", "icon": "alert-outline", "url": VEHICLE_DIAGNOSTICS_URL},
+                        {"name": "Washer Fluid Level warning", "domain": "sensor", "id": "washer_fluid_warning", "icon": "alert-outline", "url": VEHICLE_DIAGNOSTICS_URL},
+                        {"name": "API Backend status", "domain": "sensor", "id": "api_backend_status", "icon": "alert"}
+]
+
+old_entity_ids = ["months_to_service", "service_warning_trigger", "distance_to_empty"]

src/main.py

@@ -0,0 +1,16 @@
+import logging
+from volvo import authorize
+from mqtt import update_loop, connect
+from const import VERSION
+from util import set_tz, setup_logging, set_mqtt_settings, validate_settings
+
+
+if __name__ == '__main__':
+    setup_logging()
+    logging.info("Starting volvo2mqtt version " + VERSION)
+    validate_settings()
+    set_tz()
+    set_mqtt_settings()
+    connect()
+    authorize()
+    update_loop()

src/mqtt.py

@@ -0,0 +1,379 @@
+import logging
+import time
+import paho.mqtt.client as mqtt
+import json
+import volvo
+import util
+import os
+from threading import Thread, Timer
+from datetime import datetime
+from babel.dates import format_datetime
+from config import settings
+from const import CLIMATE_START_URL, CLIMATE_STOP_URL, CAR_LOCK_URL, \
+    CAR_UNLOCK_URL, availability_topic, icon_states, old_entity_ids
+
+mqtt_client: mqtt.Client
+subscribed_topics = []
+assumed_climate_state = {}
+last_data_update = None
+climate_timer = {}
+engine_status = {}
+devices = {}
+active_schedules = {}
+
+
+def connect():
+    client = mqtt.Client("volvoAAOS2mqtt") if os.environ.get("IS_HA_ADDON") \
+        else mqtt.Client("volvoAAOS2mqtt_" + settings.volvoData["username"].replace("+", ""))
+
+    client.will_set(availability_topic, "offline", 0, False)
+    if settings["mqtt"]["username"] and settings["mqtt"]["password"]:
+        client.username_pw_set(settings["mqtt"]["username"], settings["mqtt"]["password"])
+    port = 1883
+    if util.keys_exists(settings["mqtt"], "port"):
+        conf_port = settings["mqtt"]["port"]
+        if isinstance(conf_port, int):
+            if conf_port > 0:
+                port = settings["mqtt"]["port"]
+    client.connect(settings["mqtt"]["broker"], port)
+    client.loop_start()
+    client.on_message = on_message
+    client.on_disconnect = on_disconnect
+    client.on_connect = on_connect
+
+    global mqtt_client
+    mqtt_client = client
+
+
+def send_car_images(vin, data, device):
+    if util.keys_exists(data, "images"):
+        for entity in [{"name": "Exterior Image", "id": "exterior_image"},
+                       {"name": "Interior Image", "id": "interior_image"}]:
+            url_topic = f"homeassistant/image/{vin}_{entity['id']}/image_url"
+            config = {
+                "name": entity["name"],
+                "object_id": f"volvo_{vin}_{entity['id']}",
+                "schema": "state",
+                "icon": "mdi:image-area",
+                "url_topic": url_topic,
+                "device": device,
+                "unique_id": f"volvoAAOS2mqtt_{vin}_{entity['id']}",
+                "availability_topic": availability_topic
+            }
+
+            mqtt_client.publish(
+                f"homeassistant/image/volvoAAOS2mqtt/{vin}_{entity['id']}/config",
+                json.dumps(config),
+                retain=True
+            )
+
+            if entity["id"] == "exterior_image":
+                mqtt_client.publish(
+                    url_topic,
+                    data["images"]["exteriorImageUrl"],
+                    retain=True
+                )
+
+            if entity["id"] == "interior_image":
+                mqtt_client.publish(
+                    url_topic,
+                    data["images"]["internalImageUrl"],
+                    retain=True
+                )
+
+
+def on_connect(client, userdata, flags, rc):
+    send_heartbeat()
+    if len(subscribed_topics) > 0:
+        for topic in subscribed_topics:
+            mqtt_client.subscribe(topic)
+
+
+def on_disconnect(client, userdata, rc):
+    logging.warning("MQTT disconnected, reconnecting automatically")
+
+
+def on_message(client, userdata, msg):
+    try:
+        vin = msg.topic.split('/')[2].split('_')[0]
+    except IndexError:
+        logging.error("Error - Cannot get vin from MQTT topic!")
+        return None
+
+    payload = msg.payload.decode("UTF-8")
+    if "climate_status" in msg.topic:
+        if payload == "ON":
+            start_climate(vin)
+        elif payload == "OFF":
+            stop_climate(vin)
+    elif "lock_status" in msg.topic:
+        if payload == "LOCK":
+            lock_car(vin)
+        elif payload == "UNLOCK":
+            unlock_car(vin)
+    elif "update_data" in msg.topic:
+        if payload == "PRESS":
+            update_car_data(True)
+    elif "schedule" in msg.topic:
+        try:
+            d = json.loads(payload)
+        except ValueError as e:
+            logging.error("Can't set timer. Error: " + str(e))
+            return None
+
+        if d["mode"] == "timer":
+            start_climate_timer(d, vin)
+        else:
+            logging.warning("No schedule mode found, doing nothing")
+
+
+def start_climate_timer(d, vin):
+    global active_schedules
+    try:
+        minute = int(d["start_time"].split(":")[1])
+        hour = int(d["start_time"].split(":")[0])
+        local_datetime = datetime.now(util.TZ)
+        start_datetime = local_datetime.replace(hour=hour, minute=minute, second=0)
+        timer_seconds = (start_datetime - local_datetime).total_seconds()
+    except Exception as e:
+        logging.error("Error creating climate timer: " + str(e))
+        return None
+
+    if timer_seconds > 0:
+        Timer(timer_seconds, activate_climate_timer, (vin, start_datetime.isoformat(),)).start()
+        active_schedules[vin]["timers"].append(start_datetime.isoformat())
+        logging.debug("Climate timer set to " + str(start_datetime))
+        update_car_data()
+    else:
+        logging.warning("Timer can not be set. Unusable start time entered")
+
+
+def unlock_car(vin):
+    # Start the api call in another thread for HA performance
+    Thread(target=volvo.api_call, args=(CAR_UNLOCK_URL, "POST", vin)).start()
+
+    # Force set unlocking state
+    update_car_data(False, {"entity_id": "lock_status", "vin": vin, "state": "UNLOCKING"})
+    # Fetch API lock state until unlocking finished
+    Thread(target=volvo.check_lock_status, args=(vin, "LOCKED")).start()
+
+
+def lock_car(vin):
+    # Start the api call in another thread for HA performance
+    Thread(target=volvo.api_call, args=(CAR_LOCK_URL, "POST", vin)).start()
+
+    # Force set locking state
+    update_car_data(False, {"entity_id": "lock_status", "vin": vin, "state": "LOCKING"})
+    # Fetch API lock state until locking finished
+    Thread(target=volvo.check_lock_status, args=(vin, "UNLOCKED")).start()
+
+
+def stop_climate(vin):
+    global assumed_climate_state, climate_timer, engine_status
+    # Start the api call in another thread for HA performance
+    Thread(target=volvo.api_call, args=(CLIMATE_STOP_URL, "POST", vin)).start()
+
+    # Stop door check thread if running
+    if engine_status[vin].is_alive():
+        engine_status[vin].do_run = False
+
+    # Stop climate timer if active
+    if climate_timer[vin].is_alive():
+        climate_timer[vin].cancel()
+
+    # Set and update switch status
+    assumed_climate_state[vin] = "OFF"
+    update_car_data()
+
+
+def activate_climate_timer(vin, start_time):
+    start_climate(vin)
+    active_schedules[vin]["timers"].remove(start_time)
+    update_car_data()
+
+
+def start_climate(vin):
+    global assumed_climate_state, climate_timer, engine_status
+    # Start the api call in another thread for HA performance
+    Thread(target=volvo.api_call, args=(CLIMATE_START_URL, "POST", vin)).start()
+
+    # Start door check thread to turn off climate if driver door is opened
+    check_engine_thread = Thread(target=volvo.check_engine_status, args=(vin,))
+    check_engine_thread.start()
+    engine_status[vin] = check_engine_thread
+
+    # Starting timer to disable climate after 30 mins
+    climate_timer[vin] = Timer(30 * 60, volvo.disable_climate, (vin,))
+    climate_timer[vin].start()
+
+    # Set and update switch status
+    assumed_climate_state[vin] = "ON"
+    update_car_data()
+
+
+def update_loop():
+    create_ha_devices()
+    while True:
+        logging.info("Sending mqtt update...")
+        send_heartbeat()
+        update_car_data()
+        logging.info("Mqtt update done. Next run in " + str(settings["updateInterval"]) + " seconds.")
+        time.sleep(settings["updateInterval"])
+
+
+def update_car_data(force_update=False, overwrite={}):
+    global last_data_update
+    last_data_update = format_datetime(datetime.now(util.TZ), format="medium", locale=settings["babelLocale"])
+    for vin in volvo.vins:
+        for entity in volvo.supported_endpoints[vin]:
+            if entity["domain"] == "button":
+                continue
+
+            ov_entity_id = ""
+            ov_vin = ""
+            ov_state = ""
+            if bool(overwrite):
+                ov_entity_id = overwrite["entity_id"]
+                ov_vin = overwrite["vin"]
+                ov_state = overwrite["state"]
+
+            if entity["id"] == "climate_status":
+                state = assumed_climate_state[vin]
+            elif entity["id"] == "last_data_update":
+                state = last_data_update
+            elif entity["id"] == "active_schedules":
+                state = active_schedules[vin]
+            elif entity["id"] == "api_backend_status":
+                if force_update:
+                    state = volvo.get_backend_status()
+                else:
+                    state = volvo.backend_status
+            else:
+                if entity["id"] == ov_entity_id and vin == ov_vin:
+                    state = ov_state
+                else:
+                    state = volvo.api_call(entity["url"], "GET", vin, entity["id"], force_update)
+
+            if entity["domain"] == "device_tracker" or entity["id"] == "active_schedules":
+                topic = f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/attributes"
+            else:
+                topic = f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/state"
+
+            if state or state == 0:
+                mqtt_client.publish(
+                    topic,
+                    json.dumps(state) if isinstance(state, dict) or isinstance(state, list) else state
+                )
+                update_ha_device(entity, vin, state)
+
+
+def update_ha_device(entity, vin, state):
+    icon_config = icon_states.get(entity["id"])
+    try:
+        if icon_config and state:
+            logging.debug("Entity " + entity["id"] + " state " + str(state))
+            if isinstance(state, float):
+                icon = util.get_icon_between(icon_config, state)
+            elif state.replace(".", "").isnumeric():
+                state = float(state)
+                icon = util.get_icon_between(icon_config, state)
+            else:
+                icon = icon_config[state]
+        else:
+            return None
+    except:
+        return None
+
+    logging.debug("Updating icon to " + icon + " for " + entity["id"])
+    config = {
+        "name": entity['name'],
+        "object_id": f"volvo_{vin}_{entity['id']}",
+        "schema": "state",
+        "icon": f"mdi:{icon}" if icon else f"mdi:{entity['icon']}",
+        "state_topic": f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/state",
+        "device": devices[vin],
+        "unique_id": f"volvoAAOS2mqtt_{vin}_{entity['id']}",
+        "availability_topic": availability_topic
+    }
+    if entity.get("device_class"):
+        config["device_class"] = entity["device_class"]
+
+    if entity.get("unit"):
+        config["unit_of_measurement"] = entity["unit"]
+
+    if entity.get("state_class"):
+        config["state_class"] = entity["state_class"]
+
+    if entity.get("domain") == "device_tracker":
+        config["json_attributes_topic"] = f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/attributes"
+
+    if entity.get("domain") in ["switch", "lock", "button"]:
+        command_topic = f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/command"
+        config["command_topic"] = command_topic
+        subscribed_topics.append(command_topic)
+        mqtt_client.subscribe(command_topic)
+
+    mqtt_client.publish(
+        f"homeassistant/{entity['domain']}/volvoAAOS2mqtt/{vin}_{entity['id']}/config",
+        json.dumps(config),
+        retain=True
+    )
+
+
+def create_ha_devices():
+    global subscribed_topics, devices
+    for vin in volvo.vins:
+        device = volvo.get_vehicle_details(vin)
+        devices[vin] = device
+        for entity in volvo.supported_endpoints[vin]:
+            config = {
+                "name": entity['name'],
+                "object_id": f"volvo_{vin}_{entity['id']}",
+                "schema": "state",
+                "icon": f"mdi:{entity['icon']}",
+                "state_topic": f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/state",
+                "device": device,
+                "unique_id": f"volvoAAOS2mqtt_{vin}_{entity['id']}",
+                "availability_topic": availability_topic
+            }
+            if entity.get("device_class"):
+                config["device_class"] = entity["device_class"]
+
+            if entity.get("unit"):
+                config["unit_of_measurement"] = entity["unit"]
+
+            if entity.get("state_class"):
+                config["state_class"] = entity["state_class"]
+
+            if entity.get("domain") == "device_tracker" or entity.get("id") == "active_schedules":
+                config["json_attributes_topic"] = f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/attributes"
+            elif entity.get("domain") in ["switch", "lock", "button"]:
+                command_topic = f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/command"
+                config["command_topic"] = command_topic
+                subscribed_topics.append(command_topic)
+                mqtt_client.subscribe(command_topic)
+            elif entity.get("domain") == "image":
+                config["url_topic"] = f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/image_url"
+
+            mqtt_client.publish(
+                f"homeassistant/{entity['domain']}/volvoAAOS2mqtt/{vin}_{entity['id']}/config",
+                json.dumps(config),
+                retain=True
+            )
+    time.sleep(2)
+    send_heartbeat()
+
+
+def send_heartbeat():
+    mqtt_client.publish(availability_topic, "online")
+
+
+def send_offline():
+    mqtt_client.publish(availability_topic, "offline")
+
+
+def delete_old_entities():
+    for vin in volvo.vins:
+        for entity in old_entity_ids:
+            topic = f"homeassistant/sensor/volvoAAOS2mqtt/{vin}_{entity}/config"
+            mqtt_client.publish(topic, payload="", retain=True)

src/run.sh

@@ -0,0 +1,9 @@
+#!/command/with-contenv bashio
+export IS_HA_ADDON="true"
+
+export MQTTHOST=$(bashio::services mqtt "host")
+export MQTTPORT=$(bashio::services mqtt "port")
+export MQTTUSER=$(bashio::services mqtt "username")
+export MQTTPASS=$(bashio::services mqtt "password")
+
+python -u main.py

src/settings.json

@@ -0,0 +1,22 @@
+{
+  "updateInterval": 300,
+  "babelLocale": "de",
+  "TZ": "Europe/Berlin",
+  "debug": false,
+  "disable_logging": false,
+  "mqtt": {
+    "broker": "",
+    "port": 1883,
+    "username": "",
+    "password": ""
+  },
+  "volvoData": {
+    "username": "",
+    "password": "",
+    "vin": "",
+	"vccapikey": [],
+    "odometerMultiplier": "",
+    "averageSpeedDivider": "",
+    "averageFuelConsumptionMultiplier": ""
+  }
+}

src/translations/en.yaml

@@ -0,0 +1,22 @@
+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!
+  TZ:
+    name: Timezone
+    description: Set your local timezone eg. "Europe/Berlin" or "America/New_York"
+  debug:
+    name: API debug mode
+    description: Enable Volvo API debug, normaly this can stay off. If enabled, the complete log file can be found under \\<Your HA Host IP>\addons\volvo2mqtt\log\volvo2mqtt.log.
+  disable_logging:
+    name: Disable logging
+    description: Disable logging completely to reduce IO and SD card access.
+  mqtt:
+    name: MQTT Broker settings
+    description: Leave the settings as they are if you are using the MQTT Mosquitto Addon. If not, take a look at the readme from volvo2mqtt.
+  volvoData:
+    name: Volvo configuration options
+    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. This setting works as list, so it is possible to define multiple VCCAPI keys. Odometer multiplier is sometimes 10, sometimes 1. The same is applicable for average speed divider and average fuel consumption. Leave it as it is if you don't know what's right. Take a look at the GitHub repo for more information!

src/util.py

@@ -0,0 +1,154 @@
+import logging
+import pytz
+import os
+import re
+import sys
+import config
+from logging import handlers
+from datetime import datetime
+from const import units
+from config import settings
+from pathlib import Path
+
+TZ = None
+SENSITIVE_PATTERNS = [
+    r"[A-Z0-9]{17}",  # VIN
+    r"\d{1,2}\.\d{5,16}",  # Location
+    r"[a-z0-9]{32}"  # VCCAPIKEY
+]
+
+
+class SensitiveDataFilter(logging.Filter):
+    def __init__(self, patterns=None):
+        super().__init__()
+        self.patterns = patterns or []
+
+    def filter(self, record: logging.LogRecord) -> bool:
+        for pattern in self.patterns:
+            record.msg = re.sub(pattern, "<REDACTED>", record.msg)
+        return True
+
+
+def get_icon_between(icon_list, state):
+    icon = None
+    for s in icon_list:
+        if s["to"] <= state <= s["from"]:
+            icon = s["icon"]
+    return icon
+
+
+def setup_logging():
+    log_location = "volvo2mqtt.log"
+    if os.environ.get("IS_HA_ADDON"):
+        check_existing_folder()
+        log_location = "/addons/volvo2mqtt/log/volvo2mqtt.log"
+
+    logging.Formatter.converter = lambda *args: datetime.now(tz=TZ).timetuple()
+    file_log_handler = logging.handlers.RotatingFileHandler(log_location, maxBytes=1000000, backupCount=1)
+    formatter = logging.Formatter(
+        '%(asctime)s volvo2mqtt [%(process)d] - %(levelname)s: %(message)s',
+        '%b %d %H:%M:%S')
+    file_log_handler.setFormatter(formatter)
+
+    if "debug" in settings:
+        if settings["debug"]:
+            sensitive_data_filter = SensitiveDataFilter(SENSITIVE_PATTERNS)
+            file_log_handler.addFilter(sensitive_data_filter)
+
+    console_log_handler = logging.StreamHandler(sys.stdout)
+    console_log_handler.setFormatter(formatter)
+
+    logger = logging.getLogger()
+    logger.addHandler(console_log_handler)
+    logger.addHandler(file_log_handler)
+    logging.getLogger("urllib3").setLevel(logging.WARNING)
+
+    logger.setLevel(logging.INFO)
+    if "debug" in settings:
+        if settings["debug"]:
+            logger.setLevel(logging.DEBUG)
+
+    if "disable_logging" in settings:
+        if settings["disable_logging"]:
+            logger.setLevel(logging.ERROR)
+
+
+def check_existing_folder():
+    Path("/addons/volvo2mqtt/log/").mkdir(parents=True, exist_ok=True)
+
+
+def keys_exists(element, *keys):
+    """"
+    Check if *keys (nested) exists in `element` (dict).
+    Thanks stackoverflow: https://stackoverflow.com/questions/43491287/elegant-way-to-check-if-a-nested-key-exists-in-a-dict
+    """
+    if not isinstance(element, dict):
+        raise AttributeError('keys_exists() expects dict as first argument.')
+    if len(keys) == 0:
+        raise AttributeError('keys_exists() expects at least two arguments, one given.')
+
+    _element = element
+    for key in keys:
+        try:
+            _element = _element[key]
+        except KeyError:
+            return False
+    return True
+
+
+def set_tz():
+    global TZ
+    env_tz = os.environ.get("TZ")
+    settings_tz = settings.get("TZ")
+    if env_tz:
+        TZ = pytz.timezone(env_tz)
+    elif settings_tz:
+        TZ = pytz.timezone(settings_tz)
+    else:
+        raise Exception("No timezone setting found! Please read the README!")
+
+
+def convert_metric_values(value):
+    if keys_exists(units, settings["babelLocale"]):
+        divider = units[settings["babelLocale"]]["divider"]
+        return round((float(value) / divider), 2)
+    else:
+        return value
+
+
+def set_mqtt_settings():
+    if os.environ.get("IS_HA_ADDON"):
+        if config.settings["mqtt"]["broker"] != "auto_broker" \
+                or config.settings["mqtt"]["port"] != "auto_port" \
+                or config.settings["mqtt"]["username"] != "auto_user" \
+                or config.settings["mqtt"]["password"] != "auto_password":
+            # If settings were manually set, use the manually set settings
+            return None
+
+        broker_host = os.getenv("MQTTHOST", None)
+        broker_port = os.getenv("MQTTPORT", None)
+        broker_user = os.getenv("MQTTUSER", None)
+        broker_pass = os.getenv("MQTTPASS", None)
+
+        if not broker_host or not broker_port:
+            raise Exception("MQTT connection could not be established. Please check if your MQTT Add-On is running!")
+
+        logging.debug("MQTT Credentials - Host " + broker_host + " Port: " + str(broker_port) +
+                      " User: " + str(broker_user) + " Pass: " + str(broker_pass))
+
+        config.settings["mqtt"]["broker"] = broker_host
+        config.settings["mqtt"]["port"] = broker_port
+        config.settings["mqtt"]["username"] = broker_user
+        config.settings["mqtt"]["password"] = broker_pass
+
+
+def validate_settings():
+    if not os.environ.get("DEV_MODE"):
+        setting_keys = settings.volvoData["vccapikey"]
+        if isinstance(setting_keys, list):
+            if len(setting_keys) > 3:
+                raise Exception("Settings invalid! Maximum allowed vccapikeys are three!")
+
+        update_interval = settings["updateInterval"]
+        if update_interval < 60:
+            raise Exception("Settings invalid! Minimum allowed update interval is 60 seconds!")

src/volvo.py

@@ -0,0 +1,599 @@
+import logging
+import requests
+import mqtt
+import util
+import time
+import re
+from threading import current_thread, Thread
+from datetime import datetime, timedelta
+from config import settings
+from babel.dates import format_datetime
+from json import JSONDecodeError
+from const import charging_system_states, charging_connection_states, door_states, window_states, \
+    OAUTH_URL, VEHICLES_URL, VEHICLE_DETAILS_URL, RECHARGE_STATE_URL, CLIMATE_START_URL, \
+    WINDOWS_STATE_URL, LOCK_STATE_URL, TYRE_STATE_URL, supported_entities, FUEL_BATTERY_STATE_URL, \
+    STATISTICS_URL, ENGINE_DIAGNOSTICS_URL, API_BACKEND_STATUS, engine_states
+
+session = requests.Session()
+session.headers = {
+    "vcc-api-key": "",
+    "content-type": "application/json",
+    "accept": "*/*"
+}
+
+token_expires_at: datetime
+refresh_token = None
+vins = []
+supported_endpoints = {}
+cached_requests = {}
+vcc_api_keys = []
+backend_status = ""
+
+
+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(util.TZ) + timedelta(seconds=(data["expires_in"] - 30))
+        refresh_token = data["refresh_token"]
+
+        get_vcc_api_keys()
+        get_vehicles()
+        check_supported_endpoints()
+        Thread(target=backend_status_loop).start()
+    else:
+        message = auth.json()
+        raise Exception(message["error_description"])
+
+
+def refresh_auth():
+    logging.info("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
+    }
+
+    try:
+        auth = requests.post(OAUTH_URL, data=body, headers=headers)
+    except requests.exceptions.RequestException as e:
+        logging.error("Error refreshing credentials data: " + str(e))
+        return None
+
+    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(util.TZ) + 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)
+        data = vehicles.json()
+        if vehicles.status_code == 200:
+            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:
+            error = vehicles.json()
+            raise Exception(
+                "Error getting vehicles: " + str(vehicles.status_code) + ". " + str(error["error"].get("message")))
+    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)
+        initialize_scheduler(vins)
+        mqtt.delete_old_entities()
+        logging.info("Vin: " + str(vins) + " found!")
+
+
+def get_vcc_api_keys(used_key=None):
+    working_keys = None
+
+    while not working_keys:
+        setting_keys = settings.volvoData["vccapikey"]
+        if isinstance(setting_keys, str):
+            set_key_state(setting_keys)
+        elif isinstance(setting_keys, list):
+            for key in setting_keys:
+                set_key_state(key)
+
+        logging.debug(str(vcc_api_keys))
+        working_keys = [key["key"] for key in vcc_api_keys if not key.get("extended") and key.get('key') != used_key]
+        if len(working_keys) < 1:
+            used_key = None
+            logging.warning("No working VCCAPIKEY found, waiting 10 minutes. Then trying again!")
+            mqtt.send_offline()
+            time.sleep(600)
+        else:
+            mqtt.send_heartbeat()
+            session.headers.update({"vcc-api-key": working_keys[0]})
+            logging.info("Using VCCAPIKEY: " + working_keys[0])
+            for key_dict in vcc_api_keys:
+                if key_dict["key"] == working_keys[0]:
+                    key_dict["in_use"] = True
+
+        logging.debug(str(vcc_api_keys))
+
+
+def set_key_state(key):
+    global vcc_api_keys
+    list_index = next((index for (index, d) in enumerate(vcc_api_keys) if d["key"] == key), None)
+
+    if list_index or list_index == 0:
+        extended, extended_until = check_vcc_api_key(key, vcc_api_keys[list_index]["extended_until"])
+        vcc_api_keys[list_index] = ({"key": key, "extended": extended,
+                                     "extended_until": extended_until, "in_use": False})
+    else:
+        extended, extended_until = check_vcc_api_key(key)
+        vcc_api_keys.append({"key": key, "extended": extended,
+                             "extended_until": extended_until, "in_use": False})
+
+
+def check_vcc_api_key(test_key, extended_until=None):
+    if extended_until:
+        if extended_until >= datetime.now():
+            logging.warning("VCCAPIKEY " + test_key + " is extended and will be reusable at: "
+                            + format_datetime(extended_until, format="medium", locale=settings["babelLocale"]))
+            return True, extended_until
+
+    if datetime.now(util.TZ) >= token_expires_at:
+        refresh_auth()
+
+    token = session.headers.get("authorization")
+    headers = {
+        "vcc-api-key": test_key,
+        "content-type": "application/json",
+        "accept": "*/*",
+        "authorization": token
+    }
+
+    response = requests.get(VEHICLES_URL, headers=headers)
+    data = response.json()
+    if response.status_code == 200:
+        logging.debug("VCCAPIKEY " + test_key + " works!")
+        return False, None
+    elif response.status_code == 403 and "message" in data:
+        if "Out of call volume quota" in data["message"]:
+            reuse_search = re.search(r"\d{2}\:\d{2}\:\d{2}", data["message"])
+            if reuse_search:
+                reusable_in = reuse_search.group(0).split(":")
+                now = datetime.now()
+                extended_until = now + timedelta(hours=int(reusable_in[0]),
+                                                 minutes=int(reusable_in[1]),
+                                                 seconds=int(reusable_in[2]) + 10)
+                logging.warning("VCCAPIKEY " + test_key + " is extended and will be reusable at: "
+                                + format_datetime(extended_until, format="medium", locale=settings["babelLocale"]))
+        else:
+            logging.warning("VCCAPIKEY " + test_key + " isn't working! " + data["error"]["message"])
+    else:
+        logging.warning("VCCAPIKEY " + test_key + " isn't working! " + data["error"]["message"])
+    return True, extended_until
+
+
+def change_vcc_api_key():
+    used_vcc_api_key = session.headers.get("vcc-api-key")
+    get_vcc_api_keys(used_vcc_api_key)
+
+
+def get_vehicle_details(vin):
+    response = session.get(VEHICLE_DETAILS_URL.format(vin), timeout=15)
+    if response.status_code == 200:
+        data = response.json()["data"]
+        logging.debug(response.text)
+        device = {
+            "identifiers": [f"volvoAAOS2mqtt_{vin}"],
+            "manufacturer": "Volvo",
+            "model": data['descriptions']['model'],
+            "name": f"{data['descriptions']['model']} ({data['modelYear']}) - {vin}",
+        }
+        mqtt.send_car_images(vin, data, device)
+    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 check_supported_endpoints():
+    global supported_endpoints
+    for vin in vins:
+        supported_endpoints[vin] = []
+        for entity in supported_entities:
+            if entity["id"] == "battery_charge_level" and entity["url"] == FUEL_BATTERY_STATE_URL \
+                    and any("battery_charge_level" in d["id"] for d in supported_endpoints[vin]):
+                # If battery charge level could be found in recharge-api, skip the second battery charge sensor
+                continue
+
+            if entity.get('url'):
+                state = api_call(entity["url"], "GET", vin, entity["id"])
+            else:
+                state = ""
+
+            if state is not None:
+                logging.info("Success! " + entity["name"] + " is supported by your vehicle.")
+                supported_endpoints[vin].append(entity)
+            else:
+                logging.info("Failed, " + entity["name"] + " is unfortunately not supported by your vehicle.")
+
+
+def initialize_scheduler(vins):
+    for vin in vins:
+        topic = f"homeassistant/schedule/{vin}/command"
+        mqtt.active_schedules[vin] = {"timers": []}
+        mqtt.subscribed_topics = [topic]
+        mqtt.mqtt_client.subscribe(topic)
+
+
+def initialize_climate(vins):
+    for vin in vins:
+        mqtt.assumed_climate_state[vin] = "OFF"
+
+
+def disable_climate(vin):
+    logging.info("Turning climate off by timer!")
+    mqtt.engine_status[vin].do_run = False
+    mqtt.assumed_climate_state[vin] = "OFF"
+    mqtt.update_car_data()
+
+
+def check_lock_status(vin, old_state):
+    max_runs = 10
+    done_runs = 0
+    lock_state = api_call(LOCK_STATE_URL, "GET", vin, "lock_status", True)
+    while lock_state == old_state:
+        done_runs = done_runs + 1
+        if done_runs >= max_runs:
+            break
+        lock_state = api_call(LOCK_STATE_URL, "GET", vin, "lock_status", True)
+        time.sleep(2)
+
+    mqtt.update_car_data()
+
+
+def check_engine_status(vin):
+    endpoint_url = ""
+    engine_state_supported = False
+    for endpoint in supported_endpoints[vin]:
+        if "engine_state" == endpoint["id"]:
+            engine_state_supported = True
+            endpoint_url = endpoint["url"]
+
+    if not engine_state_supported:
+        # Exit thread as engine state is unsupported by car
+        return None
+
+    t = current_thread()
+    while getattr(t, "do_run", True):
+        engine_state = api_call(endpoint_url, "GET", vin, "engine_state", True)
+        if engine_state == "ON":
+            mqtt.assumed_climate_state[vin] = "OFF"
+            mqtt.update_car_data()
+            break
+        time.sleep(5)
+
+
+def backend_status_loop():
+    while True:
+        get_backend_status()
+        # Update every hour
+        time.sleep(3600)
+
+
+def get_backend_status():
+    global backend_status
+    response = session.get(API_BACKEND_STATUS, timeout=15)
+    try:
+        data = response.json()
+        if util.keys_exists(data, "message"):
+            if data["message"]:
+                backend_status = data["message"]
+            else:
+                backend_status = "NO_WARNING"
+        else:
+            backend_status = "NO_WARNING"
+
+    except JSONDecodeError as e:
+        backend_status = "NO_WARNING"
+    return backend_status
+
+
+def api_call(url, method, vin, sensor_id=None, force_update=False, key_change=False):
+    if datetime.now(util.TZ) >= token_expires_at:
+        refresh_auth()
+
+    if url in [RECHARGE_STATE_URL, WINDOWS_STATE_URL, LOCK_STATE_URL, TYRE_STATE_URL,
+               STATISTICS_URL, ENGINE_DIAGNOSTICS_URL, FUEL_BATTERY_STATE_URL]:
+        # Minimize API calls for endpoints with multiple values
+        response = cached_request(url, method, vin, force_update, key_change)
+        if response is None:
+            # Exception caught while getting data from volvo api, doing nothing
+            return None
+    elif method == "GET":
+        logging.debug("Starting " + method + " call against " + url)
+        try:
+            response = session.get(url.format(vin), timeout=15)
+        except requests.exceptions.RequestException as e:
+            logging.error("Error getting data: " + str(e))
+            return None
+    elif method == "POST":
+        logging.debug("Starting " + method + " call against " + url)
+        try:
+            response = session.post(url.format(vin), timeout=20)
+        except requests.exceptions.RequestException as e:
+            logging.error("Error getting data: " + str(e))
+            return None
+    else:
+        logging.error("Unkown method posted: " + method + ". Returning nothing")
+        return None
+
+    logging.debug("Response status code: " + str(response.status_code))
+    try:
+        data = response.json()
+    except JSONDecodeError as e:
+        logging.error("Fetched json decode error, Volvo API seems to return garbage. Skipping update. Error: " + str(e))
+        return None
+
+    if response.status_code == 200:
+        logging.debug(response.text)
+        return parse_api_data(data, sensor_id)
+    else:
+        logging.debug(response.text)
+        if url == CLIMATE_START_URL and response.status_code == 503:
+            logging.warning("Car in use, cannot start pre climatization")
+            mqtt.assumed_climate_state[vin] = "OFF"
+            mqtt.update_car_data()
+        elif "extended-vehicle" in url and response.status_code == 403:
+            # Suppress 403 errors for unsupported extended-vehicle api cars
+            logging.debug("Suppressed 403 for extended-vehicle API")
+            return None
+        elif response.status_code == 403 and "message" in data:
+            if "Out of call volume quota" in data["message"]:
+                logging.warning("Quota extended. Try to change VCCAPIKEY!")
+                change_vcc_api_key()
+                api_call(url, method, vin, sensor_id, force_update, True)
+            else:
+                logging.error(
+                    "API Call failed. Status Code: " + str(response.status_code) + ". Error: " + response.text)
+        else:
+            logging.error("API Call failed. Status Code: " + str(response.status_code) + ". Error: " + response.text)
+        return None
+
+
+def cached_request(url, method, vin, force_update=False, key_change=False):
+    global cached_requests
+    if not util.keys_exists(cached_requests, vin + "_" + url):
+        # No API Data cached, get fresh data from API
+        logging.debug("Starting " + method + " call against " + url)
+        try:
+            response = session.get(url.format(vin), timeout=15)
+        except requests.exceptions.RequestException as e:
+            logging.error("Error getting data: " + str(e))
+            return None
+
+        data = {"response": response, "last_update": datetime.now(util.TZ)}
+        cached_requests[vin + "_" + url] = data
+    else:
+        if (datetime.now(util.TZ) - cached_requests[vin + "_" + url]["last_update"]).total_seconds() \
+                >= settings["updateInterval"] or (force_update and
+                                                  (datetime.now(util.TZ) - cached_requests[vin + "_" + url][
+                                                      "last_update"]).total_seconds() >= 2) \
+                or key_change:
+            # Old Data in Cache, or force mode active, updating
+            logging.debug("Starting " + method + " call against " + url)
+            try:
+                response = session.get(url.format(vin), timeout=15)
+            except requests.exceptions.RequestException as e:
+                logging.error("Error getting data: " + str(e))
+                return None
+            data = {"response": response, "last_update": datetime.now(util.TZ)}
+            cached_requests[vin + "_" + url] = data
+        else:
+            # Data is up do date, returning cached data
+            response = cached_requests[vin + "_" + url]["response"]
+    return response
+
+
+def parse_api_data(data, sensor_id=None):
+    if sensor_id != "api_backend_status":
+        data = data["data"]
+
+    if sensor_id == "battery_charge_level":
+        return data["batteryChargeLevel"]["value"] if util.keys_exists(data, "batteryChargeLevel") else None
+    elif sensor_id == "electric_range":
+        return util.convert_metric_values(data["electricRange"]["value"]) \
+            if util.keys_exists(data, "electricRange") else None
+    elif sensor_id == "charging_system_status":
+        return charging_system_states[data["chargingSystemStatus"]["value"]] \
+            if util.keys_exists(data, "chargingSystemStatus") else None
+    elif sensor_id == "charging_connection_status":
+        return charging_connection_states[data["chargingConnectionStatus"]["value"]] \
+            if util.keys_exists(data, "chargingConnectionStatus") else None
+    elif sensor_id == "estimated_charging_time":
+        if util.keys_exists(data, "chargingSystemStatus"):
+            charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]]
+            if charging_system_state == "Charging":
+                return data["estimatedChargingTime"]["value"] if util.keys_exists(data, "estimatedChargingTime") else ""
+            else:
+                return 0
+        return None
+    elif sensor_id == "estimated_charging_finish_time":
+        if util.keys_exists(data, "chargingSystemStatus"):
+            charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]]
+            if charging_system_state == "Charging":
+                charging_time = int(
+                    data["estimatedChargingTime"]["value"] if util.keys_exists(data, "estimatedChargingTime")
+                    else 0)
+                charging_finished = datetime.now(util.TZ) + timedelta(minutes=charging_time)
+                return format_datetime(charging_finished, format="medium", locale=settings["babelLocale"])
+            else:
+                return ""
+        return None
+    elif sensor_id == "lock_status":
+        return data["centralLock"]["value"] if util.keys_exists(data, "centralLock") else None
+    elif sensor_id == "odometer":
+        multiplier = 1
+        if util.keys_exists(settings["volvoData"], "odometerMultiplier"):
+            multiplier = settings["volvoData"]["odometerMultiplier"]
+            if isinstance(multiplier, str):
+                multiplier = 1
+            elif multiplier < 1:
+                multiplier = 1
+        return util.convert_metric_values(int(data["odometer"]["value"]) * multiplier) \
+            if util.keys_exists(data, "odometer") else None
+    elif sensor_id == "window_front_left":
+        return window_states[data["frontLeftWindow"]["value"]] if util.keys_exists(data, "frontLeftWindow") \
+            else None
+    elif sensor_id == "window_front_right":
+        return window_states[data["frontRightWindow"]["value"]] if util.keys_exists(data, "frontRightWindow") \
+            else None
+    elif sensor_id == "window_rear_left":
+        return window_states[data["rearLeftWindow"]["value"]] if util.keys_exists(data, "rearLeftWindow") \
+            else None
+    elif sensor_id == "window_rear_right":
+        return window_states[data["rearRightWindow"]["value"]] if util.keys_exists(data, "rearRightWindow") \
+            else None
+    elif sensor_id == "door_front_left":
+        return door_states[data["frontLeftDoor"]["value"]] if util.keys_exists(data, "frontLeftDoor") else None
+    elif sensor_id == "door_front_right":
+        return door_states[data["frontRightDoor"]["value"]] \
+            if util.keys_exists(data, "frontRightDoor") else None
+    elif sensor_id == "door_rear_left":
+        return door_states[data["rearLeftDoor"]["value"]] if util.keys_exists(data, "rearLeftDoor") else None
+    elif sensor_id == "door_rear_right":
+        return door_states[data["rearRightDoor"]["value"]] if util.keys_exists(data, "rearRightDoor") else None
+    elif sensor_id == "tailgate":
+        return door_states[data["tailgate"]["value"]] if util.keys_exists(data, "tailgate") else None
+    elif sensor_id == "sunroof":
+        return door_states[data["sunroof"]["value"]] if util.keys_exists(data, "sunroof") else None
+    elif sensor_id == "engine_hood":
+        return door_states[data["hood"]["value"]] if util.keys_exists(data, "hood") else None
+    elif sensor_id == "tank_lid":
+        return door_states[data["tankLid"]["value"]] if util.keys_exists(data, "tankLid") else None
+    elif sensor_id == "tyre_front_left":
+        return data["frontLeft"]["value"] if util.keys_exists(data, "frontLeft") else None
+    elif sensor_id == "tyre_front_right":
+        return data["frontRight"]["value"] if util.keys_exists(data, "frontRight") else None
+    elif sensor_id == "tyre_rear_left":
+        return data["rearLeft"]["value"] if util.keys_exists(data, "rearLeft") else None
+    elif sensor_id == "tyre_rear_right":
+        return data["rearRight"]["value"] if util.keys_exists(data, "rearRight") else None
+    elif sensor_id == "engine_state":
+        return engine_states[data["engineStatus"]["value"]] if util.keys_exists(data, "engineStatus") else None
+    elif sensor_id == "fuel_level":
+        if util.keys_exists(data, "fuelAmount"):
+            fuel_amount = float(data["fuelAmount"]["value"])
+            if fuel_amount > 0:
+                return fuel_amount
+        return None
+    elif sensor_id == "average_fuel_consumption":
+        if util.keys_exists(data, "averageFuelConsumption"):
+            average_fuel_con = float(data["averageFuelConsumption"]["value"])
+            if average_fuel_con > 0:
+                multiplier = 1
+                if util.keys_exists(settings["volvoData"], "averageFuelConsumptionMultiplier"):
+                    multiplier = settings["volvoData"]["averageFuelConsumptionMultiplier"]
+                    if isinstance(multiplier, str):
+                        multiplier = 1
+                    elif multiplier < 1:
+                        multiplier = 1
+                return average_fuel_con * multiplier
+        return None
+    elif sensor_id == "average_speed":
+        if util.keys_exists(data, "averageSpeed"):
+            average_speed = float(data["averageSpeed"]["value"])
+            if average_speed > 1:
+                divider = 1
+                if util.keys_exists(settings["volvoData"], "averageSpeedDivider"):
+                    divider = settings["volvoData"]["averageSpeedDivider"]
+                    if isinstance(divider, str):
+                        divider = 1
+                    elif divider < 1:
+                        divider = 1
+                return util.convert_metric_values(average_speed / divider)
+        return None
+    elif sensor_id == "location":
+        coordinates = {}
+        if util.keys_exists(data, "geometry"):
+            raw_data = data["geometry"]
+            if util.keys_exists(raw_data, "coordinates"):
+                coordinates = {"longitude": raw_data["coordinates"][0],
+                               "latitude": raw_data["coordinates"][1],
+                               "gps_accuracy": 1}
+        return coordinates
+    elif sensor_id == "distance_to_empty_tank":
+        if util.keys_exists(data, "distanceToEmptyTank"):
+            distance_to_empty = int(data["distanceToEmptyTank"]["value"])
+            if distance_to_empty > 0:
+                return util.convert_metric_values(data["distanceToEmptyTank"]["value"])
+        return None
+    elif sensor_id == "distance_to_empty_battery":
+        if util.keys_exists(data, "distanceToEmptyBattery"):
+            distance_to_empty = int(data["distanceToEmptyBattery"]["value"])
+            if distance_to_empty > 0:
+                return util.convert_metric_values(data["distanceToEmptyBattery"]["value"])
+        return None
+    elif sensor_id == "hours_to_service":
+        return data["engineHoursToService"]["value"] if util.keys_exists(data, "engineHoursToService") else None
+    elif sensor_id == "km_to_service":
+        if util.keys_exists(data, "distanceToService"):
+            km_to_service = int(data["distanceToService"]["value"])
+            if km_to_service > 0:
+                return util.convert_metric_values(data["distanceToService"]["value"])
+        return None
+    elif sensor_id == "time_to_service":
+        if util.keys_exists(data, "timeToService"):
+            return str(data["timeToService"]["value"]) + " " + data["timeToService"]["unit"]
+        else:
+            return None
+    elif sensor_id == "service_warning_status":
+        return data["serviceWarning"]["value"] if util.keys_exists(data, "serviceWarning") else None
+    elif sensor_id == "average_energy_consumption":
+        return data["averageEnergyConsumption"]["value"] if util.keys_exists(data, "averageEnergyConsumption") else None
+    elif sensor_id == "washer_fluid_warning":
+        return data["washerFluidLevelWarning"]["value"] if util.keys_exists(data, "washerFluidLevelWarning") else None
+    else:
+        return None

volvo.py

@@ -1,191 +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": settings["volvoData"]["vccapikey"],
-                "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"]
-
-        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 ""