Added vehicle diagnostics sensors (#78)

* Added vehicle diagnostics for additional sensors (#76)

Add support for vehicle diagnostics data

---------

Co-authored-by: Arthur van der Peijl <arthur@artned.org>

* Reduce VEHICLE_DIAGNOSTICS_URL api calls

* Bump version

---------

Co-authored-by: Arthur van der Peijl <aavanderpeijl@gmail.com>
Co-authored-by: Arthur van der Peijl <arthur@artned.org>

.github/ISSUE_TEMPLATE/bug_report.md

@@ -3,28 +3,29 @@ name: Bug report
 about: Create a report to help us improve
 title: ''
 labels: ''
-assignees: Dielee
+assignees: ''
 
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
-**To Reproduce**
+**To Reproduce**:<br>
 Steps to reproduce the behavior:
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
 
-**Expected behavior**
+**Expected behavior**:<br>
 A clear and concise description of what you expected to happen.
 
-**Screenshots**
+**Screenshots**:<br>
 If applicable, add screenshots to help explain your problem.
 
-**Version info**
+**Version info**:<br>
 The version you are using and the method you are using (Docker container/HA Addon/Cloned repo)
 
-**Additional context**
-Add any other context about the problem here.
+**Logs**:<br>
+Enable the debug option and upload your logfile here. <br>
+<b>If you are using the HA Addon the log location is `\\<Your HA Host IP>\addons\volvo2mqtt\log\volvo2mqtt.log`

.github/workflows/stale.yml

@@ -0,0 +1,33 @@
+# This workflow warns and then closes issues and PRs that have had no activity for a specified amount of time.
+#
+# You can adjust the behavior by modifying this file.
+# For more information, see:
+# https://github.com/actions/stale
+name: Mark stale issues and pull requests
+
+on:
+  schedule:
+  - cron: '0 0 * * *'
+
+jobs:
+  stale:
+
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+
+    steps:
+    - uses: actions/stale@v5
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        days-before-issue-stale: 15
+        days-before-pr-stale: 45
+        days-before-issue-close: 5
+        days-before-pr-close: 10
+        stale-issue-message: 'This issue is stale because it has been open 15 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
+        stale-pr-message: 'This PR is stale because it has been open 20 days with no activity. Remove stale label or comment or this will be closed in 10 days.'
+        close-issue-message: 'This issue was closed because it has been stalled for 5 days with no activity.'
+        close-pr-message: 'This PR was closed because it has been stalled for 10 days with no activity.'
+        stale-issue-label: 'no-issue-activity'
+        stale-pr-label: 'no-pr-activity'

README.md

@@ -15,17 +15,21 @@ Maybe this component works also with other Volvo cars. Please try out the native
 
 Home Assistant thread can be found [here](https://community.home-assistant.io/t/volvo2mqtt-connect-your-aaos-volvo/585699).
 
+If you like my work:<br>
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/U7U8MFXCF)
+
 ## Confirmed working with
 - XC40 BEV (2023)
 - XC40 BEV (2022)
 - XC40 PHEV (2021)
 - V60 T8 PHEV (2023)
-- C40 PHEV (2023)
-- C40 PHEV (2022)
+- C40 BEV (2023)
+- C40 BEV (2022)
 - XC90 T8 PHEV (2023)
 - XC60 PHEV (2023)
 - XC60 PHEV (2022)
 - XC90 PHEV T8 (2023)
+- XC90 PHEV T8 (2024)
 - V90 PHEV T8 (2019)*
 
 *only partly working
@@ -39,7 +43,7 @@ Please let me know if your car works with this addon so I can expand the list!<b
 - Sensor "Battery Charge Level"
 - Sensor "Electric Range"
 - Sensor "Charging System Status"
-- Sensor "Charging Connection Status"
+- Sensor "Charging Connection Status" (partly broken since 2.10 car update)
 - Sensor "Estimated Charging Finish Time"
 - Sensor "Door Lock Status (All doors, tank lid, and engine hood)"
 - Sensor "Window Lock Status (All windows and sunroof - Thanks to @navet)"

src/CHANGELOG.md

@@ -0,0 +1,104 @@
+## v1.7.9
+### 🚀 Features:
+
+- Added vehicle diagnostics sensors #75. Thanks to @aerrow5!
+
+## v1.7.8
+### 🐛 Bug Fixes:
+
+- Fix "Estimated Charging Finish Time" Sensor  
+
+## v1.7.7
+### 🚀 Features:
+
+- Added long term statistics for some sensors #68. Thanks to @bogdanbujdea!
+- Automatic redact sensitive data from debug log
+- Perpare for scheduler option (not yet ready)
+
+## v1.7.6
+### 🚀 Features:
+
+- Added support for interior and exterior images via the new [MQTT Image](https://www.home-assistant.io/integrations/image.mqtt/) entity. #62
+
+<b>NOTE: This feature is only available using homeassistant version 2023.7.1 or greater.</b>
+
+## v1.7.5
+### 🚀 Features:
+
+- Added support for `LOCKING` and `UNLOCKING` state (Lock entity)
+
+## v1.7.4
+### 🐛 Bug Fixes:
+
+- Fixed undocumented charging connection state `CONNECTION_STATUS_FAULT` '#57
+
+## v1.7.3
+### 🐛 Bug Fixes:
+
+- Fixed API changes from Volvo #53
+
+<b>ATTENTION: Volvo optimized their API. Maybe you have to set your odometer multiplier to 1. 
+Also check all the other multipliers!</b>
+## v1.7.2
+### 🐛 Bug Fixes:
+
+- Fixed "Engine State" can be "true" or "false", not "RUNNING" or "STOPPED" #47
+
+## v1.7.1
+### 🚀 Features:
+
+- Moved "Engine State" from "sensor" to the "binary_sensor" domain
+- Improved HA Add-On security level to 7
+
+<b>NOTE: The old "sensor" entity will be not deleted automatically. If you want to clean up your mqtt device, just delete it and restart the volvo2mqtt addon.
+</b>
+
+## v1.7.0
+### 🚀 Features:
+
+- Added MQTT autodiscovery for HA Add-On users
+- Added "Engine State" fallback endpoint for some cars (BEVs)
+- Added dynamic icons for "Engine State"
+- Turn off the pre-climate switch if "Engine State" changes to "RUNNING"
+
+<b>NOTE: The mqtt broker port is now a string. Just quote your port like this `port: "1883"`</b><br>
+<b>NOTE: If you want to switch to MQTT autodiscovery for the HA Add-On change your settings to: <br>
+![image](https://i.imgur.com/GBamhFn.png)</b>
+
+## v1.6.5
+### 🐛 Bug Fixes:
+
+- Fixed missing key in unit mappings for `en_US` and `en_GB` mapping
+
+## v1.6.4
+### 🚀 Features:
+
+- Added dynamic icons for lock, battery and window state #43 
+
+## v1.6.3
+### 🚀 Features:
+
+- Moved data source for "Distance to empty" from extended api to connected api
+
+## v1.6.2
+### 🚀 Features:
+
+- Moved print statements to logger
+- Added more debug logging
+- The full HA Addon log can now be found at your addon smb share `\\<Your HA IP>\addons\volvo2mqtt\log\volvo2mqtt.log`
+
+## v1.6.1
+### 🚀 Features:
+
+- Added "Washer Fluid Level" and "Distance to Empty" sensors #37 
+- Expanded climate control for better state sync with HA
+
+### 🐛 Bug Fixes:
+
+- Fixed wrong return values for not working endpoints
+- Fixed app crash on credential renewal timeout #39 
+
+## v1.6.0
+### 🚀 Features:
+
+- Added conversion from metric to imperial system for `en_US` and `en_GB` locale

src/config.yaml

@@ -1,10 +1,13 @@
 name: "Volvo2Mqtt"
 description: "Volvo AAOS MQTT bridge"
-version: "1.6.5"
+version: "1.7.9"
 slug: "volvo2mqtt"
 init: false
 url: "https://github.com/Dielee/volvo2mqtt"
 apparmor: true
+codenotary: notary@home-assistant.io
+services:
+  - 'mqtt:need'
 map: 
   - addons:rw
 options:
@@ -13,10 +16,10 @@ options:
   TZ: null
   debug: false
   mqtt:
-    broker: null
-    port: 1883
-    username: ""
-    password: ""
+    broker: "auto_broker"
+    port: "auto_port"
+    username: "auto_user"
+    password: "auto_password"
   volvoData:
     username: null
     password: null
@@ -32,7 +35,7 @@ schema:
   debug: bool
   mqtt:
     broker: str
-    port: int(1,)
+    port: str
     username: str?
     password: str?
   volvoData:

src/const.py

@@ -1,6 +1,6 @@
 from config import settings
 
-VERSION = "v1.6.5"
+VERSION = "v1.7.9"
 
 OAUTH_URL = "https://volvoid.eu.volvocars.com/as/token.oauth2"
 VEHICLES_URL = "https://api.volvocars.com/connected-vehicle/v1/vehicles"
@@ -19,6 +19,8 @@ ENGINE_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/
 BATTERY_CHARGE_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/battery-charge-level"
 FUEL_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/fuel"
 STATISTICS_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/statistics"
+ENGINE_DIAGNOSTICS_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/engine"
+VEHICLE_DIAGNOSTICS_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/diagnostics"
 
 units = {
             "en_GB": {
@@ -43,17 +45,20 @@ charging_system_states = {"CHARGING_SYSTEM_CHARGING": "Charging", "CHARGING_SYST
                           "CHARGING_SYSTEM_FAULT": "Fault", "CHARGING_SYSTEM_UNSPECIFIED": "Unspecified"}
 
 charging_connection_states = {"CONNECTION_STATUS_DISCONNECTED": "Disconnected", "CONNECTION_STATUS_UNSPECIFIED": "Unspecified",
-                              "CONNECTION_STATUS_CONNECTED_DC": "Connected DC", "CONNECTION_STATUS_CONNECTED_AC": "Connected AC"}
+                              "CONNECTION_STATUS_CONNECTED_DC": "Connected DC", "CONNECTION_STATUS_CONNECTED_AC": "Connected AC",
+                              "CONNECTION_STATUS_FAULT": "Fault"}
 
 window_states = {"CLOSED": "OFF", "OPEN": "ON"}
 door_states = {"CLOSED": "OFF", "OPEN": "ON"}
+engine_states = {"RUNNING": "ON", "STOPPED": "OFF", "true": "ON", "false": "OFF"}
 
 icon_states = {
-    "lock_status": {"UNLOCKED": "lock-open-alert", "LOCKED": "lock"},
+    "lock_status": {"UNLOCKED": "lock-open-alert", "LOCKED": "lock", "UNLOCKING": "lock-reset", "LOCKING": "lock-reset"},
     "door_front_left": {"ON": "car-door", "OFF": "car-door-lock"},
     "door_front_right": {"ON": "car-door", "OFF": "car-door-lock"},
     "door_rear_left": {"ON": "car-door", "OFF": "car-door-lock"},
     "door_rear_right": {"ON": "car-door", "OFF": "car-door-lock"},
+    "engine_state": {"ON": "engine-outline", "OFF": "engine-off-outline"},
     "battery_charge_level": [
                     {"from": 100, "to": 100, "icon": "battery"},
                     {"from": 99, "to": 90, "icon": "battery-90"},
@@ -70,15 +75,16 @@ icon_states = {
 }
 
 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 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": "Battery Charge Level", "domain": "sensor", "id": "battery_charge_level", "unit": "%", "icon": "car-battery", "url": RECHARGE_STATE_URL, "state_class": "measurement"},
+                        {"name": "Battery Charge Level", "domain": "sensor", "id": "battery_charge_level", "unit": "%", "icon": "car-battery", "url": BATTERY_CHARGE_STATE_URL, "state_class": "measurement"},
+                        {"name": "Electric Range", "domain": "sensor", "id": "electric_range", "unit": "km" if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["electric_range"]["unit"], "icon": "map-marker-distance", "url": RECHARGE_STATE_URL, "state_class": "measurement"},
+                        {"name": "Estimated Charging Time", "domain": "sensor", "id": "estimated_charging_time", "unit": "minutes", "icon": "timer-sync-outline", "url": RECHARGE_STATE_URL, "state_class": "measurement"},
                         {"name": "Charging System Status", "domain": "sensor", "id": "charging_system_status", "icon": "ev-station", "url": RECHARGE_STATE_URL},
                         {"name": "Charging Connection Status", "domain": "sensor", "id": "charging_connection_status", "icon": "ev-plug-ccs2", "url": RECHARGE_STATE_URL},
                         {"name": "Estimated Charging Finish Time", "domain": "sensor", "id": "estimated_charging_finish_time", "icon": "timer-sync-outline", "url": RECHARGE_STATE_URL},
-                        {"name": "Odometer", "domain": "sensor", "id": "odometer", "unit": "km" if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["odometer"]["unit"], "icon": "counter", "url": ODOMETER_STATE_URL},
+                        {"name": "Odometer", "domain": "sensor", "id": "odometer", "unit": "km" if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["odometer"]["unit"], "icon": "counter", "url": ODOMETER_STATE_URL, "state_class":"total_increasing"},
                         {"name": "Last Data Update", "domain": "sensor", "id": "last_data_update", "icon": "timer", "url": ""},
+                        {"name": "Active schedules", "domain": "sensor", "id": "active_schedules", "icon": "timer", "url": ""},
                         {"name": "Window Front Left", "domain": "binary_sensor", "device_class": "window", "id": "window_front_left", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
                         {"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": "binary_sensor", "device_class": "window", "id": "window_rear_left", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
@@ -99,9 +105,15 @@ supported_entities = [
                         {"name": "Tire Front Right", "domain": "sensor", "id": "tyre_front_right", "icon": "car-tire-alert", "url": TYRE_STATE_URL},
                         {"name": "Tire Rear Left", "domain": "sensor", "id": "tyre_rear_left", "icon": "car-tire-alert", "url": TYRE_STATE_URL},
                         {"name": "Tire Rear Right", "domain": "sensor", "id": "tyre_rear_right", "icon": "car-tire-alert", "url": TYRE_STATE_URL},
-                        {"name": "Engine State", "domain": "sensor", "id": "engine_state", "icon": "engine", "url": ENGINE_STATE_URL},
-                        {"name": "Fuel Level", "domain": "sensor", "id": "fuel_level", "unit": "liters", "icon": "fuel", "url": FUEL_STATE_URL},
+                        {"name": "Engine State", "domain": "binary_sensor", "device_class": "running", "id": "engine_state", "icon": "engine", "url": ENGINE_STATE_URL},
+                        {"name": "Engine State", "domain": "binary_sensor", "device_class": "running", "id": "engine_state", "icon": "engine", "url": ENGINE_DIAGNOSTICS_URL},
+                        {"name": "Fuel Level", "domain": "sensor", "id": "fuel_level", "unit": "liters", "icon": "fuel", "url": FUEL_STATE_URL, "state_class": "measurement"},
                         {"name": "Average Fuel Consumption", "domain": "sensor", "id": "average_fuel_consumption", "unit": "liters", "icon": "fuel", "url": STATISTICS_URL},
-                        {"name": "Distance to Empty", "domain": "sensor", "id": "distance_to_empty", "unit": "km" if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["distance_to_empty"]["unit"], "icon": "map-marker-distance", "url": STATISTICS_URL},
-                        {"name": "Average Speed", "domain": "sensor", "id": "average_speed", "unit": "km/h" if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["average_speed"]["unit"], "icon": "speedometer", "url": STATISTICS_URL}
+                        {"name": "Distance to Empty", "domain": "sensor", "id": "distance_to_empty", "unit": "km" if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["distance_to_empty"]["unit"], "icon": "map-marker-distance", "url": STATISTICS_URL, "state_class": "measurement"},
+                        {"name": "Average Speed", "domain": "sensor", "id": "average_speed", "unit": "km/h" if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["average_speed"]["unit"], "icon": "speedometer", "url": STATISTICS_URL, "state_class": "measurement"},
+                        {"name": "Hours to Service", "domain": "sensor", "id": "hours_to_service", "unit": "hour", "icon": "wrench-clock", "url": VEHICLE_DIAGNOSTICS_URL},
+                        {"name": "Distance to Service", "domain": "sensor", "id": "km_to_service", "unit": "km" if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["distance_to_service"]["unit"], "icon": "wrench-clock", "url": VEHICLE_DIAGNOSTICS_URL},
+                        {"name": "Months to Service", "domain": "sensor", "id": "months_to_service", "unit": "month", "icon": "wrench-clock", "url": VEHICLE_DIAGNOSTICS_URL},
+                        {"name": "Service warning status", "domain": "sensor", "id": "service_warning_status", "icon": "alert-outline", "url": VEHICLE_DIAGNOSTICS_URL},
+                        {"name": "Service warning trigger", "domain": "sensor", "id": "service_warning_trigger", "icon": "alert-outline", "url": VEHICLE_DIAGNOSTICS_URL}
 ]

src/main.py

@@ -2,11 +2,12 @@ import logging
 from volvo import authorize
 from mqtt import update_loop, connect
 from const import VERSION
-from util import set_tz, setup_logging
+from util import set_tz, setup_logging, set_mqtt_settings
 
 
 if __name__ == '__main__':
     set_tz()
+    set_mqtt_settings()
     setup_logging()
     logging.info("Starting volvo2mqtt version " + VERSION)
     authorize()

src/mqtt.py

@@ -17,8 +17,9 @@ subscribed_topics = []
 assumed_climate_state = {}
 last_data_update = None
 climate_timer = {}
-door_status = {}
+engine_status = {}
 devices = {}
+active_schedules = {}
 
 
 def connect():
@@ -42,6 +43,43 @@ def connect():
     mqtt_client = client
 
 
+def send_car_images(vin, data, device):
+    if util.keys_exists(data, "images"):
+        for entity in [{"name": "Exterior Image", "id": "exterior_image"},
+                       {"name": "Interior Image", "id": "interior_image"}]:
+            url_topic = f"homeassistant/image/{vin}_{entity['id']}/image_url"
+            config = {
+                "name": entity["name"],
+                "object_id": f"volvo_{vin}_{entity['id']}",
+                "schema": "state",
+                "icon": "mdi:image-area",
+                "url_topic": url_topic,
+                "device": device,
+                "unique_id": f"volvoAAOS2mqtt_{vin}_{entity['id']}",
+                "availability_topic": availability_topic
+            }
+
+            mqtt_client.publish(
+                f"homeassistant/image/volvoAAOS2mqtt/{vin}_{entity['id']}/config",
+                json.dumps(config),
+                retain=True
+            )
+
+            if entity["id"] == "exterior_image":
+                mqtt_client.publish(
+                    url_topic,
+                    data["images"]["exteriorDefaultUrl"],
+                    retain=True
+                )
+
+            if entity["id"] == "interior_image":
+                mqtt_client.publish(
+                    url_topic,
+                    data["images"]["interiorDefaultUrl"],
+                    retain=True
+                )
+
+
 def on_connect(client, userdata, flags, rc):
     send_heartbeat()
     if len(subscribed_topics) > 0:
@@ -62,52 +100,113 @@ def on_message(client, userdata, msg):
 
     payload = msg.payload.decode("UTF-8")
     if "climate_status" in msg.topic:
-        global assumed_climate_state, climate_timer, door_status
         if payload == "ON":
-            # Start the api call in another thread for HA performance
-            Thread(target=volvo.api_call, args=(CLIMATE_START_URL, "POST", vin)).start()
-
-            # 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()
+            start_climate(vin)
         elif payload == "OFF":
-            # Start the api call in another thread for HA performance
-            Thread(target=volvo.api_call, args=(CLIMATE_STOP_URL, "POST", vin)).start()
-
-            # 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()
+            stop_climate(vin)
     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"})
+            lock_car(vin)
         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"})
+            unlock_car(vin)
     elif "update_data" in msg.topic:
         if payload == "PRESS":
             update_car_data(True)
+    elif "schedule" in msg.topic:
+        try:
+            d = json.loads(payload)
+        except ValueError as e:
+            logging.error("Can't set timer. Error: " + str(e))
+            return None
+
+        if d["mode"] == "timer":
+            start_climate_timer(d, vin)
+        else:
+            logging.warning("No schedule mode found, doing nothing")
+
+
+def start_climate_timer(d, vin):
+    global active_schedules
+    try:
+        minute = int(d["start_time"].split(":")[1])
+        hour = int(d["start_time"].split(":")[0])
+        local_datetime = datetime.now(util.TZ)
+        start_datetime = local_datetime.replace(hour=hour, minute=minute, second=0)
+        timer_seconds = (start_datetime - local_datetime).total_seconds()
+    except Exception as e:
+        logging.error("Error creating climate timer: " + str(e))
+        return None
+
+    if timer_seconds > 0:
+        Timer(timer_seconds, activate_climate_timer, (vin, start_datetime.isoformat(), )).start()
+        active_schedules[vin]["timers"].append(start_datetime.isoformat())
+        logging.debug("Climate timer set to " + str(start_datetime))
+        update_car_data()
+    else:
+        logging.warning("Timer can not be set. Unusable start time entered")
+
+
+def unlock_car(vin):
+    # Start the api call in another thread for HA performance
+    Thread(target=volvo.api_call, args=(CAR_UNLOCK_URL, "POST", vin)).start()
+
+    # Force set unlocking state
+    update_car_data(False, {"entity_id": "lock_status", "vin": vin, "state": "UNLOCKING"})
+    # Fetch API lock state until unlocking finished
+    Thread(target=volvo.check_lock_status, args=(vin, "LOCKED")).start()
+
+
+def lock_car(vin):
+    # Start the api call in another thread for HA performance
+    Thread(target=volvo.api_call, args=(CAR_LOCK_URL, "POST", vin)).start()
+
+    # Force set locking state
+    update_car_data(False, {"entity_id": "lock_status", "vin": vin, "state": "LOCKING"})
+    # Fetch API lock state until locking finished
+    Thread(target=volvo.check_lock_status, args=(vin, "UNLOCKED")).start()
+
+
+def stop_climate(vin):
+    global assumed_climate_state, climate_timer, engine_status
+    # Start the api call in another thread for HA performance
+    Thread(target=volvo.api_call, args=(CLIMATE_STOP_URL, "POST", vin)).start()
+
+    # Stop door check thread if running
+    if engine_status[vin].is_alive():
+        engine_status[vin].do_run = False
+
+    # Stop climate timer if active
+    if climate_timer[vin].is_alive():
+        climate_timer[vin].cancel()
+
+    # Set and update switch status
+    assumed_climate_state[vin] = "OFF"
+    update_car_data()
+
+
+def activate_climate_timer(vin, start_time):
+    start_climate(vin)
+    active_schedules[vin]["timers"].remove(start_time)
+    update_car_data()
+
+
+def start_climate(vin):
+    global assumed_climate_state, climate_timer, engine_status
+    # Start the api call in another thread for HA performance
+    Thread(target=volvo.api_call, args=(CLIMATE_START_URL, "POST", vin)).start()
+
+    # Start door check thread to turn off climate if driver door is opened
+    check_engine_thread = Thread(target=volvo.check_engine_status, args=(vin,))
+    check_engine_thread.start()
+    engine_status[vin] = check_engine_thread
+
+    # Starting timer to disable climate after 30 mins
+    climate_timer[vin] = Timer(30 * 60, volvo.disable_climate, (vin,))
+    climate_timer[vin].start()
+
+    # Set and update switch status
+    assumed_climate_state[vin] = "ON"
+    update_car_data()
 
 
 def update_loop():
@@ -140,20 +239,22 @@ def update_car_data(force_update=False, overwrite={}):
                 state = assumed_climate_state[vin]
             elif entity["id"] == "last_data_update":
                 state = last_data_update
+            elif entity["id"] == "active_schedules":
+                state = active_schedules[vin]
             else:
                 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":
+            if entity["domain"] == "device_tracker" or entity["id"] == "active_schedules":
                 topic = f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/attributes"
             else:
                 topic = f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/state"
 
             mqtt_client.publish(
                 topic,
-                json.dumps(state) if isinstance(state, dict) else state
+                json.dumps(state) if isinstance(state, dict) or isinstance(state, list) else state
             )
             update_ha_device(entity, vin, state)
 
@@ -186,6 +287,9 @@ def update_ha_device(entity, vin, state):
     if entity.get("unit"):
         config["unit_of_measurement"] = entity["unit"]
 
+    if entity.get("state_class"):
+        config["state_class"] = entity["state_class"]
+        
     if entity.get("domain") == "device_tracker":
         config["json_attributes_topic"] = f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/attributes"
 
@@ -224,14 +328,18 @@ def create_ha_devices():
             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("state_class"):
+                config["state_class"] = entity["state_class"]
 
-            if entity.get("domain") in ["switch", "lock", "button"]:
+            if entity.get("domain") == "device_tracker" or entity.get("id") == "active_schedules":
+                config["json_attributes_topic"] = f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/attributes"
+            elif 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)
+            elif entity.get("domain") == "image":
+                config["url_topic"] = f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/image_url"
 
             mqtt_client.publish(
                 f"homeassistant/{entity['domain']}/volvoAAOS2mqtt/{vin}_{entity['id']}/config",

src/run.sh

@@ -1,4 +1,9 @@
-#!/bin/bash
+#!/command/with-contenv bashio
 export IS_HA_ADDON="true"
 
+export MQTTHOST=$(bashio::services mqtt "host")
+export MQTTPORT=$(bashio::services mqtt "port")
+export MQTTUSER=$(bashio::services mqtt "username")
+export MQTTPASS=$(bashio::services mqtt "password")
+
 python -u main.py

src/translations/en.yaml

@@ -10,10 +10,10 @@ configuration:
     description: Set your local timezone eg. "Europe/Berlin" or "America/New_York"
   debug:
     name: API debug mode
-    description: Enable Volvo API debug, normaly this can stay off
+    description: Enable Volvo API debug, normaly this can stay off. If enabled, the complete log file can be found under \\<Your HA Host IP>\addons\volvo2mqtt\log\volvo2mqtt.log.
   mqtt:
     name: MQTT Broker settings
-    description: Broker is your mqtt broker IP eg "192.168.0.1". Mqtt username and password are optional. Broker port can be changed. If no value is given, port 1883 will be used.
+    description: Leave the settings as they are if you are using the MQTT Mosquitto Addon. If not, take a look at the readme from volvo2mqtt.
   volvoData:
     name: Volvo 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. 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,7 +1,9 @@
 import logging
 import pytz
 import os
+import re
 import sys
+import config
 from logging import handlers
 from datetime import datetime
 from const import units
@@ -9,6 +11,21 @@ from config import settings
 from pathlib import Path
 
 TZ = None
+SENSITIVE_PATTERNS = [
+    r"[A-Z0-9]{17}",  # VIN
+    r"\d{1,2}\.\d{5,16}"  # Location
+]
+
+
+class SensitiveDataFilter(logging.Filter):
+    def __init__(self, patterns=None):
+        super().__init__()
+        self.patterns = patterns or []
+
+    def filter(self, record: logging.LogRecord) -> bool:
+        for pattern in self.patterns:
+            record.msg = re.sub(pattern, "<REDACTED>", record.msg)
+        return True
 
 
 def get_icon_between(icon_list, state):
@@ -31,6 +48,8 @@ def setup_logging():
         '%(asctime)s volvo2mqtt [%(process)d] - %(levelname)s: %(message)s',
         '%b %d %H:%M:%S')
     file_log_handler.setFormatter(formatter)
+    sensitive_data_filter = SensitiveDataFilter(SENSITIVE_PATTERNS)
+    file_log_handler.addFilter(sensitive_data_filter)
     logger = logging.getLogger()
 
     console_log_handler = logging.StreamHandler(sys.stdout)
@@ -38,6 +57,7 @@ def setup_logging():
 
     logger.addHandler(console_log_handler)
     logger.addHandler(file_log_handler)
+    logging.getLogger("urllib3").setLevel(logging.WARNING)
 
     logger.setLevel(logging.INFO)
     if "debug" in settings:
@@ -87,3 +107,28 @@ def convert_metric_values(value):
     else:
         return value
 
+
+def set_mqtt_settings():
+    if os.environ.get("IS_HA_ADDON"):
+        if config.settings["mqtt"]["broker"] != "auto_broker" \
+                or config.settings["mqtt"]["port"] != "auto_port" \
+                or config.settings["mqtt"]["username"] != "auto_user" \
+                or config.settings["mqtt"]["password"] != "auto_password":
+            # If settings were manually set, use the manually set settings
+            return None
+
+        broker_host = os.getenv("MQTTHOST", None)
+        broker_port = os.getenv("MQTTPORT", None)
+        broker_user = os.getenv("MQTTUSER", None)
+        broker_pass = os.getenv("MQTTPASS", None)
+
+        if not broker_host or not broker_port:
+            raise Exception("MQTT connection could not be established. Please check if your MQTT Add-On is running!")
+
+        logging.debug("MQTT Credentials - Host " + broker_host + " Port: " + str(broker_port) +
+                      " User: " + str(broker_user) + " Pass: " + str(broker_pass))
+
+        config.settings["mqtt"]["broker"] = broker_host
+        config.settings["mqtt"]["port"] = broker_port
+        config.settings["mqtt"]["username"] = broker_user
+        config.settings["mqtt"]["password"] = broker_pass

src/volvo.py

@@ -3,14 +3,14 @@ import requests
 import mqtt
 import util
 import time
-from threading import Thread, currentThread
+from threading import currentThread
 from datetime import datetime, timedelta
 from config import settings
 from babel.dates import format_datetime
 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, \
     WINDOWS_STATE_URL, LOCK_STATE_URL, TYRE_STATE_URL, supported_entities, BATTERY_CHARGE_STATE_URL, \
-    STATISTICS_URL, CLIMATE_STOP_URL
+    STATISTICS_URL, ENGINE_DIAGNOSTICS_URL, engine_states
 
 session = requests.Session()
 session.headers = {
@@ -111,6 +111,7 @@ def get_vehicles():
         raise Exception("No vehicle found, exiting application!")
     else:
         initialize_climate(vins)
+        initialize_scheduler(vins)
         logging.info("Vin: " + str(vins) + " found!")
 
 
@@ -125,6 +126,7 @@ def get_vehicle_details(vin):
             "model": data['descriptions']['model'],
             "name": f"{data['descriptions']['model']} ({data['modelYear']}) - {vin}",
         }
+        mqtt.send_car_images(vin, data, device)
     elif response.status_code == 500 and not settings.volvoData["vin"]:
         # Workaround for some cars that are not returning vehicle details
         device = {
@@ -150,6 +152,11 @@ def check_supported_endpoints():
                 # If battery charge level could be found in recharge-api, skip the second battery charge sensor
                 continue
 
+            if entity["id"] == "engine_state" and entity["url"] == ENGINE_DIAGNOSTICS_URL \
+                    and any("engine_state" in d["id"] for d in supported_endpoints[vin]):
+                # If engine state could be found in engine state endpoint, skip the second engine running sensor
+                continue
+
             if entity.get('url'):
                 state = api_call(entity["url"], "GET", vin, entity["id"])
             else:
@@ -162,6 +169,12 @@ def check_supported_endpoints():
                 logging.info("Failed, " + entity["name"] + " is unfortunately not supported by your vehicle.")
 
 
+def initialize_scheduler(vins):
+    for vin in vins:
+        mqtt.active_schedules[vin] = {"timers": []}
+        mqtt.subscribed_topics = [f"homeassistant/schedule/{vin}/command"]
+
+
 def initialize_climate(vins):
     for vin in vins:
         mqtt.assumed_climate_state[vin] = "OFF"
@@ -169,18 +182,41 @@ def initialize_climate(vins):
 
 def disable_climate(vin):
     logging.info("Turning climate off by timer!")
-    mqtt.door_status[vin].do_run = False
+    mqtt.engine_status[vin].do_run = False
     mqtt.assumed_climate_state[vin] = "OFF"
     mqtt.update_car_data()
 
 
-def check_door_status(vin):
+def check_lock_status(vin, old_state):
+    max_runs = 10
+    done_runs = 0
+    lock_state = api_call(LOCK_STATE_URL, "GET", vin, "lock_status", True)
+    while lock_state == old_state:
+        done_runs = done_runs + 1
+        if done_runs >= max_runs:
+            break
+        lock_state = api_call(LOCK_STATE_URL, "GET", vin, "lock_status", True)
+        time.sleep(2)
+
+    mqtt.update_car_data()
+
+
+def check_engine_status(vin):
+    endpoint_url = ""
+    engine_state_supported = False
+    for endpoint in supported_endpoints[vin]:
+        if "engine_state" == endpoint["id"]:
+            engine_state_supported = True
+            endpoint_url = endpoint["url"]
+
+    if not engine_state_supported:
+        # Exit thread as engine state is unsupported by car
+        return None
+
     t = currentThread()
     while getattr(t, "do_run", True):
-        lock_door_left = api_call(LOCK_STATE_URL, "GET", vin, "door_front_left", True)
-        lock_door_right = api_call(LOCK_STATE_URL, "GET", vin, "door_front_right", True)
-        if lock_door_left == "ON" or lock_door_right == "ON":
-            Thread(target=api_call, args=(CLIMATE_STOP_URL, "POST", vin)).start()
+        engine_state = api_call(endpoint_url, "GET", vin, "engine_state", True)
+        if engine_state == "ON":
             mqtt.assumed_climate_state[vin] = "OFF"
             mqtt.update_car_data()
             break
@@ -192,7 +228,8 @@ def api_call(url, method, vin, sensor_id=None, force_update=False):
     if datetime.now(util.TZ) >= token_expires_at:
         refresh_auth()
 
-    if url in [RECHARGE_STATE_URL, WINDOWS_STATE_URL, LOCK_STATE_URL, TYRE_STATE_URL, STATISTICS_URL]:
+    if url in [RECHARGE_STATE_URL, WINDOWS_STATE_URL, LOCK_STATE_URL, TYRE_STATE_URL,
+               STATISTICS_URL, ENGINE_DIAGNOSTICS_URL]:
         # Minimize API calls for endpoints with multiple values
         response = cached_request(url, method, vin, force_update)
         if response is None:
@@ -253,7 +290,7 @@ def cached_request(url, method, vin, force_update=False):
         if (datetime.now(util.TZ) - cached_requests[vin + "_" + url]["last_update"]).total_seconds() \
                 >= settings["updateInterval"] or (force_update and
                                                   (datetime.now(util.TZ) - cached_requests[vin + "_" + url]
-                                                      ["last_update"]).total_seconds() >= 2):
+                                                  ["last_update"]).total_seconds() >= 2):
             # Old Data in Cache, or force mode active, updating
             logging.debug("Starting " + method + " call against " + url)
             try:
@@ -352,10 +389,10 @@ def parse_api_data(data, sensor_id=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
+        return engine_states[data["engineRunning"]["value"]] if util.keys_exists(data, "engineRunning") else None
     elif sensor_id == "fuel_level":
         if util.keys_exists(data, "fuelAmount"):
-            fuel_amount = int(data["fuelAmount"]["value"])
+            fuel_amount = float(data["fuelAmount"]["value"])
             if fuel_amount > 0:
                 return fuel_amount
         return None
@@ -374,7 +411,7 @@ def parse_api_data(data, sensor_id=None):
         return None
     elif sensor_id == "average_speed":
         if util.keys_exists(data, "averageSpeed"):
-            average_speed = int(data["averageSpeed"]["value"])
+            average_speed = float(data["averageSpeed"]["value"])
             if average_speed > 1:
                 divider = 1
                 if util.keys_exists(settings["volvoData"], "averageSpeedDivider"):
@@ -400,5 +437,19 @@ def parse_api_data(data, sensor_id=None):
             if distance_to_empty > 0:
                 return util.convert_metric_values(data["distanceToEmpty"]["value"])
         return None
+    elif sensor_id == "hours_to_service":
+        return data["engineHoursToService"]["value"] if util.keys_exists(data, "engineHoursToService") else None
+    elif sensor_id == "km_to_service":
+        if util.keys_exists(data, "kmToService"):
+            km_to_service = int(data["kmToService"]["value"])
+            if km_to_service > 0:
+                return util.convert_metric_values(data["kmToService"]["value"])
+        return None
+    elif sensor_id == "months_to_service":
+        return data["monthsToService"]["value"] if util.keys_exists(data, "monthsToService") else None
+    elif sensor_id == "service_warning_status":
+        return data["serviceWarningStatus"]["value"] if util.keys_exists(data, "serviceWarningStatus") else None
+    elif sensor_id == "service_warning_trigger":
+        return data["serviceWarningTrigger"]["value"] if util.keys_exists(data, "serviceWarningTrigger") else None
     else:
         return None