Compare commits

...
8 Commits
Author SHA1 Message Date
Linus Dietz 8c0ce8976e get distanceToEmpty sensor from connected api 2023-06-30 12:21:28 +02:00
Linus DietzandGitHub 34a0b9b2a7 Optimize logging (#41)
* Move print statements to logger

* Add external log location for addon usage

* Add more detailed logs for debug

* Bump version
2023-06-30 11:16:57 +02:00
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
9 changed files with 491 additions and 401 deletions
+2
View File
@@ -2,3 +2,5 @@
venv venv
src/settings.dev.json src/settings.dev.json
.env .env
/src/volvo2mqtt.log
/src/volvo2mqtt.log.1
+2 -1
View File
@@ -15,6 +15,7 @@ RUN pip install -r requirements.txt
# copy the content of the local src directory to the working directory # copy the content of the local src directory to the working directory
COPY / . COPY / .
RUN chmod a+x /volvoAAOS2mqtt/run.sh
# command to run on container start # command to run on container start
CMD [ "python", "-u", "./main.py" ] CMD [ "/volvoAAOS2mqtt/run.sh" ]
+3 -1
View File
@@ -1,10 +1,12 @@
name: "Volvo2Mqtt" name: "Volvo2Mqtt"
description: "Volvo AAOS MQTT bridge" description: "Volvo AAOS MQTT bridge"
version: "1.6.0" version: "1.6.3"
slug: "volvo2mqtt" slug: "volvo2mqtt"
init: false init: false
url: "https://github.com/Dielee/volvo2mqtt" url: "https://github.com/Dielee/volvo2mqtt"
apparmor: true apparmor: true
map:
- addons:rw
options: options:
updateInterval: 300 updateInterval: 300
babelLocale: null babelLocale: null
+2 -1
View File
@@ -1,6 +1,6 @@
from config import settings from config import settings
VERSION = "v1.6.0" VERSION = "v1.6.3"
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"
@@ -79,5 +79,6 @@ 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": "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": 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}
] ]
+5 -2
View File
@@ -1,11 +1,14 @@
import logging
from volvo import authorize from volvo import authorize
from mqtt import update_loop, connect from mqtt import update_loop, connect
from const import VERSION from const import VERSION
from util import set_tz from util import set_tz, setup_logging
if __name__ == '__main__': if __name__ == '__main__':
print("Starting volvo2mqtt version " + VERSION)
set_tz() set_tz()
setup_logging()
logging.info("Starting volvo2mqtt version " + VERSION)
authorize() authorize()
connect() connect()
update_loop() update_loop()
+33 -12
View File
@@ -1,3 +1,4 @@
import logging
import time import time
import paho.mqtt.client as mqtt import paho.mqtt.client as mqtt
import json import json
@@ -16,6 +17,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():
@@ -47,41 +49,60 @@ def on_connect(client, userdata, flags, rc):
def on_disconnect(client, userdata, rc): def on_disconnect(client, userdata, rc):
print("MQTT disconnected, reconnecting automatically") logging.warning("MQTT disconnected, reconnecting automatically")
def on_message(client, userdata, msg): def on_message(client, userdata, msg):
try: try:
vin = msg.topic.split('/')[2].split('_')[0] vin = msg.topic.split('/')[2].split('_')[0]
except IndexError: except IndexError:
print("Error - Cannot get vin from MQTT topic!") logging.error("Error - Cannot get vin from MQTT topic!")
return None return None
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":
@@ -91,10 +112,10 @@ def on_message(client, userdata, msg):
def update_loop(): def update_loop():
create_ha_devices() create_ha_devices()
while True: while True:
print("Sending mqtt update...") logging.info("Sending mqtt update...")
send_heartbeat() send_heartbeat()
update_car_data() update_car_data()
print("Mqtt update done. Next run in " + str(settings["updateInterval"]) + " seconds.") logging.info("Mqtt update done. Next run in " + str(settings["updateInterval"]) + " seconds.")
time.sleep(settings["updateInterval"]) time.sleep(settings["updateInterval"])
+4
View File
@@ -0,0 +1,4 @@
#!/bin/bash
export IS_HA_ADDON="true"
python -u main.py
+36
View File
@@ -1,11 +1,46 @@
import logging
import pytz import pytz
import os import os
import sys
from logging import handlers
from datetime import datetime
from const import units from const import units
from config import settings from config import settings
from pathlib import Path
TZ = None TZ = None
def setup_logging():
log_location = "volvo2mqtt.log"
if os.environ.get("IS_HA_ADDON"):
check_existing_folder()
log_location = "/addons/volvo2mqtt/log/volvo2mqtt.log"
logging.Formatter.converter = lambda *args: datetime.now(tz=TZ).timetuple()
file_log_handler = logging.handlers.RotatingFileHandler(log_location, maxBytes=1000000, backupCount=1)
formatter = logging.Formatter(
'%(asctime)s volvo2mqtt [%(process)d] - %(levelname)s: %(message)s',
'%b %d %H:%M:%S')
file_log_handler.setFormatter(formatter)
logger = logging.getLogger()
console_log_handler = logging.StreamHandler(sys.stdout)
console_log_handler.setFormatter(formatter)
logger.addHandler(console_log_handler)
logger.addHandler(file_log_handler)
logger.setLevel(logging.INFO)
if "debug" in settings:
if settings["debug"]:
logger.setLevel(logging.DEBUG)
def check_existing_folder():
Path("/addons/volvo2mqtt/log/").mkdir(parents=True, exist_ok=True)
def keys_exists(element, *keys): def keys_exists(element, *keys):
"""" """"
Check if *keys (nested) exists in `element` (dict). Check if *keys (nested) exists in `element` (dict).
@@ -43,3 +78,4 @@ def convert_metric_values(value):
return round((float(value) / divider), 2) return round((float(value) / divider), 2)
else: else:
return value return value
+404 -384
View File
@@ -1,384 +1,404 @@
import requests import logging
import mqtt import requests
import util import mqtt
from datetime import datetime, timedelta import util
from config import settings import time
from babel.dates import format_datetime from threading import Thread, currentThread
from const import charging_system_states, charging_connection_states, door_states, window_states, \ from datetime import datetime, timedelta
OAUTH_URL, VEHICLES_URL, VEHICLE_DETAILS_URL, RECHARGE_STATE_URL, CLIMATE_START_URL, \ from config import settings
WINDOWS_STATE_URL, LOCK_STATE_URL, TYRE_STATE_URL, supported_entities, BATTERY_CHARGE_STATE_URL, \ from babel.dates import format_datetime
STATISTICS_URL 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, \
session = requests.Session() WINDOWS_STATE_URL, LOCK_STATE_URL, TYRE_STATE_URL, supported_entities, BATTERY_CHARGE_STATE_URL, \
session.headers = { STATISTICS_URL, CLIMATE_STOP_URL
"vcc-api-key": settings["volvoData"]["vccapikey"],
"content-type": "application/json", session = requests.Session()
"accept": "*/*" session.headers = {
} "vcc-api-key": settings["volvoData"]["vccapikey"],
"content-type": "application/json",
token_expires_at: datetime "accept": "*/*"
refresh_token = None }
vins = []
supported_endpoints = {} token_expires_at: datetime
cached_requests = {} refresh_token = None
vins = []
supported_endpoints = {}
def authorize(): cached_requests = {}
headers = {
"authorization": "Basic aDRZZjBiOlU4WWtTYlZsNnh3c2c1WVFxWmZyZ1ZtSWFEcGhPc3kxUENhVXNpY1F0bzNUUjVrd2FKc2U0QVpkZ2ZJZmNMeXc=",
"content-type": "application/x-www-form-urlencoded", def authorize():
"accept": "application/json" headers = {
} "authorization": "Basic aDRZZjBiOlU4WWtTYlZsNnh3c2c1WVFxWmZyZ1ZtSWFEcGhPc3kxUENhVXNpY1F0bzNUUjVrd2FKc2U0QVpkZ2ZJZmNMeXc=",
"content-type": "application/x-www-form-urlencoded",
body = { "accept": "application/json"
"username": settings.volvoData["username"], }
"password": settings.volvoData["password"],
"grant_type": "password", body = {
"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" "username": settings.volvoData["username"],
} "password": settings.volvoData["password"],
auth = requests.post(OAUTH_URL, data=body, headers=headers) "grant_type": "password",
if auth.status_code == 200: "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"
data = auth.json() }
session.headers.update({'authorization': "Bearer " + data["access_token"]}) auth = requests.post(OAUTH_URL, data=body, headers=headers)
if auth.status_code == 200:
global token_expires_at, refresh_token data = auth.json()
token_expires_at = datetime.now(util.TZ) + timedelta(seconds=(data["expires_in"] - 30)) session.headers.update({'authorization': "Bearer " + data["access_token"]})
refresh_token = data["refresh_token"]
global token_expires_at, refresh_token
get_vehicles() token_expires_at = datetime.now(util.TZ) + timedelta(seconds=(data["expires_in"] - 30))
check_supported_endpoints() refresh_token = data["refresh_token"]
else:
message = auth.json() get_vehicles()
raise Exception(message["error_description"]) check_supported_endpoints()
else:
message = auth.json()
def refresh_auth(): raise Exception(message["error_description"])
print("Refreshing credentials")
global refresh_token
headers = { def refresh_auth():
"authorization": "Basic aDRZZjBiOlU4WWtTYlZsNnh3c2c1WVFxWmZyZ1ZtSWFEcGhPc3kxUENhVXNpY1F0bzNUUjVrd2FKc2U0QVpkZ2ZJZmNMeXc=", logging.info("Refreshing credentials")
"content-type": "application/x-www-form-urlencoded", global refresh_token
"accept": "application/json" headers = {
} "authorization": "Basic aDRZZjBiOlU4WWtTYlZsNnh3c2c1WVFxWmZyZ1ZtSWFEcGhPc3kxUENhVXNpY1F0bzNUUjVrd2FKc2U0QVpkZ2ZJZmNMeXc=",
"content-type": "application/x-www-form-urlencoded",
body = { "accept": "application/json"
"grant_type": "refresh_token", }
"refresh_token": refresh_token
} body = {
auth = requests.post(OAUTH_URL, data=body, headers=headers) "grant_type": "refresh_token",
if auth.status_code == 200: "refresh_token": refresh_token
data = auth.json() }
session.headers.update({'authorization': "Bearer " + data["access_token"]})
try:
global token_expires_at auth = requests.post(OAUTH_URL, data=body, headers=headers)
token_expires_at = datetime.now(util.TZ) + timedelta(seconds=(data["expires_in"] - 30)) except requests.exceptions.RequestException as e:
refresh_token = data["refresh_token"] logging.error("Error refreshing credentials data: " + str(e))
return None
def get_vehicles(): if auth.status_code == 200:
global vins data = auth.json()
if not settings.volvoData["vin"]: session.headers.update({'authorization': "Bearer " + data["access_token"]})
vehicles = session.get(VEHICLES_URL)
if vehicles.status_code == 200: global token_expires_at
data = vehicles.json() token_expires_at = datetime.now(util.TZ) + timedelta(seconds=(data["expires_in"] - 30))
if len(data["data"]) > 0: refresh_token = data["refresh_token"]
for vehicle in data["data"]:
vins.append(vehicle["vin"])
else: def get_vehicles():
raise Exception("No vehicle in account " + settings.volvoData["username"] + " found.") global vins
else: if not settings.volvoData["vin"]:
error = vehicles.json() vehicles = session.get(VEHICLES_URL)
raise Exception( if vehicles.status_code == 200:
"Error getting vehicles: " + str(vehicles.status_code) + ". " + str(error["error"].get("message"))) data = vehicles.json()
else: if len(data["data"]) > 0:
if isinstance(settings.volvoData["vin"], list): for vehicle in data["data"]:
# If setting is a list, copy vins.append(vehicle["vin"])
vins = settings.volvoData["vin"] else:
else: raise Exception("No vehicle in account " + settings.volvoData["username"] + " found.")
# If setting is a string, append to list else:
vins.append(settings.volvoData["vin"]) error = vehicles.json()
raise Exception(
if len(vins) == 0: "Error getting vehicles: " + str(vehicles.status_code) + ". " + str(error["error"].get("message")))
raise Exception("No vehicle found, exiting application!") else:
else: if isinstance(settings.volvoData["vin"], list):
initialize_climate(vins) # If setting is a list, copy
print("Vin: " + str(vins) + " found!") vins = settings.volvoData["vin"]
else:
# If setting is a string, append to list
def get_vehicle_details(vin): vins.append(settings.volvoData["vin"])
response = session.get(VEHICLE_DETAILS_URL.format(vin), timeout=15)
if response.status_code == 200: if len(vins) == 0:
data = response.json()["data"] raise Exception("No vehicle found, exiting application!")
if "debug" in settings: else:
if settings["debug"]: initialize_climate(vins)
print(response.text) logging.info("Vin: " + str(vins) + " found!")
device = {
"identifiers": [f"volvoAAOS2mqtt_{vin}"],
"manufacturer": "Volvo", def get_vehicle_details(vin):
"model": data['descriptions']['model'], response = session.get(VEHICLE_DETAILS_URL.format(vin), timeout=15)
"name": f"{data['descriptions']['model']} ({data['modelYear']}) - {vin}", if response.status_code == 200:
} data = response.json()["data"]
elif response.status_code == 500 and not settings.volvoData["vin"]: logging.debug(response.text)
# Workaround for some cars that are not returning vehicle details device = {
device = { "identifiers": [f"volvoAAOS2mqtt_{vin}"],
"identifiers": [f"volvoAAOS2mqtt_{vin}"], "manufacturer": "Volvo",
"manufacturer": "Volvo", "model": data['descriptions']['model'],
"model": vin, "name": f"{data['descriptions']['model']} ({data['modelYear']}) - {vin}",
"name": f"Volvo - {vin}", }
} elif response.status_code == 500 and not settings.volvoData["vin"]:
else: # Workaround for some cars that are not returning vehicle details
raise Exception("Getting vehicle details failed. Status Code: " + str(response.status_code) + device = {
". Error: " + response.text) "identifiers": [f"volvoAAOS2mqtt_{vin}"],
"manufacturer": "Volvo",
return device "model": vin,
"name": f"Volvo - {vin}",
}
def check_supported_endpoints(): else:
global supported_endpoints raise Exception("Getting vehicle details failed. Status Code: " + str(response.status_code) +
for vin in vins: ". Error: " + response.text)
supported_endpoints[vin] = []
for entity in supported_entities: return device
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 battery charge level could be found in recharge-api, skip the second battery charge sensor def check_supported_endpoints():
continue global supported_endpoints
for vin in vins:
if entity.get('url'): supported_endpoints[vin] = []
state = api_call(entity["url"], "GET", vin, entity["id"]) for entity in supported_entities:
else: if entity["id"] == "battery_charge_level" and entity["url"] == BATTERY_CHARGE_STATE_URL \
state = "" 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
if state is not None: continue
print("Success! " + entity["name"] + " is supported by your vehicle.")
supported_endpoints[vin].append(entity) if entity.get('url'):
else: state = api_call(entity["url"], "GET", vin, entity["id"])
print("Failed, " + entity["name"] + " is unfortunately not supported by your vehicle.") else:
state = ""
def initialize_climate(vins): if state is not None:
for vin in vins: logging.info("Success! " + entity["name"] + " is supported by your vehicle.")
mqtt.assumed_climate_state[vin] = "OFF" supported_endpoints[vin].append(entity)
else:
logging.info("Failed, " + entity["name"] + " is unfortunately not supported by your vehicle.")
def disable_climate(vin):
print("Turning climate off by timer!")
mqtt.assumed_climate_state[vin] = "OFF" def initialize_climate(vins):
mqtt.update_car_data() 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 def disable_climate(vin):
if datetime.now(util.TZ) >= token_expires_at: logging.info("Turning climate off by timer!")
refresh_auth() mqtt.door_status[vin].do_run = False
mqtt.assumed_climate_state[vin] = "OFF"
if url in [RECHARGE_STATE_URL, WINDOWS_STATE_URL, LOCK_STATE_URL, TYRE_STATE_URL, STATISTICS_URL]: mqtt.update_car_data()
# Minimize API calls for endpoints with multiple values
response = cached_request(url, method, vin, force_update)
if response is None: def check_door_status(vin):
# Exception caught while getting data from volvo api, doing nothing t = currentThread()
return None while getattr(t, "do_run", True):
elif method == "GET": lock_door_left = api_call(LOCK_STATE_URL, "GET", vin, "door_front_left", True)
print("Starting " + method + " call against " + url) lock_door_right = api_call(LOCK_STATE_URL, "GET", vin, "door_front_right", True)
try: if lock_door_left == "ON" or lock_door_right == "ON":
response = session.get(url.format(vin), timeout=15) Thread(target=api_call, args=(CLIMATE_STOP_URL, "POST", vin)).start()
except requests.exceptions.RequestException as e: mqtt.assumed_climate_state[vin] = "OFF"
print("Error getting data: " + str(e)) mqtt.update_car_data()
return "" break
elif method == "POST": time.sleep(5)
print("Starting " + method + " call against " + url)
try:
response = session.post(url.format(vin), timeout=20) def api_call(url, method, vin, sensor_id=None, force_update=False):
except requests.exceptions.RequestException as e: global token_expires_at
print("Error getting data: " + str(e)) if datetime.now(util.TZ) >= token_expires_at:
return "" refresh_auth()
else:
print("Unkown method posted: " + method + ". Returning nothing") if url in [RECHARGE_STATE_URL, WINDOWS_STATE_URL, LOCK_STATE_URL, TYRE_STATE_URL, STATISTICS_URL]:
return "" # Minimize API calls for endpoints with multiple values
response = cached_request(url, method, vin, force_update)
if response.status_code == 200: if response is None:
data = response.json() # Exception caught while getting data from volvo api, doing nothing
if "debug" in settings: return None
if settings["debug"]: elif method == "GET":
print(response.text) logging.debug("Starting " + method + " call against " + url)
else: try:
if url == CLIMATE_START_URL and response.status_code == 503: response = session.get(url.format(vin), timeout=15)
print("Car in use, cannot start pre climatization") except requests.exceptions.RequestException as e:
mqtt.assumed_climate_state[vin] = "OFF" logging.error("Error getting data: " + str(e))
mqtt.update_car_data() return None
else: elif method == "POST":
print("API Call failed. Status Code: " + str(response.status_code) + ". Error: " + response.text) logging.debug("Starting " + method + " call against " + url)
return "" try:
return parse_api_data(data, sensor_id) response = session.post(url.format(vin), timeout=20)
except requests.exceptions.RequestException as e:
logging.error("Error getting data: " + str(e))
def cached_request(url, method, vin, force_update=False): return None
global cached_requests else:
if not util.keys_exists(cached_requests, vin + "_" + url): logging.error("Unkown method posted: " + method + ". Returning nothing")
# No API Data cached, get fresh data from API return None
print("Starting " + method + " call against " + url)
try: logging.debug("Response status code: " + str(response.status_code))
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)) logging.debug(response.text)
return None else:
logging.debug(response.text)
data = {"response": response, "last_update": datetime.now(util.TZ)} if url == CLIMATE_START_URL and response.status_code == 503:
cached_requests[vin + "_" + url] = data logging.warning("Car in use, cannot start pre climatization")
else: mqtt.assumed_climate_state[vin] = "OFF"
if (datetime.now(util.TZ) - cached_requests[vin + "_" + url]["last_update"]).total_seconds() >= settings[ mqtt.update_car_data()
"updateInterval"] \ elif "extended-vehicle" in url and response.status_code == 403:
or (force_update and ( # Suppress 403 errors for unsupported extended-vehicle api cars
datetime.now(util.TZ) - cached_requests[vin + "_" + url]["last_update"]).total_seconds() >= 2): logging.debug("Suppressed 403 for extended-vehicle API")
# Old Data in Cache, or force mode active, updating return None
print("Starting " + method + " call against " + url) else:
try: logging.error("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"] logging.debug("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): logging.error("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"]] \ logging.debug("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"]] logging.error("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) \ return None
if util.keys_exists(data, "odometer") else None elif sensor_id == "estimated_charging_finish_time":
elif sensor_id == "window_front_left": if util.keys_exists(data, "chargingSystemStatus"):
return window_states[data["frontLeftWindowOpen"]["value"]] if util.keys_exists(data, "frontLeftWindowOpen") \ charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]]
else None if charging_system_state == "Charging":
elif sensor_id == "window_front_right": charging_time = int(
return window_states[data["frontRightWindowOpen"]["value"]] if util.keys_exists(data, "frontRightWindowOpen") \ data["estimatedChargingTime"]["value"] if util.keys_exists(data, "estimatedChargingTime")
else None else 0)
elif sensor_id == "window_rear_left": charging_finished = datetime.now(util.TZ) + timedelta(minutes=charging_time)
return window_states[data["rearLeftWindowOpen"]["value"]] if util.keys_exists(data, "rearLeftWindowOpen") \ return format_datetime(charging_finished, format="medium", locale=settings["babelLocale"])
else None else:
elif sensor_id == "window_rear_right": return ""
return window_states[data["rearRightWindowOpen"]["value"]] if util.keys_exists(data, "rearRightWindowOpen") \ return None
else None elif sensor_id == "lock_status":
elif sensor_id == "door_front_left": return data["carLocked"]["value"] if util.keys_exists(data, "carLocked") else None
return door_states[data["frontLeftDoorOpen"]["value"]] if util.keys_exists(data, "frontLeftDoorOpen") else None elif sensor_id == "odometer":
elif sensor_id == "door_front_right": multiplier = 1
return door_states[data["frontRightDoorOpen"]["value"]] \ if util.keys_exists(settings["volvoData"], "odometerMultiplier"):
if util.keys_exists(data, "frontRightDoorOpen") else None multiplier = settings["volvoData"]["odometerMultiplier"]
elif sensor_id == "door_rear_left": if isinstance(multiplier, str):
return door_states[data["rearLeftDoorOpen"]["value"]] if util.keys_exists(data, "rearLeftDoorOpen") else None multiplier = 1
elif sensor_id == "door_rear_right": elif multiplier < 1:
return door_states[data["rearRightDoorOpen"]["value"]] if util.keys_exists(data, "rearRightDoorOpen") else None multiplier = 1
elif sensor_id == "tailgate": return util.convert_metric_values(int(data["odometer"]["value"]) * multiplier) \
return door_states[data["tailGateOpen"]["value"]] if util.keys_exists(data, "tailGateOpen") else None if util.keys_exists(data, "odometer") else None
elif sensor_id == "sunroof": elif sensor_id == "window_front_left":
return door_states[data["sunRoofOpen"]["value"]] if util.keys_exists(data, "sunRoofOpen") else None return window_states[data["frontLeftWindowOpen"]["value"]] if util.keys_exists(data, "frontLeftWindowOpen") \
elif sensor_id == "engine_hood": else None
return door_states[data["hoodOpen"]["value"]] if util.keys_exists(data, "hoodOpen") else None elif sensor_id == "window_front_right":
elif sensor_id == "tank_lid": return window_states[data["frontRightWindowOpen"]["value"]] if util.keys_exists(data, "frontRightWindowOpen") \
return door_states[data["tankLidOpen"]["value"]] if util.keys_exists(data, "tankLidOpen") else None else None
elif sensor_id == "tyre_front_left": elif sensor_id == "window_rear_left":
return data["frontLeftTyrePressure"]["value"] if util.keys_exists(data, "frontLeftTyrePressure") else None return window_states[data["rearLeftWindowOpen"]["value"]] if util.keys_exists(data, "rearLeftWindowOpen") \
elif sensor_id == "tyre_front_right": else None
return data["frontRightTyrePressure"]["value"] if util.keys_exists(data, "frontRightTyrePressure") else None elif sensor_id == "window_rear_right":
elif sensor_id == "tyre_rear_left": return window_states[data["rearRightWindowOpen"]["value"]] if util.keys_exists(data, "rearRightWindowOpen") \
return data["rearLeftTyrePressure"]["value"] if util.keys_exists(data, "rearLeftTyrePressure") else None else None
elif sensor_id == "tyre_rear_right": elif sensor_id == "door_front_left":
return data["rearRightTyrePressure"]["value"] if util.keys_exists(data, "rearRightTyrePressure") else None return door_states[data["frontLeftDoorOpen"]["value"]] if util.keys_exists(data, "frontLeftDoorOpen") else None
elif sensor_id == "engine_state": elif sensor_id == "door_front_right":
return data["engineRunning"]["value"] if util.keys_exists(data, "engineRunning") else None return door_states[data["frontRightDoorOpen"]["value"]] \
elif sensor_id == "fuel_level": if util.keys_exists(data, "frontRightDoorOpen") else None
if util.keys_exists(data, "fuelAmount"): elif sensor_id == "door_rear_left":
fuel_amount = int(data["fuelAmount"]["value"]) return door_states[data["rearLeftDoorOpen"]["value"]] if util.keys_exists(data, "rearLeftDoorOpen") else None
if fuel_amount > 0: elif sensor_id == "door_rear_right":
return fuel_amount 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
else: elif sensor_id == "sunroof":
return None return door_states[data["sunRoofOpen"]["value"]] if util.keys_exists(data, "sunRoofOpen") else None
elif sensor_id == "average_fuel_consumption": elif sensor_id == "engine_hood":
if util.keys_exists(data, "averageFuelConsumption"): return door_states[data["hoodOpen"]["value"]] if util.keys_exists(data, "hoodOpen") else None
average_fuel_con = float(data["averageFuelConsumption"]["value"]) elif sensor_id == "tank_lid":
if average_fuel_con > 0: return door_states[data["tankLidOpen"]["value"]] if util.keys_exists(data, "tankLidOpen") else None
multiplier = 1 elif sensor_id == "tyre_front_left":
if util.keys_exists(settings["volvoData"], "averageFuelConsumptionMultiplier"): return data["frontLeftTyrePressure"]["value"] if util.keys_exists(data, "frontLeftTyrePressure") else None
multiplier = settings["volvoData"]["averageFuelConsumptionMultiplier"] elif sensor_id == "tyre_front_right":
if isinstance(multiplier, str): return data["frontRightTyrePressure"]["value"] if util.keys_exists(data, "frontRightTyrePressure") else None
multiplier = 1 elif sensor_id == "tyre_rear_left":
elif multiplier < 1: return data["rearLeftTyrePressure"]["value"] if util.keys_exists(data, "rearLeftTyrePressure") else None
multiplier = 1 elif sensor_id == "tyre_rear_right":
return average_fuel_con * multiplier 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
else: elif sensor_id == "fuel_level":
return None if util.keys_exists(data, "fuelAmount"):
elif sensor_id == "average_speed": fuel_amount = int(data["fuelAmount"]["value"])
if util.keys_exists(data, "averageSpeed"): if fuel_amount > 0:
average_speed = int(data["averageSpeed"]["value"]) return fuel_amount
if average_speed > 1: return None
divider = 1 elif sensor_id == "average_fuel_consumption":
if util.keys_exists(settings["volvoData"], "averageSpeedDivider"): if util.keys_exists(data, "averageFuelConsumption"):
divider = settings["volvoData"]["averageSpeedDivider"] average_fuel_con = float(data["averageFuelConsumption"]["value"])
if isinstance(divider, str): if average_fuel_con > 0:
divider = 1 multiplier = 1
elif divider < 1: if util.keys_exists(settings["volvoData"], "averageFuelConsumptionMultiplier"):
divider = 1 multiplier = settings["volvoData"]["averageFuelConsumptionMultiplier"]
return util.convert_metric_values(average_speed / divider) if isinstance(multiplier, str):
else: multiplier = 1
return None elif multiplier < 1:
else: multiplier = 1
return None return average_fuel_con * multiplier
elif sensor_id == "location": return None
coordinates = {} elif sensor_id == "average_speed":
if util.keys_exists(data, "geometry"): if util.keys_exists(data, "averageSpeed"):
raw_data = data["geometry"] average_speed = int(data["averageSpeed"]["value"])
if util.keys_exists(raw_data, "coordinates"): if average_speed > 1:
coordinates = {"longitude": raw_data["coordinates"][0], divider = 1
"latitude": raw_data["coordinates"][1], if util.keys_exists(settings["volvoData"], "averageSpeedDivider"):
"gps_accuracy": 1} divider = settings["volvoData"]["averageSpeedDivider"]
return coordinates if isinstance(divider, str):
else: divider = 1
return None elif divider < 1:
divider = 1
return util.convert_metric_values(average_speed / divider)
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":
if util.keys_exists(data, "distanceToEmpty"):
distance_to_empty = int(data["distanceToEmpty"]["value"])
if distance_to_empty > 0:
return util.convert_metric_values(data["distanceToEmpty"]["value"])
return None
else:
return None