Add more logging for refresh process // renew refresh token if returned from api

Improve readability and copy-paste functionality of docker command

.github/ISSUE_TEMPLATE/bug_report.md

@@ -3,28 +3,29 @@ name: Bug report
 about: Create a report to help us improve
 title: ''
 labels: ''
-assignees: Dielee
+assignees: ''
 
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
-**To Reproduce**
+**To Reproduce**:<br>
 Steps to reproduce the behavior:
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
 
-**Expected behavior**
+**Expected behavior**:<br>
 A clear and concise description of what you expected to happen.
 
-**Screenshots**
+**Screenshots**:<br>
 If applicable, add screenshots to help explain your problem.
 
-**Version info**
+**Version info**:<br>
 The version you are using and the method you are using (Docker container/HA Addon/Cloned repo)
 
-**Additional context**
-Add any other context about the problem here.
+**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/workflows/build_image.yml

@@ -27,20 +27,20 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3  
+        uses: actions/checkout@v4
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
       - name: Log in to the Container registry
-        uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
+        uses: docker/login-action@v3
         with:
           registry: ${{ env.REGISTRY }}
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
       - name: Extract metadata (tags, labels) for Docker
         id: meta
-        uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
+        uses: docker/metadata-action@v5
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
           tags: |
@@ -52,7 +52,7 @@ jobs:
             type=semver,pattern={{major}}
             type=sha
       - name: Build and push
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v5
         with:
           context: .
           platforms: linux/amd64,linux/arm/v7,linux/arm/v6,linux/arm/v8

.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

@@ -2,3 +2,5 @@
 venv
 src/settings.dev.json
 .env
+/src/volvo2mqtt.log
+/src/volvo2mqtt.log.1

README.md

@@ -1,4 +1,5 @@
 # Volvo2Mqtt
+
 ![Supports aarch64 Architecture][aarch64-shield]
 ![Supports amd64 Architecture][amd64-shield]
 ![Supports armhf Architecture][armhf-shield]
@@ -15,18 +16,35 @@ Maybe this component works also with other Volvo cars. Please try out the native
 
 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
+- EX30 BEV (2024)
+- XC40 BEV (2024)
 - XC40 BEV (2023)
 - XC40 BEV (2022)
 - XC40 PHEV (2021)
 - V60 T8 PHEV (2023)
-- C40 PHEV (2023)
-- C40 PHEV (2022)
+- V60 T6 PHEV (2025)
+- V60 CC B5 Mildhybrid (2024)
+- C40 BEV (2023)
+- C40 BEV (2022)
+- C40 BEV (2024)
 - XC90 T8 PHEV (2023)
+- XC60 PHEV (2024)
 - XC60 PHEV (2023)
 - XC60 PHEV (2022)
+- XC60 B5 Mildhybrid (2023)
 - XC90 PHEV T8 (2023)
+- XC90 PHEV T8 (2024)
+- XC90 B5 Mildhybrid (2024)
 - V90 PHEV T8 (2019)*
+- V90 PHEV T6 (2024)
+- V90 B5 Mildhybrid (2023)
+- EX40 BEV (2025)
 
 *only partly working
 
@@ -37,6 +55,7 @@ Please let me know if your car works with this addon so I can expand the list!<b
 - Lock/unlock car
 - Start/stop climate
 - Sensor "Battery Charge Level"
+- Sensor "Battery Capacity"
 - Sensor "Electric Range"
 - Sensor "Charging System Status"
 - Sensor "Charging Connection Status"
@@ -49,18 +68,78 @@ Please let me know if your car works with this addon so I can expand the list!<b
 - 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)
 
