Compare commits

..
18 Commits
8 changed files with 249 additions and 81 deletions
+3 -1
View File
@@ -1 +1,3 @@
.idea
.idea
venv
src/settings.dev.json
+4 -2
View File
@@ -7,7 +7,9 @@ Maybe this component works also with other Volvo cars. Please try out the native
- XC40 BEV (2023)
- V60 T8 PHEV (2023)
- C40 PHEV (2023)
- C40 PHEV (2022)
- XC90 T8 PHEV (2023)
- XC60 PHEV (2023)
Please let me know if your car works with this addon so I can expand the list!
@@ -23,14 +25,14 @@ Please let me know if your car works with this addon so I can expand the list!
NOTE: Energy status currently available only for cars in the Europe / Middle East / Africa regions. [source](https://developer.volvocars.com/apis/energy/v1/overview/#availability)
## Setup
Docker:
<b>Docker:</b>
Just install this addon with the following command.
Please note to fill in your settings inside the environment variables.
`docker run --pull=always -e CONF_updateInterval=300 -e CONF_babelLocale='de' -e CONF_mqtt='@json {"broker": "", "username": "", "password": ""}' -e CONF_volvoData='@json {"username": "", "password": "", "vin": "", "vccapikey": ""}' -e TZ='Europe/Berlin' --name volvo2mqtt ghcr.io/dielee/volvo2mqtt:latest`
HA Add-On<br>
<b>HA Add-On:</b><br>
[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2FDielee%2Fvolvo2mqtt)
+1 -1
View File
@@ -2,5 +2,5 @@ from dynaconf import Dynaconf
settings = Dynaconf(
envvar_prefix="CONF",
settings_files=["settings.json", "/data/options.json"],
settings_files=["settings.json", "/data/options.json", "settings.dev.json"],
)
+1 -1
View File
@@ -1,6 +1,6 @@
name: "Volvo2Mqtt"
description: "Volvo AAOS MQTT bridge"
version: "1.1.0"
version: "1.2.0"
slug: "volvo2mqtt"
init: false
url: "https://github.com/Dielee/volvo2mqtt"
+32 -12
View File
@@ -1,26 +1,42 @@
VERSION = "v1.1.0"
from config import settings
VERSION = "v1.2.0"
OAUTH_URL = "https://volvoid.eu.volvocars.com/as/token.oauth2"
VEHICLES_URL = "https://api.volvocars.com/connected-vehicle/v1/vehicles"
VEHICLE_DETAILS_URL = "https://api.volvocars.com/connected-vehicle/v1/vehicles/{0}"
WINDOW_STATUS_URL = "https://api.volvocars.com/connected-vehicle/v1/vehicles/{0}/windows"
WINDOWS_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/windows"
CLIMATE_START_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/commands/climatization-start"
CLIMATE_STOP_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/commands/climatization-stop"
CAR_LOCK_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/doors"
LOCK_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/doors"
CAR_LOCK_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/commands/lock"
CAR_UNLOCK_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/commands/unlock"
RECHARGE_STATUS_URL = "https://api.volvocars.com/energy/v1/vehicles/{0}/recharge-status"
RECHARGE_STATE_URL = "https://api.volvocars.com/energy/v1/vehicles/{0}/recharge-status"
ODOMETER_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/odometer"
LOCATION_STATE_URL = "https://api.volvocars.com/location/v1/vehicles/{0}/location"
charging_system_states = {"CHARGING_SYSTEM_CHARGING": "Charging", "CHARGING_SYSTEM_IDLE": "Idle",
"CHARGING_SYSTEM_FAULT": "Fault", "CHARGING_SYSTEM_UNSPECIFIED": "Unspecified"}
supported_sensors = [
{"name": "Battery Charge Level", "id": "battery_charge_level", "unit": "%", "icon": "car-battery", "url": RECHARGE_STATUS_URL},
{"name": "Electric Range", "id": "electric_range", "unit": "km", "icon": "map-marker-distance", "url": RECHARGE_STATUS_URL},
{"name": "Estimated Charging Time", "id": "estimated_charging_time", "unit": "minutes", "icon": "timer-sync-outline", "url": RECHARGE_STATUS_URL},
{"name": "Charging System Status", "id": "charging_system_status", "icon": "ev-plug-ccs2", "url": RECHARGE_STATUS_URL},
{"name": "Estimated Charging Finish Time", "id": "estimated_charging_finish_time", "icon": "timer-sync-outline", "url": RECHARGE_STATUS_URL},
{"name": "Last Data Update", "id": "last_data_update", "icon": "timer", "url": ""}
{"name": "Battery Charge Level", "id": "battery_charge_level", "unit": "%", "icon": "car-battery", "url": RECHARGE_STATE_URL},
{"name": "Electric Range", "id": "electric_range", "unit": "km" if settings["babelLocale"] != "en_US" else "mi", "icon": "map-marker-distance", "url": RECHARGE_STATE_URL},
{"name": "Estimated Charging Time", "id": "estimated_charging_time", "unit": "minutes", "icon": "timer-sync-outline", "url": RECHARGE_STATE_URL},
{"name": "Charging System Status", "id": "charging_system_status", "icon": "ev-plug-ccs2", "url": RECHARGE_STATE_URL},
{"name": "Estimated Charging Finish Time", "id": "estimated_charging_finish_time", "icon": "timer-sync-outline", "url": RECHARGE_STATE_URL},
{"name": "Odometer", "id": "odometer", "unit": "km" if settings["babelLocale"] != "en_US" else "mi", "icon": "counter", "url": ODOMETER_STATE_URL},
{"name": "Last Data Update", "id": "last_data_update", "icon": "timer", "url": ""},
{"name": "Window Front Left", "id": "window_front_left", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
{"name": "Window Front Right", "id": "window_front_right", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
{"name": "Window Rear Left", "id": "window_rear_left", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
{"name": "Window Rear Right", "id": "window_rear_right", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
{"name": "Door Front Left", "id": "door_front_left", "icon": "car-door-lock", "url": LOCK_STATE_URL},
{"name": "Door Front Right", "id": "door_front_right", "icon": "car-door-lock", "url": LOCK_STATE_URL},
{"name": "Door Rear Left", "id": "door_rear_left", "icon": "car-door-lock", "url": LOCK_STATE_URL},
{"name": "Door Rear Right", "id": "door_rear_right", "icon": "car-door-lock", "url": LOCK_STATE_URL},
{"name": "Tailgate", "id": "tailgate", "icon": "car-door-lock", "url": LOCK_STATE_URL},
{"name": "Engine Hood", "id": "engine_hood", "icon": "car-door-lock", "url": LOCK_STATE_URL},
{"name": "Tank Lid", "id": "tank_lid", "icon": "car-door-lock", "url": LOCK_STATE_URL}
]
supported_switches = [
@@ -28,9 +44,13 @@ supported_switches = [
]
supported_locks = [
{"name": "Lock state", "id": "lock_status", "icon": "lock", "url": CAR_LOCK_STATE_URL}
{"name": "Lock state", "id": "lock_status", "icon": "lock", "url": LOCK_STATE_URL}
]
supported_buttons = [
{"name": "Update Data", "id": "update_data", "icon": "update", "url": ""}
{"name": "Force Update Data", "id": "update_data", "icon": "update", "url": ""}
]
supported_device_trackers = [
{"name": "Location", "id": "location", "icon": "map-marker-radius", "url": LOCATION_STATE_URL}
]
+47 -36
View File
@@ -2,18 +2,21 @@ import time
import paho.mqtt.client as mqtt
import json
import volvo
import threading
from threading import Thread, Timer
from datetime import datetime
from babel.dates import format_datetime
from config import settings
from const import VEHICLE_DETAILS_URL, CLIMATE_START_URL, CLIMATE_STOP_URL, CAR_LOCK_URL, \
CAR_UNLOCK_URL, supported_sensors, supported_buttons, supported_switches, supported_locks
from const import CLIMATE_START_URL, CLIMATE_STOP_URL, CAR_LOCK_URL, \
CAR_UNLOCK_URL, supported_sensors, supported_buttons, supported_switches, \
supported_locks, supported_device_trackers
mqtt_client: mqtt.Client
subscribed_topics = []
assumed_climate_state = {}
last_data_update = None
climate_timer: Timer
def connect():
@@ -45,18 +48,22 @@ def on_message(client, userdata, msg):
vin = msg.topic.split('/')[2].split('_')[0]
payload = msg.payload.decode("UTF-8")
if "climate_status" in msg.topic:
global assumed_climate_state
global assumed_climate_state, climate_timer
if payload == "ON":
api_thread = threading.Thread(target=volvo.api_call, args=(CLIMATE_START_URL, "POST", vin))
api_thread = Thread(target=volvo.api_call, args=(CLIMATE_START_URL, "POST", vin))
api_thread.start()
assumed_climate_state[vin] = "ON"
# Starting timer to disable climate after 30 mins
threading.Timer(30 * 60, volvo.disable_climate, (vin, )).start()
climate_timer = Timer(1 * 60, volvo.disable_climate, (vin, ))
climate_timer.start()
update_car_data()
elif payload == "OFF":
api_thread = threading.Thread(target=volvo.api_call, args=(CLIMATE_STOP_URL, "POST", vin))
api_thread = Thread(target=volvo.api_call, args=(CLIMATE_STOP_URL, "POST", vin))
api_thread.start()
assumed_climate_state[vin] = "OFF"
# Stop timer if active
if climate_timer.is_alive():
climate_timer.cancel()
update_car_data()
elif "lock_status" in msg.topic:
if payload == "LOCK":
@@ -67,7 +74,7 @@ def on_message(client, userdata, msg):
update_car_data()
elif "update_data" in msg.topic:
if payload == "PRESS":
update_car_data()
update_car_data(True)
def update_loop():
@@ -79,12 +86,19 @@ def update_loop():
time.sleep(settings["updateInterval"])
def update_car_data():
def update_car_data(force_update=False):
global last_data_update
last_data_update = format_datetime(datetime.now(), format="medium", locale=settings["babelLocale"])
for vin in volvo.vins:
for device_tracker in supported_device_trackers:
state = volvo.api_call(device_tracker["url"], "GET", vin, device_tracker["id"], force_update)
mqtt_client.publish(
f"homeassistant/device_tracker/{vin}_{device_tracker['id']}/attributes",
json.dumps(state)
)
for lock in supported_locks:
state = volvo.api_call(lock["url"], "GET", vin, lock["id"])
state = volvo.api_call(lock["url"], "GET", vin, lock["id"], force_update)
mqtt_client.publish(
f"homeassistant/lock/{vin}_{lock['id']}/state",
state
@@ -105,7 +119,7 @@ def update_car_data():
if sensor["id"] == "last_data_update":
state = last_data_update
else:
state = volvo.api_call(sensor["url"], "GET", vin, sensor["id"])
state = volvo.api_call(sensor["url"], "GET", vin, sensor["id"], force_update)
mqtt_client.publish(
f"homeassistant/sensor/{vin}_{sensor['id']}/state",
state
@@ -114,7 +128,24 @@ def update_car_data():
def create_ha_devices():
for vin in volvo.vins:
car_details = volvo.api_call(VEHICLE_DETAILS_URL, "GET", vin)
device = volvo.get_vehicle_details(vin)
for device_tracker in supported_device_trackers:
config = {
"name": device_tracker['name'],
"object_id": device_tracker['id'],
"schema": "state",
"icon": f"mdi:{device_tracker['icon']}",
"state_topic": f"homeassistant/device_tracker/{vin}_{device_tracker['id']}/state",
"device": device,
"unique_id": f"volvoAAOS2mqtt_{vin}_{device_tracker['id']}",
"json_attributes_topic": f"homeassistant/device_tracker/{vin}_{device_tracker['id']}/attributes"
}
mqtt_client.publish(
f"homeassistant/device_tracker/volvoAAOS2mqtt/{vin}_{device_tracker['id']}/config",
json.dumps(config),
)
for button in supported_buttons:
command_topic = f"homeassistant/button/{vin}_{button['id']}/command"
@@ -125,12 +156,7 @@ def create_ha_devices():
"icon": f"mdi:{button['icon']}",
"state_topic": f"homeassistant/button/{vin}_{button['id']}/state",
"command_topic": command_topic,
"device": {
"identifiers": [f"volvoAAOS2mqtt_{vin}"],
"manufacturer": "Volvo",
"model": car_details['descriptions']['model'],
"name": f"{car_details['descriptions']['model']} ({car_details['modelYear']}) - {vin}",
},
"device": device,
"unique_id": f"volvoAAOS2mqtt_{vin}_{button['id']}",
}
mqtt_client.publish(
@@ -150,12 +176,7 @@ def create_ha_devices():
"state_topic": f"homeassistant/lock/{vin}_{lock['id']}/state",
"command_topic": command_topic,
"optimistic": False,
"device": {
"identifiers": [f"volvoAAOS2mqtt_{vin}"],
"manufacturer": "Volvo",
"model": car_details['descriptions']['model'],
"name": f"{car_details['descriptions']['model']} ({car_details['modelYear']}) - {vin}",
},
"device": device,
"unique_id": f"volvoAAOS2mqtt_{vin}_{lock['id']}",
}
mqtt_client.publish(
@@ -175,12 +196,7 @@ def create_ha_devices():
"state_topic": f"homeassistant/switch/{vin}_{switch['id']}/state",
"command_topic": command_topic,
"optimistic": False,
"device": {
"identifiers": [f"volvoAAOS2mqtt_{vin}"],
"manufacturer": "Volvo",
"model": car_details['descriptions']['model'],
"name": f"{car_details['descriptions']['model']} ({car_details['modelYear']}) - {vin}",
},
"device": device,
"unique_id": f"volvoAAOS2mqtt_{vin}_{switch['id']}",
}
mqtt_client.publish(
@@ -197,12 +213,7 @@ def create_ha_devices():
"schema": "state",
"icon": f"mdi:{sensor['icon']}",
"state_topic": f"homeassistant/sensor/{vin}_{sensor['id']}/state",
"device": {
"identifiers": [f"volvoAAOS2mqtt_{vin}"],
"manufacturer": "Volvo",
"model": car_details['descriptions']['model'],
"name": f"{car_details['descriptions']['model']} ({car_details['modelYear']}) - {vin}",
},
"device": device,
"unique_id": f"volvoAAOS2mqtt_{vin}_{sensor['id']}",
}
if "unit" in sensor:
+16
View File
@@ -0,0 +1,16 @@
configuration:
updateInterval:
name: Update intervall
description: Time to wait between data pulls
babelLocale:
name: Babel locale
description: Select your country code or take a look at the GitHub repo for more infos!
debug:
name: API debug mode
description: Enable Volvo API debug, normaly this can stay off
mqtt:
name: MQTT Broker settings
description: Broker is your mqtt broker IP eg "192.168.0.1". Mqtt username and password are optional.
volvoData:
name: Volvo APP credentials
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. Take a look at the GitHub repo for more information!
+145 -28
View File
@@ -4,7 +4,8 @@ import mqtt
from config import settings
from babel.dates import format_datetime
from const import charging_system_states, CLIMATE_START_URL, \
OAUTH_URL, VEHICLES_URL, VEHICLE_DETAILS_URL, RECHARGE_STATUS_URL
OAUTH_URL, VEHICLES_URL, VEHICLE_DETAILS_URL, RECHARGE_STATE_URL, \
WINDOWS_STATE_URL, LOCK_STATE_URL
session = requests.Session()
session.headers = {
@@ -16,8 +17,12 @@ session.headers = {
token_expires_at: datetime
refresh_token = None
vins = []
recharge_response = {}
recharge_last_update = {}
recharge_cached_api_response = {}
recharge_api_last_update = {}
window_cached_api_response = {}
window_api_last_update = {}
door_cached_api_response = {}
door_api_last_update = {}
def authorize():
@@ -99,6 +104,34 @@ def get_vehicles():
print("Vin: " + str(vins) + " found!")
def get_vehicle_details(vin):
response = session.get(VEHICLE_DETAILS_URL.format(vin), timeout=15)
if response.status_code == 200:
data = response.json()["data"]
if "debug" in settings:
if settings["debug"]:
print(response.text)
device = {
"identifiers": [f"volvoAAOS2mqtt_{vin}"],
"manufacturer": "Volvo",
"model": data['descriptions']['model'],
"name": f"{data['descriptions']['model']} ({data['modelYear']}) - {vin}",
}
elif response.status_code == 500 and not settings.volvoData["vin"]:
# Workaround for some cars that are not returning vehicle details
device = {
"identifiers": [f"volvoAAOS2mqtt_{vin}"],
"manufacturer": "Volvo",
"model": vin,
"name": f"Volvo - {vin}",
}
else:
raise Exception("Getting vehicle details failed. Status Code: " + str(response.status_code) +
". Error: " + response.text)
return device
def initialize_climate(vins):
for vin in vins:
mqtt.assumed_climate_state[vin] = "OFF"
@@ -110,30 +143,20 @@ def disable_climate(vin):
mqtt.update_car_data()
def api_call(url, method, vin, sensor_id=None):
def api_call(url, method, vin, sensor_id=None, force_update=False):
global token_expires_at
if datetime.now() >= token_expires_at:
refresh_auth()
global recharge_response, recharge_last_update
if url == RECHARGE_STATUS_URL:
# Minimize API calls for recharge API
if not vin in recharge_response:
# No API Data for vin cached, get fresh data from API
print("Starting " + method + " call against " + url)
response = session.get(url.format(vin), timeout=15)
recharge_response[vin] = response
recharge_last_update[vin] = datetime.now()
else:
if (datetime.now() - recharge_last_update[vin]).total_seconds() >= settings["updateInterval"]:
# Old Data in Cache, updating
print("Starting " + method + " call against " + url)
response = session.get(url.format(vin), timeout=15)
recharge_response[vin] = response
recharge_last_update[vin] = datetime.now()
else:
# Data is up do date, returning cached data
response = recharge_response[vin]
if url == RECHARGE_STATE_URL:
# Minimize API calls for recharge state
response = pull_recharge_api(url, method, vin, force_update)
elif url == WINDOWS_STATE_URL:
# Minimize API calls for window state
response = pull_window_api(url, method, vin, force_update)
elif url == LOCK_STATE_URL:
# Minimize API calls for door state
response = pull_door_api(url, method, vin, force_update)
elif method == "GET":
print("Starting " + method + " call against " + url)
response = session.get(url.format(vin), timeout=15)
@@ -157,13 +180,74 @@ def api_call(url, method, vin, sensor_id=None):
else:
print("API Call failed. Status Code: " + str(response.status_code) + ". Error: " + response.text)
return ""
return parse_api_data(url, data, sensor_id)
return parse_api_data(data, sensor_id)
def parse_api_data(url, data, sensor_id=None):
if url == VEHICLE_DETAILS_URL:
return data["data"]
elif sensor_id == "battery_charge_level":
def pull_door_api(url, method, vin, force_update=False):
global door_cached_api_response, door_api_last_update
if not vin in door_cached_api_response or force_update:
# No API Data for vin cached, get fresh data from API
print("Starting " + method + " call against " + url)
response = session.get(url.format(vin), timeout=15)
door_cached_api_response[vin] = response
door_api_last_update[vin] = datetime.now()
else:
if (datetime.now() - door_api_last_update[vin]).total_seconds() >= settings["updateInterval"]:
# Old Data in Cache, updating
print("Starting " + method + " call against " + url)
response = session.get(url.format(vin), timeout=15)
door_cached_api_response[vin] = response
door_api_last_update[vin] = datetime.now()
else:
# Data is up do date, returning cached data
response = door_cached_api_response[vin]
return response
def pull_window_api(url, method, vin, force_update=False):
global window_cached_api_response, window_api_last_update
if not vin in window_cached_api_response or force_update:
# No API Data for vin cached, get fresh data from API
print("Starting " + method + " call against " + url)
response = session.get(url.format(vin), timeout=15)
window_cached_api_response[vin] = response
window_api_last_update[vin] = datetime.now()
else:
if (datetime.now() - window_api_last_update[vin]).total_seconds() >= settings["updateInterval"]:
# Old Data in Cache, updating
print("Starting " + method + " call against " + url)
response = session.get(url.format(vin), timeout=15)
window_cached_api_response[vin] = response
window_api_last_update[vin] = datetime.now()
else:
# Data is up do date, returning cached data
response = window_cached_api_response[vin]
return response
def pull_recharge_api(url, method, vin, force_update=False):
global recharge_cached_api_response, recharge_api_last_update
if not vin in recharge_cached_api_response or force_update:
# No API Data for vin cached, get fresh data from API
print("Starting " + method + " call against " + url)
response = session.get(url.format(vin), timeout=15)
recharge_cached_api_response[vin] = response
recharge_api_last_update[vin] = datetime.now()
else:
if (datetime.now() - recharge_api_last_update[vin]).total_seconds() >= settings["updateInterval"]:
# Old Data in Cache, updating
print("Starting " + method + " call against " + url)
response = session.get(url.format(vin), timeout=15)
recharge_cached_api_response[vin] = response
recharge_api_last_update[vin] = datetime.now()
else:
# Data is up do date, returning cached data
response = recharge_cached_api_response[vin]
return response
def parse_api_data(data, sensor_id=None):
if sensor_id == "battery_charge_level":
if "batteryChargeLevel" in data["data"]:
return data["data"]["batteryChargeLevel"]["value"]
else:
@@ -200,5 +284,38 @@ def parse_api_data(url, data, sensor_id=None):
return None
elif sensor_id == "lock_status":
return data["data"]["carLocked"]["value"]
elif sensor_id == "odometer":
return data["data"]["odometer"]["value"]
elif sensor_id == "window_front_left":
return data["data"]["frontLeftWindowOpen"]["value"]
elif sensor_id == "window_front_right":
return data["data"]["frontRightWindowOpen"]["value"]
elif sensor_id == "window_rear_left":
return data["data"]["rearLeftWindowOpen"]["value"]
elif sensor_id == "window_rear_right":
return data["data"]["rearRightWindowOpen"]["value"]
elif sensor_id == "door_front_left":
return data["data"]["frontLeftDoorOpen"]["value"]
elif sensor_id == "door_front_right":
return data["data"]["frontRightDoorOpen"]["value"]
elif sensor_id == "door_rear_left":
return data["data"]["rearLeftDoorOpen"]["value"]
elif sensor_id == "door_rear_right":
return data["data"]["rearRightDoorOpen"]["value"]
elif sensor_id == "tailgate":
return data["data"]["tailGateOpen"]["value"]
elif sensor_id == "engine_hood":
return data["data"]["hoodOpen"]["value"]
elif sensor_id == "tank_lid":
if "tankLidOpen" in data["data"]:
return data["data"]["tankLidOpen"]["value"]
else:
return ""
elif sensor_id == "location":
coordinates = {}
if "geometry" in data["data"]:
raw_data = data["data"]["geometry"]["coordinates"]
coordinates = {"longitude": raw_data[0], "latitude": raw_data[1], "gps_accuracy": 1}
return coordinates
else:
return ""