Compare commits

..
6 Commits
Author SHA1 Message Date
Linus DietzandGitHub 67320c32f6 Optimize climate timer (#40)
* Add logic to turn climate switch off if driver door is opened

* Update car data after climate state change

* Climate stop on left or right door open

* Bump version
2023-06-29 17:46:34 +02:00
Dielee 30f415cb1f Merge branch 'main' of https://github.com/Dielee/volvo2mqtt into main 2023-06-29 15:16:05 +02:00
Dielee 241b2f7ba4 Fix app crash on credential refresh 2023-06-29 15:15:49 +02:00
Linus Dietz 80017f64e3 Fix app crash on credential refresh 2023-06-29 15:14:24 +02:00
Linus Dietz 47357fb582 Add "Washer Fluid Level" and "Distance to Empty" sensors 2023-06-29 08:36:23 +02:00
Linus Dietz 9f1209e628 Fix wrong return values for not working endpoints 2023-06-29 08:06:31 +02:00
4 changed files with 449 additions and 395 deletions
+1 -1
View File
@@ -1,6 +1,6 @@
name: "Volvo2Mqtt" name: "Volvo2Mqtt"
description: "Volvo AAOS MQTT bridge" description: "Volvo AAOS MQTT bridge"
version: "1.6.0" version: "1.6.1"
slug: "volvo2mqtt" slug: "volvo2mqtt"
init: false init: false
url: "https://github.com/Dielee/volvo2mqtt" url: "https://github.com/Dielee/volvo2mqtt"
+6 -2
View File
@@ -1,6 +1,6 @@
from config import settings from config import settings
VERSION = "v1.6.0" VERSION = "v1.6.1"
OAUTH_URL = "https://volvoid.eu.volvocars.com/as/token.oauth2" OAUTH_URL = "https://volvoid.eu.volvocars.com/as/token.oauth2"
VEHICLES_URL = "https://api.volvocars.com/connected-vehicle/v1/vehicles" VEHICLES_URL = "https://api.volvocars.com/connected-vehicle/v1/vehicles"
@@ -19,6 +19,8 @@ ENGINE_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/
BATTERY_CHARGE_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/battery-charge-level" 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_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/fuel"
STATISTICS_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/statistics" STATISTICS_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/statistics"
DISTANCE_TO_EMPTY_URL = "https://api.volvocars.com/extended-vehicle/v1/vehicles/{0}/resources/distanceToEmpty"
WASHER_FLUID_LEVEL_URL = "https://api.volvocars.com/extended-vehicle/v1/vehicles/{0}/resources/washerFluidLevel"
units = { units = {
"en_GB": { "en_GB": {
@@ -79,5 +81,7 @@ supported_entities = [
{"name": "Engine State", "domain": "sensor", "id": "engine_state", "icon": "engine", "url": ENGINE_STATE_URL}, {"name": "Engine State", "domain": "sensor", "id": "engine_state", "icon": "engine", "url": ENGINE_STATE_URL},
{"name": "Fuel Level", "domain": "sensor", "id": "fuel_level", "unit": "liters", "icon": "fuel", "url": FUEL_STATE_URL}, {"name": "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 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 not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["average_speed"]["unit"], "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},
{"name": "Distance to Empty", "domain": "sensor", "id": "distance_to_empty", "unit": "km" if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["odometer"]["unit"], "icon": "map-marker-distance", "url": DISTANCE_TO_EMPTY_URL},
{"name": "Washer Fluid Level", "domain": "sensor", "id": "washer_fluid_level", "icon": "wiper-wash", "url": WASHER_FLUID_LEVEL_URL},
] ]
+28 -8
View File
@@ -16,6 +16,7 @@ subscribed_topics = []
assumed_climate_state = {} assumed_climate_state = {}
last_data_update = None last_data_update = None
climate_timer = {} climate_timer = {}
door_status = {}
def connect(): def connect():
@@ -59,29 +60,48 @@ def on_message(client, userdata, msg):
payload = msg.payload.decode("UTF-8") payload = msg.payload.decode("UTF-8")
if "climate_status" in msg.topic: if "climate_status" in msg.topic:
global assumed_climate_state, climate_timer global assumed_climate_state, climate_timer, door_status
if payload == "ON": if payload == "ON":
api_thread = Thread(target=volvo.api_call, args=(CLIMATE_START_URL, "POST", vin)) # Start the api call in another thread for HA performance
api_thread.start() Thread(target=volvo.api_call, args=(CLIMATE_START_URL, "POST", vin)).start()
assumed_climate_state[vin] = "ON"
# Start door check thread to turn off climate if driver door is opened
door_thread = Thread(target=volvo.check_door_status, args=(vin, ))
door_thread.start()
door_status[vin] = door_thread
# Starting timer to disable climate after 30 mins # Starting timer to disable climate after 30 mins
climate_timer[vin] = Timer(30 * 60, volvo.disable_climate, (vin, )) climate_timer[vin] = Timer(30 * 60, volvo.disable_climate, (vin, ))
climate_timer[vin].start() climate_timer[vin].start()
# Set and update switch status
assumed_climate_state[vin] = "ON"
update_car_data() update_car_data()
elif payload == "OFF": elif payload == "OFF":
api_thread = Thread(target=volvo.api_call, args=(CLIMATE_STOP_URL, "POST", vin)) # Start the api call in another thread for HA performance
api_thread.start() Thread(target=volvo.api_call, args=(CLIMATE_STOP_URL, "POST", vin)).start()
assumed_climate_state[vin] = "OFF"
# Stop timer if active # Stop door check thread if running
if door_status[vin].is_alive():
door_status[vin].do_run = False
# Stop climate timer if active
if climate_timer[vin].is_alive(): if climate_timer[vin].is_alive():
climate_timer[vin].cancel() climate_timer[vin].cancel()
# Set and update switch status
assumed_climate_state[vin] = "OFF"
update_car_data() update_car_data()
elif "lock_status" in msg.topic: elif "lock_status" in msg.topic:
if payload == "LOCK": if payload == "LOCK":
volvo.api_call(CAR_LOCK_URL, "POST", vin) 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"}) update_car_data(True, {"entity_id": "lock_status", "vin": vin, "state": "LOCKED"})
elif payload == "UNLOCK": elif payload == "UNLOCK":
volvo.api_call(CAR_UNLOCK_URL, "POST", vin) 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"}) update_car_data(True, {"entity_id": "lock_status", "vin": vin, "state": "UNLOCKED"})
elif "update_data" in msg.topic: elif "update_data" in msg.topic:
if payload == "PRESS": if payload == "PRESS":
+414 -384
View File
@@ -1,384 +1,414 @@
import requests import requests
import mqtt import mqtt
import util import util
from datetime import datetime, timedelta import time
from config import settings from threading import Thread, currentThread
from babel.dates import format_datetime from datetime import datetime, timedelta
from const import charging_system_states, charging_connection_states, door_states, window_states, \ from config import settings
OAUTH_URL, VEHICLES_URL, VEHICLE_DETAILS_URL, RECHARGE_STATE_URL, CLIMATE_START_URL, \ from babel.dates import format_datetime
WINDOWS_STATE_URL, LOCK_STATE_URL, TYRE_STATE_URL, supported_entities, BATTERY_CHARGE_STATE_URL, \ from const import charging_system_states, charging_connection_states, door_states, window_states, \
STATISTICS_URL 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, \
session = requests.Session() STATISTICS_URL, CLIMATE_STOP_URL
session.headers = {
"vcc-api-key": settings["volvoData"]["vccapikey"], session = requests.Session()
"content-type": "application/json", session.headers = {
"accept": "*/*" "vcc-api-key": settings["volvoData"]["vccapikey"],
} "content-type": "application/json",
"accept": "*/*"
token_expires_at: datetime }
refresh_token = None
vins = [] token_expires_at: datetime
supported_endpoints = {} refresh_token = None
cached_requests = {} vins = []
supported_endpoints = {}
cached_requests = {}
def authorize():
headers = {
"authorization": "Basic aDRZZjBiOlU4WWtTYlZsNnh3c2c1WVFxWmZyZ1ZtSWFEcGhPc3kxUENhVXNpY1F0bzNUUjVrd2FKc2U0QVpkZ2ZJZmNMeXc=", def authorize():
"content-type": "application/x-www-form-urlencoded", headers = {
"accept": "application/json" "authorization": "Basic aDRZZjBiOlU4WWtTYlZsNnh3c2c1WVFxWmZyZ1ZtSWFEcGhPc3kxUENhVXNpY1F0bzNUUjVrd2FKc2U0QVpkZ2ZJZmNMeXc=",
} "content-type": "application/x-www-form-urlencoded",
"accept": "application/json"
body = { }
"username": settings.volvoData["username"],
"password": settings.volvoData["password"], body = {
"grant_type": "password", "username": settings.volvoData["username"],
"scope": "openid email profile care_by_volvo:financial_information:invoice:read care_by_volvo:financial_information:payment_method care_by_volvo:subscription:read customer:attributes customer:attributes:write order:attributes vehicle:attributes tsp_customer_api:all conve:brake_status conve:climatization_start_stop conve:command_accessibility conve:commands conve:diagnostics_engine_status conve:diagnostics_workshop conve:doors_status conve:engine_status conve:environment conve:fuel_status conve:honk_flash conve:lock conve:lock_status conve:navigation conve:odometer_status conve:trip_statistics conve:tyre_status conve:unlock conve:vehicle_relation conve:warnings conve:windows_status energy:battery_charge_level energy:charging_connection_status energy:charging_system_status energy:electric_range energy:estimated_charging_time energy:recharge_status vehicle:attributes" "password": settings.volvoData["password"],
} "grant_type": "password",
auth = requests.post(OAUTH_URL, data=body, headers=headers) "scope": "openid email profile care_by_volvo:financial_information:invoice:read care_by_volvo:financial_information:payment_method care_by_volvo:subscription:read customer:attributes customer:attributes:write order:attributes vehicle:attributes tsp_customer_api:all conve:brake_status conve:climatization_start_stop conve:command_accessibility conve:commands conve:diagnostics_engine_status conve:diagnostics_workshop conve:doors_status conve:engine_status conve:environment conve:fuel_status conve:honk_flash conve:lock conve:lock_status conve:navigation conve:odometer_status conve:trip_statistics conve:tyre_status conve:unlock conve:vehicle_relation conve:warnings conve:windows_status energy:battery_charge_level energy:charging_connection_status energy:charging_system_status energy:electric_range energy:estimated_charging_time energy:recharge_status vehicle:attributes"
if auth.status_code == 200: }
data = auth.json() auth = requests.post(OAUTH_URL, data=body, headers=headers)
session.headers.update({'authorization': "Bearer " + data["access_token"]}) if auth.status_code == 200:
data = auth.json()
global token_expires_at, refresh_token session.headers.update({'authorization': "Bearer " + data["access_token"]})
token_expires_at = datetime.now(util.TZ) + timedelta(seconds=(data["expires_in"] - 30))
refresh_token = data["refresh_token"] global token_expires_at, refresh_token
token_expires_at = datetime.now(util.TZ) + timedelta(seconds=(data["expires_in"] - 30))
get_vehicles() refresh_token = data["refresh_token"]
check_supported_endpoints()
else: get_vehicles()
message = auth.json() check_supported_endpoints()
raise Exception(message["error_description"]) else:
message = auth.json()
raise Exception(message["error_description"])
def refresh_auth():
print("Refreshing credentials")
global refresh_token def refresh_auth():
headers = { print("Refreshing credentials")
"authorization": "Basic aDRZZjBiOlU4WWtTYlZsNnh3c2c1WVFxWmZyZ1ZtSWFEcGhPc3kxUENhVXNpY1F0bzNUUjVrd2FKc2U0QVpkZ2ZJZmNMeXc=", global refresh_token
"content-type": "application/x-www-form-urlencoded", headers = {
"accept": "application/json" "authorization": "Basic aDRZZjBiOlU4WWtTYlZsNnh3c2c1WVFxWmZyZ1ZtSWFEcGhPc3kxUENhVXNpY1F0bzNUUjVrd2FKc2U0QVpkZ2ZJZmNMeXc=",
} "content-type": "application/x-www-form-urlencoded",
"accept": "application/json"
body = { }
"grant_type": "refresh_token",
"refresh_token": refresh_token body = {
} "grant_type": "refresh_token",
auth = requests.post(OAUTH_URL, data=body, headers=headers) "refresh_token": refresh_token
if auth.status_code == 200: }
data = auth.json()
session.headers.update({'authorization': "Bearer " + data["access_token"]}) try:
auth = requests.post(OAUTH_URL, data=body, headers=headers)
global token_expires_at except requests.exceptions.RequestException as e:
token_expires_at = datetime.now(util.TZ) + timedelta(seconds=(data["expires_in"] - 30)) print("Error refreshing credentials data: " + str(e))
refresh_token = data["refresh_token"] return None
if auth.status_code == 200:
def get_vehicles(): data = auth.json()
global vins session.headers.update({'authorization': "Bearer " + data["access_token"]})
if not settings.volvoData["vin"]:
vehicles = session.get(VEHICLES_URL) global token_expires_at
if vehicles.status_code == 200: token_expires_at = datetime.now(util.TZ) + timedelta(seconds=(data["expires_in"] - 30))
data = vehicles.json() refresh_token = data["refresh_token"]
if len(data["data"]) > 0:
for vehicle in data["data"]:
vins.append(vehicle["vin"]) def get_vehicles():
else: global vins
raise Exception("No vehicle in account " + settings.volvoData["username"] + " found.") if not settings.volvoData["vin"]:
else: vehicles = session.get(VEHICLES_URL)
error = vehicles.json() if vehicles.status_code == 200:
raise Exception( data = vehicles.json()
"Error getting vehicles: " + str(vehicles.status_code) + ". " + str(error["error"].get("message"))) if len(data["data"]) > 0:
else: for vehicle in data["data"]:
if isinstance(settings.volvoData["vin"], list): vins.append(vehicle["vin"])
# If setting is a list, copy else:
vins = settings.volvoData["vin"] raise Exception("No vehicle in account " + settings.volvoData["username"] + " found.")
else: else:
# If setting is a string, append to list error = vehicles.json()
vins.append(settings.volvoData["vin"]) raise Exception(
"Error getting vehicles: " + str(vehicles.status_code) + ". " + str(error["error"].get("message")))
if len(vins) == 0: else:
raise Exception("No vehicle found, exiting application!") if isinstance(settings.volvoData["vin"], list):
else: # If setting is a list, copy
initialize_climate(vins) vins = settings.volvoData["vin"]
print("Vin: " + str(vins) + " found!") else:
# If setting is a string, append to list
vins.append(settings.volvoData["vin"])
def get_vehicle_details(vin):
response = session.get(VEHICLE_DETAILS_URL.format(vin), timeout=15) if len(vins) == 0:
if response.status_code == 200: raise Exception("No vehicle found, exiting application!")
data = response.json()["data"] else:
if "debug" in settings: initialize_climate(vins)
if settings["debug"]: print("Vin: " + str(vins) + " found!")
print(response.text)
device = {
"identifiers": [f"volvoAAOS2mqtt_{vin}"], def get_vehicle_details(vin):
"manufacturer": "Volvo", response = session.get(VEHICLE_DETAILS_URL.format(vin), timeout=15)
"model": data['descriptions']['model'], if response.status_code == 200:
"name": f"{data['descriptions']['model']} ({data['modelYear']}) - {vin}", data = response.json()["data"]
} if "debug" in settings:
elif response.status_code == 500 and not settings.volvoData["vin"]: if settings["debug"]:
# Workaround for some cars that are not returning vehicle details print(response.text)
device = { device = {
"identifiers": [f"volvoAAOS2mqtt_{vin}"], "identifiers": [f"volvoAAOS2mqtt_{vin}"],
"manufacturer": "Volvo", "manufacturer": "Volvo",
"model": vin, "model": data['descriptions']['model'],
"name": f"Volvo - {vin}", "name": f"{data['descriptions']['model']} ({data['modelYear']}) - {vin}",
} }
else: elif response.status_code == 500 and not settings.volvoData["vin"]:
raise Exception("Getting vehicle details failed. Status Code: " + str(response.status_code) + # Workaround for some cars that are not returning vehicle details
". Error: " + response.text) device = {
"identifiers": [f"volvoAAOS2mqtt_{vin}"],
return device "manufacturer": "Volvo",
"model": vin,
"name": f"Volvo - {vin}",
def check_supported_endpoints(): }
global supported_endpoints else:
for vin in vins: raise Exception("Getting vehicle details failed. Status Code: " + str(response.status_code) +
supported_endpoints[vin] = [] ". Error: " + response.text)
for entity in supported_entities:
if entity["id"] == "battery_charge_level" and entity["url"] == BATTERY_CHARGE_STATE_URL \ return device
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 def check_supported_endpoints():
global supported_endpoints
if entity.get('url'): for vin in vins:
state = api_call(entity["url"], "GET", vin, entity["id"]) supported_endpoints[vin] = []
else: for entity in supported_entities:
state = "" if entity["id"] == "battery_charge_level" and entity["url"] == BATTERY_CHARGE_STATE_URL \
and any("battery_charge_level" in d["id"] for d in supported_endpoints[vin]):
if state is not None: # If battery charge level could be found in recharge-api, skip the second battery charge sensor
print("Success! " + entity["name"] + " is supported by your vehicle.") continue
supported_endpoints[vin].append(entity)
else: if entity.get('url'):
print("Failed, " + entity["name"] + " is unfortunately not supported by your vehicle.") state = api_call(entity["url"], "GET", vin, entity["id"])
else:
state = ""
def initialize_climate(vins):
for vin in vins: if state is not None:
mqtt.assumed_climate_state[vin] = "OFF" print("Success! " + entity["name"] + " is supported by your vehicle.")
supported_endpoints[vin].append(entity)
else:
def disable_climate(vin): print("Failed, " + entity["name"] + " is unfortunately not supported by your vehicle.")
print("Turning climate off by timer!")
mqtt.assumed_climate_state[vin] = "OFF"
mqtt.update_car_data() def initialize_climate(vins):
for vin in vins:
mqtt.assumed_climate_state[vin] = "OFF"
def api_call(url, method, vin, sensor_id=None, force_update=False):
global token_expires_at
if datetime.now(util.TZ) >= token_expires_at: def disable_climate(vin):
refresh_auth() print("Turning climate off by timer!")
mqtt.door_status[vin].do_run = False
if url in [RECHARGE_STATE_URL, WINDOWS_STATE_URL, LOCK_STATE_URL, TYRE_STATE_URL, STATISTICS_URL]: mqtt.assumed_climate_state[vin] = "OFF"
# Minimize API calls for endpoints with multiple values mqtt.update_car_data()
response = cached_request(url, method, vin, force_update)
if response is None:
# Exception caught while getting data from volvo api, doing nothing def check_door_status(vin):
return None t = currentThread()
elif method == "GET": while getattr(t, "do_run", True):
print("Starting " + method + " call against " + url) lock_door_left = api_call(LOCK_STATE_URL, "GET", vin, "door_front_left", True)
try: lock_door_right = api_call(LOCK_STATE_URL, "GET", vin, "door_front_right", True)
response = session.get(url.format(vin), timeout=15) if lock_door_left == "ON" or lock_door_right == "ON":
except requests.exceptions.RequestException as e: Thread(target=api_call, args=(CLIMATE_STOP_URL, "POST", vin)).start()
print("Error getting data: " + str(e)) mqtt.assumed_climate_state[vin] = "OFF"
return "" mqtt.update_car_data()
elif method == "POST": break
print("Starting " + method + " call against " + url) time.sleep(5)
try:
response = session.post(url.format(vin), timeout=20)
except requests.exceptions.RequestException as e: def api_call(url, method, vin, sensor_id=None, force_update=False):
print("Error getting data: " + str(e)) global token_expires_at
return "" if datetime.now(util.TZ) >= token_expires_at:
else: refresh_auth()
print("Unkown method posted: " + method + ". Returning nothing")
return "" if url in [RECHARGE_STATE_URL, WINDOWS_STATE_URL, LOCK_STATE_URL, TYRE_STATE_URL, STATISTICS_URL]:
# Minimize API calls for endpoints with multiple values
if response.status_code == 200: response = cached_request(url, method, vin, force_update)
data = response.json() if response is None:
if "debug" in settings: # Exception caught while getting data from volvo api, doing nothing
if settings["debug"]: return None
print(response.text) elif method == "GET":
else: print("Starting " + method + " call against " + url)
if url == CLIMATE_START_URL and response.status_code == 503: try:
print("Car in use, cannot start pre climatization") response = session.get(url.format(vin), timeout=15)
mqtt.assumed_climate_state[vin] = "OFF" except requests.exceptions.RequestException as e:
mqtt.update_car_data() print("Error getting data: " + str(e))
else: return None
print("API Call failed. Status Code: " + str(response.status_code) + ". Error: " + response.text) elif method == "POST":
return "" print("Starting " + method + " call against " + url)
return parse_api_data(data, sensor_id) try:
response = session.post(url.format(vin), timeout=20)
except requests.exceptions.RequestException as e:
def cached_request(url, method, vin, force_update=False): print("Error getting data: " + str(e))
global cached_requests return None
if not util.keys_exists(cached_requests, vin + "_" + url): else:
# No API Data cached, get fresh data from API print("Unkown method posted: " + method + ". Returning nothing")
print("Starting " + method + " call against " + url) return None
try:
response = session.get(url.format(vin), timeout=15) if response.status_code == 200:
except requests.exceptions.RequestException as e: data = response.json()
print("Error getting data: " + str(e)) if "debug" in settings:
return None if settings["debug"]:
print(response.text)
data = {"response": response, "last_update": datetime.now(util.TZ)} else:
cached_requests[vin + "_" + url] = data if url == CLIMATE_START_URL and response.status_code == 503:
else: print("Car in use, cannot start pre climatization")
if (datetime.now(util.TZ) - cached_requests[vin + "_" + url]["last_update"]).total_seconds() >= settings[ mqtt.assumed_climate_state[vin] = "OFF"
"updateInterval"] \ mqtt.update_car_data()
or (force_update and ( elif "extended-vehicle" in url and response.status_code == 403:
datetime.now(util.TZ) - cached_requests[vin + "_" + url]["last_update"]).total_seconds() >= 2): # Suppress 403 errors for unsupported extended-vehicle api cars
# Old Data in Cache, or force mode active, updating return None
print("Starting " + method + " call against " + url) else:
try: print("API Call failed. Status Code: " + str(response.status_code) + ". Error: " + response.text)
response = session.get(url.format(vin), timeout=15) return None
except requests.exceptions.RequestException as e: return parse_api_data(data, sensor_id)
print("Error getting data: " + str(e))
return None
data = {"response": response, "last_update": datetime.now(util.TZ)} def cached_request(url, method, vin, force_update=False):
cached_requests[vin + "_" + url] = data global cached_requests
else: if not util.keys_exists(cached_requests, vin + "_" + url):
# Data is up do date, returning cached data # No API Data cached, get fresh data from API
response = cached_requests[vin + "_" + url]["response"] print("Starting " + method + " call against " + url)
return response try:
response = session.get(url.format(vin), timeout=15)
except requests.exceptions.RequestException as e:
def parse_api_data(data, sensor_id=None): print("Error getting data: " + str(e))
data = data["data"] return None
if sensor_id == "battery_charge_level":
return data["batteryChargeLevel"]["value"] if util.keys_exists(data, "batteryChargeLevel") else None data = {"response": response, "last_update": datetime.now(util.TZ)}
elif sensor_id == "electric_range": cached_requests[vin + "_" + url] = data
return util.convert_metric_values(data["electricRange"]["value"]) \ else:
if util.keys_exists(data, "electricRange") else None if (datetime.now(util.TZ) - cached_requests[vin + "_" + url]["last_update"]).total_seconds() \
elif sensor_id == "charging_system_status": >= settings["updateInterval"] or (force_update and
return charging_system_states[data["chargingSystemStatus"]["value"]] \ (datetime.now(util.TZ) - cached_requests[vin + "_" + url]
if util.keys_exists(data, "chargingSystemStatus") else None ["last_update"]).total_seconds() >= 2):
elif sensor_id == "charging_connection_status": # Old Data in Cache, or force mode active, updating
return charging_connection_states[data["chargingConnectionStatus"]["value"]] \ print("Starting " + method + " call against " + url)
if util.keys_exists(data, "chargingConnectionStatus") else None try:
elif sensor_id == "estimated_charging_time": response = session.get(url.format(vin), timeout=15)
if util.keys_exists(data, "chargingSystemStatus"): except requests.exceptions.RequestException as e:
charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]] print("Error getting data: " + str(e))
if charging_system_state == "Charging": return None
return data["estimatedChargingTime"]["value"] if util.keys_exists(data, "estimatedChargingTime") else "" data = {"response": response, "last_update": datetime.now(util.TZ)}
else: cached_requests[vin + "_" + url] = data
return 0 else:
else: # Data is up do date, returning cached data
return None response = cached_requests[vin + "_" + url]["response"]
elif sensor_id == "estimated_charging_finish_time": return response
if util.keys_exists(data, "chargingSystemStatus"):
charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]]
if charging_system_state == "Charging": def parse_api_data(data, sensor_id=None):
charging_time = int( data = data["data"]
data["estimatedChargingTime"]["value"] if util.keys_exists(data, "estimatedChargingTime") if sensor_id == "battery_charge_level":
else 0) return data["batteryChargeLevel"]["value"] if util.keys_exists(data, "batteryChargeLevel") else None
charging_finished = datetime.now(util.TZ) + timedelta(minutes=charging_time) elif sensor_id == "electric_range":
return format_datetime(charging_finished, format="medium", locale=settings["babelLocale"]) return util.convert_metric_values(data["electricRange"]["value"]) \
else: if util.keys_exists(data, "electricRange") else None
return "" elif sensor_id == "charging_system_status":
else: return charging_system_states[data["chargingSystemStatus"]["value"]] \
return None if util.keys_exists(data, "chargingSystemStatus") else None
elif sensor_id == "lock_status": elif sensor_id == "charging_connection_status":
return data["carLocked"]["value"] if util.keys_exists(data, "carLocked") else None return charging_connection_states[data["chargingConnectionStatus"]["value"]] \
elif sensor_id == "odometer": if util.keys_exists(data, "chargingConnectionStatus") else None
multiplier = 1 elif sensor_id == "estimated_charging_time":
if util.keys_exists(settings["volvoData"], "odometerMultiplier"): if util.keys_exists(data, "chargingSystemStatus"):
multiplier = settings["volvoData"]["odometerMultiplier"] charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]]
if isinstance(multiplier, str): if charging_system_state == "Charging":
multiplier = 1 return data["estimatedChargingTime"]["value"] if util.keys_exists(data, "estimatedChargingTime") else ""
elif multiplier < 1: else:
multiplier = 1 return 0
return util.convert_metric_values(int(data["odometer"]["value"]) * multiplier) \ else:
if util.keys_exists(data, "odometer") else None return None
elif sensor_id == "window_front_left": elif sensor_id == "estimated_charging_finish_time":
return window_states[data["frontLeftWindowOpen"]["value"]] if util.keys_exists(data, "frontLeftWindowOpen") \ if util.keys_exists(data, "chargingSystemStatus"):
else None charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]]
elif sensor_id == "window_front_right": if charging_system_state == "Charging":
return window_states[data["frontRightWindowOpen"]["value"]] if util.keys_exists(data, "frontRightWindowOpen") \ charging_time = int(
else None data["estimatedChargingTime"]["value"] if util.keys_exists(data, "estimatedChargingTime")
elif sensor_id == "window_rear_left": else 0)
return window_states[data["rearLeftWindowOpen"]["value"]] if util.keys_exists(data, "rearLeftWindowOpen") \ charging_finished = datetime.now(util.TZ) + timedelta(minutes=charging_time)
else None return format_datetime(charging_finished, format="medium", locale=settings["babelLocale"])
elif sensor_id == "window_rear_right": else:
return window_states[data["rearRightWindowOpen"]["value"]] if util.keys_exists(data, "rearRightWindowOpen") \ return ""
else None else:
elif sensor_id == "door_front_left": return None
return door_states[data["frontLeftDoorOpen"]["value"]] if util.keys_exists(data, "frontLeftDoorOpen") else None elif sensor_id == "lock_status":
elif sensor_id == "door_front_right": return data["carLocked"]["value"] if util.keys_exists(data, "carLocked") else None
return door_states[data["frontRightDoorOpen"]["value"]] \ elif sensor_id == "odometer":
if util.keys_exists(data, "frontRightDoorOpen") else None multiplier = 1
elif sensor_id == "door_rear_left": if util.keys_exists(settings["volvoData"], "odometerMultiplier"):
return door_states[data["rearLeftDoorOpen"]["value"]] if util.keys_exists(data, "rearLeftDoorOpen") else None multiplier = settings["volvoData"]["odometerMultiplier"]
elif sensor_id == "door_rear_right": if isinstance(multiplier, str):
return door_states[data["rearRightDoorOpen"]["value"]] if util.keys_exists(data, "rearRightDoorOpen") else None multiplier = 1
elif sensor_id == "tailgate": elif multiplier < 1:
return door_states[data["tailGateOpen"]["value"]] if util.keys_exists(data, "tailGateOpen") else None multiplier = 1
elif sensor_id == "sunroof": return util.convert_metric_values(int(data["odometer"]["value"]) * multiplier) \
return door_states[data["sunRoofOpen"]["value"]] if util.keys_exists(data, "sunRoofOpen") else None if util.keys_exists(data, "odometer") else None
elif sensor_id == "engine_hood": elif sensor_id == "window_front_left":
return door_states[data["hoodOpen"]["value"]] if util.keys_exists(data, "hoodOpen") else None return window_states[data["frontLeftWindowOpen"]["value"]] if util.keys_exists(data, "frontLeftWindowOpen") \
elif sensor_id == "tank_lid": else None
return door_states[data["tankLidOpen"]["value"]] if util.keys_exists(data, "tankLidOpen") else None elif sensor_id == "window_front_right":
elif sensor_id == "tyre_front_left": return window_states[data["frontRightWindowOpen"]["value"]] if util.keys_exists(data, "frontRightWindowOpen") \
return data["frontLeftTyrePressure"]["value"] if util.keys_exists(data, "frontLeftTyrePressure") else None else None
elif sensor_id == "tyre_front_right": elif sensor_id == "window_rear_left":
return data["frontRightTyrePressure"]["value"] if util.keys_exists(data, "frontRightTyrePressure") else None return window_states[data["rearLeftWindowOpen"]["value"]] if util.keys_exists(data, "rearLeftWindowOpen") \
elif sensor_id == "tyre_rear_left": else None
return data["rearLeftTyrePressure"]["value"] if util.keys_exists(data, "rearLeftTyrePressure") else None elif sensor_id == "window_rear_right":
elif sensor_id == "tyre_rear_right": return window_states[data["rearRightWindowOpen"]["value"]] if util.keys_exists(data, "rearRightWindowOpen") \
return data["rearRightTyrePressure"]["value"] if util.keys_exists(data, "rearRightTyrePressure") else None else None
elif sensor_id == "engine_state": elif sensor_id == "door_front_left":
return data["engineRunning"]["value"] if util.keys_exists(data, "engineRunning") else None return door_states[data["frontLeftDoorOpen"]["value"]] if util.keys_exists(data, "frontLeftDoorOpen") else None
elif sensor_id == "fuel_level": elif sensor_id == "door_front_right":
if util.keys_exists(data, "fuelAmount"): return door_states[data["frontRightDoorOpen"]["value"]] \
fuel_amount = int(data["fuelAmount"]["value"]) if util.keys_exists(data, "frontRightDoorOpen") else None
if fuel_amount > 0: elif sensor_id == "door_rear_left":
return fuel_amount return door_states[data["rearLeftDoorOpen"]["value"]] if util.keys_exists(data, "rearLeftDoorOpen") else None
else: elif sensor_id == "door_rear_right":
return None return door_states[data["rearRightDoorOpen"]["value"]] if util.keys_exists(data, "rearRightDoorOpen") else None
else: elif sensor_id == "tailgate":
return None return door_states[data["tailGateOpen"]["value"]] if util.keys_exists(data, "tailGateOpen") else None
elif sensor_id == "average_fuel_consumption": elif sensor_id == "sunroof":
if util.keys_exists(data, "averageFuelConsumption"): return door_states[data["sunRoofOpen"]["value"]] if util.keys_exists(data, "sunRoofOpen") else None
average_fuel_con = float(data["averageFuelConsumption"]["value"]) elif sensor_id == "engine_hood":
if average_fuel_con > 0: return door_states[data["hoodOpen"]["value"]] if util.keys_exists(data, "hoodOpen") else None
multiplier = 1 elif sensor_id == "tank_lid":
if util.keys_exists(settings["volvoData"], "averageFuelConsumptionMultiplier"): return door_states[data["tankLidOpen"]["value"]] if util.keys_exists(data, "tankLidOpen") else None
multiplier = settings["volvoData"]["averageFuelConsumptionMultiplier"] elif sensor_id == "tyre_front_left":
if isinstance(multiplier, str): return data["frontLeftTyrePressure"]["value"] if util.keys_exists(data, "frontLeftTyrePressure") else None
multiplier = 1 elif sensor_id == "tyre_front_right":
elif multiplier < 1: return data["frontRightTyrePressure"]["value"] if util.keys_exists(data, "frontRightTyrePressure") else None
multiplier = 1 elif sensor_id == "tyre_rear_left":
return average_fuel_con * multiplier return data["rearLeftTyrePressure"]["value"] if util.keys_exists(data, "rearLeftTyrePressure") else None
else: elif sensor_id == "tyre_rear_right":
return None return data["rearRightTyrePressure"]["value"] if util.keys_exists(data, "rearRightTyrePressure") else None
else: elif sensor_id == "engine_state":
return None return data["engineRunning"]["value"] if util.keys_exists(data, "engineRunning") else None
elif sensor_id == "average_speed": elif sensor_id == "fuel_level":
if util.keys_exists(data, "averageSpeed"): if util.keys_exists(data, "fuelAmount"):
average_speed = int(data["averageSpeed"]["value"]) fuel_amount = int(data["fuelAmount"]["value"])
if average_speed > 1: if fuel_amount > 0:
divider = 1 return fuel_amount
if util.keys_exists(settings["volvoData"], "averageSpeedDivider"): else:
divider = settings["volvoData"]["averageSpeedDivider"] return None
if isinstance(divider, str): else:
divider = 1 return None
elif divider < 1: elif sensor_id == "average_fuel_consumption":
divider = 1 if util.keys_exists(data, "averageFuelConsumption"):
return util.convert_metric_values(average_speed / divider) average_fuel_con = float(data["averageFuelConsumption"]["value"])
else: if average_fuel_con > 0:
return None multiplier = 1
else: if util.keys_exists(settings["volvoData"], "averageFuelConsumptionMultiplier"):
return None multiplier = settings["volvoData"]["averageFuelConsumptionMultiplier"]
elif sensor_id == "location": if isinstance(multiplier, str):
coordinates = {} multiplier = 1
if util.keys_exists(data, "geometry"): elif multiplier < 1:
raw_data = data["geometry"] multiplier = 1
if util.keys_exists(raw_data, "coordinates"): return average_fuel_con * multiplier
coordinates = {"longitude": raw_data["coordinates"][0], else:
"latitude": raw_data["coordinates"][1], return None
"gps_accuracy": 1} else:
return coordinates return None
else: elif sensor_id == "average_speed":
return None if util.keys_exists(data, "averageSpeed"):
average_speed = int(data["averageSpeed"]["value"])
if average_speed > 1:
divider = 1
if util.keys_exists(settings["volvoData"], "averageSpeedDivider"):
divider = settings["volvoData"]["averageSpeedDivider"]
if isinstance(divider, str):
divider = 1
elif divider < 1:
divider = 1
return util.convert_metric_values(average_speed / divider)
else:
return None
else:
return None
elif sensor_id == "location":
coordinates = {}
if util.keys_exists(data, "geometry"):
raw_data = data["geometry"]
if util.keys_exists(raw_data, "coordinates"):
coordinates = {"longitude": raw_data["coordinates"][0],
"latitude": raw_data["coordinates"][1],
"gps_accuracy": 1}
return coordinates
elif sensor_id == "distance_to_empty":
return util.convert_metric_values(data["distanceToEmpty"]["value"]) \
if util.keys_exists(data, "distanceToEmpty") else None
elif sensor_id == "washer_fluid_level":
return data["washerFluidLevel"]["value"] if util.keys_exists(data, "washerFluidLevel") else None
else:
return None