Bump version

Added docker-compose.yml example

.env.dist

@@ -0,0 +1,5 @@
+CONF_updateInterval=300
+CONF_babelLocale='de'
+CONF_mqtt='@json {"broker": "mqtt", "username": "", "password": ""}'
+CONF_volvoData='@json {"username": "", "password": "", "vin": "",   "vccapikey": ""}'
+TZ='Europe/Berlin'

.github/ISSUE_TEMPLATE/bug_report.md

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

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.gitignore

@@ -1,3 +1,4 @@
 .idea
 venv
-src/settings.dev.json
+src/settings.dev.json
+.env

README.md

@@ -5,6 +5,7 @@ Maybe this component works also with other Volvo cars. Please try out the native
 
 ## Confirmed working with
 - XC40 BEV (2023)
+- XC40 BEV (2022)
 - V60 T8 PHEV (2023)
 - C40 PHEV (2023)
 - C40 PHEV (2022)
@@ -21,7 +22,15 @@ Please let me know if your car works with this addon so I can expand the list!
 - Sensor "Battery Charge Level"
 - Sensor "Electric Range"
 - Sensor "Charging System Status"
+- Sensor "Charging Connection Status"
 - Sensor "Estimated Charging Finish Time"
+- Sensor "Door Lock Status"
+- Sensor "Engine Status"
+- Sensor "Window Lock Status"
+- Sensor "Odometer"
+- Sensor "Tire Status"
+- Sensor "Fuel Status"
+- Car Device Tracker
 - Multiple cars
 
 NOTE: Energy status currently available only for cars in the Europe / Middle East / Africa regions. [source](https://developer.volvocars.com/apis/energy/v1/overview/#availability)
@@ -32,7 +41,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": ""}' -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": ""}' -e CONF_volvoData='@json {"username": "", "password": "", "vin": "",   "vccapikey": "", "odometerMultiplier": 1}' -e TZ='Europe/Berlin' --name volvo2mqtt ghcr.io/dielee/volvo2mqtt:latest`
 
 <b>HA Add-On:</b><br>
 
