Added dynamic icons lock, battery and window state (#45)

#43

.gitignore

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

README.md

@@ -11,6 +11,9 @@
 
 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)
@@ -39,7 +42,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 +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": "", "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 +68,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/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,10 +1,12 @@
 name: "Volvo2Mqtt"
 description: "Volvo AAOS MQTT bridge"
-version: "1.5.4"
+version: "1.6.4"
 slug: "volvo2mqtt"
 init: false
 url: "https://github.com/Dielee/volvo2mqtt"
 apparmor: true
+map: 
+  - addons:rw
 options:
   updateInterval: 300
   babelLocale: null
@@ -21,6 +23,8 @@ options:
     vin: ""
     vccapikey: null
     odometerMultiplier: 1
+    averageSpeedDivider: 1
+    averageFuelConsumptionMultiplier: 1
 schema:
   updateInterval: int(10,)
   babelLocale: str
@@ -37,6 +41,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.6.4"
 
 OAUTH_URL = "https://volvoid.eu.volvocars.com/as/token.oauth2"
 VEHICLES_URL = "https://api.volvocars.com/connected-vehicle/v1/vehicles"
@@ -20,6 +20,21 @@ BATTERY_CHARGE_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehic
 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"
 
+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",
@@ -31,15 +46,36 @@ charging_connection_states = {"CONNECTION_STATUS_DISCONNECTED": "Disconnected",
 window_states = {"CLOSED": "OFF", "OPEN": "ON"}
 door_states = {"CLOSED": "OFF", "OPEN": "ON"}
 
+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"},
+    "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},
@@ -64,5 +100,6 @@ supported_entities = [
                         {"name": "Engine State", "domain": "sensor", "id": "engine_state", "icon": "engine", "url": ENGINE_STATE_URL},
                         {"name": "Fuel Level", "domain": "sensor", "id": "fuel_level", "unit": "liters", "icon": "fuel", "url": FUEL_STATE_URL},
                         {"name": "Average Fuel Consumption", "domain": "sensor", "id": "average_fuel_consumption", "unit": "liters", "icon": "fuel", "url": STATISTICS_URL},
-                        {"name": "Average Speed", "domain": "sensor", "id": "average_speed", "unit": "km/h" if 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"]]["odometer"]["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,14 @@
+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
 
 
 if __name__ == '__main__':
-    print("Starting volvo2mqtt version " + VERSION)
     set_tz()
+    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 = {}
+door_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, 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)
+
+            # 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,4 @@
+#!/bin/bash
+export IS_HA_ADDON="true"
+
+python -u main.py

src/settings.json

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

src/translations/en.yaml

@@ -15,5 +15,5 @@ configuration:
     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.
   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,54 @@
+import logging
 import pytz
 import os
+import sys
+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 +78,12 @@ 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
+

src/volvo.py

@@ -1,362 +1,404 @@
-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 Thread, 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, 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(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.get('url'):
-
+                state = api_call(entity["url"], "GET", vin, entity["id"])
-
+            else:
-def initialize_climate(vins):
+                state = ""
-    for vin in vins:
+
-        mqtt.assumed_climate_state[vin] = "OFF"
+            if state is not None:
-
+                logging.info("Success! " + entity["name"] + " is supported by your vehicle.")
-
+                supported_endpoints[vin].append(entity)
-def disable_climate(vin):
+            else:
-    print("Turning climate off by timer!")
+                logging.info("Failed, " + entity["name"] + " is unfortunately not supported by your vehicle.")
-    mqtt.assumed_climate_state[vin] = "OFF"
+
-    mqtt.update_car_data()
+
-
+def initialize_climate(vins):
-
+    for vin in vins:
-def api_call(url, method, vin, sensor_id=None, force_update=False):
+        mqtt.assumed_climate_state[vin] = "OFF"
-    global token_expires_at
+
-    if datetime.now(util.TZ) >= token_expires_at:
+
-        refresh_auth()
+def disable_climate(vin):
-
+    logging.info("Turning climate off by timer!")
-    if url in [RECHARGE_STATE_URL, WINDOWS_STATE_URL, LOCK_STATE_URL, TYRE_STATE_URL, STATISTICS_URL]:
+    mqtt.door_status[vin].do_run = False
-        # Minimize API calls for endpoints with multiple values
+    mqtt.assumed_climate_state[vin] = "OFF"
-        response = cached_request(url, method, vin, force_update)
+    mqtt.update_car_data()
-        if response is None:
+
-            # Exception caught while getting data from volvo api, doing nothing
+
-            return None
+def check_door_status(vin):
-    elif method == "GET":
+    t = currentThread()
-        print("Starting " + method + " call against " + url)
+    while getattr(t, "do_run", True):
-        try:
+        lock_door_left = api_call(LOCK_STATE_URL, "GET", vin, "door_front_left", True)
-            response = session.get(url.format(vin), timeout=15)
+        lock_door_right = api_call(LOCK_STATE_URL, "GET", vin, "door_front_right", True)
-        except requests.exceptions.RequestException as e:
+        if lock_door_left == "ON" or lock_door_right == "ON":
-            print("Error getting data: " + str(e))
+            Thread(target=api_call, args=(CLIMATE_STOP_URL, "POST", vin)).start()
-            return ""
+            mqtt.assumed_climate_state[vin] = "OFF"
-    elif method == "POST":
+            mqtt.update_car_data()
-        print("Starting " + method + " call against " + url)
+            break
-        try:
+        time.sleep(5)
-            response = session.post(url.format(vin), timeout=20)
+
-        except requests.exceptions.RequestException as e:
+
-            print("Error getting data: " + str(e))
+def api_call(url, method, vin, sensor_id=None, force_update=False):
-            return ""
+    global token_expires_at
-    else:
+    if datetime.now(util.TZ) >= token_expires_at:
-        print("Unkown method posted: " + method + ". Returning nothing")
+        refresh_auth()
-        return ""
+
-
+    if url in [RECHARGE_STATE_URL, WINDOWS_STATE_URL, LOCK_STATE_URL, TYRE_STATE_URL, STATISTICS_URL]:
-    if response.status_code == 200:
+        # Minimize API calls for endpoints with multiple values
-        data = response.json()
+        response = cached_request(url, method, vin, force_update)
-        if "debug" in settings:
+        if response is None:
-            if settings["debug"]:
+            # Exception caught while getting data from volvo api, doing nothing
-                print(response.text)
+            return None
-    else:
+    elif method == "GET":
-        if url == CLIMATE_START_URL and response.status_code == 503:
+        logging.debug("Starting " + method + " call against " + url)
-            print("Car in use, cannot start pre climatization")
+        try:
-            mqtt.assumed_climate_state[vin] = "OFF"
+            response = session.get(url.format(vin), timeout=15)
-            mqtt.update_car_data()
+        except requests.exceptions.RequestException as e:
-        else:
+            logging.error("Error getting data: " + str(e))
-            print("API Call failed. Status Code: " + str(response.status_code) + ". Error: " + response.text)
+            return None
-        return ""
+    elif method == "POST":
-    return parse_api_data(data, sensor_id)
+        logging.debug("Starting " + method + " call against " + url)
-
+        try:
-
+            response = session.post(url.format(vin), timeout=20)
-def cached_request(url, method, vin, force_update=False):
+        except requests.exceptions.RequestException as e:
-    global cached_requests
+            logging.error("Error getting data: " + str(e))
-    if not util.keys_exists(cached_requests, vin + "_" + url):
+            return None
-        # No API Data cached, get fresh data from API
+    else:
-        print("Starting " + method + " call against " + url)
+        logging.error("Unkown method posted: " + method + ". Returning nothing")
-        try:
+        return None
-            response = session.get(url.format(vin), timeout=15)
+
-        except requests.exceptions.RequestException as e:
+    logging.debug("Response status code: " + str(response.status_code))
-            print("Error getting data: " + str(e))
+    if response.status_code == 200:
-            return None
+        data = response.json()
-
+        logging.debug(response.text)
-        data = {"response": response, "last_update": datetime.now(util.TZ)}
+    else:
-        cached_requests[vin + "_" + url] = data
+        logging.debug(response.text)
-    else:
+        if url == CLIMATE_START_URL and response.status_code == 503:
-        if (datetime.now(util.TZ) - cached_requests[vin + "_" + url]["last_update"]).total_seconds() >= settings["updateInterval"] \
+            logging.warning("Car in use, cannot start pre climatization")
-                or (force_update and (datetime.now(util.TZ) - cached_requests[vin + "_" + url]["last_update"]).total_seconds() >= 2):
+            mqtt.assumed_climate_state[vin] = "OFF"
-            # Old Data in Cache, or force mode active, updating
+            mqtt.update_car_data()
-            print("Starting " + method + " call against " + url)
+        elif "extended-vehicle" in url and response.status_code == 403:
-            try:
+            # Suppress 403 errors for unsupported extended-vehicle api cars
-                response = session.get(url.format(vin), timeout=15)
+            logging.debug("Suppressed 403 for extended-vehicle API")
-            except requests.exceptions.RequestException as e:
+            return None
-                print("Error getting data: " + str(e))
+        else:
-                return None
+            logging.error("API Call failed. Status Code: " + str(response.status_code) + ". Error: " + response.text)
-            data = {"response": response, "last_update": datetime.now(util.TZ)}
+        return None
-            cached_requests[vin + "_" + url] = data
+    return parse_api_data(data, sensor_id)
-        else:
+
-            # Data is up do date, returning cached data
+
-            response = cached_requests[vin + "_" + url]["response"]
+def cached_request(url, method, vin, force_update=False):
-    return response
+    global cached_requests
-
+    if not util.keys_exists(cached_requests, vin + "_" + url):
-
+        # No API Data cached, get fresh data from API
-def parse_api_data(data, sensor_id=None):
+        logging.debug("Starting " + method + " call against " + url)
-    data = data["data"]
+        try:
-    if sensor_id == "battery_charge_level":
+            response = session.get(url.format(vin), timeout=15)
-        return data["batteryChargeLevel"]["value"] if util.keys_exists(data, "batteryChargeLevel") else None
+        except requests.exceptions.RequestException as e:
-    elif sensor_id == "electric_range":
+            logging.error("Error getting data: " + str(e))
-        return data["electricRange"]["value"] if util.keys_exists(data, "electricRange") else None
+            return None
-    elif sensor_id == "charging_system_status":
+
-        return charging_system_states[data["chargingSystemStatus"]["value"]] if util.keys_exists(data,
+        data = {"response": response, "last_update": datetime.now(util.TZ)}
-                                                                                            "chargingSystemStatus") else None
+        cached_requests[vin + "_" + url] = data
-    elif sensor_id == "charging_connection_status":
+    else:
-        return charging_connection_states[data["chargingConnectionStatus"]["value"]] if util.keys_exists(data,
+        if (datetime.now(util.TZ) - cached_requests[vin + "_" + url]["last_update"]).total_seconds() \
-                                                                                                    "chargingConnectionStatus") else None
+                >= settings["updateInterval"] or (force_update and
-    elif sensor_id == "estimated_charging_time":
+                                                  (datetime.now(util.TZ) - cached_requests[vin + "_" + url]
-        if util.keys_exists(data, "chargingSystemStatus"):
+                                                      ["last_update"]).total_seconds() >= 2):
-            charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]]
+            # Old Data in Cache, or force mode active, updating
-            if charging_system_state == "Charging":
+            logging.debug("Starting " + method + " call against " + url)
-                return data["estimatedChargingTime"]["value"] if util.keys_exists(data, "estimatedChargingTime") else ""
+            try:
-            else:
+                response = session.get(url.format(vin), timeout=15)
-                return 0
+            except requests.exceptions.RequestException as e:
-        else:
+                logging.error("Error getting data: " + str(e))
-            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":
+            # Data is up do date, returning cached data
-                charging_time = int(data["estimatedChargingTime"]["value"] if util.keys_exists(data, "estimatedChargingTime")
+            response = cached_requests[vin + "_" + url]["response"]
-                                    else 0)
+    return response
-                charging_finished = datetime.now(util.TZ) + timedelta(minutes=charging_time)
+
-                return format_datetime(charging_finished, format="medium", locale=settings["babelLocale"])
+
-            else:
+def parse_api_data(data, sensor_id=None):
-                return ""
+    data = data["data"]
-        else:
+    if sensor_id == "battery_charge_level":
-            return None
+        return data["batteryChargeLevel"]["value"] if util.keys_exists(data, "batteryChargeLevel") else None
-    elif sensor_id == "lock_status":
+    elif sensor_id == "electric_range":
-        return data["carLocked"]["value"] if util.keys_exists(data, "carLocked") else None
+        return util.convert_metric_values(data["electricRange"]["value"]) \
-    elif sensor_id == "odometer":
+            if util.keys_exists(data, "electricRange") else None
-        multiplier = 1
+    elif sensor_id == "charging_system_status":
-        if util.keys_exists(settings["volvoData"], "odometerMultiplier"):
+        return charging_system_states[data["chargingSystemStatus"]["value"]] \
-            multiplier = settings["volvoData"]["odometerMultiplier"]
+            if util.keys_exists(data, "chargingSystemStatus") else None
-            if isinstance(multiplier, str):
+    elif sensor_id == "charging_connection_status":
-                multiplier = 1
+        return charging_connection_states[data["chargingConnectionStatus"]["value"]] \
-            elif multiplier < 1:
+            if util.keys_exists(data, "chargingConnectionStatus") else None
-                multiplier = 1
+    elif sensor_id == "estimated_charging_time":
-        return int(data["odometer"]["value"]) * multiplier if util.keys_exists(data, "odometer") else None
+        if util.keys_exists(data, "chargingSystemStatus"):
-    elif sensor_id == "window_front_left":
+            charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]]
-        return window_states[data["frontLeftWindowOpen"]["value"]] if util.keys_exists(data, "frontLeftWindowOpen") \
+            if charging_system_state == "Charging":
-            else None
+                return data["estimatedChargingTime"]["value"] if util.keys_exists(data, "estimatedChargingTime") else ""
-    elif sensor_id == "window_front_right":
+            else:
-        return window_states[data["frontRightWindowOpen"]["value"]] if util.keys_exists(data, "frontRightWindowOpen") \
+                return 0
-            else None
+        return None
-    elif sensor_id == "window_rear_left":
+    elif sensor_id == "estimated_charging_finish_time":
-        return window_states[data["rearLeftWindowOpen"]["value"]] if util.keys_exists(data, "rearLeftWindowOpen") \
+        if util.keys_exists(data, "chargingSystemStatus"):
-            else None
+            charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]]
-    elif sensor_id == "window_rear_right":
+            if charging_system_state == "Charging":
-        return window_states[data["rearRightWindowOpen"]["value"]] if util.keys_exists(data, "rearRightWindowOpen") \
+                charging_time = int(
-            else None
+                    data["estimatedChargingTime"]["value"] if util.keys_exists(data, "estimatedChargingTime")
-    elif sensor_id == "door_front_left":
+                    else 0)
-        return door_states[data["frontLeftDoorOpen"]["value"]] if util.keys_exists(data, "frontLeftDoorOpen") else None
+                charging_finished = datetime.now(util.TZ) + timedelta(minutes=charging_time)
-    elif sensor_id == "door_front_right":
+                return format_datetime(charging_finished, format="medium", locale=settings["babelLocale"])
-        return door_states[data["frontRightDoorOpen"]["value"]] if util.keys_exists(data, "frontRightDoorOpen") else None
+            else:
-    elif sensor_id == "door_rear_left":
+                return ""
-        return door_states[data["rearLeftDoorOpen"]["value"]] if util.keys_exists(data, "rearLeftDoorOpen") else None
+        return None
-    elif sensor_id == "door_rear_right":
+    elif sensor_id == "lock_status":
-        return door_states[data["rearRightDoorOpen"]["value"]] if util.keys_exists(data, "rearRightDoorOpen") else None
+        return data["carLocked"]["value"] if util.keys_exists(data, "carLocked") else None
-    elif sensor_id == "tailgate":
+    elif sensor_id == "odometer":
-        return door_states[data["tailGateOpen"]["value"]] if util.keys_exists(data, "tailGateOpen") else None
+        multiplier = 1
-    elif sensor_id == "sunroof":
+        if util.keys_exists(settings["volvoData"], "odometerMultiplier"):
-        return door_states[data["sunRoofOpen"]["value"]] if util.keys_exists(data, "sunRoofOpen") else None
+            multiplier = settings["volvoData"]["odometerMultiplier"]
-    elif sensor_id == "engine_hood":
+            if isinstance(multiplier, str):
-        return door_states[data["hoodOpen"]["value"]] if util.keys_exists(data, "hoodOpen") else None
+                multiplier = 1
-    elif sensor_id == "tank_lid":
+            elif multiplier < 1:
-        return door_states[data["tankLidOpen"]["value"]] if util.keys_exists(data, "tankLidOpen") else None
+                multiplier = 1
-    elif sensor_id == "tyre_front_left":
+        return util.convert_metric_values(int(data["odometer"]["value"]) * multiplier) \
-        return data["frontLeftTyrePressure"]["value"] if util.keys_exists(data, "frontLeftTyrePressure") else None
+            if util.keys_exists(data, "odometer") else None
-    elif sensor_id == "tyre_front_right":
+    elif sensor_id == "window_front_left":
-        return data["frontRightTyrePressure"]["value"] if util.keys_exists(data, "frontRightTyrePressure") else None
+        return window_states[data["frontLeftWindowOpen"]["value"]] if util.keys_exists(data, "frontLeftWindowOpen") \
-    elif sensor_id == "tyre_rear_left":
+            else None
-        return data["rearLeftTyrePressure"]["value"] if util.keys_exists(data, "rearLeftTyrePressure") else None
+    elif sensor_id == "window_front_right":
-    elif sensor_id == "tyre_rear_right":
+        return window_states[data["frontRightWindowOpen"]["value"]] if util.keys_exists(data, "frontRightWindowOpen") \
-        return data["rearRightTyrePressure"]["value"] if util.keys_exists(data, "rearRightTyrePressure") else None
+            else None
-    elif sensor_id == "engine_state":
+    elif sensor_id == "window_rear_left":
-        return data["engineRunning"]["value"] if util.keys_exists(data, "engineRunning") else None
+        return window_states[data["rearLeftWindowOpen"]["value"]] if util.keys_exists(data, "rearLeftWindowOpen") \
-    elif sensor_id == "fuel_level":
+            else None
-        if util.keys_exists(data, "fuelAmount"):
+    elif sensor_id == "window_rear_right":
-            fuel_amount = int(data["fuelAmount"]["value"])
+        return window_states[data["rearRightWindowOpen"]["value"]] if util.keys_exists(data, "rearRightWindowOpen") \
-            if fuel_amount > 0:
+            else None
-                return fuel_amount
+    elif sensor_id == "door_front_left":
-            else:
+        return door_states[data["frontLeftDoorOpen"]["value"]] if util.keys_exists(data, "frontLeftDoorOpen") else None
-                return None
+    elif sensor_id == "door_front_right":
-        else:
+        return door_states[data["frontRightDoorOpen"]["value"]] \
-            return None
+            if util.keys_exists(data, "frontRightDoorOpen") else None
-    elif sensor_id == "average_fuel_consumption":
+    elif sensor_id == "door_rear_left":
-        if util.keys_exists(data, "averageFuelConsumption"):
+        return door_states[data["rearLeftDoorOpen"]["value"]] if util.keys_exists(data, "rearLeftDoorOpen") else None
-            average_fuel_con = float(data["averageFuelConsumption"]["value"])
+    elif sensor_id == "door_rear_right":
-            if average_fuel_con > 0:
+        return door_states[data["rearRightDoorOpen"]["value"]] if util.keys_exists(data, "rearRightDoorOpen") else None
-                return average_fuel_con
+    elif sensor_id == "tailgate":
-            else:
+        return door_states[data["tailGateOpen"]["value"]] if util.keys_exists(data, "tailGateOpen") else None
-                return None
+    elif sensor_id == "sunroof":
-        else:
+        return door_states[data["sunRoofOpen"]["value"]] if util.keys_exists(data, "sunRoofOpen") else None
-            return None
+    elif sensor_id == "engine_hood":
-    elif sensor_id == "average_speed":
+        return door_states[data["hoodOpen"]["value"]] if util.keys_exists(data, "hoodOpen") else None
-        if util.keys_exists(data, "averageSpeed"):
+    elif sensor_id == "tank_lid":
-            average_speed = int(data["averageSpeed"]["value"])
+        return door_states[data["tankLidOpen"]["value"]] if util.keys_exists(data, "tankLidOpen") else None
-            if average_speed > 0:
+    elif sensor_id == "tyre_front_left":
-                return average_speed
+        return data["frontLeftTyrePressure"]["value"] if util.keys_exists(data, "frontLeftTyrePressure") else None
-            else:
+    elif sensor_id == "tyre_front_right":
-                return None
+        return data["frontRightTyrePressure"]["value"] if util.keys_exists(data, "frontRightTyrePressure") else None
-        else:
+    elif sensor_id == "tyre_rear_left":
-            return None
+        return data["rearLeftTyrePressure"]["value"] if util.keys_exists(data, "rearLeftTyrePressure") else None
-    elif sensor_id == "location":
+    elif sensor_id == "tyre_rear_right":
-        coordinates = {}
+        return data["rearRightTyrePressure"]["value"] if util.keys_exists(data, "rearRightTyrePressure") else None
-        if util.keys_exists(data, "geometry"):
+    elif sensor_id == "engine_state":
-            raw_data = data["geometry"]
+        return data["engineRunning"]["value"] if util.keys_exists(data, "engineRunning") else None
-            if util.keys_exists(raw_data, "coordinates"):
+    elif sensor_id == "fuel_level":
-                coordinates = {"longitude": raw_data["coordinates"][0],
+        if util.keys_exists(data, "fuelAmount"):
-                               "latitude": raw_data["coordinates"][1],
+            fuel_amount = int(data["fuelAmount"]["value"])
-                               "gps_accuracy": 1}
+            if fuel_amount > 0:
-        return coordinates
+                return fuel_amount
-    else:
+        return None
-        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 = 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)
+        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