Rename engine runtime sensor

* Catch Volvo API not returning a valid json string #104

* Update changelog

README.md

@@ -19,6 +19,7 @@ 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 (2024)
 - XC40 BEV (2023)
 - XC40 BEV (2022)
 - XC40 PHEV (2021)
@@ -26,9 +27,12 @@ If you like my work:<br>
 - C40 BEV (2023)
 - C40 BEV (2022)
 - XC90 T8 PHEV (2023)
+- XC60 PHEV (2024)
 - XC60 PHEV (2023)
 - XC60 PHEV (2022)
 - XC90 PHEV T8 (2023)
+- XC90 PHEV T8 (2024)
+- XC90 B5 Mildhybrid (2024)
 - V90 PHEV T8 (2019)*
 
 *only partly working
@@ -42,7 +46,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)"
@@ -52,6 +56,12 @@ Please let me know if your car works with this addon so I can expand the list!<b
 - Sensor "Fuel Status"
 - Sensor "Average Fuel Consumption"
 - Sensor "Average Speed"
+- Sensor "Distance to Empty"
+- Sensor "Hours to Service"
+- Sensor "Distance to Service"
+- Sensor "Months to Service"
+- Sensor "Service warning status"
+- Sensor "Service warning trigger"
 - Car Device Tracker
 - Multiple cars
 
@@ -63,7 +73,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, "averageSpeedDivider": 1, "averageFuelConsumptionMultiplier": 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": ["key1", "key2"], "odometerMultiplier": 1, "averageSpeedDivider": 1, "averageFuelConsumptionMultiplier": 1}' -e TZ='Europe/Berlin' --name volvo2mqtt ghcr.io/dielee/volvo2mqtt:latest`
 
 <b>HA Add-On:</b><br>
 
