Fix volvo API changes #53

#43

.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**
+**Logs**:<br>
-Add any other context about the problem here.
+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/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

@@ -11,14 +11,20 @@
 
 This component establishes a connection between the newer AAOS Volvo cars and Home Assistant via MQTT.<br>
 Maybe this component works also with other Volvo cars. Please try out the native Volvo [integration](https://www.home-assistant.io/integrations/volvooncall/) before using this component! If the native component doesn't work for your car, try this mqtt bridge.
+<p>
+
+Home Assistant thread can be found [here](https://community.home-assistant.io/t/volvo2mqtt-connect-your-aaos-volvo/585699).
+
+If you like my work:<br>
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/U7U8MFXCF)
 
 ## Confirmed working with
 - XC40 BEV (2023)
 - XC40 BEV (2022)
 - XC40 PHEV (2021)
 - V60 T8 PHEV (2023)
-- C40 PHEV (2023)
+- C40 BEV (2023)
-- C40 PHEV (2022)
+- C40 BEV (2022)
 - XC90 T8 PHEV (2023)
 - XC60 PHEV (2023)
 - XC60 PHEV (2022)
@@ -39,7 +45,7 @@ Please let me know if your car works with this addon so I can expand the list!<b
 - 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)"
+- Sensor "Window Lock Status (All windows and sunroof - Thanks to @navet)"
 - Sensor "Engine Status"
 - Sensor "Odometer"
 - Sensor "Tire Status"
@@ -57,7 +63,7 @@ NOTE: Energy status currently available only for cars in the Europe / Middle Eas
 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}' -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": "", "odometerMultiplier": 1, "averageSpeedDivider": 1, "averageFuelConsumptionMultiplier": 1}' -e TZ='Europe/Berlin' --name volvo2mqtt ghcr.io/dielee/volvo2mqtt:latest`
 
 <b>HA Add-On:</b><br>
 
@@ -65,14 +71,23 @@ Please note to fill in your settings inside the environment variables.
 
 Here is what every option means:
 
-| Name                 |   Type    |   Default    | Description                                                     |
+| Environment Variable Name |   Type    | Json Option                           |   Default    | Description                                                     |
-| -------------------- | :-------: | :----------: | --------------------------------------------------------------- |
+| ------------------------- | :-------: | :-----------------------------------: | :----------: | --------------------------------------------------------------- |
-| `CONF_updateInterval`     | `int`     | **required** | Update intervall in seconds.                                     |
+| `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_babelLocale`        | `string`  |                                       | **required** | Select your country from this [list](https://www.ibm.com/docs/en/radfws/9.7?topic=overview-locales-code-pages-supported). "Locale name" is the column you need!                                        |
-| `CONF_mqtt`               | `json`    | **required** | Broker = Mqtt Broker IP / Username and Passwort are optional! Broker port can be changed. If no value is given, port 1883 will be used.  |
+| `CONF_mqtt`               | `json`    | `broker`                              | **required** | Your MQTT Broker IP. Eg. 192.168.0.5.
-| `CONF_volvoData`          | `json`    | **required** | Username and password are REQUIRED. Car vin can be a single vin or a list of multiple vins like `["vin1", "vin2"]`. If no vin is provided, <b>ALL</b> of your vehicles will be used. Vccapi key is REQUIRED. Get your Vccapi key from [here](https://developer.volvocars.com/account/). Odometer Multiplier is sometimes 10, sometimes 1. Try what's right for your car. If you leave it empty, the multiplier will be 1.                                 |
+| `CONF_mqtt`               | `json`    | `port`                                | 1883         | Your MQTT Broker Port. If no value is given, port 1883 will be used.  |
-| `CONF_debug`              | `string`  |              | Debug option (true/false) - optional! |
+| `CONF_mqtt`               | `json`    | `username`                            | optional     | MQTT Username for your broker.
-| `TZ`                 | `string`  |              | Container timezone eg "Europe/Berlin" from [here](https://docs.diladele.com/docker/timezones.html)|
+| `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_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>

src/CHANGELOG.md

@@ -0,0 +1,70 @@
+## 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

@@ -15,6 +15,7 @@ RUN pip install -r requirements.txt
 
 # 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/config.yaml

@@ -1,26 +1,33 @@
 name: "Volvo2Mqtt"
 description: "Volvo AAOS MQTT bridge"
-version: "1.5.4"
+version: "1.7.3"
 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
   mqtt:
-    broker: null
+    broker: "auto_broker"
-    port: 1883
+    port: "auto_port"
-    username: ""
+    username: "auto_user"
-    password: ""
+    password: "auto_password"
   volvoData:
     username: null
     password: null
     vin: ""
     vccapikey: null
     odometerMultiplier: 1
+    averageSpeedDivider: 1
+    averageFuelConsumptionMultiplier: 1
 schema:
   updateInterval: int(10,)
   babelLocale: str
@@ -28,7 +35,7 @@ schema:
   debug: bool
   mqtt:
     broker: str
-    port: int(1,)
+    port: str
     username: str?
     password: str?
   volvoData:
@@ -37,6 +44,8 @@ schema:
     vin: str?
     vccapikey: str
     odometerMultiplier: int(1,)
+    averageSpeedDivider: int(1,)
+    averageFuelConsumptionMultiplier: int(1,)
 arch:
   - aarch64
   - amd64

src/const.py

@@ -1,6 +1,6 @@
 from config import settings
 
-VERSION = "v1.5.4"
+VERSION = "v1.7.3"
 
 OAUTH_URL = "https://volvoid.eu.volvocars.com/as/token.oauth2"
 VEHICLES_URL = "https://api.volvocars.com/connected-vehicle/v1/vehicles"
@@ -19,6 +19,24 @@ ENGINE_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/
 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"
 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"
+
+units = {
+            "en_GB": {
+                "divider": 1.60934,
+                "electric_range": {"unit": "mi"},
+                "odometer": {"unit": "mi"},
+                "average_speed": {"unit": "mph"},
+                "distance_to_empty": {"unit": "mi"}
+            },
+            "en_US": {
+                "divider": 1.60934,
+                "electric_range": {"unit": "mi"},
+                "odometer": {"unit": "mi"},
+                "average_speed": {"unit": "mph"},
+                "distance_to_empty": {"unit": "mi"}
+            }
+        }
 
 availability_topic = "volvoAAOS2mqtt/availability"
 
@@ -30,16 +48,39 @@ charging_connection_states = {"CONNECTION_STATUS_DISCONNECTED": "Disconnected",
 
 window_states = {"CLOSED": "OFF", "OPEN": "ON"}
 door_states = {"CLOSED": "OFF", "OPEN": "ON"}
+engine_states = {"RUNNING": "ON", "STOPPED": "OFF", "true": "ON", "false": "OFF"}
+
+icon_states = {
+    "lock_status": {"UNLOCKED": "lock-open-alert", "LOCKED": "lock"},
+    "door_front_left": {"ON": "car-door", "OFF": "car-door-lock"},
+    "door_front_right": {"ON": "car-door", "OFF": "car-door-lock"},
+    "door_rear_left": {"ON": "car-door", "OFF": "car-door-lock"},
+    "door_rear_right": {"ON": "car-door", "OFF": "car-door-lock"},
+    "engine_state": {"ON": "engine-outline", "OFF": "engine-off-outline"},
+    "battery_charge_level": [
+                    {"from": 100, "to": 100, "icon": "battery"},
+                    {"from": 99, "to": 90, "icon": "battery-90"},
+                    {"from": 89, "to": 80, "icon": "battery-80"},
+                    {"from": 79, "to": 70, "icon": "battery-70"},
+                    {"from": 69, "to": 60, "icon": "battery-60"},
+                    {"from": 59, "to": 50, "icon": "battery-50"},
+                    {"from": 49, "to": 40, "icon": "battery-40"},
+                    {"from": 39, "to": 30, "icon": "battery-30"},
+                    {"from": 29, "to": 20, "icon": "battery-20"},
+                    {"from": 19, "to": 10, "icon": "battery-10"},
+                    {"from": 9, "to": 0, "icon": "battery-alert-variant-outline"},
+    ]
+}
 
 supported_entities = [
                         {"name": "Battery Charge Level", "domain": "sensor", "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 settings["babelLocale"] != "en_US" else "mi", "icon": "map-marker-distance", "url": RECHARGE_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": "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 settings["babelLocale"] != "en_US" else "mi", "icon": "counter", "url": ODOMETER_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": "Last Data Update", "domain": "sensor", "id": "last_data_update", "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},
@@ -61,8 +102,10 @@ 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": "Engine State", "domain": "binary_sensor", "device_class": "running", "id": "engine_state", "icon": "engine", "url": ENGINE_STATE_URL},
+                        {"name": "Engine State", "domain": "binary_sensor", "device_class": "running", "id": "engine_state", "icon": "engine", "url": ENGINE_DIAGNOSTICS_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 settings["babelLocale"] != "en_US" else "mp/h", "icon": "speedometer", "url": STATISTICS_URL}
+                        {"name": "Distance to Empty", "domain": "sensor", "id": "distance_to_empty", "unit": "km" if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["distance_to_empty"]["unit"], "icon": "map-marker-distance", "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}
 ]

src/main.py

@@ -1,12 +1,15 @@
+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
 
 
 if __name__ == '__main__':
-    print("Starting volvo2mqtt version " + VERSION)
     set_tz()
+    set_mqtt_settings()
+    setup_logging()
+    logging.info("Starting volvo2mqtt version " + VERSION)
     authorize()
     connect()
     update_loop()

src/mqtt.py

@@ -1,3 +1,4 @@
+import logging
 import time
 import paho.mqtt.client as mqtt
 import json
@@ -8,7 +9,7 @@ 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
 
 
 mqtt_client: mqtt.Client
@@ -16,6 +17,8 @@ subscribed_topics = []
 assumed_climate_state = {}
 last_data_update = None
 climate_timer = {}
+engine_status = {}
+devices = {}
 
 
 def connect():
@@ -47,41 +50,60 @@ def on_connect(client, userdata, flags, rc):
 
 
 def on_disconnect(client, userdata,  rc):
-    print("MQTT disconnected, reconnecting automatically")
+    logging.warning("MQTT disconnected, reconnecting automatically")
 
 
 def on_message(client, userdata, msg):
     try:
         vin = msg.topic.split('/')[2].split('_')[0]
     except IndexError:
-        print("Error - Cannot get vin from MQTT topic!")
+        logging.error("Error - Cannot get vin from MQTT topic!")
         return None
 
     payload = msg.payload.decode("UTF-8")
     if "climate_status" in msg.topic:
-        global assumed_climate_state, climate_timer
+        global assumed_climate_state, climate_timer, engine_status
         if payload == "ON":
-            api_thread = Thread(target=volvo.api_call, args=(CLIMATE_START_URL, "POST", vin))
+            # Start the api call in another thread for HA performance
-            api_thread.start()
+            Thread(target=volvo.api_call, args=(CLIMATE_START_URL, "POST", vin)).start()
-            assumed_climate_state[vin] = "ON"
+
+            # Start door check thread to turn off climate if driver door is opened
+            check_engine_thread = Thread(target=volvo.check_engine_status, args=(vin, ))
+            check_engine_thread.start()
+            engine_status[vin] = check_engine_thread
+
             # Starting timer to disable climate after 30 mins
             climate_timer[vin] = Timer(30 * 60, volvo.disable_climate, (vin, ))
             climate_timer[vin].start()
+
+            # Set and update switch status
+            assumed_climate_state[vin] = "ON"
             update_car_data()
         elif payload == "OFF":
-            api_thread = Thread(target=volvo.api_call, args=(CLIMATE_STOP_URL, "POST", vin))
+            # Start the api call in another thread for HA performance
-            api_thread.start()
+            Thread(target=volvo.api_call, args=(CLIMATE_STOP_URL, "POST", vin)).start()
-            assumed_climate_state[vin] = "OFF"
+
-            # Stop timer if active
+            # 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()
     elif "lock_status" in msg.topic:
         if payload == "LOCK":
             volvo.api_call(CAR_LOCK_URL, "POST", vin)
+
+            # Force set unlocked state in HA because of slow api response
             update_car_data(True, {"entity_id": "lock_status", "vin": vin, "state": "LOCKED"})
         elif payload == "UNLOCK":
             volvo.api_call(CAR_UNLOCK_URL, "POST", vin)
+
+            # Force set unlocked state in HA because of slow api response
             update_car_data(True, {"entity_id": "lock_status", "vin": vin, "state": "UNLOCKED"})
     elif "update_data" in msg.topic:
         if payload == "PRESS":
@@ -91,10 +113,10 @@ def on_message(client, userdata, msg):
 def update_loop():
     create_ha_devices()
     while True:
-        print("Sending mqtt update...")
+        logging.info("Sending mqtt update...")
         send_heartbeat()
         update_car_data()
-        print("Mqtt update done. Next run in " + str(settings["updateInterval"]) + " seconds.")
+        logging.info("Mqtt update done. Next run in " + str(settings["updateInterval"]) + " seconds.")
         time.sleep(settings["updateInterval"])
 
 
@@ -133,12 +155,58 @@ def update_car_data(force_update=False, overwrite={}):
                 topic,
                 json.dumps(state) if isinstance(state, dict) else state
             )
+            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:
+        if state.replace(".", "").isnumeric():
+            state = float(state)
+            icon = util.get_icon_between(icon_config, state)
+        else:
+            icon = icon_config[state]
+    else:
+        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("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'],

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

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

src/translations/en.yaml

@@ -10,10 +10,10 @@ 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.
   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 APP credentials
+    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. Leave it empty 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. Odometer multiplier is sometimes 10, sometimes 1. The same is applicable for average speed divider and average fuel consumption. Leave it as it is if you don't know what's right. Take a look at the GitHub repo for more information!

src/util.py

@@ -1,10 +1,55 @@
+import logging
 import pytz
 import os
+import sys
+import config
+from logging import handlers
+from datetime import datetime
+from const import units
 from config import settings
+from pathlib import Path
 
 TZ = None
 
 
+def get_icon_between(icon_list, state):
+    icon = None
+    for s in icon_list:
+        if s["to"] <= state <= s["from"]:
+            icon = s["icon"]
+    return icon
+
+
+def setup_logging():
+    log_location = "volvo2mqtt.log"
+    if os.environ.get("IS_HA_ADDON"):
+        check_existing_folder()
+        log_location = "/addons/volvo2mqtt/log/volvo2mqtt.log"
+
+    logging.Formatter.converter = lambda *args: datetime.now(tz=TZ).timetuple()
+    file_log_handler = logging.handlers.RotatingFileHandler(log_location, maxBytes=1000000, backupCount=1)
+    formatter = logging.Formatter(
+        '%(asctime)s volvo2mqtt [%(process)d] - %(levelname)s: %(message)s',
+        '%b %d %H:%M:%S')
+    file_log_handler.setFormatter(formatter)
+    logger = logging.getLogger()
+
+    console_log_handler = logging.StreamHandler(sys.stdout)
+    console_log_handler.setFormatter(formatter)
+
+    logger.addHandler(console_log_handler)
+    logger.addHandler(file_log_handler)
+
+    logger.setLevel(logging.INFO)
+    if "debug" in settings:
+        if settings["debug"]:
+            logger.setLevel(logging.DEBUG)
+
+
+def check_existing_folder():
+    Path("/addons/volvo2mqtt/log/").mkdir(parents=True, exist_ok=True)
+
+
 def keys_exists(element, *keys):
     """"
     Check if *keys (nested) exists in `element` (dict).
@@ -34,3 +79,37 @@ def set_tz():
         TZ = pytz.timezone(settings_tz)
     else:
         raise Exception("No timezone setting found! Please read the README!")
+
+
+def convert_metric_values(value):
+    if keys_exists(units, settings["babelLocale"]):
+        divider = units[settings["babelLocale"]]["divider"]
+        return round((float(value) / divider), 2)
+    else:
+        return value
+
+
+def set_mqtt_settings():
+    if os.environ.get("IS_HA_ADDON"):
+        if config.settings["mqtt"]["broker"] != "auto_broker" \
+                or config.settings["mqtt"]["port"] != "auto_port" \
+                or config.settings["mqtt"]["username"] != "auto_user" \
+                or config.settings["mqtt"]["password"] != "auto_password":
+            # If settings were manually set, use the manually set settings
+            return None
+
+        broker_host = os.getenv("MQTTHOST", None)
+        broker_port = os.getenv("MQTTPORT", None)
+        broker_user = os.getenv("MQTTUSER", None)
+        broker_pass = os.getenv("MQTTPASS", None)
+
+        if not broker_host or not broker_port:
+            raise Exception("MQTT connection could not be established. Please check if your MQTT Add-On is running!")
+
+        logging.debug("MQTT Credentials - Host " + broker_host + " Port: " + str(broker_port) +
+                      " User: " + str(broker_user) + " Pass: " + str(broker_pass))
+
+        config.settings["mqtt"]["broker"] = broker_host
+        config.settings["mqtt"]["port"] = broker_port
+        config.settings["mqtt"]["username"] = broker_user
+        config.settings["mqtt"]["password"] = broker_pass

src/volvo.py

@@ -1,362 +1,418 @@
-import requests
+import logging
-import mqtt
+import requests
-import util
+import mqtt
-from datetime import datetime, timedelta
+import util
-from config import settings
+import time
-from babel.dates import format_datetime
+from threading import currentThread
-from const import charging_system_states, charging_connection_states, door_states, window_states, \
+from datetime import datetime, timedelta
-    OAUTH_URL, VEHICLES_URL, VEHICLE_DETAILS_URL, RECHARGE_STATE_URL, CLIMATE_START_URL, \
+from config import settings
-    WINDOWS_STATE_URL, LOCK_STATE_URL, TYRE_STATE_URL, supported_entities, BATTERY_CHARGE_STATE_URL, \
+from babel.dates import format_datetime
-    STATISTICS_URL
+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, \
-session = requests.Session()
+    WINDOWS_STATE_URL, LOCK_STATE_URL, TYRE_STATE_URL, supported_entities, BATTERY_CHARGE_STATE_URL, \
-session.headers = {
+    STATISTICS_URL, ENGINE_DIAGNOSTICS_URL, engine_states
-    "vcc-api-key": settings["volvoData"]["vccapikey"],
+
-    "content-type": "application/json",
+session = requests.Session()
-    "accept": "*/*"
+session.headers = {
-}
+    "vcc-api-key": settings["volvoData"]["vccapikey"],
-
+    "content-type": "application/json",
-token_expires_at: datetime
+    "accept": "*/*"
-refresh_token = None
+}
-vins = []
+
-supported_endpoints = {}
+token_expires_at: datetime
-cached_requests = {}
+refresh_token = None
-
+vins = []
-
+supported_endpoints = {}
-def authorize():
+cached_requests = {}
-    headers = {
+
-        "authorization": "Basic aDRZZjBiOlU4WWtTYlZsNnh3c2c1WVFxWmZyZ1ZtSWFEcGhPc3kxUENhVXNpY1F0bzNUUjVrd2FKc2U0QVpkZ2ZJZmNMeXc=",
+
-        "content-type": "application/x-www-form-urlencoded",
+def authorize():
-        "accept": "application/json"
+    headers = {
-    }
+        "authorization": "Basic aDRZZjBiOlU4WWtTYlZsNnh3c2c1WVFxWmZyZ1ZtSWFEcGhPc3kxUENhVXNpY1F0bzNUUjVrd2FKc2U0QVpkZ2ZJZmNMeXc=",
-
+        "content-type": "application/x-www-form-urlencoded",
-    body = {
+        "accept": "application/json"
-        "username": settings.volvoData["username"],
+    }
-        "password": settings.volvoData["password"],
+
-        "grant_type": "password",
+    body = {
-        "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"
+        "username": settings.volvoData["username"],
-    }
+        "password": settings.volvoData["password"],
-    auth = requests.post(OAUTH_URL, data=body, headers=headers)
+        "grant_type": "password",
-    if auth.status_code == 200:
+        "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"
-        data = auth.json()
+    }
-        session.headers.update({'authorization': "Bearer " + data["access_token"]})
+    auth = requests.post(OAUTH_URL, data=body, headers=headers)
-
+    if auth.status_code == 200:
-        global token_expires_at, refresh_token
+        data = auth.json()
-        token_expires_at = datetime.now(util.TZ) + timedelta(seconds=(data["expires_in"] - 30))
+        session.headers.update({'authorization': "Bearer " + data["access_token"]})
-        refresh_token = data["refresh_token"]
+
-
+        global token_expires_at, refresh_token
-        get_vehicles()
+        token_expires_at = datetime.now(util.TZ) + timedelta(seconds=(data["expires_in"] - 30))
-        check_supported_endpoints()
+        refresh_token = data["refresh_token"]
-    else:
+
-        message = auth.json()
+        get_vehicles()
-        raise Exception(message["error_description"])
+        check_supported_endpoints()
-
+    else:
-
+        message = auth.json()
-def refresh_auth():
+        raise Exception(message["error_description"])
-    print("Refreshing credentials")
+
-    global refresh_token
+
-    headers = {
+def refresh_auth():
-        "authorization": "Basic aDRZZjBiOlU4WWtTYlZsNnh3c2c1WVFxWmZyZ1ZtSWFEcGhPc3kxUENhVXNpY1F0bzNUUjVrd2FKc2U0QVpkZ2ZJZmNMeXc=",
+    logging.info("Refreshing credentials")
-        "content-type": "application/x-www-form-urlencoded",
+    global refresh_token
-        "accept": "application/json"
+    headers = {
-    }
+        "authorization": "Basic aDRZZjBiOlU4WWtTYlZsNnh3c2c1WVFxWmZyZ1ZtSWFEcGhPc3kxUENhVXNpY1F0bzNUUjVrd2FKc2U0QVpkZ2ZJZmNMeXc=",
-
+        "content-type": "application/x-www-form-urlencoded",
-    body = {
+        "accept": "application/json"
-        "grant_type": "refresh_token",
+    }
-        "refresh_token": refresh_token
+
-    }
+    body = {
-    auth = requests.post(OAUTH_URL, data=body, headers=headers)
+        "grant_type": "refresh_token",
-    if auth.status_code == 200:
+        "refresh_token": refresh_token
-        data = auth.json()
+    }
-        session.headers.update({'authorization': "Bearer " + data["access_token"]})
+
-
+    try:
-        global token_expires_at
+        auth = requests.post(OAUTH_URL, data=body, headers=headers)
-        token_expires_at = datetime.now(util.TZ) + timedelta(seconds=(data["expires_in"] - 30))
+    except requests.exceptions.RequestException as e:
-        refresh_token = data["refresh_token"]
+        logging.error("Error refreshing credentials data: " + str(e))
-
+        return None
-
+
-def get_vehicles():
+    if auth.status_code == 200:
-    global vins
+        data = auth.json()
-    if not settings.volvoData["vin"]:
+        session.headers.update({'authorization': "Bearer " + data["access_token"]})
-        vehicles = session.get(VEHICLES_URL)
+
-        if vehicles.status_code == 200:
+        global token_expires_at
-            data = vehicles.json()
+        token_expires_at = datetime.now(util.TZ) + timedelta(seconds=(data["expires_in"] - 30))
-            if len(data["data"]) > 0:
+        refresh_token = data["refresh_token"]
-                for vehicle in data["data"]:
+
-                    vins.append(vehicle["vin"])
+
-            else:
+def get_vehicles():
-                raise Exception("No vehicle in account " + settings.volvoData["username"] + " found.")
+    global vins
-        else:
+    if not settings.volvoData["vin"]:
-            raise Exception("Error getting vehicles: " + str(vehicles.status_code))
+        vehicles = session.get(VEHICLES_URL)
-    else:
+        if vehicles.status_code == 200:
-        if isinstance(settings.volvoData["vin"], list):
+            data = vehicles.json()
-            # If setting is a list, copy
+            if len(data["data"]) > 0:
-            vins = settings.volvoData["vin"]
+                for vehicle in data["data"]:
-        else:
+                    vins.append(vehicle["vin"])
-            # If setting is a string, append to list
+            else:
-            vins.append(settings.volvoData["vin"])
+                raise Exception("No vehicle in account " + settings.volvoData["username"] + " found.")
-
+        else:
-    if len(vins) == 0:
+            error = vehicles.json()
-        raise Exception("No vehicle found, exiting application!")
+            raise Exception(
-    else:
+                "Error getting vehicles: " + str(vehicles.status_code) + ". " + str(error["error"].get("message")))
-        initialize_climate(vins)
+    else:
-        print("Vin: " + str(vins) + " found!")
+        if isinstance(settings.volvoData["vin"], list):
-
+            # If setting is a list, copy
-
+            vins = settings.volvoData["vin"]
-def get_vehicle_details(vin):
+        else:
-    response = session.get(VEHICLE_DETAILS_URL.format(vin), timeout=15)
+            # If setting is a string, append to list
-    if response.status_code == 200:
+            vins.append(settings.volvoData["vin"])
-        data = response.json()["data"]
+
-        if "debug" in settings:
+    if len(vins) == 0:
-            if settings["debug"]:
+        raise Exception("No vehicle found, exiting application!")
-                print(response.text)
+    else:
-        device = {
+        initialize_climate(vins)
-            "identifiers": [f"volvoAAOS2mqtt_{vin}"],
+        logging.info("Vin: " + str(vins) + " found!")
-            "manufacturer": "Volvo",
+
-            "model": data['descriptions']['model'],
+
-            "name": f"{data['descriptions']['model']} ({data['modelYear']}) - {vin}",
+def get_vehicle_details(vin):
-        }
+    response = session.get(VEHICLE_DETAILS_URL.format(vin), timeout=15)
-    elif response.status_code == 500 and not settings.volvoData["vin"]:
+    if response.status_code == 200:
-        # Workaround for some cars that are not returning vehicle details
+        data = response.json()["data"]
-        device = {
+        logging.debug(response.text)
-            "identifiers": [f"volvoAAOS2mqtt_{vin}"],
+        device = {
-            "manufacturer": "Volvo",
+            "identifiers": [f"volvoAAOS2mqtt_{vin}"],
-            "model": vin,
+            "manufacturer": "Volvo",
-            "name": f"Volvo - {vin}",
+            "model": data['descriptions']['model'],
-        }
+            "name": f"{data['descriptions']['model']} ({data['modelYear']}) - {vin}",
-    else:
+        }
-        raise Exception("Getting vehicle details failed. Status Code: " + str(response.status_code) +
+    elif response.status_code == 500 and not settings.volvoData["vin"]:
-                        ". Error: " + response.text)
+        # Workaround for some cars that are not returning vehicle details
-
+        device = {
-    return device
+            "identifiers": [f"volvoAAOS2mqtt_{vin}"],
-
+            "manufacturer": "Volvo",
-
+            "model": vin,
-def check_supported_endpoints():
+            "name": f"Volvo - {vin}",
-    global supported_endpoints
+        }
-    for vin in vins:
+    else:
-        supported_endpoints[vin] = []
+        raise Exception("Getting vehicle details failed. Status Code: " + str(response.status_code) +
-        for entity in supported_entities:
+                        ". Error: " + response.text)
-            if entity["id"] == "battery_charge_level" and entity["url"] == BATTERY_CHARGE_STATE_URL \
+
-                    and any("battery_charge_level" in d["id"] for d in supported_endpoints[vin]):
+    return device
-                # If battery charge level could be found in recharge-api, skip the second battery charge sensor
+
-                continue
+
-
+def check_supported_endpoints():
-            if entity.get('url'):
+    global supported_endpoints
-                state = api_call(entity["url"], "GET", vin, entity["id"])
+    for vin in vins:
-            else:
+        supported_endpoints[vin] = []
-                state = ""
+        for entity in supported_entities:
-
+            if entity["id"] == "battery_charge_level" and entity["url"] == BATTERY_CHARGE_STATE_URL \
-            if state is not None:
+                    and any("battery_charge_level" in d["id"] for d in supported_endpoints[vin]):
-                print("Success! " + entity["name"] + " is supported by your vehicle.")
+                # If battery charge level could be found in recharge-api, skip the second battery charge sensor
-                supported_endpoints[vin].append(entity)
+                continue
-            else:
+
-                print("Failed, " + entity["name"] + " is unfortunately not supported by your vehicle.")
+            if entity["id"] == "engine_state" and entity["url"] == ENGINE_DIAGNOSTICS_URL \
-
+                    and any("engine_state" in d["id"] for d in supported_endpoints[vin]):
-
+                # If engine state could be found in engine state endpoint, skip the second engine running sensor
-def initialize_climate(vins):
+                continue
-    for vin in vins:
+
-        mqtt.assumed_climate_state[vin] = "OFF"
+            if entity.get('url'):
-
+                state = api_call(entity["url"], "GET", vin, entity["id"])
-
+            else:
-def disable_climate(vin):
+                state = ""
-    print("Turning climate off by timer!")
+
-    mqtt.assumed_climate_state[vin] = "OFF"
+            if state is not None:
-    mqtt.update_car_data()
+                logging.info("Success! " + entity["name"] + " is supported by your vehicle.")
-
+                supported_endpoints[vin].append(entity)
-
+            else:
-def api_call(url, method, vin, sensor_id=None, force_update=False):
+                logging.info("Failed, " + entity["name"] + " is unfortunately not supported by your vehicle.")
-    global token_expires_at
+
-    if datetime.now(util.TZ) >= token_expires_at:
+
-        refresh_auth()
+def initialize_climate(vins):
-
+    for vin in vins:
-    if url in [RECHARGE_STATE_URL, WINDOWS_STATE_URL, LOCK_STATE_URL, TYRE_STATE_URL, STATISTICS_URL]:
+        mqtt.assumed_climate_state[vin] = "OFF"
-        # Minimize API calls for endpoints with multiple values
+
-        response = cached_request(url, method, vin, force_update)
+
-        if response is None:
+def disable_climate(vin):
-            # Exception caught while getting data from volvo api, doing nothing
+    logging.info("Turning climate off by timer!")
-            return None
+    mqtt.engine_status[vin].do_run = False
-    elif method == "GET":
+    mqtt.assumed_climate_state[vin] = "OFF"
-        print("Starting " + method + " call against " + url)
+    mqtt.update_car_data()
-        try:
+
-            response = session.get(url.format(vin), timeout=15)
+
-        except requests.exceptions.RequestException as e:
+def check_engine_status(vin):
-            print("Error getting data: " + str(e))
+    endpoint_url = ""
-            return ""
+    engine_state_supported = False
-    elif method == "POST":
+    for endpoint in supported_endpoints[vin]:
-        print("Starting " + method + " call against " + url)
+        if "engine_state" == endpoint["id"]:
-        try:
+            engine_state_supported = True
-            response = session.post(url.format(vin), timeout=20)
+            endpoint_url = endpoint["url"]
-        except requests.exceptions.RequestException as e:
+
-            print("Error getting data: " + str(e))
+    if not engine_state_supported:
-            return ""
+        # Exit thread as engine state is unsupported by car
-    else:
+        return None
-        print("Unkown method posted: " + method + ". Returning nothing")
+
-        return ""
+    t = currentThread()
-
+    while getattr(t, "do_run", True):
-    if response.status_code == 200:
+        engine_state = api_call(endpoint_url, "GET", vin, "engine_state", True)
-        data = response.json()
+        if engine_state == "ON":
-        if "debug" in settings:
+            mqtt.assumed_climate_state[vin] = "OFF"
-            if settings["debug"]:
+            mqtt.update_car_data()
-                print(response.text)
+            break
-    else:
+        time.sleep(5)
-        if url == CLIMATE_START_URL and response.status_code == 503:
+
-            print("Car in use, cannot start pre climatization")
+
-            mqtt.assumed_climate_state[vin] = "OFF"
+def api_call(url, method, vin, sensor_id=None, force_update=False):
-            mqtt.update_car_data()
+    global token_expires_at
-        else:
+    if datetime.now(util.TZ) >= token_expires_at:
-            print("API Call failed. Status Code: " + str(response.status_code) + ". Error: " + response.text)
+        refresh_auth()
-        return ""
+
-    return parse_api_data(data, sensor_id)
+    if url in [RECHARGE_STATE_URL, WINDOWS_STATE_URL, LOCK_STATE_URL, TYRE_STATE_URL, STATISTICS_URL]:
-
+        # Minimize API calls for endpoints with multiple values
-
+        response = cached_request(url, method, vin, force_update)
-def cached_request(url, method, vin, force_update=False):
+        if response is None:
-    global cached_requests
+            # Exception caught while getting data from volvo api, doing nothing
-    if not util.keys_exists(cached_requests, vin + "_" + url):
+            return None
-        # No API Data cached, get fresh data from API
+    elif method == "GET":
-        print("Starting " + method + " call against " + url)
+        logging.debug("Starting " + method + " call against " + url)
-        try:
+        try:
-            response = session.get(url.format(vin), timeout=15)
+            response = session.get(url.format(vin), timeout=15)
-        except requests.exceptions.RequestException as e:
+        except requests.exceptions.RequestException as e:
-            print("Error getting data: " + str(e))
+            logging.error("Error getting data: " + str(e))
-            return None
+            return None
-
+    elif method == "POST":
-        data = {"response": response, "last_update": datetime.now(util.TZ)}
+        logging.debug("Starting " + method + " call against " + url)
-        cached_requests[vin + "_" + url] = data
+        try:
-    else:
+            response = session.post(url.format(vin), timeout=20)
-        if (datetime.now(util.TZ) - cached_requests[vin + "_" + url]["last_update"]).total_seconds() >= settings["updateInterval"] \
+        except requests.exceptions.RequestException as e:
-                or (force_update and (datetime.now(util.TZ) - cached_requests[vin + "_" + url]["last_update"]).total_seconds() >= 2):
+            logging.error("Error getting data: " + str(e))
-            # Old Data in Cache, or force mode active, updating
+            return None
-            print("Starting " + method + " call against " + url)
+    else:
-            try:
+        logging.error("Unkown method posted: " + method + ". Returning nothing")
-                response = session.get(url.format(vin), timeout=15)
+        return None
-            except requests.exceptions.RequestException as e:
+
-                print("Error getting data: " + str(e))
+    logging.debug("Response status code: " + str(response.status_code))
-                return None
+    if response.status_code == 200:
-            data = {"response": response, "last_update": datetime.now(util.TZ)}
+        data = response.json()
-            cached_requests[vin + "_" + url] = data
+        logging.debug(response.text)
-        else:
+    else:
-            # Data is up do date, returning cached data
+        logging.debug(response.text)
-            response = cached_requests[vin + "_" + url]["response"]
+        if url == CLIMATE_START_URL and response.status_code == 503:
-    return response
+            logging.warning("Car in use, cannot start pre climatization")
-
+            mqtt.assumed_climate_state[vin] = "OFF"
-
+            mqtt.update_car_data()
-def parse_api_data(data, sensor_id=None):
+        elif "extended-vehicle" in url and response.status_code == 403:
-    data = data["data"]
+            # Suppress 403 errors for unsupported extended-vehicle api cars
-    if sensor_id == "battery_charge_level":
+            logging.debug("Suppressed 403 for extended-vehicle API")
-        return data["batteryChargeLevel"]["value"] if util.keys_exists(data, "batteryChargeLevel") else None
+            return None
-    elif sensor_id == "electric_range":
+        else:
-        return data["electricRange"]["value"] if util.keys_exists(data, "electricRange") else None
+            logging.error("API Call failed. Status Code: " + str(response.status_code) + ". Error: " + response.text)
-    elif sensor_id == "charging_system_status":
+        return None
-        return charging_system_states[data["chargingSystemStatus"]["value"]] if util.keys_exists(data,
+    return parse_api_data(data, sensor_id)
-                                                                                            "chargingSystemStatus") else None
+
-    elif sensor_id == "charging_connection_status":
+
-        return charging_connection_states[data["chargingConnectionStatus"]["value"]] if util.keys_exists(data,
+def cached_request(url, method, vin, force_update=False):
-                                                                                                    "chargingConnectionStatus") else None
+    global cached_requests
-    elif sensor_id == "estimated_charging_time":
+    if not util.keys_exists(cached_requests, vin + "_" + url):
-        if util.keys_exists(data, "chargingSystemStatus"):
+        # No API Data cached, get fresh data from API
-            charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]]
+        logging.debug("Starting " + method + " call against " + url)
-            if charging_system_state == "Charging":
+        try:
-                return data["estimatedChargingTime"]["value"] if util.keys_exists(data, "estimatedChargingTime") else ""
+            response = session.get(url.format(vin), timeout=15)
-            else:
+        except requests.exceptions.RequestException as e:
-                return 0
+            logging.error("Error getting data: " + str(e))
-        else:
+            return None
-            return None
+
-    elif sensor_id == "estimated_charging_finish_time":
+        data = {"response": response, "last_update": datetime.now(util.TZ)}
-        if util.keys_exists(data, "chargingSystemStatus"):
+        cached_requests[vin + "_" + url] = data
-            charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]]
+    else:
-            if charging_system_state == "Charging":
+        if (datetime.now(util.TZ) - cached_requests[vin + "_" + url]["last_update"]).total_seconds() \
-                charging_time = int(data["estimatedChargingTime"]["value"] if util.keys_exists(data, "estimatedChargingTime")
+                >= settings["updateInterval"] or (force_update and
-                                    else 0)
+                                                  (datetime.now(util.TZ) - cached_requests[vin + "_" + url]
-                charging_finished = datetime.now(util.TZ) + timedelta(minutes=charging_time)
+                                                  ["last_update"]).total_seconds() >= 2):
-                return format_datetime(charging_finished, format="medium", locale=settings["babelLocale"])
+            # Old Data in Cache, or force mode active, updating
-            else:
+            logging.debug("Starting " + method + " call against " + url)
-                return ""
+            try:
-        else:
+                response = session.get(url.format(vin), timeout=15)
-            return None
+            except requests.exceptions.RequestException as e:
-    elif sensor_id == "lock_status":
+                logging.error("Error getting data: " + str(e))
-        return data["carLocked"]["value"] if util.keys_exists(data, "carLocked") else None
+                return None
-    elif sensor_id == "odometer":
+            data = {"response": response, "last_update": datetime.now(util.TZ)}
-        multiplier = 1
+            cached_requests[vin + "_" + url] = data
-        if util.keys_exists(settings["volvoData"], "odometerMultiplier"):
+        else:
-            multiplier = settings["volvoData"]["odometerMultiplier"]
+            # Data is up do date, returning cached data
-            if isinstance(multiplier, str):
+            response = cached_requests[vin + "_" + url]["response"]
-                multiplier = 1
+    return response
-            elif multiplier < 1:
+
-                multiplier = 1
+
-        return int(data["odometer"]["value"]) * multiplier if util.keys_exists(data, "odometer") else None
+def parse_api_data(data, sensor_id=None):
-    elif sensor_id == "window_front_left":
+    data = data["data"]
-        return window_states[data["frontLeftWindowOpen"]["value"]] if util.keys_exists(data, "frontLeftWindowOpen") \
+    if sensor_id == "battery_charge_level":
-            else None
+        return data["batteryChargeLevel"]["value"] if util.keys_exists(data, "batteryChargeLevel") else None
-    elif sensor_id == "window_front_right":
+    elif sensor_id == "electric_range":
-        return window_states[data["frontRightWindowOpen"]["value"]] if util.keys_exists(data, "frontRightWindowOpen") \
+        return util.convert_metric_values(data["electricRange"]["value"]) \
-            else None
+            if util.keys_exists(data, "electricRange") else None
-    elif sensor_id == "window_rear_left":
+    elif sensor_id == "charging_system_status":
-        return window_states[data["rearLeftWindowOpen"]["value"]] if util.keys_exists(data, "rearLeftWindowOpen") \
+        return charging_system_states[data["chargingSystemStatus"]["value"]] \
-            else None
+            if util.keys_exists(data, "chargingSystemStatus") else None
-    elif sensor_id == "window_rear_right":
+    elif sensor_id == "charging_connection_status":
-        return window_states[data["rearRightWindowOpen"]["value"]] if util.keys_exists(data, "rearRightWindowOpen") \
+        return charging_connection_states[data["chargingConnectionStatus"]["value"]] \
-            else None
+            if util.keys_exists(data, "chargingConnectionStatus") else None
-    elif sensor_id == "door_front_left":
+    elif sensor_id == "estimated_charging_time":
-        return door_states[data["frontLeftDoorOpen"]["value"]] if util.keys_exists(data, "frontLeftDoorOpen") else None
+        if util.keys_exists(data, "chargingSystemStatus"):
-    elif sensor_id == "door_front_right":
+            charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]]
-        return door_states[data["frontRightDoorOpen"]["value"]] if util.keys_exists(data, "frontRightDoorOpen") else None
+            if charging_system_state == "Charging":
-    elif sensor_id == "door_rear_left":
+                return data["estimatedChargingTime"]["value"] if util.keys_exists(data, "estimatedChargingTime") else ""
-        return door_states[data["rearLeftDoorOpen"]["value"]] if util.keys_exists(data, "rearLeftDoorOpen") else None
+            else:
-    elif sensor_id == "door_rear_right":
+                return 0
-        return door_states[data["rearRightDoorOpen"]["value"]] if util.keys_exists(data, "rearRightDoorOpen") else None
+        return None
-    elif sensor_id == "tailgate":
+    elif sensor_id == "estimated_charging_finish_time":
-        return door_states[data["tailGateOpen"]["value"]] if util.keys_exists(data, "tailGateOpen") else None
+        if util.keys_exists(data, "chargingSystemStatus"):
-    elif sensor_id == "sunroof":
+            charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]]
-        return door_states[data["sunRoofOpen"]["value"]] if util.keys_exists(data, "sunRoofOpen") else None
+            if charging_system_state == "Charging":
-    elif sensor_id == "engine_hood":
+                charging_time = int(
-        return door_states[data["hoodOpen"]["value"]] if util.keys_exists(data, "hoodOpen") else None
+                    data["estimatedChargingTime"]["value"] if util.keys_exists(data, "estimatedChargingTime")
-    elif sensor_id == "tank_lid":
+                    else 0)
-        return door_states[data["tankLidOpen"]["value"]] if util.keys_exists(data, "tankLidOpen") else None
+                charging_finished = datetime.now(util.TZ) + timedelta(minutes=charging_time)
-    elif sensor_id == "tyre_front_left":
+                return format_datetime(charging_finished, format="medium", locale=settings["babelLocale"])
-        return data["frontLeftTyrePressure"]["value"] if util.keys_exists(data, "frontLeftTyrePressure") else None
+            else:
-    elif sensor_id == "tyre_front_right":
+                return ""
-        return data["frontRightTyrePressure"]["value"] if util.keys_exists(data, "frontRightTyrePressure") else None
+        return None
-    elif sensor_id == "tyre_rear_left":
+    elif sensor_id == "lock_status":
-        return data["rearLeftTyrePressure"]["value"] if util.keys_exists(data, "rearLeftTyrePressure") else None
+        return data["carLocked"]["value"] if util.keys_exists(data, "carLocked") else None
-    elif sensor_id == "tyre_rear_right":
+    elif sensor_id == "odometer":
-        return data["rearRightTyrePressure"]["value"] if util.keys_exists(data, "rearRightTyrePressure") else None
+        multiplier = 1
-    elif sensor_id == "engine_state":
+        if util.keys_exists(settings["volvoData"], "odometerMultiplier"):
-        return data["engineRunning"]["value"] if util.keys_exists(data, "engineRunning") else None
+            multiplier = settings["volvoData"]["odometerMultiplier"]
-    elif sensor_id == "fuel_level":
+            if isinstance(multiplier, str):
-        if util.keys_exists(data, "fuelAmount"):
+                multiplier = 1
-            fuel_amount = int(data["fuelAmount"]["value"])
+            elif multiplier < 1:
-            if fuel_amount > 0:
+                multiplier = 1
-                return fuel_amount
+        return util.convert_metric_values(int(data["odometer"]["value"]) * multiplier) \
-            else:
+            if util.keys_exists(data, "odometer") else None
-                return None
+    elif sensor_id == "window_front_left":
-        else:
+        return window_states[data["frontLeftWindowOpen"]["value"]] if util.keys_exists(data, "frontLeftWindowOpen") \
-            return None
+            else None
-    elif sensor_id == "average_fuel_consumption":
+    elif sensor_id == "window_front_right":
-        if util.keys_exists(data, "averageFuelConsumption"):
+        return window_states[data["frontRightWindowOpen"]["value"]] if util.keys_exists(data, "frontRightWindowOpen") \
-            average_fuel_con = float(data["averageFuelConsumption"]["value"])
+            else None
-            if average_fuel_con > 0:
+    elif sensor_id == "window_rear_left":
-                return average_fuel_con
+        return window_states[data["rearLeftWindowOpen"]["value"]] if util.keys_exists(data, "rearLeftWindowOpen") \
-            else:
+            else None
-                return None
+    elif sensor_id == "window_rear_right":
-        else:
+        return window_states[data["rearRightWindowOpen"]["value"]] if util.keys_exists(data, "rearRightWindowOpen") \
-            return None
+            else None
-    elif sensor_id == "average_speed":
+    elif sensor_id == "door_front_left":
-        if util.keys_exists(data, "averageSpeed"):
+        return door_states[data["frontLeftDoorOpen"]["value"]] if util.keys_exists(data, "frontLeftDoorOpen") else None
-            average_speed = int(data["averageSpeed"]["value"])
+    elif sensor_id == "door_front_right":
-            if average_speed > 0:
+        return door_states[data["frontRightDoorOpen"]["value"]] \
-                return average_speed
+            if util.keys_exists(data, "frontRightDoorOpen") else None
-            else:
+    elif sensor_id == "door_rear_left":
-                return None
+        return door_states[data["rearLeftDoorOpen"]["value"]] if util.keys_exists(data, "rearLeftDoorOpen") else None
-        else:
+    elif sensor_id == "door_rear_right":
-            return None
+        return door_states[data["rearRightDoorOpen"]["value"]] if util.keys_exists(data, "rearRightDoorOpen") else None
-    elif sensor_id == "location":
+    elif sensor_id == "tailgate":
-        coordinates = {}
+        return door_states[data["tailGateOpen"]["value"]] if util.keys_exists(data, "tailGateOpen") else None
-        if util.keys_exists(data, "geometry"):
+    elif sensor_id == "sunroof":
-            raw_data = data["geometry"]
+        return door_states[data["sunRoofOpen"]["value"]] if util.keys_exists(data, "sunRoofOpen") else None
-            if util.keys_exists(raw_data, "coordinates"):
+    elif sensor_id == "engine_hood":
-                coordinates = {"longitude": raw_data["coordinates"][0],
+        return door_states[data["hoodOpen"]["value"]] if util.keys_exists(data, "hoodOpen") else None
-                               "latitude": raw_data["coordinates"][1],
+    elif sensor_id == "tank_lid":
-                               "gps_accuracy": 1}
+        return door_states[data["tankLidOpen"]["value"]] if util.keys_exists(data, "tankLidOpen") else None
-        return coordinates
+    elif sensor_id == "tyre_front_left":
-    else:
+        return data["frontLeftTyrePressure"]["value"] if util.keys_exists(data, "frontLeftTyrePressure") else None
-        return None
+    elif sensor_id == "tyre_front_right":
+        return data["frontRightTyrePressure"]["value"] if util.keys_exists(data, "frontRightTyrePressure") else None
+    elif sensor_id == "tyre_rear_left":
+        return data["rearLeftTyrePressure"]["value"] if util.keys_exists(data, "rearLeftTyrePressure") else None
+    elif sensor_id == "tyre_rear_right":
+        return data["rearRightTyrePressure"]["value"] if util.keys_exists(data, "rearRightTyrePressure") else None
+    elif sensor_id == "engine_state":
+        return engine_states[data["engineRunning"]["value"]] if util.keys_exists(data, "engineRunning") else None
+    elif sensor_id == "fuel_level":
+        if util.keys_exists(data, "fuelAmount"):
+            fuel_amount = float(data["fuelAmount"]["value"])
+            if fuel_amount > 0:
+                return fuel_amount
+        return None
+    elif sensor_id == "average_fuel_consumption":
+        if util.keys_exists(data, "averageFuelConsumption"):
+            average_fuel_con = float(data["averageFuelConsumption"]["value"])
+            if average_fuel_con > 0:
+                multiplier = 1
+                if util.keys_exists(settings["volvoData"], "averageFuelConsumptionMultiplier"):
+                    multiplier = settings["volvoData"]["averageFuelConsumptionMultiplier"]
+                    if isinstance(multiplier, str):
+                        multiplier = 1
+                    elif multiplier < 1:
+                        multiplier = 1
+                return average_fuel_con * multiplier
+        return None
+    elif sensor_id == "average_speed":
+        if util.keys_exists(data, "averageSpeed"):
+            average_speed = float(data["averageSpeed"]["value"])
+            if average_speed > 1:
+                divider = 1
+                if util.keys_exists(settings["volvoData"], "averageSpeedDivider"):
+                    divider = settings["volvoData"]["averageSpeedDivider"]
+                    if isinstance(divider, str):
+                        divider = 1
+                    elif divider < 1:
+                        divider = 1
+                return util.convert_metric_values(average_speed / divider)
+        return None
+    elif sensor_id == "location":
+        coordinates = {}
+        if util.keys_exists(data, "geometry"):
+            raw_data = data["geometry"]
+            if util.keys_exists(raw_data, "coordinates"):
+                coordinates = {"longitude": raw_data["coordinates"][0],
+                               "latitude": raw_data["coordinates"][1],
+                               "gps_accuracy": 1}
+        return coordinates
+    elif sensor_id == "distance_to_empty":
+        if util.keys_exists(data, "distanceToEmpty"):
+            distance_to_empty = int(data["distanceToEmpty"]["value"])
+            if distance_to_empty > 0:
+                return util.convert_metric_values(data["distanceToEmpty"]["value"])
+        return None
+    else:
+        return None