Remove not used addon settings (#266)

Similar to #68

.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

README.md

@@ -1,4 +1,5 @@
 # Volvo2Mqtt
+
 ![Supports aarch64 Architecture][aarch64-shield]
 ![Supports amd64 Architecture][amd64-shield]
 ![Supports armhf Architecture][armhf-shield]
@@ -15,25 +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)
+- 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
 
@@ -44,9 +55,10 @@ 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" (partly broken since 2.10 car update)
+- Sensor "Charging Connection Status"
 - 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)"
@@ -67,13 +79,57 @@ Please let me know if your car works with this addon so I can expand the list!<b
 
 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": ["key1", "key2"], "odometerMultiplier": 1, "averageSpeedDivider": 1, "averageFuelConsumptionMultiplier": 1}' -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"]}' -e TZ='Europe/Berlin' --name volvo2mqtt ghcr.io/dielee/volvo2mqtt:latest`
 
 <b>HA Add-On:</b><br>
 
@@ -93,14 +149,10 @@ Here is what every option means:
 | `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)|
 
 
-
 [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
@@ -108,6 +160,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

@@ -1,4 +1,185 @@
+## 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
@@ -8,6 +189,7 @@
 - Fix Battery Charge Level icon update
 
 ## v1.8.16
+
 ### 🚀 Features:
 
 - Add `Average energy consumption`, `Distance to empty battery` and `Washer fluid level` sensors
@@ -15,18 +197,21 @@
 - 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>
@@ -34,62 +219,73 @@
   "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 
+- 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 
+- Add `device_class: battery` for battery state sensors from BEV and PHEV
 
 ## v1.8.2
+
 ### 🚀 Features:
 
 - Add `updateInterval` limit to prevent abuse (60 Seconds)
@@ -97,17 +293,19 @@
 - 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" 
@@ -122,24 +320,28 @@
       - etc.
   ```
   More information about this feature [here](https://github.com/Dielee/volvo2mqtt/issues/84).
-    </b>
+  </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  
+- Fix "Estimated Charging Finish Time" Sensor
 
 ## v1.7.7
+
 ### 🚀 Features:
 
 - Added long term statistics for some sensors #68. Thanks to @bogdanbujdea!
@@ -147,44 +349,54 @@
 - 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
+- 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. 
+<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>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
@@ -197,21 +409,25 @@ Also check all the other multipliers!</b>
 ![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 
+- 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
@@ -219,17 +435,19 @@ Also check all the other multipliers!</b>
 - 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 
+- 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 
+- 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,11 +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 [ "/volvoAAOS2mqtt/run.sh" ]
+CMD [ "/volvoAAOS2mqtt/run.sh" ]

src/config.yaml

@@ -1,6 +1,6 @@
 name: "Volvo2Mqtt"
 description: "Volvo AAOS MQTT bridge"
-version: "1.8.17"
+version: "1.10.6"
 slug: "volvo2mqtt"
 init: false
 url: "https://github.com/Dielee/volvo2mqtt"
@@ -27,9 +27,6 @@ options:
     vin: ""
     vccapikey:
         - null
-    odometerMultiplier: 1
-    averageSpeedDivider: 1
-    averageFuelConsumptionMultiplier: 1
 schema:
   updateInterval: int(60,)
   babelLocale: str
@@ -47,9 +44,6 @@ schema:
     vin: str?
     vccapikey:
         - match(^\b\w{32}\b$)
-    odometerMultiplier: int(1,)
-    averageSpeedDivider: int(1,)
-    averageFuelConsumptionMultiplier: int(1,)
 arch:
   - aarch64
   - amd64

src/const.py

@@ -1,8 +1,9 @@
 from config import settings
 
-VERSION = "v1.8.17"
+VERSION = "v1.10.6"
 
-OAUTH_URL = "https://volvoid.eu.volvocars.com/as/token.oauth2"
+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"
@@ -20,37 +21,49 @@ FUEL_BATTERY_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicle
 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"
+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"},
-                "distance_to_empty": {"unit": "mi"},
-                "distance_to_service": {"unit": "mi"}
+                "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": "mi"},
-                "odometer": {"unit": "mi"},
-                "average_speed": {"unit": "mph"},
-                "distance_to_empty": {"unit": "mi"},
-                "distance_to_service": {"unit": "mi"}
+                "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_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", "AJAR": "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"}
 
@@ -62,29 +75,30 @@ icon_states = {
     "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"},
+                    {"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", "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": "km" 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": "minutes", "icon": "timer-sync-outline", "url": RECHARGE_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, "state_class":"total_increasing"},
+                        {"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},
@@ -108,18 +122,22 @@ supported_entities = [
                         {"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": "liters", "icon": "fuel", "url": FUEL_BATTERY_STATE_URL, "state_class": "measurement"},
-                        {"name": "Average Fuel Consumption", "domain": "sensor", "id": "average_fuel_consumption", "unit": "liters", "icon": "fuel", "url": STATISTICS_URL},
-                        {"name": "Average Energy Consumption", "domain": "sensor", "id": "average_energy_consumption", "unit": "kwh", "icon": "car-electric", "url": STATISTICS_URL},
-                        {"name": "Distance to Empty Tank", "domain": "sensor", "id": "distance_to_empty_tank", "unit": "km" 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": "km" 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": "km/h" 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": "hour", "icon": "wrench-clock", "url": VEHICLE_DIAGNOSTICS_URL},
-                        {"name": "Distance to Service", "domain": "sensor", "id": "km_to_service", "unit": "km" if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["distance_to_service"]["unit"], "icon": "wrench-clock", "url": VEHICLE_DIAGNOSTICS_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": "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}
 ]
 
 old_entity_ids = ["months_to_service", "service_warning_trigger", "distance_to_empty"]
+otp_max_loops = 24
+otp_mqtt_topic = "volvoAAOS2mqtt/otp_code"

src/mqtt.py

@@ -5,12 +5,13 @@ import json
 import volvo
 import util
 import os
+import requests
 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
+    CAR_UNLOCK_URL, availability_topic, icon_states, old_entity_ids, otp_mqtt_topic
 
 mqtt_client: mqtt.Client
 subscribed_topics = []
@@ -20,7 +21,7 @@ climate_timer = {}
 engine_status = {}
 devices = {}
 active_schedules = {}
-
+otp_code = None
 
 def connect():
     client = mqtt.Client("volvoAAOS2mqtt") if os.environ.get("IS_HA_ADDON") \
@@ -37,6 +38,7 @@ def connect():
                 port = settings["mqtt"]["port"]
     client.connect(settings["mqtt"]["broker"], port)
     client.loop_start()
+    client.subscribe("volvoAAOS2mqtt/otp_code")
     client.on_message = on_message
     client.on_disconnect = on_disconnect
     client.on_connect = on_connect
@@ -45,17 +47,52 @@ def connect():
     mqtt_client = client
 
 
+def create_otp_input():
+    state_topic = otp_mqtt_topic + "/state"
+    config = {
+        "name": "Volvo OTP",
+        "object_id": f"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"}]:
-            url_topic = f"homeassistant/image/{vin}_{entity['id']}/image_url"
+            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",
-                "url_topic": url_topic,
+                "content_type": "image/png",
+                "image_topic": image_topic,
                 "device": device,
                 "unique_id": f"volvoAAOS2mqtt_{vin}_{entity['id']}",
                 "availability_topic": availability_topic
@@ -67,17 +104,25 @@ def send_car_images(vin, data, device):
                 retain=True
             )
 
-            if entity["id"] == "exterior_image":
-                mqtt_client.publish(
-                    url_topic,
-                    data["images"]["exteriorImageUrl"],
-                    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"}
 
-            if entity["id"] == "interior_image":
+            # 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(
-                    url_topic,
-                    data["images"]["internalImageUrl"],
+                    image_topic,
+                    ext_image,
                     retain=True
                 )
 
@@ -94,13 +139,22 @@ def on_disconnect(client, userdata, rc):
 
 
 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 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("Error - Cannot get vin from MQTT topic!")
+            return None
+
     if "climate_status" in msg.topic:
         if payload == "ON":
             start_climate(vin)
@@ -114,6 +168,13 @@ def on_message(client, userdata, msg):
     elif "update_data" in msg.topic:
         if payload == "PRESS":
             update_car_data(True)
+    elif "update_interval" in msg.topic:
+        update_interval = int(payload)
+        if update_interval >= 60 or update_interval == -1:
+            settings.update({"updateInterval": int(update_interval)})
+        else:
+            logging.warning("Interval " + str(update_interval) + " seconds is to low. Doing nothing!")
+        update_car_data()
     elif "schedule" in msg.topic:
         try:
             d = json.loads(payload)
@@ -214,11 +275,15 @@ def start_climate(vin):
 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"])
+        if settings["updateInterval"] > 0:
+            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"])
+        else:
+            logging.info("Data update is disabled, doing nothing for 30 seconds")
+            time.sleep(30)
 
 
 def update_car_data(force_update=False, overwrite={}):
@@ -226,7 +291,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 = ""
@@ -243,6 +308,8 @@ def update_car_data(force_update=False, overwrite={}):
                 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()
@@ -256,29 +323,45 @@ def update_car_data(force_update=False, overwrite={}):
 
             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"
 
-            if state:
+            if state or state == 0:
                 mqtt_client.publish(
                     topic,
-                    json.dumps(state) if isinstance(state, dict) or isinstance(state, list) else state
+                    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"])
-    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)
+    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:
-            icon = icon_config[state]
-    else:
+            return None
+    except:
         return None
 
     logging.debug("Updating icon to " + icon + " for " + entity["id"])
@@ -333,6 +416,7 @@ def create_ha_devices():
                 "unique_id": f"volvoAAOS2mqtt_{vin}_{entity['id']}",
                 "availability_topic": availability_topic
             }
+
             if entity.get("device_class"):
                 config["device_class"] = entity["device_class"]
 
@@ -342,13 +426,20 @@ def create_ha_devices():
             if entity.get("state_class"):
                 config["state_class"] = entity["state_class"]
 
-            if entity.get("domain") == "device_tracker" or entity.get("id") == "active_schedules":
+            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"
-            elif 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"
 
@@ -362,11 +453,11 @@ 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")
+    mqtt_client.publish(availability_topic, "offline", retain=True)
 
 
 def delete_old_entities():

src/settings.json

@@ -14,9 +14,6 @@
     "username": "",
     "password": "",
     "vin": "",
-	"vccapikey": [],
-    "odometerMultiplier": "",
-    "averageSpeedDivider": "",
-    "averageFuelConsumptionMultiplier": ""
+	  "vccapikey": []
   }
 }

src/translations/en.yaml

@@ -19,4 +19,4 @@ configuration:
     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!
+    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

@@ -4,6 +4,8 @@ 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
@@ -28,11 +30,34 @@ class SensitiveDataFilter(logging.Filter):
             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"]:
+        if s["to"] <= state < s["from"]:
             icon = s["icon"]
     return icon
 
@@ -40,7 +65,7 @@ def get_icon_between(icon_list, state):
 def setup_logging():
     log_location = "volvo2mqtt.log"
     if os.environ.get("IS_HA_ADDON"):
-        check_existing_folder()
+        check_existing_folder("/addons/volvo2mqtt/log/")
         log_location = "/addons/volvo2mqtt/log/volvo2mqtt.log"
 
     logging.Formatter.converter = lambda *args: datetime.now(tz=TZ).timetuple()
@@ -73,8 +98,8 @@ def setup_logging():
             logger.setLevel(logging.ERROR)
 
 