+## OTP Authentication
+
+As of version <b>v1.9.0</b>, this addon uses the same OTP authentication as the Volvo app. 
+The following steps are required for authentication in exactly this order:
+
+1. Setup volvo2Mqtt, either via Docker, or via HA addon (take a look at the "Setup" section below)
+2. Fill in your settings and start volvo2Mqtt
+3. Your log will show the following lines <br> 
+```Waiting for otp code... Please check your mailbox and post your otp code to the following mqtt topic "volvoAAOS2mqtt/otp_code". Retry 0/15```<br>
+```Waiting for otp code... Please check your mailbox and post your otp code to the following mqtt topic "volvoAAOS2mqtt/otp_code". Retry 1/15```<br>
+```etc ...```
+4. Now, open your mailbox and copy your OTP Code
+5. Open HomeAssistant and search for the entity ID ```text.volvo_otp```
+6. Paste your OTP into the text entity and **<ins>press Enter</ins>**<br>
+   6a. (optional) If your OTP cannot be safed, try to paste your OTP code via MQTT to the following topic: `volvoAAOS2mqtt/otp_code` <p>
+       <details>
+             <summary>OTP Post Script</summary>
+             <div>
+                <p>
+                1. Safe the following script in your script section <br>
+                2. Go to https://yourHAUrl/developer-tools/service<br>
+                3. Search for "Post Volvo OTP"<br>
+                4. Tick "OTP" and fill in your OTP<br>
+                5. Run this service<br>
+             </div>
+       
+            alias: Post Volvo OTP
+            sequence:
+              - service: mqtt.publish
+                metadata: {}
+                data:
+                  topic: volvoAAOS2mqtt/otp_code
+                  payload: "{{ otp }}"
+            mode: single
+            fields:
+              otp:
+                selector:
+                  text: null
+                name: OTP
+                description: Volvo OTP
+   
+   </details>
+8. If everything has worked, your addon is now authenticated. In the future, OTP authentication only needs to be done when updating, not when restarting the container.
+
 ## 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 -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": "", "odometerMultiplier": 1, "averageSpeedDivider": 1, "averageFuelConsumptionMultiplier": 1}' -e TZ='Europe/Berlin' --name volvo2mqtt ghcr.io/dielee/volvo2mqtt:latest`
+<pre>
+<code>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"]}' \
+  -e TZ='Europe/Berlin' \
+  --name volvo2mqtt \
+  ghcr.io/dielee/volvo2mqtt:latest
+</code>
+</pre>
 
 <b>HA Add-On:</b><br>
 
@@ -72,89 +151,18 @@ Here is what every option means:
 | ------------------------- | :-------: | :-----------------------------------: | :----------: | --------------------------------------------------------------- |
 | `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`    | `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** | API key linked with your volvo developer account. Get your Vccapi key from [here](https://developer.volvocars.com/account/)
-| `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_mqtt`               | `json`    | `username`                            | optional     | MQTT Username for your broker. |
+| `CONF_mqtt`               | `json`    | `password`                            | optional     | MQTT Password for your broker. |
+| `CONF_mqtt`               | `json`    | `logging`                             | optional     | Enable MQTT logging (true/false). Default don't enable MQTT log. |
+| `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_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)|
 
