Add value conversion from metric to imperial (#36)

* Convert km to miles, km/h to mp/h if babelLocale is en_GB or en_US #34

* Remove unused variable

* Change speed unit for imperial system // Bump version

README.md

@@ -11,6 +11,9 @@
 
 This component establishes a connection between the newer AAOS Volvo cars and Home Assistant via MQTT.<br>
 Maybe this component works also with other Volvo cars. Please try out the native Volvo [integration](https://www.home-assistant.io/integrations/volvooncall/) before using this component! If the native component doesn't work for your car, try this mqtt bridge.
+<p>
+
+Home Assistant thread can be found [here](https://community.home-assistant.io/t/volvo2mqtt-connect-your-aaos-volvo/585699).
 
 ## Confirmed working with
 - XC40 BEV (2023)
@@ -57,7 +60,7 @@ NOTE: Energy status currently available only for cars in the Europe / Middle Eas
 Just install this addon with the following command.
 Please note to fill in your settings inside the environment variables.
 
-`docker run -d --pull=always -e CONF_updateInterval=300 -e CONF_babelLocale='de' -e CONF_mqtt='@json {"broker": "", "username": "", "password": "", "port": 1883}' -e CONF_volvoData='@json {"username": "", "password": "", "vin": "",   "vccapikey": "", "odometerMultiplier": 1, "averageSpeedDivider": 1}' -e TZ='Europe/Berlin' --name volvo2mqtt ghcr.io/dielee/volvo2mqtt:latest`
+`docker run -d --pull=always -e CONF_updateInterval=300 -e CONF_babelLocale='de' -e CONF_mqtt='@json {"broker": "", "username": "", "password": "", "port": 1883}' -e CONF_volvoData='@json {"username": "", "password": "", "vin": "", "vccapikey": "", "odometerMultiplier": 1, "averageSpeedDivider": 1, "averageFuelConsumptionMultiplier": 1}' -e TZ='Europe/Berlin' --name volvo2mqtt ghcr.io/dielee/volvo2mqtt:latest`
 
 <b>HA Add-On:</b><br>
 
@@ -65,14 +68,23 @@ Please note to fill in your settings inside the environment variables.
 
 Here is what every option means:
 
-| Name                 |   Type    |   Default    | Description                                                     |
-| -------------------- | :-------: | :----------: | --------------------------------------------------------------- |
-| `CONF_updateInterval`     | `int`     | **required** | Update intervall in seconds.                                     |
-| `CONF_babelLocale`        | `string`  | **required** | Select your country from this [list](https://www.ibm.com/docs/en/radfws/9.7?topic=overview-locales-code-pages-supported). "Locale name" is the column you need!                                        |
-| `CONF_mqtt`               | `json`    | **required** | Broker = Mqtt Broker IP / Username and Passwort are optional! Broker port can be changed. If no value is given, port 1883 will be used.  |
-| `CONF_volvoData`          | `json`    | **required** | Username and password are REQUIRED. Car vin can be a single vin or a list of multiple vins like `["vin1", "vin2"]`. If no vin is provided, <b>ALL</b> of your vehicles will be used. Vccapi key is REQUIRED. Get your Vccapi key from [here](https://developer.volvocars.com/account/). Odometer Multiplier is sometimes 10, sometimes 1. The same is applicable for average speed divider. Try what's right for your car. If you leave it empty, the multiplier and divider will be 1.                                 |
-| `CONF_debug`              | `string`  |              | Debug option (true/false) - optional! |
-| `TZ`                 | `string`  |              | Container timezone eg "Europe/Berlin" from [here](https://docs.diladele.com/docker/timezones.html)|
+| Environment Variable Name |   Type    | Json Option                           |   Default    | Description                                                     |
+| ------------------------- | :-------: | :-----------------------------------: | :----------: | --------------------------------------------------------------- |
+| `CONF_updateInterval`     | `int`     |                                       | **required** | Update intervall in seconds.                                     |
+| `CONF_babelLocale`        | `string`  |                                       | **required** | Select your country from this [list](https://www.ibm.com/docs/en/radfws/9.7?topic=overview-locales-code-pages-supported). "Locale name" is the column you need!                                        |
+| `CONF_mqtt`               | `json`    | `broker`                              | **required** | Your MQTT Broker IP. Eg. 192.168.0.5.
+| `CONF_mqtt`               | `json`    | `port`                                | 1883         | Your MQTT Broker Port. If no value is given, port 1883 will be used.  |
+| `CONF_mqtt`               | `json`    | `username`                            | optional     | MQTT Username for your broker.
+| `CONF_mqtt`               | `json`    | `password`                            | optional     | MQTT Password for your broker.
+| `CONF_volvoData`          | `json`    | `username`                            | **required** | Normally your email address to login into the Volvo App.
+| `CONF_volvoData`          | `json`    | `password`                            | **required** | Your password to login into the Volvo App.
+| `CONF_volvoData`          | `json`    | `vin`                                 | optional     | A single VIN like "VIN1" or a list of VINs like "["VIN1", "VIN2"]". Leave this empty if you don't know your VIN. The addon will use every car that is tied to your account.
+| `CONF_volvoData`          | `json`    | `vccapikey`                           | **required** | API key linked with your volvo developer account. Get your Vccapi key from [here](https://developer.volvocars.com/account/)
+| `CONF_volvoData`          | `json`    | `odometerMultiplier`                  | optional     | The multiplier value for the odometer value, as the volvo api delivers inconsistent data. For some cars this setting is 10, for some 1. Try what's right for your car. If you leave it empty, the multiplier will be 1.
+| `CONF_volvoData`          | `json`    | `averageSpeedDivider`                 | optional     | The divider value for the average speed value, as the volvo api delivers inconsistent data. For some cars this setting is 10, for some 1. Try what's right for your car. If you leave it empty, the divider will be 1.
+| `CONF_volvoData`          | `json`    | `averageFuelConsumptionMultiplier`    | optional     | The multiplier value for the average fuel consumption value, as the volvo api delivers inconsistent data. For some cars this setting is 10, for some 1. Try what's right for your car. If you leave it empty, the multiplier will be 1.
+| `CONF_debug`              | `string`  |                                       | optional     | Debug option (true/false). Normally you don't need this. |
+| `TZ`                      | `string`  |                                       | **required** | Container timezone eg "Europe/Berlin" from [here](https://docs.diladele.com/docker/timezones.html)|
 
 ## Lovelace sample card
 <details>

src/config.yaml

@@ -1,6 +1,6 @@
 name: "Volvo2Mqtt"
 description: "Volvo AAOS MQTT bridge"
-version: "1.5.5"
+version: "1.6.0"
 slug: "volvo2mqtt"
 init: false
 url: "https://github.com/Dielee/volvo2mqtt"
@@ -22,6 +22,7 @@ options:
     vccapikey: null
     odometerMultiplier: 1
     averageSpeedDivider: 1
+    averageFuelConsumptionMultiplier: 1
 schema:
   updateInterval: int(10,)
   babelLocale: str
@@ -39,6 +40,7 @@ schema:
     vccapikey: str
     odometerMultiplier: int(1,)
     averageSpeedDivider: int(1,)
+    averageFuelConsumptionMultiplier: int(1,)
 arch:
   - aarch64
   - amd64

src/const.py

@@ -1,6 +1,6 @@
 from config import settings
 
-VERSION = "v1.5.5"
+VERSION = "v1.6.0"
 
 OAUTH_URL = "https://volvoid.eu.volvocars.com/as/token.oauth2"
 VEHICLES_URL = "https://api.volvocars.com/connected-vehicle/v1/vehicles"
@@ -20,6 +20,21 @@ BATTERY_CHARGE_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehic
 FUEL_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/fuel"
 STATISTICS_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/statistics"
 
+units = {
+            "en_GB": {
+                "divider": 1.60934,
+                "electric_range": {"unit": "mi"},
+                "odometer": {"unit": "mi"},
+                "average_speed": {"unit": "mph"}
+            },
+            "en_US": {
+                "divider": 1.60934,
+                "electric_range": {"unit": "mi"},
+                "odometer": {"unit": "mi"},
+                "average_speed": {"unit": "mph"}
+            }
+        }
+
 availability_topic = "volvoAAOS2mqtt/availability"
 
 charging_system_states = {"CHARGING_SYSTEM_CHARGING": "Charging", "CHARGING_SYSTEM_IDLE": "Idle",
@@ -34,12 +49,12 @@ door_states = {"CLOSED": "OFF", "OPEN": "ON"}
 supported_entities = [
                         {"name": "Battery Charge Level", "domain": "sensor", "id": "battery_charge_level", "unit": "%", "icon": "car-battery", "url": RECHARGE_STATE_URL},
                         {"name": "Battery Charge Level", "domain": "sensor", "id": "battery_charge_level", "unit": "%", "icon": "car-battery", "url": BATTERY_CHARGE_STATE_URL},
-                        {"name": "Electric Range", "domain": "sensor", "id": "electric_range", "unit": "km" if settings["babelLocale"] != "en_US" else "mi", "icon": "map-marker-distance", "url": RECHARGE_STATE_URL},
+                        {"name": "Electric Range", "domain": "sensor", "id": "electric_range", "unit": "km" if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["electric_range"]["unit"], "icon": "map-marker-distance", "url": RECHARGE_STATE_URL},
                         {"name": "Estimated Charging Time", "domain": "sensor", "id": "estimated_charging_time", "unit": "minutes", "icon": "timer-sync-outline", "url": RECHARGE_STATE_URL},
                         {"name": "Charging System Status", "domain": "sensor", "id": "charging_system_status", "icon": "ev-station", "url": RECHARGE_STATE_URL},
                         {"name": "Charging Connection Status", "domain": "sensor", "id": "charging_connection_status", "icon": "ev-plug-ccs2", "url": RECHARGE_STATE_URL},
                         {"name": "Estimated Charging Finish Time", "domain": "sensor", "id": "estimated_charging_finish_time", "icon": "timer-sync-outline", "url": RECHARGE_STATE_URL},
-                        {"name": "Odometer", "domain": "sensor", "id": "odometer", "unit": "km" if settings["babelLocale"] != "en_US" else "mi", "icon": "counter", "url": ODOMETER_STATE_URL},
+                        {"name": "Odometer", "domain": "sensor", "id": "odometer", "unit": "km" if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["odometer"]["unit"], "icon": "counter", "url": ODOMETER_STATE_URL},
                         {"name": "Last Data Update", "domain": "sensor", "id": "last_data_update", "icon": "timer", "url": ""},
                         {"name": "Window Front Left", "domain": "binary_sensor", "device_class": "window", "id": "window_front_left", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
                         {"name": "Window Front Right", "domain": "binary_sensor", "device_class": "window", "id": "window_front_right", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
@@ -64,5 +79,5 @@ supported_entities = [
                         {"name": "Engine State", "domain": "sensor", "id": "engine_state", "icon": "engine", "url": ENGINE_STATE_URL},
                         {"name": "Fuel Level", "domain": "sensor", "id": "fuel_level", "unit": "liters", "icon": "fuel", "url": FUEL_STATE_URL},
                         {"name": "Average Fuel Consumption", "domain": "sensor", "id": "average_fuel_consumption", "unit": "liters", "icon": "fuel", "url": STATISTICS_URL},
-                        {"name": "Average Speed", "domain": "sensor", "id": "average_speed", "unit": "km/h" if settings["babelLocale"] != "en_US" else "mp/h", "icon": "speedometer", "url": STATISTICS_URL}
+                        {"name": "Average Speed", "domain": "sensor", "id": "average_speed", "unit": "km/h" if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["average_speed"]["unit"], "icon": "speedometer", "url": STATISTICS_URL}
 ]

src/main.py

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

src/settings.json

@@ -14,6 +14,7 @@
     "vin": "",
 	"vccapikey": "",
     "odometerMultiplier": "",
-    "averageSpeedDivider": ""
+    "averageSpeedDivider": "",
+    "averageFuelConsumptionMultiplier": ""
   }
 }

src/translations/en.yaml

@@ -16,4 +16,4 @@ configuration:
     description: Broker is your mqtt broker IP eg "192.168.0.1". Mqtt username and password are optional. Broker port can be changed. If no value is given, port 1883 will be used.
   volvoData:
     name: Volvo 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. 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. 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,5 +1,6 @@
 import pytz
 import os
+from const import units
 from config import settings
 
 TZ = None
@@ -34,3 +35,11 @@ def set_tz():
         TZ = pytz.timezone(settings_tz)
     else:
         raise Exception("No timezone setting found! Please read the README!")
+
+
+def convert_metric_values(value):
+    if keys_exists(units, settings["babelLocale"]):
+        divider = units[settings["babelLocale"]]["divider"]
+        return round((float(value) / divider), 2)
+    else:
+        return value

src/volvo.py

@@ -87,7 +87,9 @@ def get_vehicles():
             else:
                 raise Exception("No vehicle in account " + settings.volvoData["username"] + " found.")
         else:
-            raise Exception("Error getting vehicles: " + str(vehicles.status_code))
+            error = vehicles.json()
+            raise Exception(
+                "Error getting vehicles: " + str(vehicles.status_code) + ". " + str(error["error"].get("message")))
     else:
         if isinstance(settings.volvoData["vin"], list):
             # If setting is a list, copy
@@ -223,8 +225,10 @@ def cached_request(url, method, vin, force_update=False):
         data = {"response": response, "last_update": datetime.now(util.TZ)}
         cached_requests[vin + "_" + url] = data
     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):
+        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):
             # Old Data in Cache, or force mode active, updating
             print("Starting " + method + " call against " + url)
             try:
@@ -245,13 +249,14 @@ def parse_api_data(data, sensor_id=None):
     if sensor_id == "battery_charge_level":
         return data["batteryChargeLevel"]["value"] if util.keys_exists(data, "batteryChargeLevel") else None
     elif sensor_id == "electric_range":
-        return data["electricRange"]["value"] if util.keys_exists(data, "electricRange") else None
+        return util.convert_metric_values(data["electricRange"]["value"]) \
+            if util.keys_exists(data, "electricRange") else None
     elif sensor_id == "charging_system_status":
-        return charging_system_states[data["chargingSystemStatus"]["value"]] if util.keys_exists(data,
-                                                                                            "chargingSystemStatus") else None
+        return charging_system_states[data["chargingSystemStatus"]["value"]] \
+            if util.keys_exists(data, "chargingSystemStatus") else None
     elif sensor_id == "charging_connection_status":
-        return charging_connection_states[data["chargingConnectionStatus"]["value"]] if util.keys_exists(data,
-                                                                                                    "chargingConnectionStatus") else None
+        return charging_connection_states[data["chargingConnectionStatus"]["value"]] \
+            if util.keys_exists(data, "chargingConnectionStatus") else None
     elif sensor_id == "estimated_charging_time":
         if util.keys_exists(data, "chargingSystemStatus"):
             charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]]
@@ -265,8 +270,9 @@ def parse_api_data(data, sensor_id=None):
         if util.keys_exists(data, "chargingSystemStatus"):
             charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]]
             if charging_system_state == "Charging":
-                charging_time = int(data["estimatedChargingTime"]["value"] if util.keys_exists(data, "estimatedChargingTime")
-                                    else 0)
+                charging_time = int(
+                    data["estimatedChargingTime"]["value"] if util.keys_exists(data, "estimatedChargingTime")
+                    else 0)
                 charging_finished = datetime.now(util.TZ) + timedelta(minutes=charging_time)
                 return format_datetime(charging_finished, format="medium", locale=settings["babelLocale"])
             else:
@@ -283,7 +289,8 @@ def parse_api_data(data, sensor_id=None):
                 multiplier = 1
             elif multiplier < 1:
                 multiplier = 1
-        return int(data["odometer"]["value"]) * multiplier if util.keys_exists(data, "odometer") else 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") \
             else None
@@ -299,7 +306,8 @@ def parse_api_data(data, sensor_id=None):
     elif sensor_id == "door_front_left":
         return door_states[data["frontLeftDoorOpen"]["value"]] if util.keys_exists(data, "frontLeftDoorOpen") 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["frontRightDoorOpen"]["value"]] \
+            if util.keys_exists(data, "frontRightDoorOpen") else None
     elif sensor_id == "door_rear_left":
         return door_states[data["rearLeftDoorOpen"]["value"]] if util.keys_exists(data, "rearLeftDoorOpen") else None
     elif sensor_id == "door_rear_right":
@@ -335,7 +343,14 @@ def parse_api_data(data, sensor_id=None):
         if util.keys_exists(data, "averageFuelConsumption"):
             average_fuel_con = float(data["averageFuelConsumption"]["value"])
             if average_fuel_con > 0:
-                return average_fuel_con
+                multiplier = 1
+                if util.keys_exists(settings["volvoData"], "averageFuelConsumptionMultiplier"):
+                    multiplier = settings["volvoData"]["averageFuelConsumptionMultiplier"]
+                    if isinstance(multiplier, str):
+                        multiplier = 1
+                    elif multiplier < 1:
+                        multiplier = 1
+                return average_fuel_con * multiplier
             else:
                 return None
         else:
@@ -343,7 +358,7 @@ def parse_api_data(data, sensor_id=None):
     elif sensor_id == "average_speed":
         if util.keys_exists(data, "averageSpeed"):
             average_speed = int(data["averageSpeed"]["value"])
-            if average_speed > 0:
+            if average_speed > 1:
                 divider = 1
                 if util.keys_exists(settings["volvoData"], "averageSpeedDivider"):
                     divider = settings["volvoData"]["averageSpeedDivider"]
@@ -351,7 +366,7 @@ def parse_api_data(data, sensor_id=None):
                         divider = 1
                     elif divider < 1:
                         divider = 1
-                return average_speed / divider
+                return util.convert_metric_values(average_speed / divider)
             else:
                 return None
         else: