Optimize climate timer (#40)

* Add logic to turn climate switch off if driver door is opened

* Update car data after climate state change

* Climate stop on left or right door open

* Bump version

.github/workflows/build_image.yml

@@ -11,7 +11,7 @@ name: Create and publish a Docker image
 
 on:
   release:
-    types: [created, edited]
+    types: [created]
   workflow_dispatch:
   
 env:

README.md

@@ -1,20 +1,37 @@
 # Volvo2Mqtt
+![Supports aarch64 Architecture][aarch64-shield]
+![Supports amd64 Architecture][amd64-shield]
+![Supports armhf Architecture][armhf-shield]
+![Supports armv7 Architecture][armv7-shield]
+![Supports i386 Architecture][i386-shield]
+<br>
+![Project Maintenance][maintenance-shield]
+[![GitHub Release][releases-shield]][releases]
+[![GitHub Activity][commits-shield]][commits]
 
 This component establishes a connection between the newer AAOS Volvo cars and Home Assistant via MQTT.<br>
 Maybe this component works also with other Volvo cars. Please try out the native Volvo [integration](https://www.home-assistant.io/integrations/volvooncall/) before using this component! If the native component doesn't work for your car, try this mqtt bridge.
+<p>
+
+Home Assistant thread can be found [here](https://community.home-assistant.io/t/volvo2mqtt-connect-your-aaos-volvo/585699).
 
 ## Confirmed working with
 - XC40 BEV (2023)
 - XC40 BEV (2022)
+- XC40 PHEV (2021)
 - V60 T8 PHEV (2023)
 - C40 PHEV (2023)
 - C40 PHEV (2022)
 - XC90 T8 PHEV (2023)
 - XC60 PHEV (2023)
 - XC60 PHEV (2022)
-- V90 PHEV T8 (2019)
+- XC90 PHEV T8 (2023)
+- V90 PHEV T8 (2019)*
+
+*only partly working
+
+Please let me know if your car works with this addon so I can expand the list!<br>
 
-Please let me know if your car works with this addon so I can expand the list!
 
 ## Supported features
 - Lock/unlock car
@@ -24,12 +41,14 @@ Please let me know if your car works with this addon so I can expand the list!
 - Sensor "Charging System Status"
 - Sensor "Charging Connection Status"
 - Sensor "Estimated Charging Finish Time"
-- Sensor "Door Lock Status"
+- Sensor "Door Lock Status (All doors, tank lid, and engine hood)"
+- Sensor "Window Lock Status (All windows and sunroof - Thanks to @navet)"
 - Sensor "Engine Status"
-- Sensor "Window Lock Status"
 - Sensor "Odometer"
 - Sensor "Tire Status"
 - Sensor "Fuel Status"
+- Sensor "Average Fuel Consumption"
+- Sensor "Average Speed"
 - Car Device Tracker
 - Multiple cars
 
@@ -41,7 +60,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": ""}' -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>
 
@@ -49,15 +68,101 @@ 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!   |
+| `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" |
+| `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)|
 
-If you like my work:
+## Lovelace sample card
+<details>
+  <summary>Show me more!</summary><blockquote>
+  <br>
+    
+  ![alt text](https://raw.githubusercontent.com/Dielee/volvo2mqtt/main/img/lovelace_sample.png)<br>
+    
+  <details>
+  <summary>Lovelace card sample</summary>
+        		
+  ```
+   type: vertical-stack
+   title: Autostatus
+   cards:
+     - type: custom:vertical-stack-in-card
+       cards:
+         - type: custom:mushroom-lock-card
+           entity: lock.volvo_<your vin>_lock_status
+           name: Verrigelungsstatus
+         - type: horizontal-stack
+           cards:
+             - type: custom:mushroom-entity-card
+               entity: sensor.volvo_<your vin>_electric_range
+               name: Reichweite
+               layout: vertical
+             - type: custom:mushroom-entity-card
+               entity: sensor.volvo_<your vin>_battery_charge_level
+               name: Batteriestatus
+               layout: vertical
+             - type: custom:mushroom-entity-card
+               entity: sensor.volvo_<your vin>_estimated_charging_time
+               layout: vertical
+               name: Ladezeit
+         - type: horizontal-stack
+           cards:
+             - type: custom:mushroom-entity-card
+               entity: switch.volvo_<your vin>_climate_status
+               tap_action:
+                 action: toggle
+               layout: vertical
+               name: Klimatisieren/Heizen
+             - type: custom:mushroom-template-card
+               primary: Daten aktualisieren
+               secondary: '{{ states(''sensor.volvo_<your vin>_last_data_update'')}}'
+               icon: mdi:update
+               layout: vertical
+               entity: button.volvo_<your vin>_update_data
+         - type: conditional
+           conditions:
+             - entity: sensor.volvo_<your vin>_estimated_charging_time
+               state_not: '0'
+           card:
+             type: custom:mushroom-entity-card
+             entity: sensor.volvo_<your vin>_estimated_charging_finish_time
+             name: Ladung vorraussichtlich abgeschlossen
+             show_name: true
+         - type: map
+           entities:
+             - entity: device_tracker.volvo_<your vin>_location
+           default_zoom: 16
+           dark_mode: false
+           hours_to_show: 0
+           auto_fit: true
+           aspect_ratio: '16:9'
+  ```
 
-[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/U7U8MFXCF)
+</details>
+</blockquote></details>
+
+
+[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
+[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
+[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
+[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
+[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
+[releases]: https://github.com/Dielee/volvo2mqtt/releases
+[releases-shield]: https://img.shields.io/github/release/Dielee/volvo2mqtt.svg
+[maintenance-shield]: https://img.shields.io/maintenance/yes/2023.svg
+[commits-shield]: https://img.shields.io/github/commit-activity/y/Dielee/volvo2mqtt.svg
+[commits]: https://github.com/Dielee/volvo2mqtt/commits/main

requirements.txt

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

src/Dockerfile

@@ -8,7 +8,7 @@ RUN apk add --no-cache python3 bash py3-pip
 WORKDIR /volvoAAOS2mqtt
 
 # download requirements.txt
-RUN wget https://raw.githubusercontent.com/Dielee/volvo2mqtt/main/requirements.txt
+RUN wget --no-cache https://raw.githubusercontent.com/Dielee/volvo2mqtt/main/requirements.txt
 
 # install dependencies
 RUN pip install -r requirements.txt

src/config.yaml

@@ -1,6 +1,6 @@
 name: "Volvo2Mqtt"
 description: "Volvo AAOS MQTT bridge"
-version: "1.4.0"
+version: "1.6.1"
 slug: "volvo2mqtt"
 init: false
 url: "https://github.com/Dielee/volvo2mqtt"
@@ -8,9 +8,11 @@ apparmor: true
 options:
   updateInterval: 300
   babelLocale: null
+  TZ: null
   debug: false
   mqtt:
     broker: null
+    port: 1883
     username: ""
     password: ""
   volvoData:
@@ -19,12 +21,16 @@ options:
     vin: ""
     vccapikey: null
     odometerMultiplier: 1
+    averageSpeedDivider: 1
+    averageFuelConsumptionMultiplier: 1
 schema:
   updateInterval: int(10,)
   babelLocale: str
+  TZ: str
   debug: bool
   mqtt:
     broker: str
+    port: int(1,)
     username: str?
     password: str?
   volvoData:
@@ -33,6 +39,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.4.0"
+VERSION = "v1.6.1"
 
 OAUTH_URL = "https://volvoid.eu.volvocars.com/as/token.oauth2"
 VEHICLES_URL = "https://api.volvocars.com/connected-vehicle/v1/vehicles"
@@ -18,6 +18,26 @@ TYRE_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/ty
 ENGINE_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/engine-status"
 BATTERY_CHARGE_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/battery-charge-level"
 FUEL_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/fuel"
+STATISTICS_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/statistics"
+DISTANCE_TO_EMPTY_URL = "https://api.volvocars.com/extended-vehicle/v1/vehicles/{0}/resources/distanceToEmpty"
+WASHER_FLUID_LEVEL_URL = "https://api.volvocars.com/extended-vehicle/v1/vehicles/{0}/resources/washerFluidLevel"
+
+units = {
+            "en_GB": {
+                "divider": 1.60934,
+                "electric_range": {"unit": "mi"},
+                "odometer": {"unit": "mi"},
+                "average_speed": {"unit": "mph"}
+            },
+            "en_US": {
+                "divider": 1.60934,
+                "electric_range": {"unit": "mi"},
+                "odometer": {"unit": "mi"},
+                "average_speed": {"unit": "mph"}
+            }
+        }
+
+availability_topic = "volvoAAOS2mqtt/availability"
 
 charging_system_states = {"CHARGING_SYSTEM_CHARGING": "Charging", "CHARGING_SYSTEM_IDLE": "Idle",
                           "CHARGING_SYSTEM_FAULT": "Fault", "CHARGING_SYSTEM_UNSPECIFIED": "Unspecified"}
@@ -25,27 +45,31 @@ charging_system_states = {"CHARGING_SYSTEM_CHARGING": "Charging", "CHARGING_SYST
 charging_connection_states = {"CONNECTION_STATUS_DISCONNECTED": "Disconnected", "CONNECTION_STATUS_UNSPECIFIED": "Unspecified",
                               "CONNECTION_STATUS_CONNECTED_DC": "Connected DC", "CONNECTION_STATUS_CONNECTED_AC": "Connected AC"}
 
+window_states = {"CLOSED": "OFF", "OPEN": "ON"}
+door_states = {"CLOSED": "OFF", "OPEN": "ON"}
+
 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": "sensor", "id": "window_front_left", "icon": "car-door-lock", "url": WINDOWS_STATE_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": "sensor", "id": "window_front_right", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
+                        {"name": "Window Front Right", "domain": "binary_sensor", "device_class": "window", "id": "window_front_right", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
-                        {"name": "Window Rear Left", "domain": "sensor", "id": "window_rear_left", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
+                        {"name": "Window Rear Left", "domain": "binary_sensor", "device_class": "window", "id": "window_rear_left", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
-                        {"name": "Window Rear Right", "domain": "sensor", "id": "window_rear_right", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
+                        {"name": "Window Rear Right", "domain": "binary_sensor", "device_class": "window", "id": "window_rear_right", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
-                        {"name": "Door Front Left", "domain": "sensor", "id": "door_front_left", "icon": "car-door-lock", "url": LOCK_STATE_URL},
+                        {"name": "Door Front Left", "domain": "binary_sensor", "device_class": "door", "id": "door_front_left", "icon": "car-door-lock", "url": LOCK_STATE_URL},
-                        {"name": "Door Front Right", "domain": "sensor", "id": "door_front_right", "icon": "car-door-lock", "url": LOCK_STATE_URL},
+                        {"name": "Door Front Right", "domain": "binary_sensor", "device_class": "door", "id": "door_front_right", "icon": "car-door-lock", "url": LOCK_STATE_URL},
-                        {"name": "Door Rear Left", "domain": "sensor", "id": "door_rear_left", "icon": "car-door-lock", "url": LOCK_STATE_URL},
+                        {"name": "Door Rear Left", "domain": "binary_sensor", "device_class": "door", "id": "door_rear_left", "icon": "car-door-lock", "url": LOCK_STATE_URL},
-                        {"name": "Door Rear Right", "domain": "sensor", "id": "door_rear_right", "icon": "car-door-lock", "url": LOCK_STATE_URL},
+                        {"name": "Door Rear Right", "domain": "binary_sensor", "device_class": "door", "id": "door_rear_right", "icon": "car-door-lock", "url": LOCK_STATE_URL},
-                        {"name": "Tailgate", "domain": "sensor", "id": "tailgate", "icon": "car-door-lock", "url": LOCK_STATE_URL},
+                        {"name": "Tailgate", "domain": "binary_sensor", "device_class": "door", "id": "tailgate", "icon": "car-door-lock", "url": LOCK_STATE_URL},
-                        {"name": "Engine Hood", "domain": "sensor", "id": "engine_hood", "icon": "car-door-lock", "url": LOCK_STATE_URL},
+                        {"name": "Engine Hood", "domain": "binary_sensor", "device_class": "door", "id": "engine_hood", "icon": "car-door-lock", "url": LOCK_STATE_URL},
-                        {"name": "Tank Lid", "domain": "sensor", "id": "tank_lid", "icon": "car-door-lock", "url": LOCK_STATE_URL},
+                        {"name": "Tank Lid", "domain": "binary_sensor", "device_class": "door", "id": "tank_lid", "icon": "car-door-lock", "url": LOCK_STATE_URL},
+                        {"name": "Sunroof", "domain": "binary_sensor", "device_class": "door", "id": "sunroof", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
                         {"name": "Air Conditioning", "domain": "switch", "id": "climate_status", "icon": "air-conditioner"},
                         {"name": "Lock state", "domain": "lock", "id": "lock_status", "icon": "lock", "url": LOCK_STATE_URL},
                         {"name": "Force Update Data", "domain": "button", "id": "update_data", "icon": "update", "url": ""},
@@ -55,5 +79,9 @@ 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": "sensor", "id": "engine_state", "icon": "engine", "url": ENGINE_STATE_URL},
-                        {"name": "Fuel Level", "domain": "sensor", "id": "fuel_level", "unit": "liters", "icon": "fuel", "url": FUEL_STATE_URL}
+                        {"name": "Fuel Level", "domain": "sensor", "id": "fuel_level", "unit": "liters", "icon": "fuel", "url": FUEL_STATE_URL},
+                        {"name": "Average Fuel Consumption", "domain": "sensor", "id": "average_fuel_consumption", "unit": "liters", "icon": "fuel", "url": STATISTICS_URL},
+                        {"name": "Average Speed", "domain": "sensor", "id": "average_speed", "unit": "km/h" if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["average_speed"]["unit"], "icon": "speedometer", "url": STATISTICS_URL},
+                        {"name": "Distance to Empty", "domain": "sensor", "id": "distance_to_empty", "unit": "km" if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["odometer"]["unit"], "icon": "map-marker-distance", "url": DISTANCE_TO_EMPTY_URL},
+                        {"name": "Washer Fluid Level", "domain": "sensor", "id": "washer_fluid_level", "icon": "wiper-wash", "url": WASHER_FLUID_LEVEL_URL},
 ]

src/main.py

@@ -1,10 +1,11 @@
 from volvo import authorize
 from mqtt import update_loop, connect
 from const import VERSION
-
+from util import set_tz
 
 if __name__ == '__main__':
     print("Starting volvo2mqtt version " + VERSION)
+    set_tz()
     authorize()
     connect()
     update_loop()

src/mqtt.py

@@ -2,12 +2,13 @@ import time
 import paho.mqtt.client as mqtt
 import json
 import volvo
+import util
 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
+            CAR_UNLOCK_URL, availability_topic
 
 
 mqtt_client: mqtt.Client
@@ -15,13 +16,21 @@ subscribed_topics = []
 assumed_climate_state = {}
 last_data_update = None
 climate_timer = {}
+door_status = {}
 
 
 def connect():
     client = mqtt.Client("volvoAAOS2mqtt")
+    client.will_set(availability_topic, "offline", 0, False)
     if settings["mqtt"]["username"] and settings["mqtt"]["password"]:
         client.username_pw_set(settings["mqtt"]["username"], settings["mqtt"]["password"])
-    client.connect(settings["mqtt"]["broker"])
+    port = 1883
+    if util.keys_exists(settings["mqtt"], "port"):
+        conf_port = settings["mqtt"]["port"]
+        if isinstance(conf_port, int):
+            if conf_port > 0:
+                port = settings["mqtt"]["port"]
+    client.connect(settings["mqtt"]["broker"], port)
     client.loop_start()
     client.on_message = on_message
     client.on_disconnect = on_disconnect
@@ -32,6 +41,7 @@ def connect():
 
 
 def on_connect(client, userdata, flags, rc):
+    send_heartbeat()
     if len(subscribed_topics) > 0:
         for topic in subscribed_topics:
             mqtt_client.subscribe(topic)
@@ -50,30 +60,49 @@ def on_message(client, userdata, msg):
 
     payload = msg.payload.decode("UTF-8")
     if "climate_status" in msg.topic:
-        global assumed_climate_state, climate_timer
+        global assumed_climate_state, climate_timer, door_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
+            door_thread = Thread(target=volvo.check_door_status, args=(vin, ))
+            door_thread.start()
+            door_status[vin] = door_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 door_status[vin].is_alive():
+                door_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)
-            update_car_data(True)
+
+            # 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)
-            update_car_data(True)
+
+            # 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":
             update_car_data(True)
@@ -83,25 +112,37 @@ def update_loop():
     create_ha_devices()
     while True:
         print("Sending mqtt update...")
+        send_heartbeat()
         update_car_data()
         print("Mqtt update done. Next run in " + str(settings["updateInterval"]) + " seconds.")
         time.sleep(settings["updateInterval"])
 
 
-def update_car_data(force_update=False):
+def update_car_data(force_update=False, overwrite={}):
     global last_data_update
-    last_data_update = format_datetime(datetime.now(), format="medium", locale=settings["babelLocale"])
+    last_data_update = format_datetime(datetime.now(util.TZ), format="medium", locale=settings["babelLocale"])
     for vin in volvo.vins:
         for entity in volvo.supported_endpoints[vin]:
             if entity["domain"] == "button":
                 continue
 
+            ov_entity_id = ""
+            ov_vin = ""
+            ov_state = ""
+            if bool(overwrite):
+                ov_entity_id = overwrite["entity_id"]
+                ov_vin = overwrite["vin"]
+                ov_state = overwrite["state"]
+
             if entity["id"] == "climate_status":
                 state = assumed_climate_state[vin]
             elif entity["id"] == "last_data_update":
                 state = last_data_update
             else:
-                state = volvo.api_call(entity["url"], "GET", vin, entity["id"], force_update)
+                if entity["id"] == ov_entity_id and vin == ov_vin:
+                    state = ov_state
+                else:
+                    state = volvo.api_call(entity["url"], "GET", vin, entity["id"], force_update)
 
             if entity["domain"] == "device_tracker":
                 topic = f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/attributes"
@@ -126,15 +167,19 @@ def create_ha_devices():
                         "icon": f"mdi:{entity['icon']}",
                         "state_topic": f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/state",
                         "device": device,
-                        "unique_id": f"volvoAAOS2mqtt_{vin}_{entity['id']}"
+                        "unique_id": f"volvoAAOS2mqtt_{vin}_{entity['id']}",
+                        "availability_topic": availability_topic
                     }
-            if entity.get('unit'):
+            if entity.get("device_class"):
+                config["device_class"] = entity["device_class"]
+
+            if entity.get("unit"):
                 config["unit_of_measurement"] = entity["unit"]
 
-            if entity.get('domain') == "device_tracker":
+            if entity.get("domain") == "device_tracker":
                 config["json_attributes_topic"] = f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/attributes"
 
-            if entity.get('domain') in ["switch", "lock", "button"]:
+            if entity.get("domain") in ["switch", "lock", "button"]:
                 command_topic = f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/command"
                 config["command_topic"] = command_topic
                 subscribed_topics.append(command_topic)
@@ -146,3 +191,8 @@ def create_ha_devices():
                 retain=True
             )
     time.sleep(2)
+    send_heartbeat()
+
+
+def send_heartbeat():
+    mqtt_client.publish(availability_topic, "online")

src/settings.json

@@ -1,8 +1,10 @@
 {
   "updateInterval": 300,
   "babelLocale": "de",
+  "TZ": "Europe/Berlin",
   "mqtt": {
     "broker": "",
+    "port": 1883,
     "username": "",
     "password": ""
   },
@@ -10,6 +12,9 @@
     "username": "",
     "password": "",
     "vin": "",
-	"vccapikey": ""
+	"vccapikey": "",
+    "odometerMultiplier": "",
+    "averageSpeedDivider": "",
+    "averageFuelConsumptionMultiplier": ""
   }
 }

src/translations/en.yaml

@@ -5,12 +5,15 @@ configuration:
   babelLocale:
     name: Babel locale
     description: Select your country code or take a look at the GitHub repo for more infos!
+  TZ:
+    name: Timezone
+    description: Set your local timezone eg. "Europe/Berlin" or "America/New_York"
   debug:
     name: API debug mode
     description: Enable Volvo API debug, normaly this can stay off
   mqtt:
     name: MQTT Broker settings
-    description: Broker is your mqtt broker IP eg "192.168.0.1". Mqtt username and password are optional.
+    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.
   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,3 +1,11 @@
+import pytz
+import os
+from const import units
+from config import settings
+
+TZ = None
+
+
 def keys_exists(element, *keys):
     """"
     Check if *keys (nested) exists in `element` (dict).
@@ -15,3 +23,23 @@ def keys_exists(element, *keys):
         except KeyError:
             return False
     return True
+
+
+def set_tz():
+    global TZ
+    env_tz = os.environ.get("TZ")
+    settings_tz = settings.get("TZ")
+    if env_tz:
+        TZ = pytz.timezone(env_tz)
+    elif settings_tz:
+        TZ = pytz.timezone(settings_tz)
+    else:
+        raise Exception("No timezone setting found! Please read the README!")
+
+
+def convert_metric_values(value):
+    if keys_exists(units, settings["babelLocale"]):
+        divider = units[settings["babelLocale"]]["divider"]
+        return round((float(value) / divider), 2)
+    else:
+        return value

src/volvo.py

@@ -1,348 +1,414 @@
-import requests
+import requests
-from datetime import datetime, timedelta
+import mqtt
-import mqtt
+import util
-from config import settings
+import time
-from babel.dates import format_datetime
+from threading import Thread, currentThread
-from util import keys_exists
+from datetime import datetime, timedelta
-from const import charging_system_states, charging_connection_states, CLIMATE_START_URL, \
+from config import settings
-    OAUTH_URL, VEHICLES_URL, VEHICLE_DETAILS_URL, RECHARGE_STATE_URL, \
+from babel.dates import format_datetime
-    WINDOWS_STATE_URL, LOCK_STATE_URL, TYRE_STATE_URL, supported_entities, BATTERY_CHARGE_STATE_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, CLIMATE_STOP_URL
-    "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() + 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=",
+    print("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() + timedelta(seconds=(data["expires_in"] - 30))
+    except requests.exceptions.RequestException as e:
-        refresh_token = data["refresh_token"]
+        print("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}"],
+        print("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 = {
+        if "debug" in settings:
-            "identifiers": [f"volvoAAOS2mqtt_{vin}"],
+            if settings["debug"]:
-            "manufacturer": "Volvo",
+                print(response.text)
-            "model": vin,
+        device = {
-            "name": f"Volvo - {vin}",
+            "identifiers": [f"volvoAAOS2mqtt_{vin}"],
-        }
+            "manufacturer": "Volvo",
-    else:
+            "model": data['descriptions']['model'],
-        raise Exception("Getting vehicle details failed. Status Code: " + str(response.status_code) +
+            "name": f"{data['descriptions']['model']} ({data['modelYear']}) - {vin}",
-                        ". Error: " + response.text)
+        }
-
+    elif response.status_code == 500 and not settings.volvoData["vin"]:
-    return device
+        # Workaround for some cars that are not returning vehicle details
-
+        device = {
-
+            "identifiers": [f"volvoAAOS2mqtt_{vin}"],
-def check_supported_endpoints():
+            "manufacturer": "Volvo",
-    global supported_endpoints
+            "model": vin,
-    for vin in vins:
+            "name": f"Volvo - {vin}",
-        supported_endpoints[vin] = []
+        }
-        for entity in supported_entities:
+    else:
-            if entity["id"] == "battery_charge_level" and entity["url"] == BATTERY_CHARGE_STATE_URL \
+        raise Exception("Getting vehicle details failed. Status Code: " + str(response.status_code) +
-                    and any("battery_charge_level" in d["id"] for d in supported_endpoints[vin]):
+                        ". Error: " + response.text)
-                # If battery charge level could be found in recharge-api, skip the second battery charge sensor
+
-                continue
+    return device
-
+
-            if entity.get('url'):
+
-                state = api_call(entity["url"], "GET", vin, entity["id"])
+def check_supported_endpoints():
-            else:
+    global supported_endpoints
-                state = ""
+    for vin in vins:
-
+        supported_endpoints[vin] = []
-            if state is not None:
+        for entity in supported_entities:
-                print("Success! " + entity["name"] + " is supported by your vehicle.")
+            if entity["id"] == "battery_charge_level" and entity["url"] == BATTERY_CHARGE_STATE_URL \
-                supported_endpoints[vin].append(entity)
+                    and any("battery_charge_level" in d["id"] for d in supported_endpoints[vin]):
-            else:
+                # If battery charge level could be found in recharge-api, skip the second battery charge sensor
-                print("Failed, " + entity["name"] + " is unfortunately not supported by your vehicle.")
+                continue
-
+
-
+            if entity.get('url'):
-def initialize_climate(vins):
+                state = api_call(entity["url"], "GET", vin, entity["id"])
-    for vin in vins:
+            else:
-        mqtt.assumed_climate_state[vin] = "OFF"
+                state = ""
-
+
-
+            if state is not None:
-def disable_climate(vin):
+                print("Success! " + entity["name"] + " is supported by your vehicle.")
-    print("Turning climate off by timer!")
+                supported_endpoints[vin].append(entity)
-    mqtt.assumed_climate_state[vin] = "OFF"
+            else:
-    mqtt.update_car_data()
+                print("Failed, " + entity["name"] + " is unfortunately not supported by your vehicle.")
-
+
-
+
-def api_call(url, method, vin, sensor_id=None, force_update=False):
+def initialize_climate(vins):
-    global token_expires_at
+    for vin in vins:
-    if datetime.now() >= token_expires_at:
+        mqtt.assumed_climate_state[vin] = "OFF"
-        refresh_auth()
+
-
+
-    if url == RECHARGE_STATE_URL:
+def disable_climate(vin):
-        # Minimize API calls for recharge state
+    print("Turning climate off by timer!")
-        response = cached_request(url, method, vin, force_update)
+    mqtt.door_status[vin].do_run = False
-        if response is None:
+    mqtt.assumed_climate_state[vin] = "OFF"
-            # Exception caught while getting data from volvo api, doing nothing
+    mqtt.update_car_data()
-            return None
+
-    elif url == WINDOWS_STATE_URL:
+
-        # Minimize API calls for window state
+def check_door_status(vin):
-        response = cached_request(url, method, vin, force_update)
+    t = currentThread()
-        if response is None:
+    while getattr(t, "do_run", True):
-            # Exception caught while getting data from volvo api, doing nothing
+        lock_door_left = api_call(LOCK_STATE_URL, "GET", vin, "door_front_left", True)
-            return ""
+        lock_door_right = api_call(LOCK_STATE_URL, "GET", vin, "door_front_right", True)
-    elif url == LOCK_STATE_URL:
+        if lock_door_left == "ON" or lock_door_right == "ON":
-        # Minimize API calls for door state
+            Thread(target=api_call, args=(CLIMATE_STOP_URL, "POST", vin)).start()
-        response = cached_request(url, method, vin, force_update)
+            mqtt.assumed_climate_state[vin] = "OFF"
-        if response is None:
+            mqtt.update_car_data()
-            # Exception caught while getting data from volvo api, doing nothing
+            break
-            return ""
+        time.sleep(5)
-    elif url == TYRE_STATE_URL:
+
-        # Minimize API calls for tyre state
+
-        response = cached_request(url, method, vin, force_update)
+def api_call(url, method, vin, sensor_id=None, force_update=False):
-        if response is None:
+    global token_expires_at
-            # Exception caught while getting data from volvo api, doing nothing
+    if datetime.now(util.TZ) >= token_expires_at:
-            return ""
+        refresh_auth()
-    elif method == "GET":
+
-        print("Starting " + method + " call against " + url)
+    if url in [RECHARGE_STATE_URL, WINDOWS_STATE_URL, LOCK_STATE_URL, TYRE_STATE_URL, STATISTICS_URL]:
-        try:
+        # Minimize API calls for endpoints with multiple values
-            response = session.get(url.format(vin), timeout=15)
+        response = cached_request(url, method, vin, force_update)
-        except requests.exceptions.RequestException as e:
+        if response is None:
-            print("Error getting data: " + str(e))
+            # Exception caught while getting data from volvo api, doing nothing
-            return ""
+            return None
-    elif method == "POST":
+    elif method == "GET":
-        print("Starting " + method + " call against " + url)
+        print("Starting " + method + " call against " + url)
-        try:
+        try:
-            response = session.post(url.format(vin), timeout=20)
+            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))
+            print("Error getting data: " + str(e))
-            return ""
+            return None
-    else:
+    elif method == "POST":
-        print("Unkown method posted: " + method + ". Returning nothing")
+        print("Starting " + method + " call against " + url)
-        return ""
+        try:
-
+            response = session.post(url.format(vin), timeout=20)
-    if response.status_code == 200:
+        except requests.exceptions.RequestException as e:
-        data = response.json()
+            print("Error getting data: " + str(e))
-        if "debug" in settings:
+            return None
-            if settings["debug"]:
+    else:
-                print(response.text)
+        print("Unkown method posted: " + method + ". Returning nothing")
-    else:
+        return None
-        if url == CLIMATE_START_URL and response.status_code == 503:
+
-            print("Car in use, cannot start pre climatization")
+    if response.status_code == 200:
-            mqtt.assumed_climate_state[vin] = "OFF"
+        data = response.json()
-            mqtt.update_car_data()
+        if "debug" in settings:
-        else:
+            if settings["debug"]:
-            print("API Call failed. Status Code: " + str(response.status_code) + ". Error: " + response.text)
+                print(response.text)
-        return ""
+    else:
-    return parse_api_data(data, sensor_id)
+        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 cached_request(url, method, vin, force_update=False):
+            mqtt.update_car_data()
-    global cached_requests
+        elif "extended-vehicle" in url and response.status_code == 403:
-    if not keys_exists(cached_requests, vin + "_" + url):
+            # Suppress 403 errors for unsupported extended-vehicle api cars
-        # No API Data cached, get fresh data from API
+            return None
-        print("Starting " + method + " call against " + url)
+        else:
-        try:
+            print("API Call failed. Status Code: " + str(response.status_code) + ". Error: " + response.text)
-            response = session.get(url.format(vin), timeout=15)
+        return None
-        except requests.exceptions.RequestException as e:
+    return parse_api_data(data, sensor_id)
-            print("Error getting data: " + str(e))
+
-            return None
+
-
+def cached_request(url, method, vin, force_update=False):
-        data = {"response": response, "last_update": datetime.now()}
+    global cached_requests
-        cached_requests[vin + "_" + url] = data
+    if not util.keys_exists(cached_requests, vin + "_" + url):
-    else:
+        # No API Data cached, get fresh data from API
-        if (datetime.now() - cached_requests[vin + "_" + url]["last_update"]).total_seconds() >= settings["updateInterval"] \
+        print("Starting " + method + " call against " + url)
-                or (force_update and (datetime.now() - cached_requests[vin + "_" + url]["last_update"]).total_seconds() >= 2):
+        try:
-            # Old Data in Cache, or force mode active, updating
+            response = session.get(url.format(vin), timeout=15)
-            print("Starting " + method + " call against " + url)
+        except requests.exceptions.RequestException as e:
-            try:
+            print("Error getting data: " + str(e))
-                response = session.get(url.format(vin), timeout=15)
+            return None
-            except requests.exceptions.RequestException as e:
+
-                print("Error getting data: " + str(e))
+        data = {"response": response, "last_update": datetime.now(util.TZ)}
-                return None
+        cached_requests[vin + "_" + url] = data
-            data = {"response": response, "last_update": datetime.now()}
+    else:
-            cached_requests[vin + "_" + url] = data
+        if (datetime.now(util.TZ) - cached_requests[vin + "_" + url]["last_update"]).total_seconds() \
-        else:
+                >= settings["updateInterval"] or (force_update and
-            # Data is up do date, returning cached data
+                                                  (datetime.now(util.TZ) - cached_requests[vin + "_" + url]
-            response = cached_requests[vin + "_" + url]["response"]
+                                                      ["last_update"]).total_seconds() >= 2):
-    return response
+            # Old Data in Cache, or force mode active, updating
-
+            print("Starting " + method + " call against " + url)
-
+            try:
-def parse_api_data(data, sensor_id=None):
+                response = session.get(url.format(vin), timeout=15)
-    data = data["data"]
+            except requests.exceptions.RequestException as e:
-    if sensor_id == "battery_charge_level":
+                print("Error getting data: " + str(e))
-        return data["batteryChargeLevel"]["value"] if keys_exists(data, "batteryChargeLevel") else None
+                return None
-    elif sensor_id == "electric_range":
+            data = {"response": response, "last_update": datetime.now(util.TZ)}
-        return data["electricRange"]["value"] if keys_exists(data, "electricRange") else None
+            cached_requests[vin + "_" + url] = data
-    elif sensor_id == "charging_system_status":
+        else:
-        return charging_system_states[data["chargingSystemStatus"]["value"]] if keys_exists(data,
+            # Data is up do date, returning cached data
-                                                                                            "chargingSystemStatus") else None
+            response = cached_requests[vin + "_" + url]["response"]
-    elif sensor_id == "charging_connection_status":
+    return response
-        return charging_connection_states[data["chargingConnectionStatus"]["value"]] if keys_exists(data,
+
-                                                                                                    "chargingConnectionStatus") else None
+
-    elif sensor_id == "estimated_charging_time":
+def parse_api_data(data, sensor_id=None):
-        if keys_exists(data, "chargingSystemStatus"):
+    data = data["data"]
-            charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]]
+    if sensor_id == "battery_charge_level":
-            if charging_system_state == "Charging":
+        return data["batteryChargeLevel"]["value"] if util.keys_exists(data, "batteryChargeLevel") else None
-                return data["estimatedChargingTime"]["value"] if keys_exists(data, "estimatedChargingTime") else ""
+    elif sensor_id == "electric_range":
-            else:
+        return util.convert_metric_values(data["electricRange"]["value"]) \
-                return 0
+            if util.keys_exists(data, "electricRange") else None
-        else:
+    elif sensor_id == "charging_system_status":
-            return None
+        return charging_system_states[data["chargingSystemStatus"]["value"]] \
-    elif sensor_id == "estimated_charging_finish_time":
+            if util.keys_exists(data, "chargingSystemStatus") else None
-        if keys_exists(data, "chargingSystemStatus"):
+    elif sensor_id == "charging_connection_status":
-            charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]]
+        return charging_connection_states[data["chargingConnectionStatus"]["value"]] \
-            if charging_system_state == "Charging":
+            if util.keys_exists(data, "chargingConnectionStatus") else None
-                charging_time = int(data["estimatedChargingTime"]["value"] if keys_exists(data, "estimatedChargingTime")
+    elif sensor_id == "estimated_charging_time":
-                                    else 0)
+        if util.keys_exists(data, "chargingSystemStatus"):
-                charging_finished = datetime.now() + timedelta(minutes=charging_time)
+            charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]]
-                return format_datetime(charging_finished, format="medium", locale=settings["babelLocale"])
+            if charging_system_state == "Charging":
-            else:
+                return data["estimatedChargingTime"]["value"] if util.keys_exists(data, "estimatedChargingTime") else ""
-                return ""
+            else:
-        else:
+                return 0
-            return None
+        else:
-    elif sensor_id == "lock_status":
+            return None
-        return data["carLocked"]["value"] if keys_exists(data, "carLocked") else None
+    elif sensor_id == "estimated_charging_finish_time":
-    elif sensor_id == "odometer":
+        if util.keys_exists(data, "chargingSystemStatus"):
-        multiplier = 1
+            charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]]
-        if keys_exists(settings["volvoData"], "odometerMultiplier"):
+            if charging_system_state == "Charging":
-            multiplier = settings["volvoData"]["odometerMultiplier"]
+                charging_time = int(
-            if isinstance(multiplier, str):
+                    data["estimatedChargingTime"]["value"] if util.keys_exists(data, "estimatedChargingTime")
-                multiplier = 1
+                    else 0)
-            elif multiplier < 1:
+                charging_finished = datetime.now(util.TZ) + timedelta(minutes=charging_time)
-                multiplier = 1
+                return format_datetime(charging_finished, format="medium", locale=settings["babelLocale"])
-        return int(data["odometer"]["value"]) * multiplier if keys_exists(data, "odometer") else None
+            else:
-    elif sensor_id == "window_front_left":
+                return ""
-        return data["frontLeftWindowOpen"]["value"] if keys_exists(data, "frontLeftWindowOpen") else None
+        else:
-    elif sensor_id == "window_front_right":
+            return None
-        return data["frontRightWindowOpen"]["value"] if keys_exists(data, "frontRightWindowOpen") else None
+    elif sensor_id == "lock_status":
-    elif sensor_id == "window_rear_left":
+        return data["carLocked"]["value"] if util.keys_exists(data, "carLocked") else None
-        return data["rearLeftWindowOpen"]["value"] if keys_exists(data, "rearLeftWindowOpen") else None
+    elif sensor_id == "odometer":
-    elif sensor_id == "window_rear_right":
+        multiplier = 1
-        return data["rearRightWindowOpen"]["value"] if keys_exists(data, "rearRightWindowOpen") else None
+        if util.keys_exists(settings["volvoData"], "odometerMultiplier"):
-    elif sensor_id == "door_front_left":
+            multiplier = settings["volvoData"]["odometerMultiplier"]
-        return data["frontLeftDoorOpen"]["value"] if keys_exists(data, "frontLeftDoorOpen") else None
+            if isinstance(multiplier, str):
-    elif sensor_id == "door_front_right":
+                multiplier = 1
-        return data["frontRightDoorOpen"]["value"] if keys_exists(data, "frontRightDoorOpen") else None
+            elif multiplier < 1:
-    elif sensor_id == "door_rear_left":
+                multiplier = 1
-        return data["rearLeftDoorOpen"]["value"] if keys_exists(data, "rearLeftDoorOpen") else None
+        return util.convert_metric_values(int(data["odometer"]["value"]) * multiplier) \
-    elif sensor_id == "door_rear_right":
+            if util.keys_exists(data, "odometer") else None
-        return data["rearRightDoorOpen"]["value"] if keys_exists(data, "rearRightDoorOpen") else None
+    elif sensor_id == "window_front_left":
-    elif sensor_id == "tailgate":
+        return window_states[data["frontLeftWindowOpen"]["value"]] if util.keys_exists(data, "frontLeftWindowOpen") \
-        return data["tailGateOpen"]["value"] if keys_exists(data, "tailGateOpen") else None
+            else None
-    elif sensor_id == "engine_hood":
+    elif sensor_id == "window_front_right":
-        return data["hoodOpen"]["value"] if keys_exists(data, "hoodOpen") else None
+        return window_states[data["frontRightWindowOpen"]["value"]] if util.keys_exists(data, "frontRightWindowOpen") \
-    elif sensor_id == "tank_lid":
+            else None
-        return data["tankLidOpen"]["value"] if keys_exists(data, "tankLidOpen") else None
+    elif sensor_id == "window_rear_left":
-    elif sensor_id == "tyre_front_left":
+        return window_states[data["rearLeftWindowOpen"]["value"]] if util.keys_exists(data, "rearLeftWindowOpen") \
-        return data["frontLeftTyrePressure"]["value"] if keys_exists(data, "frontLeftTyrePressure") else None
+            else None
-    elif sensor_id == "tyre_front_right":
+    elif sensor_id == "window_rear_right":
-        return data["frontRightTyrePressure"]["value"] if keys_exists(data, "frontRightTyrePressure") else None
+        return window_states[data["rearRightWindowOpen"]["value"]] if util.keys_exists(data, "rearRightWindowOpen") \
-    elif sensor_id == "tyre_rear_left":
+            else None
-        return data["rearLeftTyrePressure"]["value"] if keys_exists(data, "rearLeftTyrePressure") else None
+    elif sensor_id == "door_front_left":
-    elif sensor_id == "tyre_rear_right":
+        return door_states[data["frontLeftDoorOpen"]["value"]] if util.keys_exists(data, "frontLeftDoorOpen") else None
-        return data["rearRightTyrePressure"]["value"] if keys_exists(data, "rearRightTyrePressure") else None
+    elif sensor_id == "door_front_right":
-    elif sensor_id == "engine_state":
+        return door_states[data["frontRightDoorOpen"]["value"]] \
-        return data["engineRunning"]["value"] if keys_exists(data, "engineRunning") else None
+            if util.keys_exists(data, "frontRightDoorOpen") else None
-    elif sensor_id == "fuel_level":
+    elif sensor_id == "door_rear_left":
-        return data["fuelAmount"]["value"] if keys_exists(data, "fuelAmount") else None
+        return door_states[data["rearLeftDoorOpen"]["value"]] if util.keys_exists(data, "rearLeftDoorOpen") else None
-    elif sensor_id == "location":
+    elif sensor_id == "door_rear_right":
-        coordinates = {}
+        return door_states[data["rearRightDoorOpen"]["value"]] if util.keys_exists(data, "rearRightDoorOpen") else None
-        if keys_exists(data, "geometry"):
+    elif sensor_id == "tailgate":
-            raw_data = data["geometry"]
+        return door_states[data["tailGateOpen"]["value"]] if util.keys_exists(data, "tailGateOpen") else None
-            if keys_exists(raw_data, "coordinates"):
+    elif sensor_id == "sunroof":
-                coordinates = {"longitude": raw_data["coordinates"][0],
+        return door_states[data["sunRoofOpen"]["value"]] if util.keys_exists(data, "sunRoofOpen") else None
-                               "latitude": raw_data["coordinates"][1],
+    elif sensor_id == "engine_hood":
-                               "gps_accuracy": 1}
+        return door_states[data["hoodOpen"]["value"]] if util.keys_exists(data, "hoodOpen") else None
-        return coordinates
+    elif sensor_id == "tank_lid":
-    else:
+        return door_states[data["tankLidOpen"]["value"]] if util.keys_exists(data, "tankLidOpen") else None
-        return None
+    elif sensor_id == "tyre_front_left":
+        return data["frontLeftTyrePressure"]["value"] if util.keys_exists(data, "frontLeftTyrePressure") else 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 data["engineRunning"]["value"] if util.keys_exists(data, "engineRunning") else None
+    elif sensor_id == "fuel_level":
+        if util.keys_exists(data, "fuelAmount"):
+            fuel_amount = int(data["fuelAmount"]["value"])
+            if fuel_amount > 0:
+                return fuel_amount
+            else:
+                return None
+        else:
+            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
+            else:
+                return None
+        else:
+            return None
+    elif sensor_id == "average_speed":
+        if util.keys_exists(data, "averageSpeed"):
+            average_speed = int(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)
+            else:
+                return None
+        else:
+            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":
+        return util.convert_metric_values(data["distanceToEmpty"]["value"]) \
+            if util.keys_exists(data, "distanceToEmpty") else None
+    elif sensor_id == "washer_fluid_level":
+        return data["washerFluidLevel"]["value"] if util.keys_exists(data, "washerFluidLevel") else None
+    else:
+        return None