-## Lovelace sample card
-<details>
-  <summary>Show me more!</summary><blockquote>
-  <br>
-    
-  ![alt text](https://raw.githubusercontent.com/Dielee/volvo2mqtt/main/img/lovelace_sample.png)<br>
-    
-  <details>
-  <summary>Lovelace card sample</summary>
-        		
-  ```
-   type: vertical-stack
-   title: Autostatus
-   cards:
-     - type: custom:vertical-stack-in-card
-       cards:
-         - type: custom:mushroom-lock-card
-           entity: lock.volvo_<your vin>_lock_status
-           name: Verrigelungsstatus
-         - type: horizontal-stack
-           cards:
-             - type: custom:mushroom-entity-card
-               entity: sensor.volvo_<your vin>_electric_range
-               name: Reichweite
-               layout: vertical
-             - type: custom:mushroom-entity-card
-               entity: sensor.volvo_<your vin>_battery_charge_level
-               name: Batteriestatus
-               layout: vertical
-             - type: custom:mushroom-entity-card
-               entity: sensor.volvo_<your vin>_estimated_charging_time
-               layout: vertical
-               name: Ladezeit
-         - type: horizontal-stack
-           cards:
-             - type: custom:mushroom-entity-card
-               entity: switch.volvo_<your vin>_climate_status
-               tap_action:
-                 action: toggle
-               layout: vertical
-               name: Klimatisieren/Heizen
-             - type: custom:mushroom-template-card
-               primary: Daten aktualisieren
-               secondary: '{{ states(''sensor.volvo_<your vin>_last_data_update'')}}'
-               icon: mdi:update
-               layout: vertical
-               entity: button.volvo_<your vin>_update_data
-         - type: conditional
-           conditions:
-             - entity: sensor.volvo_<your vin>_estimated_charging_time
-               state_not: '0'
-           card:
-             type: custom:mushroom-entity-card
-             entity: sensor.volvo_<your vin>_estimated_charging_finish_time
-             name: Ladung vorraussichtlich abgeschlossen
-             show_name: true
-         - type: map
-           entities:
-             - entity: device_tracker.volvo_<your vin>_location
-           default_zoom: 16
-           dark_mode: false
-           hours_to_show: 0
-           auto_fit: true
-           aspect_ratio: '16:9'
-  ```
-
-</details>
-</blockquote></details>
-
 
 [aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
 [amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
@@ -163,6 +171,6 @@ Here is what every option means:
 [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
+[maintenance-shield]: https://img.shields.io/maintenance/yes/2025.svg
 [commits-shield]: https://img.shields.io/github/commit-activity/y/Dielee/volvo2mqtt.svg
 [commits]: https://github.com/Dielee/volvo2mqtt/commits/main

requirements.txt

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

src/CHANGELOG.md

@@ -0,0 +1,478 @@
+## v1.12.2
+
+### 🚀 Features:
+
+- Add more logging for refresh process
+- Update refresh token, if volvo API returns a new one
+
+## v1.12.1
+
+### 🐛 Bug Fixes:
+
+- Fix `trip_speed` and `trip_distance` unit for `en_US` and `en_GB` #301
+
+## v1.12.0
+
+### 🚀 Features:
+
+- Some minor corrections and more checking for exceptions #267
+- Better logging, indicate URL used on API errors, check exceptions in more places to dont kill threads, add option for mqtt logging
+- Dont force token renew on 5xx errors
+- Indicate payload on error message to understand better issue #270
+- Better checking on received update_interval #270 
+- Add TA trip statistics #283
+
+Thanks to @luka6000 and @ivanfmartinez for your PRs!
+
+## v1.10.6
+
+### 🐛 Bug Fixes:
+
+- Fix missing refresh_token and API changes by volvo. Thanks to @esusxunil.
+
+## v1.10.5
+
+### 🐛 Bug Fixes:
+
+- Fix interior and exterior images if more than one car is in use
+
+## v1.10.4
+
+### 🐛 Bug Fixes:
+
+- re-fix bug if app needs to be re-authenticated with OTP while runtime
+
+## v1.10.3
+
+### 🐛 Bug Fixes:
+
+- Add more info logging for credential refresh process
+- Fix bug if app needs to be re-authenticated with OTP while runtime
+
+## v1.10.2
+
+### 🐛 Bug Fixes:
+
+- Remove unused multiplier options #239
+
+## v1.10.1
+
+### 🚀 Features:
+
+- Optimize logging for vcc-api-key check #238
+
+## v1.10.0
+
+### 🚀 Features:
+
+- Remove unused multiplier options
+
+### 🐛 Bug Fixes:
+
+- Support new statistic keys #237
+
+## v1.9.7
+
+### 🐛 Bug Fixes:
+
+- Fix EX30 battery state #230
+
+## v1.9.6
+
+### 🐛 Bug Fixes:
+
+- Fixed interior and exterior Images #219
+- Take care of broken token files #220
+
+## v1.9.5
+
+### 🚀 Features:
+
+- Added "retain" states to survive HA reboot
+
+## v1.9.4
+
+### 🐛 Bug Fixes:
+
+- Fix backend state API url
+
+## v1.9.3
+
+### 🐛 Bug Fixes:
+
+- Ignore retained OTP messages #193
+
+## v1.9.2
+
+### 🐛 Bug Fixes:
+
+- Try to fix OTP Input
+- Fix `SyntaxWarning: invalid escape sequence '\d'` #196
+
+## v1.9.1
+
+### 🚀 Features:
+
+- The token file now survives an HA addon update/restart
+
+### 🐛 Bug Fixes:
+
+- Extend OTP retry time to 120 seconds
+
+## v1.9.0
+
+### ⚠️ Breaking change
+
+### 🚀 Features:
+
+- Add "Battery Capacity" sensor. Thanks to @gurtjun!
+- OTP Auth
+  This addon uses the same OTP authentication as the Volvo app, now.
+  The following steps are required for authentication in exactly this order:
+
+        1. Setup volvo2Mqtt, either via Docker, or via HA addon (take a look at the "Setup" section)
+        2. Fill in your settings and start volvo2Mqtt
+        3. Your log will show the following lines
+        Waiting for otp code... Please check your mailbox and post your otp code to the following mqtt topic "volvoAAOS2mqtt/otp_code". Retry 0/15
+        Waiting for otp code... Please check your mailbox and post your otp code to the following mqtt topic "volvoAAOS2mqtt/otp_code". Retry 1/15
+        etc ...
+        4. Now, open your mailbox and copy your OTP Code
+        5. Open HomeAssistant and search for the entity ID text.volvo_otp
+        6. Paste your OTP into the text entity and press Enter
+        7. If everything has worked, your addon is now authenticated. In the future, OTP authentication only needs to be done when updating, not when restarting the container.
+
+## v1.8.27
+
+### 🚀 Features:
+
+- Add state caching for "diagnostics" endpoint
+
+## v1.8.26
+
+### 🚀 Features:
+
+- Add option to disable updates #160 (Set the update interval to -1)
+
+## v1.8.25
+
+### 🚀 Features:
+
+- Fix INTERNAL_SERVER_ERROR #165
+
+## v1.8.24
+
+### 🚀 Features:
+
+- Add option for dynamic interval settings #160
+- Add warnings endpoint #151
+
+## 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

@@ -1,6 +1,9 @@
 ARG BUILD_FROM
 FROM $BUILD_FROM
 
+# Add community packets
+RUN echo -e "https://nl.alpinelinux.org/alpine/latest-stable/main\nhttps://nl.alpinelinux.org/alpine/latest-stable/community" > /etc/apk/repositories
+
 # Install requirements for add-on
 RUN apk add --no-cache python3 bash py3-pip
 
@@ -11,10 +14,11 @@ WORKDIR /volvoAAOS2mqtt
 RUN wget --no-cache https://raw.githubusercontent.com/Dielee/volvo2mqtt/main/requirements.txt
 
 # install dependencies
-RUN pip install -r requirements.txt
+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 [ "python", "-u", "./main.py" ]
+CMD [ "/volvoAAOS2mqtt/run.sh" ]

src/apparmor.txt

@@ -4,8 +4,10 @@ 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,

src/config.yaml

@@ -1,46 +1,51 @@
 name: "Volvo2Mqtt"
 description: "Volvo AAOS MQTT bridge"
-version: "1.6.0"
+version: "1.12.2"
 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: null
-    port: 1883
-    username: ""
-    password: ""
+    broker: "auto_broker"
+    port: "auto_port"
+    username: "auto_user"
+    password: "auto_password"
+    logging: false
   volvoData:
     username: null
     password: null
     vin: ""
-    vccapikey: null
-    odometerMultiplier: 1
-    averageSpeedDivider: 1
-    averageFuelConsumptionMultiplier: 1
+    vccapikey:
+        - null
 schema:
-  updateInterval: int(10,)
+  updateInterval: int(60,)
   babelLocale: str
-  TZ: str
+  TZ: match(^.+/.+$)
   debug: bool
+  disable_logging: bool
   mqtt:
     broker: str
-    port: int(1,)
+    port: str
     username: str?
     password: str?
+    logging: bool
   volvoData:
-    username: str
+    username: match(^([a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+)|(\+\d{5,20})$)
     password: str
     vin: str?
-    vccapikey: str
-    odometerMultiplier: int(1,)
-    averageSpeedDivider: int(1,)
-    averageFuelConsumptionMultiplier: int(1,)
+    vccapikey:
+        - match(^\b\w{32}\b$)
 arch:
   - aarch64
   - amd64

src/const.py

@@ -1,10 +1,11 @@
 from config import settings
 
-VERSION = "v1.6.0"
+VERSION = "v1.12.2"
 
-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}"
+OAUTH_TOKEN_URL = "https://volvoid.eu.volvocars.com/as/token.oauth2"
+OAUTH_AUTH_URL = "https://volvoid.eu.volvocars.com/as/authorization.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"
@@ -16,46 +17,94 @@ ODOMETER_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0
 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"
-BATTERY_CHARGE_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/battery-charge-level"
-FUEL_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/fuel"
+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"
+WARNINGS_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/warnings"
+API_BACKEND_STATUS = "https://public-developer-portal-bff.weu-prod.ecpaz.volvocars.biz/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": "mi"},
-                "odometer": {"unit": "mi"},
-                "average_speed": {"unit": "mph"}
+                "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},
+                "trip_distance": {"unit": LENGTH_MILES},
+                "trip_speed": {"unit": SPEED_MILES_PER_HOUR}
             },
             "en_US": {
                 "divider": 1.60934,
-                "electric_range": {"unit": "mi"},
-                "odometer": {"unit": "mi"},
-                "average_speed": {"unit": "mph"}
+                "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},
+                "trip_distance": {"unit": LENGTH_MILES},
+                "trip_speed": {"unit": SPEED_MILES_PER_HOUR}
             }
         }
 
 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_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_CONNECTED_DC": "Connected DC", "CONNECTION_STATUS_CONNECTED_AC": "Connected AC",
+                              "CONNECTION_STATUS_FAULT": "Fault"}
 