-def check_existing_folder():
-    Path("/addons/volvo2mqtt/log/").mkdir(parents=True, exist_ok=True)
+def check_existing_folder(path):
+    Path(path).mkdir(parents=True, exist_ok=True)
 
 
 def keys_exists(element, *keys):

src/volvo.py

@@ -1,18 +1,21 @@
+import json
 import logging
 import requests
 import mqtt
 import util
 import time
 import re
+import os.path
 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, \
+    OAUTH_AUTH_URL, OAUTH_TOKEN_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
+    STATISTICS_URL, ENGINE_DIAGNOSTICS_URL, VEHICLE_DIAGNOSTICS_URL, API_BACKEND_STATUS, WARNINGS_URL, engine_states, \
+    otp_max_loops
 
 session = requests.Session()
 session.headers = {
@@ -30,37 +33,142 @@ vcc_api_keys = []
 backend_status = ""
 
 
-def authorize():
-    headers = {
-        "authorization": "Basic aDRZZjBiOlU4WWtTYlZsNnh3c2c1WVFxWmZyZ1ZtSWFEcGhPc3kxUENhVXNpY1F0bzNUUjVrd2FKc2U0QVpkZ2ZJZmNMeXc=",
-        "content-type": "application/x-www-form-urlencoded",
-        "accept": "application/json"
-    }
+def authorize(renew_tokenfile=False):
+    global refresh_token
+
+    token_path = util.get_token_path()
+    if os.path.isfile(token_path) and not renew_tokenfile:
+        logging.info("Using login from token file")
+        f = open(token_path)
+        try:
+            data = json.load(f)
+            refresh_token = data["refresh_token"]
+            refresh_auth()
+        except ValueError:
+            logging.warning("Detected corrupted token file, restarting auth process")
+            authorize(True)
+    else:
+        logging.info("Starting login with OTP")
+        auth_session = requests.session()
+        auth_session.headers = {
+            "authorization": "Basic aDRZZjBiOlU4WWtTYlZsNnh3c2c1WVFxWmZyZ1ZtSWFEcGhPc3kxUENhVXNpY1F0bzNUUjVrd2FKc2U0QVpkZ2ZJZmNMeXc=",
+            "User-Agent": "vca-android/" + util.get_volvo_app_version(),
+            "Accept-Encoding": "gzip",
+            "Content-Type": "application/json; charset=utf-8"
+        }
+
+        url_params = ("?client_id=h4Yf0b"
+                      "&response_type=code"
+                      "&acr_values=urn:volvoid:aal:bronze:2sv"
+                      "&response_mode=pi.flow"
+                      "&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 = auth_session.get(OAUTH_AUTH_URL + url_params)
+        if auth.status_code == 200:
+            response = auth.json()
+            auth_state = response["status"]
+
+            if auth_state == "USERNAME_PASSWORD_REQUIRED":
+                auth_session.headers.update({"x-xsrf-header": "PingFederate"})
+                response = check_username_password(auth_session, response)
+                auth_state = response["status"]
+
+                if auth_state == "OTP_REQUIRED":
+                    response = send_otp(auth_session, response)
+                    response = continue_auth(auth_session, response)
+                    token_data = get_token(auth_session, response)
+                else:
+                    raise Exception("Unkown auth state " + auth_state)
+            elif auth_state == "OTP_REQUIRED":
+                response = send_otp(auth_session, response)
+                response = continue_auth(auth_session, response)
+                token_data = get_token(auth_session, response)
+            elif auth_state == "OTP_VERIFIED":
+                response = continue_auth(auth_session, response)
+                token_data = get_token(auth_session, response)
+            elif auth_state == "COMPLETED":
+                token_data = get_token(auth_session, response)
+            else:
+                raise Exception("Unkown auth state " + auth_state)
+
+            session.headers.update({"authorization": "Bearer " + token_data["access_token"]})
+
+            global token_expires_at
+            token_expires_at = datetime.now(util.TZ) + timedelta(seconds=(token_data["expires_in"] - 30))
+            refresh_token = token_data["refresh_token"]
+
+            util.save_to_json(token_data, token_path)
+        else:
+            message = auth.json()
+            raise Exception(message["details"][0]["userMessage"])
+
+    get_vcc_api_keys()
+    get_vehicles()
+    check_supported_endpoints()
+    Thread(target=backend_status_loop).start()
+
+def continue_auth(auth_session, data):
+    next_url = data["_links"]["continueAuthentication"]["href"].replace("http://", "https://") + "?action=continueAuthentication"
+    auth = auth_session.get(next_url)
 
-    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()
+        return auth.json()
     else:
         message = auth.json()
+        raise Exception(message["details"][0]["userMessage"])
+
+
+def get_token(auth_session, data):
+    auth_session.headers.update({"content-type": "application/x-www-form-urlencoded"})
+    body = {"code": data["authorizeResponse"]["code"], "grant_type": "authorization_code"}
+    token_auth = auth_session.post(OAUTH_TOKEN_URL, data=body)
+
+    if token_auth.status_code == 200:
+        return token_auth.json()
+    else:
+        message = token_auth.json()
         raise Exception(message["error_description"])
 
 
+def check_username_password(auth_session, data):
+    next_url = data["_links"]["checkUsernamePassword"]["href"].replace("http://", "https://") + "?action=checkUsernamePassword"
+    body = {"username": settings.volvoData["username"],
+             "password": settings.volvoData["password"]}
+    auth = auth_session.post(next_url, data=json.dumps(body))
+
+    if auth.status_code == 200:
+        return auth.json()
+    else:
+        message = auth.json()
+        raise Exception(message["details"][0]["userMessage"])
+
+
+def send_otp(auth_session, data):
+    mqtt.create_otp_input()
+    next_url = data["_links"]["checkOtp"]["href"].replace("http://", "https://") + "?action=checkOtp"
+    body = {"otp": ""}
+
+    for i in range(otp_max_loops):
+        if mqtt.otp_code:
+            body["otp"] = mqtt.otp_code
+            break
+
+        logging.info("Waiting for otp code... Please check your mailbox and post your otp code to the following "
+                     "mqtt topic \"volvoAAOS2mqtt/otp_code\". Retry " + str(i) + "/" + str(otp_max_loops))
+        time.sleep(5)
+
+    if not mqtt.otp_code:
+        raise Exception ("No OTP found, exting...")
+
+    auth = auth_session.post(next_url, data=json.dumps(body))
+    mqtt.otp_code = None
+    if auth.status_code == 200:
+        return auth.json()
+    else:
+        message = auth.json()
+        raise Exception(message["details"][0]["userMessage"])
+
+
 def refresh_auth():
     logging.info("Refreshing credentials")
     global refresh_token
@@ -76,18 +184,34 @@ def refresh_auth():
     }
 
     try:
-        auth = requests.post(OAUTH_URL, data=body, headers=headers)
+        auth = requests.post(OAUTH_TOKEN_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"]})
+        token_path = util.get_token_path()
+        refresh_data = auth.json()
+
+        f = open(token_path)
+        try:
+            data = json.load(f)
+            refresh_token = data["refresh_token"]
+        except ValueError:
+            raise Exception("Cannot refresh token!")
+
+        refresh_data["refresh_token"] = refresh_token
+        util.save_to_json(refresh_data, token_path)
+        session.headers.update({"authorization": "Bearer " + refresh_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"]
+        token_expires_at = datetime.now(util.TZ) + timedelta(seconds=(refresh_data["expires_in"] - 30))
+        refresh_token = refresh_data["refresh_token"]
+        return None
+    else:
+        logging.warning("Refreshing credentials failed!: " + str(auth.status_code) + " Message: " + auth.text)
+        authorize(renew_tokenfile=True)
+        return None
 
 
 def get_vehicles():
@@ -200,9 +324,17 @@ def check_vcc_api_key(test_key, extended_until=None):
                 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"])
+            if "error" in data:
+                logging.warning("VCCAPIKEY " + test_key + " isn't working! " + data["error"]["message"])
+            else:
+                logging.warning("VCCAPIKEY " + test_key + " isn't working! Statuscode " + str(response.status_code) +
+                                " Message: " + response.text)
     else:
-        logging.warning("VCCAPIKEY " + test_key + " isn't working! " + data["error"]["message"])
+        if "error" in data:
+            logging.warning("VCCAPIKEY " + test_key + " isn't working! " + data["error"]["message"])
+        else:
+            logging.warning("VCCAPIKEY " + test_key + " isn't working! Statuscode " + str(response.status_code) +
+                            " Message: " + response.text)
     return True, extended_until
 
 
@@ -328,9 +460,16 @@ def get_backend_status():
     response = session.get(API_BACKEND_STATUS, timeout=15)
     try:
         data = response.json()
-        backend_status = data["message"] if util.keys_exists(data, "message") else "No warnings"
+        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 warnings"
+        backend_status = "NO_WARNING"
     return backend_status
 
 
@@ -339,7 +478,7 @@ def api_call(url, method, vin, sensor_id=None, force_update=False, key_change=Fa
         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]:
+               STATISTICS_URL, ENGINE_DIAGNOSTICS_URL, VEHICLE_DIAGNOSTICS_URL, FUEL_BATTERY_STATE_URL, WARNINGS_URL]:
         # Minimize API calls for endpoints with multiple values
         response = cached_request(url, method, vin, force_update, key_change)
         if response is None:
@@ -433,9 +572,10 @@ def cached_request(url, method, vin, force_update=False, key_change=False):
 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 == "battery_capacity":
+        return data["batteryCapacityKWH"] if util.keys_exists(data, "batteryCapacityKWH") else None
     elif sensor_id == "electric_range":
         return util.convert_metric_values(data["electricRange"]["value"]) \
             if util.keys_exists(data, "electricRange") else None
@@ -468,14 +608,7 @@ def parse_api_data(data, sensor_id=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) \
+        return util.convert_metric_values(int(data["odometer"]["value"])) \
             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") \
@@ -523,30 +656,25 @@ def parse_api_data(data, sensor_id=None):
                 return fuel_amount
         return None
     elif sensor_id == "average_fuel_consumption":
+        average_fuel_con = 0
         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
+        elif util.keys_exists(data, "averageFuelConsumptionAutomatic"):
+            average_fuel_con = float(data["averageFuelConsumptionAutomatic"]["value"])
+
+        if average_fuel_con > 0:
+            return average_fuel_con
         return None
     elif sensor_id == "average_speed":
+        average_speed = 0
         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)
+        elif util.keys_exists(data, "averageSpeedAutomatic"):
+            average_speed = float(data["averageSpeedAutomatic"]["value"])
+
+        if average_speed != 0:
+            return util.convert_metric_values(average_speed)
+
         return None
     elif sensor_id == "location":
         coordinates = {}
@@ -585,8 +713,28 @@ def parse_api_data(data, sensor_id=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
+        average_energy_con = 0
+        if util.keys_exists(data, "averageEnergyConsumption"):
+            average_energy_con = data["averageEnergyConsumption"]["value"]
+        elif util.keys_exists(data, "averageEnergyConsumptionAutomatic"):
+            average_energy_con = data["averageEnergyConsumptionAutomatic"]["value"]
+
+        if average_energy_con != 0:
+            return average_energy_con
+        return None
     elif sensor_id == "washer_fluid_warning":
         return data["washerFluidLevelWarning"]["value"] if util.keys_exists(data, "washerFluidLevelWarning") else None
+    elif sensor_id == "warnings":
+        warnings = 0
+        cleaned_data = {}
+        for key, dicts in data.items():
+            contains_data = sum(value == "NO_WARNING" or value == "FAILURE" for value in dicts.values())
+            if contains_data:
+                warnings = warnings + 1
+                cleaned_data[key] = dicts["value"]
+
+        return cleaned_data if warnings > 0 else None
     else:
         return None
+
+