@@ -45,7 +54,7 @@ Here is what every option means:
 | `CONF_updateInterval`     | `int`     | **required** | Update intervall in seconds.                                     |
 | `CONF_babelLocale`        | `string`  | **required** | Select your country from this [list](https://www.ibm.com/docs/en/radfws/9.7?topic=overview-locales-code-pages-supported). "Locale name" is the column you need!                                        |
 | `CONF_mqtt`               | `json`    | **required** | Broker = Mqtt Broker IP / Username and Passwort are optional!   |
-| `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/).                                   |
+| `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_debug`              | `string`  |              | Debug option (true/false) - optional! |
 | `TZ`                 | `string`  |              | Container timezone eg "Europe/Berlin" |
 

docker-compose.yml

@@ -0,0 +1,24 @@
+version: '3'
+services:
+  app:
+    build: .
+    env_file:
+      - .env
+    #    environment:
+    #      CONF_updateInterval: 300
+    #      CONF_babelLocale: 'de'
+    #      CONF_mqtt: '@json {"broker": "mqtt", "username": "", "password": ""}'
+    #      CONF_volvoData: '@json {"username": "", "password": "", "vin": "",   "vccapikey": ""}'
+    #      TZ: 'Europe/Berlin'
+    links:
+      - mqtt
+    depends_on:
+      - mqtt
+
+  mqtt:
+    container_name: mqtt
+    image: eclipse-mosquitto
+    expose:
+      - 1883
+    command: [ "/usr/sbin/mosquitto", "-c", "/mosquitto-no-auth.conf" ]
+

src/config.yaml

@@ -1,6 +1,6 @@
 name: "Volvo2Mqtt"
 description: "Volvo AAOS MQTT bridge"
-version: "1.3.0"
+version: "1.4.0"
 slug: "volvo2mqtt"
 init: false
 url: "https://github.com/Dielee/volvo2mqtt"
@@ -18,6 +18,7 @@ options:
     password: null
     vin: ""
     vccapikey: null
+    odometerMultiplier: 1
 schema:
   updateInterval: int(10,)
   babelLocale: str
@@ -31,6 +32,7 @@ schema:
     password: str
     vin: str?
     vccapikey: str
+    odometerMultiplier: int(1,)
 arch:
   - aarch64
   - amd64

src/const.py

@@ -1,6 +1,6 @@
 from config import settings
 
-VERSION = "v1.3.0"
+VERSION = "v1.4.0"
 
 OAUTH_URL = "https://volvoid.eu.volvocars.com/as/token.oauth2"
 VEHICLES_URL = "https://api.volvocars.com/connected-vehicle/v1/vehicles"
@@ -17,6 +17,7 @@ LOCATION_STATE_URL = "https://api.volvocars.com/location/v1/vehicles/{0}/locatio
 TYRE_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/tyres"
 ENGINE_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/engine-status"
 BATTERY_CHARGE_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/battery-charge-level"
+FUEL_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/fuel"
 
 charging_system_states = {"CHARGING_SYSTEM_CHARGING": "Charging", "CHARGING_SYSTEM_IDLE": "Idle",
                           "CHARGING_SYSTEM_FAULT": "Fault", "CHARGING_SYSTEM_UNSPECIFIED": "Unspecified"}
@@ -49,9 +50,10 @@ supported_entities = [
                         {"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": ""},
                         {"name": "Location", "domain": "device_tracker", "id": "location", "icon": "map-marker-radius", "url": LOCATION_STATE_URL},
-                        {"name": "Tyre Front Left", "domain": "sensor", "id": "tyre_front_left", "icon": "car-tire-alert", "url": TYRE_STATE_URL},
-                        {"name": "Tyre Front Right", "domain": "sensor", "id": "tyre_front_right", "icon": "car-tire-alert", "url": TYRE_STATE_URL},
-                        {"name": "Tyre Rear Left", "domain": "sensor", "id": "tyre_rear_left", "icon": "car-tire-alert", "url": TYRE_STATE_URL},
-                        {"name": "Tyre 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": "Tire Front Left", "domain": "sensor", "id": "tyre_front_left", "icon": "car-tire-alert", "url": TYRE_STATE_URL},
+                        {"name": "Tire Front Right", "domain": "sensor", "id": "tyre_front_right", "icon": "car-tire-alert", "url": TYRE_STATE_URL},
+                        {"name": "Tire Rear Left", "domain": "sensor", "id": "tyre_rear_left", "icon": "car-tire-alert", "url": TYRE_STATE_URL},
+                        {"name": "Tire Rear Right", "domain": "sensor", "id": "tyre_rear_right", "icon": "car-tire-alert", "url": TYRE_STATE_URL},
+                        {"name": "Engine State", "domain": "sensor", "id": "engine_state", "icon": "engine", "url": ENGINE_STATE_URL},
+                        {"name": "Fuel Level", "domain": "sensor", "id": "fuel_level", "unit": "liters", "icon": "fuel", "url": FUEL_STATE_URL}
 ]

src/main.py

@@ -2,6 +2,7 @@ from volvo import authorize
 from mqtt import update_loop, connect
 from const import VERSION
 
+
 if __name__ == '__main__':
     print("Starting volvo2mqtt version " + VERSION)
     authorize()

src/mqtt.py

@@ -14,7 +14,7 @@ mqtt_client: mqtt.Client
 subscribed_topics = []
 assumed_climate_state = {}
 last_data_update = None
-climate_timer: Timer
+climate_timer = {}
 
 
 def connect():
@@ -56,24 +56,24 @@ def on_message(client, userdata, msg):
             api_thread.start()
             assumed_climate_state[vin] = "ON"
             # Starting timer to disable climate after 30 mins
-            climate_timer = Timer(1 * 60, volvo.disable_climate, (vin, ))
-            climate_timer.start()
+            climate_timer[vin] = Timer(30 * 60, volvo.disable_climate, (vin, ))
+            climate_timer[vin].start()
             update_car_data()
         elif payload == "OFF":
             api_thread = Thread(target=volvo.api_call, args=(CLIMATE_STOP_URL, "POST", vin))
             api_thread.start()
             assumed_climate_state[vin] = "OFF"
             # Stop timer if active
-            if climate_timer.is_alive():
-                climate_timer.cancel()
+            if climate_timer[vin].is_alive():
+                climate_timer[vin].cancel()
             update_car_data()
     elif "lock_status" in msg.topic:
         if payload == "LOCK":
             volvo.api_call(CAR_LOCK_URL, "POST", vin)
-            update_car_data()
+            update_car_data(True)
         elif payload == "UNLOCK":
             volvo.api_call(CAR_UNLOCK_URL, "POST", vin)
-            update_car_data()
+            update_car_data(True)
     elif "update_data" in msg.topic:
         if payload == "PRESS":
             update_car_data(True)
@@ -143,5 +143,6 @@ def create_ha_devices():
             mqtt_client.publish(
                 f"homeassistant/{entity['domain']}/volvoAAOS2mqtt/{vin}_{entity['id']}/config",
                 json.dumps(config),
+                retain=True
             )
     time.sleep(2)

src/translations/en.yaml

@@ -13,4 +13,4 @@ configuration:
     description: Broker is your mqtt broker IP eg "192.168.0.1". Mqtt username and password are optional.
   volvoData:
     name: Volvo APP credentials
-    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. 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. Leave it empty if you don't know what's right. Take a look at the GitHub repo for more information!

src/volvo.py

@@ -18,15 +18,8 @@ session.headers = {
 token_expires_at: datetime
 refresh_token = None
 vins = []
-recharge_cached_api_response = {}
-recharge_api_last_update = {}
-window_cached_api_response = {}
-window_api_last_update = {}
-door_cached_api_response = {}
-door_api_last_update = {}
-tyre_cached_api_response = {}
-tyre_api_last_update = {}
 supported_endpoints = {}
+cached_requests = {}
 
 
 def authorize():
@@ -177,22 +170,42 @@ def api_call(url, method, vin, sensor_id=None, force_update=False):
 
     if url == RECHARGE_STATE_URL:
         # Minimize API calls for recharge state
-        response = pull_recharge_api(url, method, vin, force_update)
+        response = cached_request(url, method, vin, force_update)
+        if response is None:
+            # Exception caught while getting data from volvo api, doing nothing
+            return None
     elif url == WINDOWS_STATE_URL:
         # Minimize API calls for window state
-        response = pull_window_api(url, method, vin, force_update)
+        response = cached_request(url, method, vin, force_update)
+        if response is None:
+            # Exception caught while getting data from volvo api, doing nothing
+            return ""
     elif url == LOCK_STATE_URL:
         # Minimize API calls for door state
-        response = pull_door_api(url, method, vin, force_update)
+        response = cached_request(url, method, vin, force_update)
+        if response is None:
+            # Exception caught while getting data from volvo api, doing nothing
+            return ""
     elif url == TYRE_STATE_URL:
         # Minimize API calls for tyre state
-        response = pull_tyre_api(url, method, vin, force_update)
+        response = cached_request(url, method, vin, force_update)
+        if response is None:
+            # Exception caught while getting data from volvo api, doing nothing
+            return ""
     elif method == "GET":
         print("Starting " + method + " call against " + url)
-        response = session.get(url.format(vin), timeout=15)
+        try:
+            response = session.get(url.format(vin), timeout=15)
+        except requests.exceptions.RequestException as e:
+            print("Error getting data: " + str(e))
+            return ""
     elif method == "POST":
         print("Starting " + method + " call against " + url)
-        response = session.post(url.format(vin), timeout=20)
+        try:
+            response = session.post(url.format(vin), timeout=20)
+        except requests.exceptions.RequestException as e:
+            print("Error getting data: " + str(e))
+            return ""
     else:
         print("Unkown method posted: " + method + ". Returning nothing")
         return ""
@@ -213,87 +226,34 @@ def api_call(url, method, vin, sensor_id=None, force_update=False):
     return parse_api_data(data, sensor_id)
 
 
-def pull_tyre_api(url, method, vin, force_update=False):
-    global tyre_cached_api_response, tyre_api_last_update
-    if not vin in tyre_cached_api_response or force_update:
-        # No API Data for vin cached, get fresh data from API
+def cached_request(url, method, vin, force_update=False):
+    global cached_requests
+    if not keys_exists(cached_requests, vin + "_" + url):
+        # No API Data cached, get fresh data from API
         print("Starting " + method + " call against " + url)
-        response = session.get(url.format(vin), timeout=15)
-        tyre_cached_api_response[vin] = response
-        tyre_api_last_update[vin] = datetime.now()
-    else:
-        if (datetime.now() - tyre_api_last_update[vin]).total_seconds() >= settings["updateInterval"]:
-            # Old Data in Cache, updating
-            print("Starting " + method + " call against " + url)
+        try:
             response = session.get(url.format(vin), timeout=15)
-            tyre_cached_api_response[vin] = response
-            tyre_api_last_update[vin] = datetime.now()
+        except requests.exceptions.RequestException as e:
+            print("Error getting data: " + str(e))
+            return None
+
+        data = {"response": response, "last_update": datetime.now()}
+        cached_requests[vin + "_" + url] = data
+    else:
+        if (datetime.now() - cached_requests[vin + "_" + url]["last_update"]).total_seconds() >= settings["updateInterval"] \
+                or (force_update and (datetime.now() - cached_requests[vin + "_" + url]["last_update"]).total_seconds() >= 2):
+            # Old Data in Cache, or force mode active, updating
+            print("Starting " + method + " call against " + url)
+            try:
+                response = session.get(url.format(vin), timeout=15)
+            except requests.exceptions.RequestException as e:
+                print("Error getting data: " + str(e))
+                return None
+            data = {"response": response, "last_update": datetime.now()}
+            cached_requests[vin + "_" + url] = data
         else:
             # Data is up do date, returning cached data
-            response = tyre_cached_api_response[vin]
-    return response
-
-
-def pull_door_api(url, method, vin, force_update=False):
-    global door_cached_api_response, door_api_last_update
-    if not vin in door_cached_api_response or force_update:
-        # No API Data for vin cached, get fresh data from API
-        print("Starting " + method + " call against " + url)
-        response = session.get(url.format(vin), timeout=15)
-        door_cached_api_response[vin] = response
-        door_api_last_update[vin] = datetime.now()
-    else:
-        if (datetime.now() - door_api_last_update[vin]).total_seconds() >= settings["updateInterval"]:
-            # Old Data in Cache, updating
-            print("Starting " + method + " call against " + url)
-            response = session.get(url.format(vin), timeout=15)
-            door_cached_api_response[vin] = response
-            door_api_last_update[vin] = datetime.now()
-        else:
-            # Data is up do date, returning cached data
-            response = door_cached_api_response[vin]
-    return response
-
-
-def pull_window_api(url, method, vin, force_update=False):
-    global window_cached_api_response, window_api_last_update
-    if not vin in window_cached_api_response or force_update:
-        # No API Data for vin cached, get fresh data from API
-        print("Starting " + method + " call against " + url)
-        response = session.get(url.format(vin), timeout=15)
-        window_cached_api_response[vin] = response
-        window_api_last_update[vin] = datetime.now()
-    else:
-        if (datetime.now() - window_api_last_update[vin]).total_seconds() >= settings["updateInterval"]:
-            # Old Data in Cache, updating
-            print("Starting " + method + " call against " + url)
-            response = session.get(url.format(vin), timeout=15)
-            window_cached_api_response[vin] = response
-            window_api_last_update[vin] = datetime.now()
-        else:
-            # Data is up do date, returning cached data
-            response = window_cached_api_response[vin]
-    return response
-
-
-def pull_recharge_api(url, method, vin, force_update=False):
-    global recharge_cached_api_response, recharge_api_last_update
-    if not vin in recharge_cached_api_response or force_update:
-        # No API Data for vin cached, get fresh data from API
-        print("Starting " + method + " call against " + url)
-        response = session.get(url.format(vin), timeout=15)
-        recharge_cached_api_response[vin] = response
-        recharge_api_last_update[vin] = datetime.now()
-    else:
-        if (datetime.now() - recharge_api_last_update[vin]).total_seconds() >= settings["updateInterval"]:
-            # Old Data in Cache, updating
-            print("Starting " + method + " call against " + url)
-            response = session.get(url.format(vin), timeout=15)
-            recharge_cached_api_response[vin] = response
-            recharge_api_last_update[vin] = datetime.now()
-        else:
-            # Data is up do date, returning cached data
-            response = recharge_cached_api_response[vin]
+            response = cached_requests[vin + "_" + url]["response"]
     return response
 
 
@@ -304,9 +264,11 @@ def parse_api_data(data, sensor_id=None):
     elif sensor_id == "electric_range":
         return data["electricRange"]["value"] if keys_exists(data, "electricRange") else None
     elif sensor_id == "charging_system_status":
-        return charging_system_states[data["chargingSystemStatus"]["value"]] if keys_exists(data, "chargingSystemStatus") else None
+        return charging_system_states[data["chargingSystemStatus"]["value"]] if keys_exists(data,
+                                                                                            "chargingSystemStatus") else None
     elif sensor_id == "charging_connection_status":
-        return charging_connection_states[data["chargingConnectionStatus"]["value"]] if keys_exists(data, "chargingConnectionStatus") else None
+        return charging_connection_states[data["chargingConnectionStatus"]["value"]] if keys_exists(data,
+                                                                                                    "chargingConnectionStatus") else None
     elif sensor_id == "estimated_charging_time":
         if keys_exists(data, "chargingSystemStatus"):
             charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]]
@@ -331,7 +293,14 @@ def parse_api_data(data, sensor_id=None):
     elif sensor_id == "lock_status":
         return data["carLocked"]["value"] if keys_exists(data, "carLocked") else None
     elif sensor_id == "odometer":
-        return int(data["odometer"]["value"]) * 10 if keys_exists(data, "odometer") else None
+        multiplier = 1
+        if keys_exists(settings["volvoData"], "odometerMultiplier"):
+            multiplier = settings["volvoData"]["odometerMultiplier"]
+            if isinstance(multiplier, str):
+                multiplier = 1
+            elif multiplier < 1:
+                multiplier = 1
+        return int(data["odometer"]["value"]) * multiplier if keys_exists(data, "odometer") else None
     elif sensor_id == "window_front_left":
         return data["frontLeftWindowOpen"]["value"] if keys_exists(data, "frontLeftWindowOpen") else None
     elif sensor_id == "window_front_right":
@@ -364,6 +333,8 @@ def parse_api_data(data, sensor_id=None):
         return data["rearRightTyrePressure"]["value"] if keys_exists(data, "rearRightTyrePressure") else None
     elif sensor_id == "engine_state":
         return data["engineRunning"]["value"] if keys_exists(data, "engineRunning") else None
+    elif sensor_id == "fuel_level":
+        return data["fuelAmount"]["value"] if keys_exists(data, "fuelAmount") else None
     elif sensor_id == "location":
         coordinates = {}
         if keys_exists(data, "geometry"):