-window_states = {"CLOSED": "OFF", "OPEN": "ON"}
-door_states = {"CLOSED": "OFF", "OPEN": "ON"}
+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": float('inf'), "to": 100, "icon": "battery"},
+                    {"from": 100, "to": 90, "icon": "battery-90"},
+                    {"from": 90, "to": 80, "icon": "battery-80"},
+                    {"from": 80, "to": 70, "icon": "battery-70"},
+                    {"from": 70, "to": 60, "icon": "battery-60"},
+                    {"from": 60, "to": 50, "icon": "battery-50"},
+                    {"from": 50, "to": 40, "icon": "battery-40"},
+                    {"from": 40, "to": 30, "icon": "battery-30"},
+                    {"from": 30, "to": 20, "icon": "battery-20"},
+                    {"from": 20, "to": 10, "icon": "battery-10"},
+                    {"from": 10, "to": 0, "icon": "battery-alert-variant-outline"},
+    ]
+}
 
 supported_entities = [
-                        {"name": "Battery Charge Level", "domain": "sensor", "id": "battery_charge_level", "unit": "%", "icon": "car-battery", "url": RECHARGE_STATE_URL},
-                        {"name": "Battery Charge Level", "domain": "sensor", "id": "battery_charge_level", "unit": "%", "icon": "car-battery", "url": BATTERY_CHARGE_STATE_URL},
-                        {"name": "Electric Range", "domain": "sensor", "id": "electric_range", "unit": "km" if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["electric_range"]["unit"], "icon": "map-marker-distance", "url": RECHARGE_STATE_URL},
-                        {"name": "Estimated Charging Time", "domain": "sensor", "id": "estimated_charging_time", "unit": "minutes", "icon": "timer-sync-outline", "url": RECHARGE_STATE_URL},
+                        {"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": "Battery Capacity", "domain": "sensor", "device_class": "energy_storage", "id": "battery_capacity", "unit": ENERGY_KILO_WATT_HOUR, "icon": "car-battery", "url": VEHICLE_DETAILS_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": "km" if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["odometer"]["unit"], "icon": "counter", "url": ODOMETER_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},
@@ -76,8 +125,27 @@ supported_entities = [
                         {"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": "sensor", "id": "engine_state", "icon": "engine", "url": ENGINE_STATE_URL},
-                        {"name": "Fuel Level", "domain": "sensor", "id": "fuel_level", "unit": "liters", "icon": "fuel", "url": FUEL_STATE_URL},
-                        {"name": "Average Fuel Consumption", "domain": "sensor", "id": "average_fuel_consumption", "unit": "liters", "icon": "fuel", "url": STATISTICS_URL},
-                        {"name": "Average Speed", "domain": "sensor", "id": "average_speed", "unit": "km/h" if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["average_speed"]["unit"], "icon": "speedometer", "url": STATISTICS_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, "state_class": "measurement"},
+                        {"name": "Average Energy Consumption", "domain": "sensor", "id": "average_energy_consumption", "unit": ENERGY_KILO_WATT_HOUR, "icon": "car-electric", "url": STATISTICS_URL, "state_class": "measurement"},
+                        {"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"},
+                        {"name": "Update Interval", "domain": "number", "id": "update_interval", "unit": "seconds", "icon": "timer", "min": -1, "max": 600, "mode": "box"},
+                        {"name": "Warnings", "domain": "sensor", "id": "warnings", "icon": "alert", "url": WARNINGS_URL}
+                        ,{"name": "Trip Fuel Consumption", "domain": "sensor", "id": "trip_fuel_consumption", "unit": VOLUME_LITERS, "icon": "fuel", "url": STATISTICS_URL}
+                        ,{"name": "Trip distance", "domain": "sensor", "id": "trip_distance", "unit": LENGTH_KILOMETERS if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["trip_distance"]["unit"], "icon": "counter", "url": STATISTICS_URL, "state_class":"measurement"}
+                        ,{"name": "Trip Energy Consumption", "domain": "sensor", "id": "trip_energy_consumption", "unit": ENERGY_KILO_WATT_HOUR, "icon": "car-electric", "url": STATISTICS_URL}
+                        ,{"name": "Trip Speed", "domain": "sensor", "id": "trip_speed", "unit": SPEED_KILOMETERS_PER_HOUR if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["trip_speed"]["unit"], "icon": "speedometer", "url": STATISTICS_URL, "state_class": "measurement"}
 ]
+
+old_entity_ids = ["months_to_service", "service_warning_trigger", "distance_to_empty"]
+otp_max_loops = 24
+otp_mqtt_topic = "volvoAAOS2mqtt/otp_code"

src/main.py

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

src/mqtt.py

@@ -1,25 +1,41 @@
+import logging
 import time
 import paho.mqtt.client as mqtt
 import json
 import volvo
 import util
+import os
+import requests
+import threading
 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
-
+    CAR_UNLOCK_URL, availability_topic, icon_states, old_entity_ids, otp_mqtt_topic
 
 mqtt_client: mqtt.Client
 subscribed_topics = []
 assumed_climate_state = {}
 last_data_update = None
 climate_timer = {}
-
+engine_status = {}
+devices = {}
+active_schedules = {}
+otp_code = None
 
 def connect():
-    client = mqtt.Client("volvoAAOS2mqtt")
+    client = mqtt.Client("volvoAAOS2mqtt") if os.environ.get("IS_HA_ADDON") \
+        else mqtt.Client("volvoAAOS2mqtt_" + settings.volvoData["username"].replace("+", ""))
+
+    if "logging" in settings["mqtt"] and settings["mqtt"]["logging"]:
+        mqtt_logger = logging.getLogger("mqtt")
+        client.enable_logger(mqtt_logger)
+    
+    client.on_message = safe_on_message
+    client.on_disconnect = on_disconnect
+    client.on_connect = on_connect
+
     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"])
@@ -30,72 +46,268 @@ def connect():
             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
+    client.subscribe("volvoAAOS2mqtt/otp_code")
 
     global mqtt_client
     mqtt_client = client
 
 
+def create_otp_input():
+    state_topic = otp_mqtt_topic + "/state"
+    config = {
+        "name": "Volvo OTP",
+        "object_id": "volvo_otp",
+        "schema": "state",
+        "command_topic": otp_mqtt_topic,
+        "state_topic": state_topic,
+        "unique_id": "volvoAAOS2mqtt_otp",
+        "pattern": r"\d{6}",
+        "icon": "mdi:two-factor-authentication",
+        "mode": "text"
+    }
+
+    mqtt_client.publish(
+        "homeassistant/text/volvoAAOS2mqtt/volvo_otp/config",
+        json.dumps(config),
+        retain=True
+    )
+
+    mqtt_client.publish(
+        state_topic,
+        "000000",
+        retain=True
+    )
+
+def set_otp_state():
+    mqtt_client.publish(
+        otp_mqtt_topic + "/state",
+        otp_code,
+        retain=True
+    )
+
+
+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"}]:
+            image_topic = f"homeassistant/image/{vin}_{entity['id']}/image_topic"
+            config = {
+                "name": entity["name"],
+                "object_id": f"volvo_{vin}_{entity['id']}",
+                "schema": "state",
+                "icon": "mdi:image-area",
+                "content_type": "image/png",
+                "image_topic": image_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
+            )
+
+            headers = {"User-Agent": "(Windows NT 10.0; Win64; x64)",
+                       "sec-ch-ua-platform": "\"Windows\"", "sec-fetch-dest": "document", "Accept-Encoding": "gzip, deflate, br, zstd",
+                       "sec-fetch-mode": "navigate", "sec-fetch-site": "none", "sec-fetch-user": "?1", "upgrade-insecure-requests": "1"}
+
+            # Post Images
+            if not os.path.exists(f'{entity["id"]}_{vin}.png'):
+                data_path = "exteriorImageUrl" if entity["id"] == "exterior_image" else "internalImageUrl"
+                response = requests.get(data["images"][data_path], headers=headers)
+                if response.status_code == 200:
+                    with open(f'{entity["id"]}_{vin}.png', 'wb') as image:
+                        image.write(response.content)
+                else:
+                    logging.warning("Error getting car images: " + str(response.status_code) + " Message: " + response.text)
+
+            if os.path.exists(f'{entity["id"]}_{vin}.png'):
+                ext_image = open(f'{entity["id"]}_{vin}.png', mode="rb").read()
+                mqtt_client.publish(
+                    image_topic,
+                    ext_image,
+                    retain=True
+                )
+
+
 def on_connect(client, userdata, flags, rc):
+    # set a better name for the mqtt_loop Thread
+    threading.current_thread().name = 'mqtt_thread'
+    logging.info("MQTT connected")
+    
     send_heartbeat()
     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_disconnect(client, userdata, rc):
+    logging.warning(f"MQTT disconnected, reconnecting automatically rc={rc}")
 
 
-def on_message(client, userdata, msg):
+def safe_on_message(client, userdata, msg):
     try:
-        vin = msg.topic.split('/')[2].split('_')[0]
-    except IndexError:
-        print("Error - Cannot get vin from MQTT topic!")
+        on_message(client, userdata, msg)
+    except Exception as error:
+        logging.error(f"Exception {error} processing received message on topic {msg.topic}")
         return None
-
+        
+def on_message(client, userdata, msg):
     payload = msg.payload.decode("UTF-8")
+    if msg.topic == otp_mqtt_topic:
+        if msg.retain == 0:
+            global otp_code
+            otp_code = payload
+            set_otp_state()
+        else:
+            logging.warning("Found retained OTP, this can't work! Please clean retained messages!")
+        return None
+    else:
+        try:
+            vin = msg.topic.split('/')[2].split('_')[0]
+        except IndexError:
+            logging.error(f"Error - Cannot get vin from MQTT topic : {msg.topic}!")
+            return None
+
     if "climate_status" in msg.topic:
-        global assumed_climate_state, climate_timer
         if payload == "ON":
-            api_thread = Thread(target=volvo.api_call, args=(CLIMATE_START_URL, "POST", vin))
-            api_thread.start()
-            assumed_climate_state[vin] = "ON"
-            # Starting timer to disable climate after 30 mins
-            climate_timer[vin] = Timer(30 * 60, volvo.disable_climate, (vin, ))
-            climate_timer[vin].start()
-            update_car_data()
+            start_climate(vin)
         elif payload == "OFF":
-            api_thread = Thread(target=volvo.api_call, args=(CLIMATE_STOP_URL, "POST", vin))
-            api_thread.start()
-            assumed_climate_state[vin] = "OFF"
-            # Stop timer if active
-            if climate_timer[vin].is_alive():
-                climate_timer[vin].cancel()
-            update_car_data()
+            stop_climate(vin)
     elif "lock_status" in msg.topic:
         if payload == "LOCK":
-            volvo.api_call(CAR_LOCK_URL, "POST", vin)
-            update_car_data(True, {"entity_id": "lock_status", "vin": vin, "state": "LOCKED"})
+            lock_car(vin)
         elif payload == "UNLOCK":
-            volvo.api_call(CAR_UNLOCK_URL, "POST", vin)
-            update_car_data(True, {"entity_id": "lock_status", "vin": vin, "state": "UNLOCKED"})
+            unlock_car(vin)
     elif "update_data" in msg.topic:
         if payload == "PRESS":
             update_car_data(True)
+    elif "update_interval" in msg.topic:
+        try:
+            update_interval = int(payload)
+            if update_interval >= 60 or update_interval == -1:
+               settings.update({"updateInterval": int(update_interval)})
+            else:
+                logging.warning(f"Interval {update_interval} seconds is to low. Doing nothing!")
+            update_car_data()
+        except ValueError as error:
+            logging.error(f"Unable to change update_interval {error} payload={payload}") 
+    elif "schedule" in msg.topic:
+        try:
+            d = json.loads(payload)
+        except ValueError as e:
+            logging.error(f"Can't set timer. Error: {e}, payload={payload}")
+            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(f"Error creating climate timer: {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(f"Climate timer set to {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), name="unlock_car_thread").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"), name="check_lock_status_thread").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), name="lock_car_thread").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"), name="check_lock_status_thread").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), name="stop_climate_thread").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), name="start_climate_thread").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,), name="check_engine_status_thread")
+    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:
-        print("Sending mqtt update...")
-        send_heartbeat()
-        update_car_data()
-        print("Mqtt update done. Next run in " + str(settings["updateInterval"]) + " seconds.")
-        time.sleep(settings["updateInterval"])
+        if settings["updateInterval"] > 0:
+            logging.info("Sending mqtt update...")
+            try:
+                send_heartbeat()
+                update_car_data()
+                logging.info(f"Mqtt update done. Next run in {settings['updateInterval']} seconds.")
+            except Exception as error:
+                logging.info(f"Exception {error} in Mqtt update. Next run in {settings['updateInterval']} seconds.")
+            time.sleep(settings["updateInterval"])
+        else:
+            logging.info("Data update is disabled, doing nothing for 30 seconds")
+            time.sleep(30)
 
 
 def update_car_data(force_update=False, overwrite={}):
