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>

README.md

@@ -29,6 +29,7 @@ If you like my work:<br>
 - XC60 PHEV (2023)
 - XC60 PHEV (2022)
 - XC90 PHEV T8 (2023)
+- XC90 PHEV T8 (2024)
 - V90 PHEV T8 (2019)*
 
 *only partly working

src/CHANGELOG.md

@@ -1,3 +1,20 @@
+## 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:
 

src/config.yaml

@@ -1,6 +1,6 @@
 name: "Volvo2Mqtt"
 description: "Volvo AAOS MQTT bridge"
-version: "1.7.6"
+version: "1.7.9"
 slug: "volvo2mqtt"
 init: false
 url: "https://github.com/Dielee/volvo2mqtt"

src/const.py

@@ -1,6 +1,6 @@
 from config import settings
 
-VERSION = "v1.7.6"
+VERSION = "v1.7.9"
 
 OAUTH_URL = "https://volvoid.eu.volvocars.com/as/token.oauth2"
 VEHICLES_URL = "https://api.volvocars.com/connected-vehicle/v1/vehicles"
@@ -20,6 +20,7 @@ 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"
 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": {
@@ -74,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},
@@ -105,8 +107,13 @@ supported_entities = [
                         {"name": "Tire Rear Right", "domain": "sensor", "id": "tyre_rear_right", "icon": "car-tire-alert", "url": TYRE_STATE_URL},
                         {"name": "Engine State", "domain": "binary_sensor", "device_class": "running", "id": "engine_state", "icon": "engine", "url": ENGINE_STATE_URL},
                         {"name": "Engine State", "domain": "binary_sensor", "device_class": "running", "id": "engine_state", "icon": "engine", "url": ENGINE_DIAGNOSTICS_URL},
-                        {"name": "Fuel Level", "domain": "sensor", "id": "fuel_level", "unit": "liters", "icon": "fuel", "url": FUEL_STATE_URL},
+                        {"name": "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/mqtt.py

@@ -19,6 +19,7 @@ last_data_update = None
 climate_timer = {}
 engine_status = {}
 devices = {}
+active_schedules = {}
 
 
 def connect():
@@ -99,58 +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, engine_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
-            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()
+            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 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()
+            stop_climate(vin)
     elif "lock_status" in msg.topic:
         if payload == "LOCK":
-            # 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()
+            lock_car(vin)
         elif payload == "UNLOCK":
-            # 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()
+            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():
@@ -183,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)
 
@@ -229,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"
 
@@ -267,7 +328,10 @@ def create_ha_devices():
             if entity.get("unit"):
                 config["unit_of_measurement"] = entity["unit"]
 
-            if entity.get("domain") == "device_tracker":
+            if entity.get("state_class"):
+                config["state_class"] = entity["state_class"]
+
+            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"

src/util.py

@@ -1,6 +1,7 @@
 import logging
 import pytz
 import os
+import re
 import sys
 import config
 from logging import handlers
@@ -10,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):
@@ -32,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)
@@ -39,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:

src/volvo.py

@@ -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!")
 
 
@@ -168,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"
@@ -221,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:
@@ -429,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