@@ -82,81 +92,13 @@ Here is what every option means:
 | `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`    | `vccapikey`                           | **required** | VCCAPIKEY linked with your volvo developer account. Get your Vccapi key from [here](https://developer.volvocars.com/account/). <b>Starting version 1.8.0, it is possible to define multiple keys, like this: `["vccapikey1", "vccapikey2", "vccapikey3", "etc..."]`</b>
 | `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>
-  <summary>Show me more!</summary><blockquote>
-  <br>
-    
-  ![alt text](https://raw.githubusercontent.com/Dielee/volvo2mqtt/main/img/lovelace_sample.png)<br>
-    
-  <details>
-  <summary>Lovelace card sample</summary>
-        		
-  ```
-   type: vertical-stack
-   title: Autostatus
-   cards:
-     - type: custom:vertical-stack-in-card
-       cards:
-         - type: custom:mushroom-lock-card
-           entity: lock.volvo_<your vin>_lock_status
-           name: Verrigelungsstatus
-         - type: horizontal-stack
-           cards:
-             - type: custom:mushroom-entity-card
-               entity: sensor.volvo_<your vin>_electric_range
-               name: Reichweite
-               layout: vertical
-             - type: custom:mushroom-entity-card
-               entity: sensor.volvo_<your vin>_battery_charge_level
-               name: Batteriestatus
-               layout: vertical
-             - type: custom:mushroom-entity-card
-               entity: sensor.volvo_<your vin>_estimated_charging_time
-               layout: vertical
-               name: Ladezeit
-         - type: horizontal-stack
-           cards:
-             - type: custom:mushroom-entity-card
-               entity: switch.volvo_<your vin>_climate_status
-               tap_action:
-                 action: toggle
-               layout: vertical
-               name: Klimatisieren/Heizen
-             - type: custom:mushroom-template-card
-               primary: Daten aktualisieren
-               secondary: '{{ states(''sensor.volvo_<your vin>_last_data_update'')}}'
-               icon: mdi:update
-               layout: vertical
-               entity: button.volvo_<your vin>_update_data
-         - type: conditional
-           conditions:
-             - entity: sensor.volvo_<your vin>_estimated_charging_time
-               state_not: '0'
-           card:
-             type: custom:mushroom-entity-card
-             entity: sensor.volvo_<your vin>_estimated_charging_finish_time
-             name: Ladung vorraussichtlich abgeschlossen
-             show_name: true
-         - type: map
-           entities:
-             - entity: device_tracker.volvo_<your vin>_location
-           default_zoom: 16
-           dark_mode: false
-           hours_to_show: 0
-           auto_fit: true
-           aspect_ratio: '16:9'
-  ```
-
-</details>
-</blockquote></details>
 
 
 [aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg

src/CHANGELOG.md

@@ -1,3 +1,184 @@
+## v1.9.0
+### 🚀 Features:
+
+- Add check for supported commands
+- Add Engine start/stop and Engine runtime minutes for supported cars
+
+## v1.8.19
+### 🐛 Bug Fixes:
+
+- Fix Estimated Charging Time not changing to zero #133 
+
+## v1.8.18
+### 🐛 Bug Fixes:
+
+- Fix Backend State Sensor returning `null`
+
+## v1.8.17
+### 🚀 Features:
+
+- Move vehicle and vehicle details to v2 endpoint
+
+### 🐛 Bug Fixes:
+
+- Fix Battery Charge Level icon update
+
+## v1.8.16
+### 🚀 Features:
+
+- Add `Average energy consumption`, `Distance to empty battery` and `Washer fluid level` sensors
+- Support force update for `Backend state` Sensor
+- Use cached requests for fuel endpoint
+
+## v1.8.15
+### 🚀 Features:
+
+- Move `batteryChargeLevel` to the new v2 fuel endpoint
+- Add api backend status sensor
+
+## v1.8.14
+### 🐛 Bug Fixes:
+
+- Fix distance to empty sensor #127
+- Remove unused service warning trigger sensor
+
+## v1.8.13
+### 🐛 Bug Fixes:
+
+- Add "Time to Service" sensor #125<p>
+  <b>Breaking change: The "Months to Service" sensor will be automatically deleted.<br>
+  "Time to Service" contains this information now.
+
+## v1.8.12
+### 🐛 Bug Fixes:
+
+- Fix `AJAR` state for windows
+- Fix deprecation from `currentThread` to `current_thread`
+
+## v1.8.11
+### 🐛 Bug Fixes:
+
+- Remove old code from checks for running engine sensor
+- Move battery charge level sensor from v2 to v1, as v2 returns 404
+
+## v1.8.10
+### 🐛 Bug Fixes:
+
+- Add `AJAR` state for sunroof #123
+
+## v1.8.9
+### 🐛 Bug Fixes:
+
+- Fix api changes from volvo #121
+
+## v1.8.8
+### 🐛 Bug Fixes:
+
+- Fix json decode error, if volvo API returns a simple string #104
+
+## v1.8.7
+### 🚀 Features:
+
+- Add option to disable log completely #96 
+
+### 🐛 Bug Fixes:
+
+- Fix regex error for some mailaddresses #97
+
+## v1.8.6
+### 🚀 Features:
+
+- Add option to use multiple docker containers (with different logins) #93
+
+## v1.8.5
+### 🚀 Features:
+
+- Allow phone number as username #91
+
+## v1.8.4
+### 🚀 Features:
+
+- Optimize Addon configuration #90
+
+## v1.8.3
+### 🚀 Features:
+
+- Add `device_class: battery` for battery state sensors from BEV and PHEV 
+
+## v1.8.2
+### 🚀 Features:
+
+- Add `updateInterval` limit to prevent abuse (60 Seconds)
+- Add `vccapikey` limit to prevent abuse (3 Keys)
+- Optimize vcc api key change behaviour
+
+## v1.8.1
+### 🐛 Bug Fixes:
+
+- Fix app crash if `debug` is not set #86
+
+## v1.8.0
+### 🚀 Features:
+
+- <b>Breaking change: The `vccapikey` setting is now a list. It is possible to
+  add multiple VCCAPIKEYs. This will be helpful if you are extending your 10.000 call limit sometimes.
+  Change your vccapikey config like this:
+  
+  Old:
+  ```
+    "vccapikey": "vccapikey1" 
+  ```
+
+  New:
+  ```
+    vccapikey:
+      - vccapikey1
+      - vccapikey2
+      - vccapikey3
+      - etc.
+  ```
+  More information about this feature [here](https://github.com/Dielee/volvo2mqtt/issues/84).
+    </b>
+
+## v1.7.10
+### 🐛 Bug Fixes:
+
+- Fix application startup if using `en_US` or `en_GB` as locale
+
+## 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:
 

src/apparmor.txt

@@ -4,8 +4,10 @@ profile volvo2mqtt flags=(attach_disconnected,mediate_deleted) {
   #include <abstractions/base>
 
   # Capabilities
+  capability,
   file,
   signal (send) set=(kill,term,int,hup,cont),
+  network,
 
   # S6-Overlay
   /init ix,

src/config.yaml

@@ -1,6 +1,6 @@
 name: "Volvo2Mqtt"
 description: "Volvo AAOS MQTT bridge"
-version: "1.7.3"
+version: "1.9.0"
 slug: "volvo2mqtt"
 init: false
 url: "https://github.com/Dielee/volvo2mqtt"
@@ -15,6 +15,7 @@ options:
   babelLocale: null
   TZ: null
   debug: false
+  disable_logging: false
   mqtt:
     broker: "auto_broker"
     port: "auto_port"
@@ -24,25 +25,28 @@ options:
     username: null
     password: null
     vin: ""
-    vccapikey: null
+    vccapikey:
+        - null
     odometerMultiplier: 1
     averageSpeedDivider: 1
     averageFuelConsumptionMultiplier: 1
 schema:
-  updateInterval: int(10,)
+  updateInterval: int(60,)
   babelLocale: str
-  TZ: str
+  TZ: match(^.+/.+$)
   debug: bool
+  disable_logging: bool
   mqtt:
     broker: str
     port: str
     username: str?
     password: str?
   volvoData:
-    username: str
+    username: match(^([a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+)|(\+\d{5,20})$)
     password: str
     vin: str?
-    vccapikey: str
+    vccapikey:
+        - match(^\b\w{32}\b$)
     odometerMultiplier: int(1,)
     averageSpeedDivider: int(1,)
     averageFuelConsumptionMultiplier: int(1,)

src/const.py

@@ -1,10 +1,10 @@
 from config import settings
 
-VERSION = "v1.7.3"
+VERSION = "v1.9.0"
 
 OAUTH_URL = "https://volvoid.eu.volvocars.com/as/token.oauth2"
-VEHICLES_URL = "https://api.volvocars.com/connected-vehicle/v1/vehicles"
-VEHICLE_DETAILS_URL = "https://api.volvocars.com/connected-vehicle/v1/vehicles/{0}"
+VEHICLES_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles"
+VEHICLE_DETAILS_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}"
 WINDOWS_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/windows"
 CLIMATE_START_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/commands/climatization-start"
 CLIMATE_STOP_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/commands/climatization-stop"
@@ -16,10 +16,14 @@ ODOMETER_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0
 LOCATION_STATE_URL = "https://api.volvocars.com/location/v1/vehicles/{0}/location"
 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"
+FUEL_BATTERY_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"
+API_BACKEND_STATUS_URL = "https://oip-dev-bff.euwest1.production.volvo.care/api/v1/backend-status"
+SUPPORTED_COMMANDS_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/commands"
+ENGINE_START_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/commands/engine-start"
+ENGINE_STOP_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/commands/engine-stop"
 
 units = {
             "en_GB": {
@@ -27,14 +31,16 @@ units = {
                 "electric_range": {"unit": "mi"},
                 "odometer": {"unit": "mi"},
                 "average_speed": {"unit": "mph"},
-                "distance_to_empty": {"unit": "mi"}
+                "distance_to_empty": {"unit": "mi"},
+                "distance_to_service": {"unit": "mi"}
             },
             "en_US": {
                 "divider": 1.60934,
                 "electric_range": {"unit": "mi"},
                 "odometer": {"unit": "mi"},
                 "average_speed": {"unit": "mph"},
-                "distance_to_empty": {"unit": "mi"}
+                "distance_to_empty": {"unit": "mi"},
+                "distance_to_service": {"unit": "mi"}
             }
         }
 
@@ -44,14 +50,15 @@ 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"}
+window_states = {"CLOSED": "OFF", "OPEN": "ON", "AJAR": "ON"}
+door_states = {"CLOSED": "OFF", "OPEN": "ON", "UNSPECIFIED": "UNKNOWN", "AJAR": "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"},
@@ -73,15 +80,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", "device_class": "battery", "id": "battery_charge_level", "unit": "%", "icon": "car-battery", "url": RECHARGE_STATE_URL, "state_class": "measurement"},
+                        {"name": "Battery Charge Level", "domain": "sensor", "device_class": "battery", "id": "battery_charge_level", "unit": "%", "icon": "car-battery", "url": FUEL_BATTERY_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},
@@ -94,18 +102,29 @@ supported_entities = [
                         {"name": "Engine Hood", "domain": "binary_sensor", "device_class": "door", "id": "engine_hood", "icon": "car-door-lock", "url": LOCK_STATE_URL},
                         {"name": "Tank Lid", "domain": "binary_sensor", "device_class": "door", "id": "tank_lid", "icon": "car-door-lock", "url": LOCK_STATE_URL},
                         {"name": "Sunroof", "domain": "binary_sensor", "device_class": "door", "id": "sunroof", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
-                        {"name": "Air Conditioning", "domain": "switch", "id": "climate_status", "icon": "air-conditioner"},
-                        {"name": "Lock state", "domain": "lock", "id": "lock_status", "icon": "lock", "url": LOCK_STATE_URL},
+                        {"name": "Air Conditioning", "domain": "switch", "id": "climate_status", "icon": "air-conditioner", "commands": ["CLIMATIZATION_START", "CLIMATIZATION_STOP"]},
+                        {"name": "Engine State", "domain": "switch", "id": "engine_state", "icon": "engine", "url": ENGINE_STATE_URL ,"commands": ["ENGINE_START", "ENGINE_STOP"]},
+                        {"name": "Leave in", "domain": "number", "id": "engine_runtime", "unit": "minutes", "icon": "timer-sand", "commands": ["ENGINE_START", "ENGINE_STOP"], "min": 1, "max": 15, "mode": "box"},
+                        {"name": "Engine State", "domain": "binary_sensor", "device_class": "running", "id": "engine_state", "icon": "engine", "url": ENGINE_STATE_URL},
+                        {"name": "Lock state", "domain": "lock", "id": "lock_status", "icon": "lock", "url": LOCK_STATE_URL, "commands": ["LOCK", "UNLOCK"]},
                         {"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": "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": "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_BATTERY_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": "Average Energy Consumption", "domain": "sensor", "id": "average_energy_consumption", "unit": "kwh", "icon": "car-electric", "url": STATISTICS_URL},
+                        {"name": "Distance to Empty Tank", "domain": "sensor", "id": "distance_to_empty_tank", "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": "Distance to Empty Battery", "domain": "sensor", "id": "distance_to_empty_battery", "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": "Time to Service", "domain": "sensor", "id": "time_to_service", "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": "Washer Fluid Level warning", "domain": "sensor", "id": "washer_fluid_warning", "icon": "alert-outline", "url": VEHICLE_DIAGNOSTICS_URL},
+                        {"name": "API Backend status", "domain": "sensor", "id": "api_backend_status", "icon": "alert"}
 ]
+
+old_entity_ids = ["months_to_service", "service_warning_trigger", "distance_to_empty"]

src/main.py

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

src/mqtt.py

@@ -4,13 +4,13 @@ import paho.mqtt.client as mqtt
 import json
 import volvo
 import util
+import os
 from threading import Thread, Timer
 from datetime import datetime
 from babel.dates import format_datetime
 from config import settings
 from const import CLIMATE_START_URL, CLIMATE_STOP_URL, CAR_LOCK_URL, \
-            CAR_UNLOCK_URL, availability_topic, icon_states
-
+    CAR_UNLOCK_URL, ENGINE_START_URL, ENGINE_STOP_URL, availability_topic, icon_states, old_entity_ids
 
 mqtt_client: mqtt.Client
 subscribed_topics = []
@@ -19,10 +19,14 @@ last_data_update = None
 climate_timer = {}
 engine_status = {}
 devices = {}
+active_schedules = {}
+engine_runtime = 1
 
 
 def connect():
-    client = mqtt.Client("volvoAAOS2mqtt")
+    client = mqtt.Client("volvoAAOS2mqtt") if os.environ.get("IS_HA_ADDON") \
+        else mqtt.Client("volvoAAOS2mqtt_" + settings.volvoData["username"].replace("+", ""))
+
     client.will_set(availability_topic, "offline", 0, False)
     if settings["mqtt"]["username"] and settings["mqtt"]["password"]:
         client.username_pw_set(settings["mqtt"]["username"], settings["mqtt"]["password"])
@@ -42,6 +46,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"]["exteriorImageUrl"],
+                    retain=True
+                )
+
+            if entity["id"] == "interior_image":
+                mqtt_client.publish(
+                    url_topic,
+                    data["images"]["internalImageUrl"],
+                    retain=True
+                )
+
+
 def on_connect(client, userdata, flags, rc):
     send_heartbeat()
     if len(subscribed_topics) > 0:
@@ -49,7 +90,7 @@ def on_connect(client, userdata, flags, rc):
             mqtt_client.subscribe(topic)
 
 
-def on_disconnect(client, userdata,  rc):
+def on_disconnect(client, userdata, rc):
     logging.warning("MQTT disconnected, reconnecting automatically")
 
 
@@ -62,52 +103,139 @@ 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":
-            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 "engine_runtime" in msg.topic:
+        global engine_runtime
+        engine_runtime = int(payload)
+        logging.debug("Updated engine runtime to " + str(engine_runtime) + " minutes!")
+    elif "engine_state" in msg.topic:
+        if payload == "ON":
+            start_engine(vin)
+        elif payload == "OFF":
+            stop_engine(vin)
+    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 start_engine(vin):
+    body = {"runtimeMinutes": engine_runtime}
+    # Start the api call in another thread for HA performance
+    Thread(target=volvo.api_call, args=(ENGINE_START_URL, "POST", vin, None, None, None, body)).start()
+
+    # Set and update switch status
+    update_car_data(False, {"entity_id": "engine_state", "vin": vin, "state": "ON"})
+
+
+def stop_engine(vin):
+    # Start the api call in another thread for HA performance
+    Thread(target=volvo.api_call, args=(ENGINE_STOP_URL, "POST", vin)).start()
+
+    # Set and update switch status
+    update_car_data(False, {"entity_id": "engine_state", "vin": vin, "state": "OFF"})
 
 
 def update_loop():
@@ -125,7 +253,7 @@ def update_car_data(force_update=False, overwrite={}):
     last_data_update = format_datetime(datetime.now(util.TZ), format="medium", locale=settings["babelLocale"])
     for vin in volvo.vins:
         for entity in volvo.supported_endpoints[vin]:
-            if entity["domain"] == "button":
+            if entity["domain"] in ["button", "number"]:
                 continue
 
             ov_entity_id = ""
@@ -140,28 +268,39 @@ 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]
+            elif entity["id"] == "api_backend_status":
+                if force_update:
+                    state = volvo.get_backend_status()
+                else:
+                    state = volvo.backend_status
             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
-            )
-            update_ha_device(entity, vin, state)
+            if state or state == 0:
+                mqtt_client.publish(
+                    topic,
+                    json.dumps(state) if isinstance(state, dict) or isinstance(state, list) 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():
+        logging.debug("Entity " + entity["id"] + " state " + str(state))
+        if isinstance(state, float):
+            icon = util.get_icon_between(icon_config, state)
+        elif state.replace(".", "").isnumeric():
             state = float(state)
             icon = util.get_icon_between(icon_config, state)
         else:
@@ -186,6 +325,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"
 
@@ -209,30 +351,40 @@ def create_ha_devices():
         devices[vin] = device
         for entity in volvo.supported_endpoints[vin]:
             config = {
-                        "name": entity['name'],
-                        "object_id": f"volvo_{vin}_{entity['id']}",
-                        "schema": "state",
-                        "icon": f"mdi:{entity['icon']}",
-                        "state_topic": f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/state",
-                        "device": device,
-                        "unique_id": f"volvoAAOS2mqtt_{vin}_{entity['id']}",
-                        "availability_topic": availability_topic
-                    }
+                "name": entity['name'],
+                "object_id": f"volvo_{vin}_{entity['id']}",
+                "schema": "state",
+                "icon": f"mdi:{entity['icon']}",
+                "state_topic": f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/state",
+                "device": device,
+                "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("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", "number"]:
                 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)
 
+                if entity["domain"] == "number":
+                    config["min"] = entity["min"]
+                    config["max"] = entity["max"]
+                    config["mode"] = entity["mode"]
+
+            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",
                 json.dumps(config),
@@ -244,3 +396,14 @@ def create_ha_devices():
 
 def send_heartbeat():
     mqtt_client.publish(availability_topic, "online")
+
+
+def send_offline():
+    mqtt_client.publish(availability_topic, "offline")
+
+
+def delete_old_entities():
+    for vin in volvo.vins:
+        for entity in old_entity_ids:
+            topic = f"homeassistant/sensor/volvoAAOS2mqtt/{vin}_{entity}/config"
+            mqtt_client.publish(topic, payload="", retain=True)

src/settings.json

@@ -2,6 +2,8 @@
   "updateInterval": 300,
   "babelLocale": "de",
   "TZ": "Europe/Berlin",
+  "debug": false,
+  "disable_logging": false,
   "mqtt": {
     "broker": "",
     "port": 1883,
@@ -12,7 +14,7 @@
     "username": "",
     "password": "",
     "vin": "",
-	"vccapikey": "",
+	"vccapikey": [],
     "odometerMultiplier": "",
     "averageSpeedDivider": "",
     "averageFuelConsumptionMultiplier": ""

src/translations/en.yaml

@@ -11,9 +11,12 @@ configuration:
   debug:
     name: API debug mode
     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.
+  disable_logging:
+    name: Disable logging
+    description: Disable logging completely to reduce IO and SD card access.
   mqtt:
     name: MQTT Broker settings
     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!
+    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. This setting works as list, so it is possible to define multiple VCCAPI keys. 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,6 +1,7 @@
 import logging
 import pytz
 import os
+import re
 import sys
 import config
 from logging import handlers
@@ -10,6 +11,22 @@ 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
+    r"[a-z0-9]{32}"  # VCCAPIKEY
+]
+
+
+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,19 +49,29 @@ def setup_logging():
         '%(asctime)s volvo2mqtt [%(process)d] - %(levelname)s: %(message)s',
         '%b %d %H:%M:%S')
     file_log_handler.setFormatter(formatter)
-    logger = logging.getLogger()
+
+    if "debug" in settings:
+        if settings["debug"]:
+            sensitive_data_filter = SensitiveDataFilter(SENSITIVE_PATTERNS)
+            file_log_handler.addFilter(sensitive_data_filter)
 
     console_log_handler = logging.StreamHandler(sys.stdout)
     console_log_handler.setFormatter(formatter)
 
+    logger = logging.getLogger()
     logger.addHandler(console_log_handler)
     logger.addHandler(file_log_handler)
+    logging.getLogger("urllib3").setLevel(logging.WARNING)
 
     logger.setLevel(logging.INFO)
     if "debug" in settings:
         if settings["debug"]:
             logger.setLevel(logging.DEBUG)
 
+    if "disable_logging" in settings:
+        if settings["disable_logging"]:
+            logger.setLevel(logging.ERROR)
+
 
 def check_existing_folder():
     Path("/addons/volvo2mqtt/log/").mkdir(parents=True, exist_ok=True)
@@ -113,3 +140,15 @@ def set_mqtt_settings():
         config.settings["mqtt"]["port"] = broker_port
         config.settings["mqtt"]["username"] = broker_user
         config.settings["mqtt"]["password"] = broker_pass
+
+
+def validate_settings():
+    if not os.environ.get("DEV_MODE"):
+        setting_keys = settings.volvoData["vccapikey"]
+        if isinstance(setting_keys, list):
+            if len(setting_keys) > 3:
+                raise Exception("Settings invalid! Maximum allowed vccapikeys are three!")
+
+        update_interval = settings["updateInterval"]
+        if update_interval < 60:
+            raise Exception("Settings invalid! Minimum allowed update interval is 60 seconds!")

src/volvo.py

@@ -1,20 +1,24 @@
+import json
 import logging
 import requests
 import mqtt
 import util
 import time
-from threading import currentThread
+import re
+from threading import current_thread, Thread
 from datetime import datetime, timedelta
 from config import settings
 from babel.dates import format_datetime
+from json import JSONDecodeError
 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, ENGINE_DIAGNOSTICS_URL, engine_states
+    WINDOWS_STATE_URL, LOCK_STATE_URL, TYRE_STATE_URL, supported_entities, FUEL_BATTERY_STATE_URL, \
+    STATISTICS_URL, ENGINE_DIAGNOSTICS_URL, API_BACKEND_STATUS_URL, SUPPORTED_COMMANDS_URL, \
+    ENGINE_STATE_URL, engine_states
 
 session = requests.Session()
 session.headers = {
-    "vcc-api-key": settings["volvoData"]["vccapikey"],
+    "vcc-api-key": "",
     "content-type": "application/json",
     "accept": "*/*"
 }
@@ -24,6 +28,9 @@ refresh_token = None
 vins = []
 supported_endpoints = {}
 cached_requests = {}
+vcc_api_keys = []
+supported_commands = []
+backend_status = ""
 
 
 def authorize():
@@ -42,14 +49,17 @@ def authorize():
     auth = requests.post(OAUTH_URL, data=body, headers=headers)
     if auth.status_code == 200:
         data = auth.json()
-        session.headers.update({'authorization': "Bearer " + data["access_token"]})
+        session.headers.update({"authorization": "Bearer " + data["access_token"]})
 
         global token_expires_at, refresh_token
         token_expires_at = datetime.now(util.TZ) + timedelta(seconds=(data["expires_in"] - 30))
         refresh_token = data["refresh_token"]
 
+        get_vcc_api_keys()
         get_vehicles()
+        get_supported_commands()
         check_supported_endpoints()
+        Thread(target=backend_status_loop).start()
     else:
         message = auth.json()
         raise Exception(message["error_description"])
@@ -77,28 +87,40 @@ def refresh_auth():
 
     if auth.status_code == 200:
         data = auth.json()
-        session.headers.update({'authorization': "Bearer " + data["access_token"]})
+        session.headers.update({"authorization": "Bearer " + data["access_token"]})
 
         global token_expires_at
         token_expires_at = datetime.now(util.TZ) + timedelta(seconds=(data["expires_in"] - 30))
         refresh_token = data["refresh_token"]
 
 
+def get_supported_commands():
+    global supported_commands
+    for vin in vins:
+        commands = session.get(SUPPORTED_COMMANDS_URL.format(vin))
+        data = commands.json()
+        if commands.status_code == 200:
+            for command in data["data"]:
+                supported_commands.append(command["command"])
+        else:
+            logging.error("Error getting supported commands: " + str(commands.status_code) + ". " + str(data["error"].get("message")))
+    logging.debug("Supported commands: " + str(supported_commands))
+
+
 def get_vehicles():
     global vins
     if not settings.volvoData["vin"]:
         vehicles = session.get(VEHICLES_URL)
+        data = vehicles.json()
         if vehicles.status_code == 200:
-            data = vehicles.json()
             if len(data["data"]) > 0:
                 for vehicle in data["data"]:
                     vins.append(vehicle["vin"])
             else:
                 raise Exception("No vehicle in account " + settings.volvoData["username"] + " found.")
         else:
-            error = vehicles.json()
             raise Exception(
-                "Error getting vehicles: " + str(vehicles.status_code) + ". " + str(error["error"].get("message")))
+                "Error getting vehicles: " + str(vehicles.status_code) + ". " + str(data["error"].get("message")))
     else:
         if isinstance(settings.volvoData["vin"], list):
             # If setting is a list, copy
@@ -111,9 +133,100 @@ def get_vehicles():
         raise Exception("No vehicle found, exiting application!")
     else:
         initialize_climate(vins)
+        initialize_scheduler(vins)
+        mqtt.delete_old_entities()
         logging.info("Vin: " + str(vins) + " found!")
 
 
+def get_vcc_api_keys(used_key=None):
+    working_keys = None
+
+    while not working_keys:
+        setting_keys = settings.volvoData["vccapikey"]
+        if isinstance(setting_keys, str):
+            set_key_state(setting_keys)
+        elif isinstance(setting_keys, list):
+            for key in setting_keys:
+                set_key_state(key)
+
+        logging.debug(str(vcc_api_keys))
+        working_keys = [key["key"] for key in vcc_api_keys if not key.get("extended") and key.get('key') != used_key]
+        if len(working_keys) < 1:
+            used_key = None
+            logging.warning("No working VCCAPIKEY found, waiting 10 minutes. Then trying again!")
+            mqtt.send_offline()
+            time.sleep(600)
+        else:
+            mqtt.send_heartbeat()
+            session.headers.update({"vcc-api-key": working_keys[0]})
+            logging.info("Using VCCAPIKEY: " + working_keys[0])
+            for key_dict in vcc_api_keys:
+                if key_dict["key"] == working_keys[0]:
+                    key_dict["in_use"] = True
+
+        logging.debug(str(vcc_api_keys))
+
+
+def set_key_state(key):
+    global vcc_api_keys
+    list_index = next((index for (index, d) in enumerate(vcc_api_keys) if d["key"] == key), None)
+
+    if list_index or list_index == 0:
+        extended, extended_until = check_vcc_api_key(key, vcc_api_keys[list_index]["extended_until"])
+        vcc_api_keys[list_index] = ({"key": key, "extended": extended,
+                                     "extended_until": extended_until, "in_use": False})
+    else:
+        extended, extended_until = check_vcc_api_key(key)
+        vcc_api_keys.append({"key": key, "extended": extended,
+                             "extended_until": extended_until, "in_use": False})
+
+
+def check_vcc_api_key(test_key, extended_until=None):
+    if extended_until:
+        if extended_until >= datetime.now():
+            logging.warning("VCCAPIKEY " + test_key + " is extended and will be reusable at: "
+                            + format_datetime(extended_until, format="medium", locale=settings["babelLocale"]))
+            return True, extended_until
+
+    if datetime.now(util.TZ) >= token_expires_at:
+        refresh_auth()
+
+    token = session.headers.get("authorization")
+    headers = {
+        "vcc-api-key": test_key,
+        "content-type": "application/json",
+        "accept": "*/*",
+        "authorization": token
+    }
+
+    response = requests.get(VEHICLES_URL, headers=headers)
+    data = response.json()
+    if response.status_code == 200:
+        logging.debug("VCCAPIKEY " + test_key + " works!")
+        return False, None
+    elif response.status_code == 403 and "message" in data:
+        if "Out of call volume quota" in data["message"]:
+            reuse_search = re.search(r"\d{2}\:\d{2}\:\d{2}", data["message"])
+            if reuse_search:
+                reusable_in = reuse_search.group(0).split(":")
+                now = datetime.now()
+                extended_until = now + timedelta(hours=int(reusable_in[0]),
+                                                 minutes=int(reusable_in[1]),
+                                                 seconds=int(reusable_in[2]) + 10)
+                logging.warning("VCCAPIKEY " + test_key + " is extended and will be reusable at: "
+                                + format_datetime(extended_until, format="medium", locale=settings["babelLocale"]))
+        else:
+            logging.warning("VCCAPIKEY " + test_key + " isn't working! " + data["error"]["message"])
+    else:
+        logging.warning("VCCAPIKEY " + test_key + " isn't working! " + data["error"]["message"])
+    return True, extended_until
+
+
+def change_vcc_api_key():
+    used_vcc_api_key = session.headers.get("vcc-api-key")
+    get_vcc_api_keys(used_vcc_api_key)
+
+
 def get_vehicle_details(vin):
     response = session.get(VEHICLE_DETAILS_URL.format(vin), timeout=15)
     if response.status_code == 200:
@@ -125,6 +238,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 = {
@@ -145,26 +259,51 @@ def check_supported_endpoints():
     for vin in vins:
         supported_endpoints[vin] = []
         for entity in supported_entities:
-            if entity["id"] == "battery_charge_level" and entity["url"] == BATTERY_CHARGE_STATE_URL \
+            if entity["id"] == "battery_charge_level" and entity["url"] == FUEL_BATTERY_STATE_URL \
                     and any("battery_charge_level" in d["id"] for d in supported_endpoints[vin]):
                 # 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 \
+            if entity["id"] == "engine_state" and entity["url"] == ENGINE_STATE_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
+                # If engine state is supported with commands, skip engine state sensor, as switch
+                # represents the actual engine state
                 continue
 
-            if entity.get('url'):
-                state = api_call(entity["url"], "GET", vin, entity["id"])
+            if entity["domain"] in ["switch", "lock", "number"]:
+                state = check_supported_command(entity["commands"])
             else:
-                state = ""
+                if entity.get('url'):
+                    state = api_call(entity["url"], "GET", vin, entity["id"])
+                else:
+                    state = ""
 
             if state is not None:
-                logging.info("Success! " + entity["name"] + " is supported by your vehicle.")
+                logging.info("Success! " + entity["name"] + " (" + entity["domain"] + ") is supported by your vehicle.")
                 supported_endpoints[vin].append(entity)
             else:
-                logging.info("Failed, " + entity["name"] + " is unfortunately not supported by your vehicle.")
+                logging.info("Failed, " + entity["name"] + " (" + entity["domain"] + ") is unfortunately not supported by your vehicle.")
+
+
+def check_supported_command(entity_commands):
+    commands_supported = True
+    for entity_command in entity_commands:
+        if entity_command not in supported_commands:
+            commands_supported = False
+            break
+
+    if commands_supported:
+        return ""
+    else:
+        return None
+
+
+def initialize_scheduler(vins):
+    for vin in vins:
+        topic = f"homeassistant/schedule/{vin}/command"
+        mqtt.active_schedules[vin] = {"timers": []}
+        mqtt.subscribed_topics = [topic]
+        mqtt.mqtt_client.subscribe(topic)
 
 
 def initialize_climate(vins):
@@ -179,6 +318,20 @@ def disable_climate(vin):
     mqtt.update_car_data()
 
 
+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
@@ -191,7 +344,7 @@ def check_engine_status(vin):
         # Exit thread as engine state is unsupported by car
         return None
 
-    t = currentThread()
+    t = current_thread()
     while getattr(t, "do_run", True):
         engine_state = api_call(endpoint_url, "GET", vin, "engine_state", True)
         if engine_state == "ON":
@@ -201,14 +354,39 @@ def check_engine_status(vin):
         time.sleep(5)
 
 
-def api_call(url, method, vin, sensor_id=None, force_update=False):
-    global token_expires_at
+def backend_status_loop():
+    while True:
+        get_backend_status()
+        # Update every hour
+        time.sleep(3600)
+
+
+def get_backend_status():
+    global backend_status
+    response = session.get(API_BACKEND_STATUS_URL, timeout=15)
+    try:
+        data = response.json()
+        if util.keys_exists(data, "message"):
+            if data["message"]:
+                backend_status = data["message"]
+            else:
+                backend_status = "NO_WARNING"
+        else:
+            backend_status = "NO_WARNING"
+
+    except JSONDecodeError as e:
+        backend_status = "NO_WARNING"
+    return backend_status
+
+
+def api_call(url, method, vin, sensor_id=None, force_update=False, key_change=False, body=None):
     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, FUEL_BATTERY_STATE_URL]:
         # Minimize API calls for endpoints with multiple values
-        response = cached_request(url, method, vin, force_update)
+        response = cached_request(url, method, vin, force_update, key_change)
         if response is None:
             # Exception caught while getting data from volvo api, doing nothing
             return None
@@ -222,7 +400,7 @@ def api_call(url, method, vin, sensor_id=None, force_update=False):
     elif method == "POST":
         logging.debug("Starting " + method + " call against " + url)
         try:
-            response = session.post(url.format(vin), timeout=20)
+            response = session.post(url.format(vin), data=json.dumps(body), timeout=20)
         except requests.exceptions.RequestException as e:
             logging.error("Error getting data: " + str(e))
             return None
@@ -231,9 +409,15 @@ def api_call(url, method, vin, sensor_id=None, force_update=False):
         return None
 
     logging.debug("Response status code: " + str(response.status_code))
-    if response.status_code == 200:
+    try:
         data = response.json()
+    except JSONDecodeError as e:
+        logging.error("Fetched json decode error, Volvo API seems to return garbage. Skipping update. Error: " + str(e))
+        return None
+
+    if response.status_code == 200:
         logging.debug(response.text)
+        return parse_api_data(data, sensor_id)
     else:
         logging.debug(response.text)
         if url == CLIMATE_START_URL and response.status_code == 503:
@@ -244,13 +428,20 @@ def api_call(url, method, vin, sensor_id=None, force_update=False):
             # Suppress 403 errors for unsupported extended-vehicle api cars
             logging.debug("Suppressed 403 for extended-vehicle API")
             return None
+        elif response.status_code == 403 and "message" in data:
+            if "Out of call volume quota" in data["message"]:
+                logging.warning("Quota extended. Try to change VCCAPIKEY!")
+                change_vcc_api_key()
+                api_call(url, method, vin, sensor_id, force_update, True)
+            else:
+                logging.error(
+                    "API Call failed. Status Code: " + str(response.status_code) + ". Error: " + response.text)
         else:
             logging.error("API Call failed. Status Code: " + str(response.status_code) + ". Error: " + response.text)
         return None
-    return parse_api_data(data, sensor_id)
 
 
-def cached_request(url, method, vin, force_update=False):
+def cached_request(url, method, vin, force_update=False, key_change=False):
     global cached_requests
     if not util.keys_exists(cached_requests, vin + "_" + url):
         # No API Data cached, get fresh data from API
@@ -266,8 +457,9 @@ def cached_request(url, method, vin, force_update=False):
     else:
         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):
+                                                  (datetime.now(util.TZ) - cached_requests[vin + "_" + url][
+                                                      "last_update"]).total_seconds() >= 2) \
+                or key_change:
             # Old Data in Cache, or force mode active, updating
             logging.debug("Starting " + method + " call against " + url)
             try:
@@ -284,7 +476,9 @@ def cached_request(url, method, vin, force_update=False):
 
 
 def parse_api_data(data, sensor_id=None):
-    data = data["data"]
+    if sensor_id != "api_backend_status":
+        data = data["data"]
+
     if sensor_id == "battery_charge_level":
         return data["batteryChargeLevel"]["value"] if util.keys_exists(data, "batteryChargeLevel") else None
     elif sensor_id == "electric_range":
@@ -317,7 +511,7 @@ def parse_api_data(data, sensor_id=None):
                 return ""
         return None
     elif sensor_id == "lock_status":
-        return data["carLocked"]["value"] if util.keys_exists(data, "carLocked") else None
+        return data["centralLock"]["value"] if util.keys_exists(data, "centralLock") else None
     elif sensor_id == "odometer":
         multiplier = 1
         if util.keys_exists(settings["volvoData"], "odometerMultiplier"):
@@ -329,44 +523,44 @@ def parse_api_data(data, sensor_id=None):
         return util.convert_metric_values(int(data["odometer"]["value"]) * multiplier) \
             if util.keys_exists(data, "odometer") else None
     elif sensor_id == "window_front_left":
-        return window_states[data["frontLeftWindowOpen"]["value"]] if util.keys_exists(data, "frontLeftWindowOpen") \
+        return window_states[data["frontLeftWindow"]["value"]] if util.keys_exists(data, "frontLeftWindow") \
             else None
     elif sensor_id == "window_front_right":
-        return window_states[data["frontRightWindowOpen"]["value"]] if util.keys_exists(data, "frontRightWindowOpen") \
+        return window_states[data["frontRightWindow"]["value"]] if util.keys_exists(data, "frontRightWindow") \
             else None
     elif sensor_id == "window_rear_left":
-        return window_states[data["rearLeftWindowOpen"]["value"]] if util.keys_exists(data, "rearLeftWindowOpen") \
+        return window_states[data["rearLeftWindow"]["value"]] if util.keys_exists(data, "rearLeftWindow") \
             else None
     elif sensor_id == "window_rear_right":
-        return window_states[data["rearRightWindowOpen"]["value"]] if util.keys_exists(data, "rearRightWindowOpen") \
+        return window_states[data["rearRightWindow"]["value"]] if util.keys_exists(data, "rearRightWindow") \
             else None
     elif sensor_id == "door_front_left":
-        return door_states[data["frontLeftDoorOpen"]["value"]] if util.keys_exists(data, "frontLeftDoorOpen") else None
+        return door_states[data["frontLeftDoor"]["value"]] if util.keys_exists(data, "frontLeftDoor") else None
     elif sensor_id == "door_front_right":
-        return door_states[data["frontRightDoorOpen"]["value"]] \
-            if util.keys_exists(data, "frontRightDoorOpen") else None
+        return door_states[data["frontRightDoor"]["value"]] \
+            if util.keys_exists(data, "frontRightDoor") else None
     elif sensor_id == "door_rear_left":
-        return door_states[data["rearLeftDoorOpen"]["value"]] if util.keys_exists(data, "rearLeftDoorOpen") else None
+        return door_states[data["rearLeftDoor"]["value"]] if util.keys_exists(data, "rearLeftDoor") else None
     elif sensor_id == "door_rear_right":
-        return door_states[data["rearRightDoorOpen"]["value"]] if util.keys_exists(data, "rearRightDoorOpen") else None
+        return door_states[data["rearRightDoor"]["value"]] if util.keys_exists(data, "rearRightDoor") else None
     elif sensor_id == "tailgate":
-        return door_states[data["tailGateOpen"]["value"]] if util.keys_exists(data, "tailGateOpen") else None
+        return door_states[data["tailgate"]["value"]] if util.keys_exists(data, "tailgate") else None
     elif sensor_id == "sunroof":
-        return door_states[data["sunRoofOpen"]["value"]] if util.keys_exists(data, "sunRoofOpen") else None
+        return door_states[data["sunroof"]["value"]] if util.keys_exists(data, "sunroof") else None
     elif sensor_id == "engine_hood":
-        return door_states[data["hoodOpen"]["value"]] if util.keys_exists(data, "hoodOpen") else None
+        return door_states[data["hood"]["value"]] if util.keys_exists(data, "hood") else None
     elif sensor_id == "tank_lid":
-        return door_states[data["tankLidOpen"]["value"]] if util.keys_exists(data, "tankLidOpen") else None
+        return door_states[data["tankLid"]["value"]] if util.keys_exists(data, "tankLid") else None
     elif sensor_id == "tyre_front_left":
-        return data["frontLeftTyrePressure"]["value"] if util.keys_exists(data, "frontLeftTyrePressure") else None
+        return data["frontLeft"]["value"] if util.keys_exists(data, "frontLeft") else None
     elif sensor_id == "tyre_front_right":
-        return data["frontRightTyrePressure"]["value"] if util.keys_exists(data, "frontRightTyrePressure") else None
+        return data["frontRight"]["value"] if util.keys_exists(data, "frontRight") else None
     elif sensor_id == "tyre_rear_left":
-        return data["rearLeftTyrePressure"]["value"] if util.keys_exists(data, "rearLeftTyrePressure") else None
+        return data["rearLeft"]["value"] if util.keys_exists(data, "rearLeft") else None
     elif sensor_id == "tyre_rear_right":
-        return data["rearRightTyrePressure"]["value"] if util.keys_exists(data, "rearRightTyrePressure") else None
+        return data["rearRight"]["value"] if util.keys_exists(data, "rearRight") else None
     elif sensor_id == "engine_state":
-        return engine_states[data["engineRunning"]["value"]] if util.keys_exists(data, "engineRunning") else None
+        return engine_states[data["engineStatus"]["value"]] if util.keys_exists(data, "engineStatus") else None
     elif sensor_id == "fuel_level":
         if util.keys_exists(data, "fuelAmount"):
             fuel_amount = float(data["fuelAmount"]["value"])
@@ -408,11 +602,36 @@ def parse_api_data(data, sensor_id=None):
                                "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"])
+    elif sensor_id == "distance_to_empty_tank":
+        if util.keys_exists(data, "distanceToEmptyTank"):
+            distance_to_empty = int(data["distanceToEmptyTank"]["value"])
             if distance_to_empty > 0:
-                return util.convert_metric_values(data["distanceToEmpty"]["value"])
+                return util.convert_metric_values(data["distanceToEmptyTank"]["value"])
         return None
+    elif sensor_id == "distance_to_empty_battery":
+        if util.keys_exists(data, "distanceToEmptyBattery"):
+            distance_to_empty = int(data["distanceToEmptyBattery"]["value"])
+            if distance_to_empty > 0:
+                return util.convert_metric_values(data["distanceToEmptyBattery"]["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, "distanceToService"):
+            km_to_service = int(data["distanceToService"]["value"])
+            if km_to_service > 0:
+                return util.convert_metric_values(data["distanceToService"]["value"])
+        return None
+    elif sensor_id == "time_to_service":
+        if util.keys_exists(data, "timeToService"):
+            return str(data["timeToService"]["value"]) + " " + data["timeToService"]["unit"]
+        else:
+            return None
+    elif sensor_id == "service_warning_status":
+        return data["serviceWarning"]["value"] if util.keys_exists(data, "serviceWarning") else None
+    elif sensor_id == "average_energy_consumption":
+        return data["averageEnergyConsumption"]["value"] if util.keys_exists(data, "averageEnergyConsumption") else None
+    elif sensor_id == "washer_fluid_warning":
+        return data["washerFluidLevelWarning"]["value"] if util.keys_exists(data, "washerFluidLevelWarning") else None
     else:
         return None