@@ -103,7 +315,7 @@ def update_car_data(force_update=False, overwrite={}):
     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":
+            if entity["domain"] in ["button"]:
                 continue
 
             ov_entity_id = ""
@@ -118,53 +330,144 @@ def update_car_data(force_update=False, overwrite={}):
                 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"] == "update_interval":
+                state = settings["updateInterval"]
+            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":
+            if entity["domain"] == "device_tracker" or entity["id"] == "active_schedules":
                 topic = f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/attributes"
+            elif entity["id"] == "warnings":
+                mqtt_client.publish(
+                    f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/attributes",
+                    json.dumps(state),
+                    retain=True
+                )
+                if state:
+                    state = sum(value == "FAILURE" for value in state.values())
+                else:
+                    state = 0
+
+                topic = f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/state"
             else:
                 topic = f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/state"
 
-            mqtt_client.publish(
-                topic,
-                json.dumps(state) if isinstance(state, dict) else state
-            )
+            logging.info(f"update_car_data {topic} {state}")
+            if state or state == 0:
+                mqtt_client.publish(
+                    topic,
+                    json.dumps(state) if isinstance(state, dict) or isinstance(state, list) else state,
+                    retain=True
+                )
+                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
+    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
-                    }
+                "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("domain") == "device_tracker":
+            if entity.get("state_class"):
+                config["state_class"] = entity["state_class"]
+
+            if (entity.get("domain") == "device_tracker" or entity.get("id") == "active_schedules"
+                    or entity.get("id") == "warnings"):
                 config["json_attributes_topic"] = f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/attributes"
 
-            if entity.get("domain") in ["switch", "lock", "button"]:
+            if entity.get("domain") in ["switch", "lock", "button", "number"]:
                 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)
 
+                if entity["domain"] == "number":
+                    config["min"] = entity["min"]
+                    config["max"] = entity["max"]
+                    config["mode"] = entity["mode"]
+            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),
@@ -175,4 +478,15 @@ def create_ha_devices():
 
 
 def send_heartbeat():
-    mqtt_client.publish(availability_topic, "online")
+    mqtt_client.publish(availability_topic, "online", retain=True)
+
+
+def send_offline():
+    mqtt_client.publish(availability_topic, "offline", retain=True)
+
+
+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

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

src/translations/en.yaml

@@ -10,10 +10,13 @@ configuration:
     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
+    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: Broker is your mqtt broker IP eg "192.168.0.1". Mqtt username and password are optional. Broker port can be changed. If no value is given, port 1883 will be used.
+    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. 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!
+    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. Take a look at the GitHub repo for more information!

src/util.py

@@ -1,9 +1,105 @@
+import logging
 import pytz
 import os
+import re
+import sys
+import config
+import json
+from google_play_scraper import app
+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_volvo_app_version():
+    result = app(
+        'se.volvo.vcc',
+        lang='en',
+        country='us'
+    )
+
+    if "version" in result:
+        return result["version"]
+    else:
+        return "5.37.0"
+
+def get_token_path():
+    token_path = ".token"
+    if os.environ.get("IS_HA_ADDON"):
+        check_existing_folder("/addons/volvo2mqtt/token/")
+        token_path = "/addons/volvo2mqtt/token/.token"
+
+    return token_path
+
+def save_to_json(data, token_path):
+    with open(token_path, 'w', encoding='utf-8') as f:
+        json.dump(data, f, ensure_ascii=False, indent=4)
+
+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("/addons/volvo2mqtt/log/")
+        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 [%(threadName)s] [%(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):
+    Path(path).mkdir(parents=True, exist_ok=True)
 
 
 def keys_exists(element, *keys):
@@ -43,3 +139,41 @@ def convert_metric_values(value):
         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!")