Compare commits

...
20 Commits
Author SHA1 Message Date
Linus Dietz 0a12587276 Merge remote-tracking branch 'origin/main' into main 2023-07-03 09:02:30 +02:00
Linus Dietz 91c50dba05 Add MQTT autodiscovery for HA MQTT Addon 2023-07-03 09:02:21 +02:00
Linus DietzandGitHub b93f50ae0b Add stale bot 2023-07-03 07:54:59 +02:00
Linus Dietz 9a6d128cdf Rework pre-climate state based on engine state 2023-07-03 07:48:39 +02:00
Linus Dietz 1998dfc231 Add engine state fallback endpoint // Dynamic icons for engine state 2023-07-03 07:26:18 +02:00
Linus Dietz 389be776d0 Add log location to debug description 2023-07-03 07:15:10 +02:00
Linus Dietz ebc3ba4e16 Fix missing key for en_GB and en_US locales 2023-07-02 09:03:11 +02:00
Linus DietzandGitHub a1881a87d8 Added dynamic icons lock, battery and window state (#45)
#43
2023-07-01 15:06:23 +02:00
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
Linus DietzandGitHub f0d4d68792 Add value conversion from metric to imperial (#36)
* Convert km to miles, km/h to mp/h if babelLocale is en_GB or en_US #34

* Remove unused variable

* Change speed unit for imperial system // Bump version
2023-06-27 15:29:48 +02:00
Linus DietzandGitHub 140a735773 Update README.md 2023-06-27 14:24:43 +02:00
Linus Dietz ebcabc6ff4 rework error message for get_vehicles 2023-06-27 09:11:07 +02:00
Linus Dietz c995c2a44d Optimize error message for get_vehicles 2023-06-27 09:09:28 +02:00
12 changed files with 689 additions and 406 deletions
+33
View File
@@ -0,0 +1,33 @@
# This workflow warns and then closes issues and PRs that have had no activity for a specified amount of time.
#
# You can adjust the behavior by modifying this file.
# For more information, see:
# https://github.com/actions/stale
name: Mark stale issues and pull requests
on:
schedule:
- cron: '0 0 * * *'
jobs:
stale:
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write
steps:
- uses: actions/stale@v5
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
days-before-issue-stale: 15
days-before-pr-stale: 45
days-before-issue-close: 5
days-before-pr-close: 10
stale-issue-message: 'This issue is stale because it has been open 15 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
stale-pr-message: 'This PR is stale because it has been open 20 days with no activity. Remove stale label or comment or this will be closed in 10 days.'
close-issue-message: 'This issue was closed because it has been stalled for 5 days with no activity.'
close-pr-message: 'This PR was closed because it has been stalled for 10 days with no activity.'
stale-issue-label: 'no-issue-activity'
stale-pr-label: 'no-pr-activity'
+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" ]
+10 -6
View File
@@ -1,20 +1,24 @@
name: "Volvo2Mqtt" name: "Volvo2Mqtt"
description: "Volvo AAOS MQTT bridge" description: "Volvo AAOS MQTT bridge"
version: "1.5.6" version: "1.7.0"
slug: "volvo2mqtt" slug: "volvo2mqtt"
init: false init: false
url: "https://github.com/Dielee/volvo2mqtt" url: "https://github.com/Dielee/volvo2mqtt"
apparmor: true apparmor: true
services:
- 'mqtt:need'
map:
- addons:rw
options: options:
updateInterval: 300 updateInterval: 300
babelLocale: null babelLocale: null
TZ: null TZ: null
debug: false debug: false
mqtt: mqtt:
broker: null broker: "auto_broker"
port: 1883 port: "auto_port"
username: "" username: "auto_user"
password: "" password: "auto_password"
volvoData: volvoData:
username: null username: null
password: null password: null
@@ -30,7 +34,7 @@ schema:
debug: bool debug: bool
mqtt: mqtt:
broker: str broker: str
port: int(1,) port: str
username: str? username: str?
password: str? password: str?
volvoData: volvoData:
+46 -4
View File
@@ -1,6 +1,6 @@
from config import settings from config import settings
VERSION = "v1.5.6" VERSION = "v1.7.0"
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,24 @@ 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"
ENGINE_DIAGNOSTICS_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/engine"
units = {
"en_GB": {
"divider": 1.60934,
"electric_range": {"unit": "mi"},
"odometer": {"unit": "mi"},
"average_speed": {"unit": "mph"},
"distance_to_empty": {"unit": "mi"}
},
"en_US": {
"divider": 1.60934,
"electric_range": {"unit": "mi"},
"odometer": {"unit": "mi"},
"average_speed": {"unit": "mph"},
"distance_to_empty": {"unit": "mi"}
}
}
availability_topic = "volvoAAOS2mqtt/availability" availability_topic = "volvoAAOS2mqtt/availability"
@@ -31,15 +49,37 @@ charging_connection_states = {"CONNECTION_STATUS_DISCONNECTED": "Disconnected",
window_states = {"CLOSED": "OFF", "OPEN": "ON"} window_states = {"CLOSED": "OFF", "OPEN": "ON"}
door_states = {"CLOSED": "OFF", "OPEN": "ON"} door_states = {"CLOSED": "OFF", "OPEN": "ON"}
icon_states = {
"lock_status": {"UNLOCKED": "lock-open-alert", "LOCKED": "lock"},
"door_front_left": {"ON": "car-door", "OFF": "car-door-lock"},
"door_front_right": {"ON": "car-door", "OFF": "car-door-lock"},
"door_rear_left": {"ON": "car-door", "OFF": "car-door-lock"},
"door_rear_right": {"ON": "car-door", "OFF": "car-door-lock"},
"engine_state": {"RUNNING": "engine-outline", "STOPPED": "engine-off-outline"},
"battery_charge_level": [
{"from": 100, "to": 100, "icon": "battery"},
{"from": 99, "to": 90, "icon": "battery-90"},
{"from": 89, "to": 80, "icon": "battery-80"},
{"from": 79, "to": 70, "icon": "battery-70"},
{"from": 69, "to": 60, "icon": "battery-60"},
{"from": 59, "to": 50, "icon": "battery-50"},
{"from": 49, "to": 40, "icon": "battery-40"},
{"from": 39, "to": 30, "icon": "battery-30"},
{"from": 29, "to": 20, "icon": "battery-20"},
{"from": 19, "to": 10, "icon": "battery-10"},
{"from": 9, "to": 0, "icon": "battery-alert-variant-outline"},
]
}
supported_entities = [ supported_entities = [
{"name": "Battery Charge Level", "domain": "sensor", "id": "battery_charge_level", "unit": "%", "icon": "car-battery", "url": RECHARGE_STATE_URL}, {"name": "Battery Charge Level", "domain": "sensor", "id": "battery_charge_level", "unit": "%", "icon": "car-battery", "url": RECHARGE_STATE_URL},
{"name": "Battery Charge Level", "domain": "sensor", "id": "battery_charge_level", "unit": "%", "icon": "car-battery", "url": BATTERY_CHARGE_STATE_URL}, {"name": "Battery Charge Level", "domain": "sensor", "id": "battery_charge_level", "unit": "%", "icon": "car-battery", "url": BATTERY_CHARGE_STATE_URL},
{"name": "Electric Range", "domain": "sensor", "id": "electric_range", "unit": "km" if settings["babelLocale"] != "en_US" else "mi", "icon": "map-marker-distance", "url": RECHARGE_STATE_URL}, {"name": "Electric Range", "domain": "sensor", "id": "electric_range", "unit": "km" if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["electric_range"]["unit"], "icon": "map-marker-distance", "url": RECHARGE_STATE_URL},
{"name": "Estimated Charging Time", "domain": "sensor", "id": "estimated_charging_time", "unit": "minutes", "icon": "timer-sync-outline", "url": RECHARGE_STATE_URL}, {"name": "Estimated Charging Time", "domain": "sensor", "id": "estimated_charging_time", "unit": "minutes", "icon": "timer-sync-outline", "url": RECHARGE_STATE_URL},
{"name": "Charging System Status", "domain": "sensor", "id": "charging_system_status", "icon": "ev-station", "url": RECHARGE_STATE_URL}, {"name": "Charging System Status", "domain": "sensor", "id": "charging_system_status", "icon": "ev-station", "url": RECHARGE_STATE_URL},
{"name": "Charging Connection Status", "domain": "sensor", "id": "charging_connection_status", "icon": "ev-plug-ccs2", "url": RECHARGE_STATE_URL}, {"name": "Charging Connection Status", "domain": "sensor", "id": "charging_connection_status", "icon": "ev-plug-ccs2", "url": RECHARGE_STATE_URL},
{"name": "Estimated Charging Finish Time", "domain": "sensor", "id": "estimated_charging_finish_time", "icon": "timer-sync-outline", "url": RECHARGE_STATE_URL}, {"name": "Estimated Charging Finish Time", "domain": "sensor", "id": "estimated_charging_finish_time", "icon": "timer-sync-outline", "url": RECHARGE_STATE_URL},
{"name": "Odometer", "domain": "sensor", "id": "odometer", "unit": "km" if settings["babelLocale"] != "en_US" else "mi", "icon": "counter", "url": ODOMETER_STATE_URL}, {"name": "Odometer", "domain": "sensor", "id": "odometer", "unit": "km" if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["odometer"]["unit"], "icon": "counter", "url": ODOMETER_STATE_URL},
{"name": "Last Data Update", "domain": "sensor", "id": "last_data_update", "icon": "timer", "url": ""}, {"name": "Last Data Update", "domain": "sensor", "id": "last_data_update", "icon": "timer", "url": ""},
{"name": "Window Front Left", "domain": "binary_sensor", "device_class": "window", "id": "window_front_left", "icon": "car-door-lock", "url": WINDOWS_STATE_URL}, {"name": "Window Front Left", "domain": "binary_sensor", "device_class": "window", "id": "window_front_left", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
{"name": "Window Front Right", "domain": "binary_sensor", "device_class": "window", "id": "window_front_right", "icon": "car-door-lock", "url": WINDOWS_STATE_URL}, {"name": "Window Front Right", "domain": "binary_sensor", "device_class": "window", "id": "window_front_right", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
@@ -62,7 +102,9 @@ supported_entities = [
{"name": "Tire Rear Left", "domain": "sensor", "id": "tyre_rear_left", "icon": "car-tire-alert", "url": TYRE_STATE_URL}, {"name": "Tire Rear Left", "domain": "sensor", "id": "tyre_rear_left", "icon": "car-tire-alert", "url": TYRE_STATE_URL},
{"name": "Tire Rear Right", "domain": "sensor", "id": "tyre_rear_right", "icon": "car-tire-alert", "url": TYRE_STATE_URL}, {"name": "Tire Rear Right", "domain": "sensor", "id": "tyre_rear_right", "icon": "car-tire-alert", "url": TYRE_STATE_URL},
{"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": "Engine State", "domain": "sensor", "id": "engine_state", "icon": "engine", "url": ENGINE_DIAGNOSTICS_URL},
{"name": "Fuel Level", "domain": "sensor", "id": "fuel_level", "unit": "liters", "icon": "fuel", "url": FUEL_STATE_URL}, {"name": "Fuel Level", "domain": "sensor", "id": "fuel_level", "unit": "liters", "icon": "fuel", "url": FUEL_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 settings["babelLocale"] != "en_US" else "mp/h", "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"]]["distance_to_empty"]["unit"], "icon": "map-marker-distance", "url": STATISTICS_URL},
{"name": "Average Speed", "domain": "sensor", "id": "average_speed", "unit": "km/h" if not units.get(settings["babelLocale"]) else units[settings["babelLocale"]]["average_speed"]["unit"], "icon": "speedometer", "url": STATISTICS_URL}
] ]
+5 -2
View File
@@ -1,12 +1,15 @@
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, set_mqtt_settings
if __name__ == '__main__': if __name__ == '__main__':
print("Starting volvo2mqtt version " + VERSION)
set_tz() set_tz()
set_mqtt_settings()
setup_logging()
logging.info("Starting volvo2mqtt version " + VERSION)
authorize() authorize()
connect() connect()
update_loop() update_loop()
+82 -14
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
@@ -8,7 +9,7 @@ from datetime import datetime
from babel.dates import format_datetime from babel.dates import format_datetime
from config import settings from config import settings
from const import CLIMATE_START_URL, CLIMATE_STOP_URL, CAR_LOCK_URL, \ from const import CLIMATE_START_URL, CLIMATE_STOP_URL, CAR_LOCK_URL, \
CAR_UNLOCK_URL, availability_topic CAR_UNLOCK_URL, availability_topic, icon_states
mqtt_client: mqtt.Client mqtt_client: mqtt.Client
@@ -16,6 +17,8 @@ subscribed_topics = []
assumed_climate_state = {} assumed_climate_state = {}
last_data_update = None last_data_update = None
climate_timer = {} climate_timer = {}
engine_status = {}
devices = {}
def connect(): def connect():
@@ -47,41 +50,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, engine_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
check_engine_thread = Thread(target=volvo.check_engine_status, args=(vin, ))
check_engine_thread.start()
engine_status[vin] = check_engine_thread
# Starting timer to disable climate after 30 mins # 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 engine_status[vin].is_alive():
engine_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 +113,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"])
@@ -133,12 +155,58 @@ def update_car_data(force_update=False, overwrite={}):
topic, topic,
json.dumps(state) if isinstance(state, dict) else state json.dumps(state) if isinstance(state, dict) else state
) )
update_ha_device(entity, vin, state)
def update_ha_device(entity, vin, state):
icon_config = icon_states.get(entity["id"])
if icon_config and state:
if state.replace(".", "").isnumeric():
state = float(state)
icon = util.get_icon_between(icon_config, state)
else:
icon = icon_config[state]
else:
return None
logging.debug("Updating icon to " + icon + " for " + entity["id"])
config = {
"name": entity['name'],
"object_id": f"volvo_{vin}_{entity['id']}",
"schema": "state",
"icon": f"mdi:{icon}" if icon else f"mdi:{entity['icon']}",
"state_topic": f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/state",
"device": devices[vin],
"unique_id": f"volvoAAOS2mqtt_{vin}_{entity['id']}",
"availability_topic": availability_topic
}
if entity.get("device_class"):
config["device_class"] = entity["device_class"]
if entity.get("unit"):
config["unit_of_measurement"] = entity["unit"]
if entity.get("domain") == "device_tracker":
config["json_attributes_topic"] = f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/attributes"
if entity.get("domain") in ["switch", "lock", "button"]:
command_topic = f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/command"
config["command_topic"] = command_topic
subscribed_topics.append(command_topic)
mqtt_client.subscribe(command_topic)
mqtt_client.publish(
f"homeassistant/{entity['domain']}/volvoAAOS2mqtt/{vin}_{entity['id']}/config",
json.dumps(config),
retain=True
)
def create_ha_devices(): def create_ha_devices():
global subscribed_topics global subscribed_topics, devices
for vin in volvo.vins: for vin in volvo.vins:
device = volvo.get_vehicle_details(vin) device = volvo.get_vehicle_details(vin)
devices[vin] = device
for entity in volvo.supported_endpoints[vin]: for entity in volvo.supported_endpoints[vin]:
config = { config = {
"name": entity['name'], "name": entity['name'],
+9
View File
@@ -0,0 +1,9 @@
#!/command/with-contenv bashio
export IS_HA_ADDON="true"
export MQTTHOST=$(bashio::services mqtt "host")
export MQTTPORT=$(bashio::services mqtt "port")
export MQTTUSER=$(bashio::services mqtt "username")
export MQTTPASS=$(bashio::services mqtt "password")
python -u main.py
+2 -2
View File
@@ -10,10 +10,10 @@ configuration:
description: Set your local timezone eg. "Europe/Berlin" or "America/New_York" description: Set your local timezone eg. "Europe/Berlin" or "America/New_York"
debug: debug:
name: API debug mode name: API debug mode
description: Enable Volvo API debug, normaly this can stay off description: Enable Volvo API debug, normaly this can stay off. If enabled, the complete log file can be found under \\<Your HA Host IP>\addons\volvo2mqtt\log\volvo2mqtt.log.
mqtt: mqtt:
name: MQTT Broker settings name: MQTT Broker settings
description: Broker is your mqtt broker IP eg "192.168.0.1". Mqtt username and password are optional. Broker port can be changed. If no value is given, port 1883 will be used. description: Leave the settings as they are if you are using the MQTT Mosquitto Addon. If not, take a look at the readme from volvo2mqtt.
volvoData: volvoData:
name: Volvo configuration options name: Volvo configuration options
description: You have to enter your Volvo app credentials. The username is normally your email, and the password is the password you use for your Volvo app. The vin can stay empty. The Add-On will use any vin inside your Volvo account. VCCAPI key is required and comes from your Volvo developer account. Odometer multiplier is sometimes 10, sometimes 1. The same is applicable for average speed divider and average fuel consumption. Leave it as it is if you don't know what's right. Take a look at the GitHub repo for more information! description: You have to enter your Volvo app credentials. The username is normally your email, and the password is the password you use for your Volvo app. The vin can stay empty. The Add-On will use any vin inside your Volvo account. VCCAPI key is required and comes from your Volvo developer account. Odometer multiplier is sometimes 10, sometimes 1. The same is applicable for average speed divider and average fuel consumption. Leave it as it is if you don't know what's right. Take a look at the GitHub repo for more information!
+79
View File
@@ -1,10 +1,55 @@
import logging
import pytz import pytz
import os import os
import sys
import config
from logging import handlers
from datetime import datetime
from const import units
from config import settings from config import settings
from pathlib import Path
TZ = None TZ = None
def get_icon_between(icon_list, state):
icon = None
for s in icon_list:
if s["to"] <= state <= s["from"]:
icon = s["icon"]
return icon
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).
@@ -34,3 +79,37 @@ def set_tz():
TZ = pytz.timezone(settings_tz) TZ = pytz.timezone(settings_tz)
else: else:
raise Exception("No timezone setting found! Please read the README!") raise Exception("No timezone setting found! Please read the README!")
def convert_metric_values(value):
if keys_exists(units, settings["babelLocale"]):
divider = units[settings["babelLocale"]]["divider"]
return round((float(value) / divider), 2)
else:
return value
def set_mqtt_settings():
if os.environ.get("IS_HA_ADDON"):
if config.settings["mqtt"]["broker"] != "auto_broker" \
or config.settings["mqtt"]["port"] != "auto_port" \
or config.settings["mqtt"]["username"] != "auto_user" \
or config.settings["mqtt"]["password"] != "auto_password":
# If settings were manually set, use the manually set settings
return None
broker_host = os.getenv("MQTTHOST", None)
broker_port = os.getenv("MQTTPORT", None)
broker_user = os.getenv("MQTTUSER", None)
broker_pass = os.getenv("MQTTPASS", None)
if not broker_host or not broker_port:
raise Exception("MQTT connection could not be established. Please check if your MQTT Add-On is running!")
logging.debug("MQTT Credentials - Host " + broker_host + " Port: " + str(broker_port) +
" User: " + str(broker_user) + " Pass: " + str(broker_pass))
config.settings["mqtt"]["broker"] = broker_host
config.settings["mqtt"]["port"] = broker_port
config.settings["mqtt"]["username"] = broker_user
config.settings["mqtt"]["password"] = broker_pass
+92 -50
View File
@@ -1,13 +1,16 @@
import logging
import requests import requests
import mqtt import mqtt
import util import util
import time
from threading import Thread, currentThread
from datetime import datetime, timedelta from datetime import datetime, timedelta
from config import settings from config import settings
from babel.dates import format_datetime from babel.dates import format_datetime
from const import charging_system_states, charging_connection_states, door_states, window_states, \ 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, \ 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, \ WINDOWS_STATE_URL, LOCK_STATE_URL, TYRE_STATE_URL, supported_entities, BATTERY_CHARGE_STATE_URL, \
STATISTICS_URL STATISTICS_URL, CLIMATE_STOP_URL, ENGINE_DIAGNOSTICS_URL
session = requests.Session() session = requests.Session()
session.headers = { session.headers = {
@@ -53,7 +56,7 @@ def authorize():
def refresh_auth(): def refresh_auth():
print("Refreshing credentials") logging.info("Refreshing credentials")
global refresh_token global refresh_token
headers = { headers = {
"authorization": "Basic aDRZZjBiOlU4WWtTYlZsNnh3c2c1WVFxWmZyZ1ZtSWFEcGhPc3kxUENhVXNpY1F0bzNUUjVrd2FKc2U0QVpkZ2ZJZmNMeXc=", "authorization": "Basic aDRZZjBiOlU4WWtTYlZsNnh3c2c1WVFxWmZyZ1ZtSWFEcGhPc3kxUENhVXNpY1F0bzNUUjVrd2FKc2U0QVpkZ2ZJZmNMeXc=",
@@ -65,7 +68,13 @@ def refresh_auth():
"grant_type": "refresh_token", "grant_type": "refresh_token",
"refresh_token": refresh_token "refresh_token": refresh_token
} }
try:
auth = requests.post(OAUTH_URL, data=body, headers=headers) auth = requests.post(OAUTH_URL, data=body, headers=headers)
except requests.exceptions.RequestException as e:
logging.error("Error refreshing credentials data: " + str(e))
return None
if auth.status_code == 200: if auth.status_code == 200:
data = auth.json() data = auth.json()
session.headers.update({'authorization': "Bearer " + data["access_token"]}) session.headers.update({'authorization': "Bearer " + data["access_token"]})
@@ -87,7 +96,9 @@ def get_vehicles():
else: else:
raise Exception("No vehicle in account " + settings.volvoData["username"] + " found.") raise Exception("No vehicle in account " + settings.volvoData["username"] + " found.")
else: else:
raise Exception("Error getting vehicles: " + str(vehicles.status_code)) error = vehicles.json()
raise Exception(
"Error getting vehicles: " + str(vehicles.status_code) + ". " + str(error["error"].get("message")))
else: else:
if isinstance(settings.volvoData["vin"], list): if isinstance(settings.volvoData["vin"], list):
# If setting is a list, copy # If setting is a list, copy
@@ -100,16 +111,14 @@ def get_vehicles():
raise Exception("No vehicle found, exiting application!") raise Exception("No vehicle found, exiting application!")
else: else:
initialize_climate(vins) initialize_climate(vins)
print("Vin: " + str(vins) + " found!") logging.info("Vin: " + str(vins) + " found!")
def get_vehicle_details(vin): def get_vehicle_details(vin):
response = session.get(VEHICLE_DETAILS_URL.format(vin), timeout=15) response = session.get(VEHICLE_DETAILS_URL.format(vin), timeout=15)
if response.status_code == 200: if response.status_code == 200:
data = response.json()["data"] data = response.json()["data"]
if "debug" in settings: logging.debug(response.text)
if settings["debug"]:
print(response.text)
device = { device = {
"identifiers": [f"volvoAAOS2mqtt_{vin}"], "identifiers": [f"volvoAAOS2mqtt_{vin}"],
"manufacturer": "Volvo", "manufacturer": "Volvo",
@@ -141,16 +150,21 @@ def check_supported_endpoints():
# If battery charge level could be found in recharge-api, skip the second battery charge sensor # If battery charge level could be found in recharge-api, skip the second battery charge sensor
continue continue
if entity["id"] == "engine_state" and entity["url"] == ENGINE_DIAGNOSTICS_URL \
and any("engine_state" in d["id"] for d in supported_endpoints[vin]):
# If engine state could be found in engine state endpoint, skip the second engine running sensor
continue
if entity.get('url'): if entity.get('url'):
state = api_call(entity["url"], "GET", vin, entity["id"]) state = api_call(entity["url"], "GET", vin, entity["id"])
else: else:
state = "" state = ""
if state is not None: if state is not None:
print("Success! " + entity["name"] + " is supported by your vehicle.") logging.info("Success! " + entity["name"] + " is supported by your vehicle.")
supported_endpoints[vin].append(entity) supported_endpoints[vin].append(entity)
else: else:
print("Failed, " + entity["name"] + " is unfortunately not supported by your vehicle.") logging.info("Failed, " + entity["name"] + " is unfortunately not supported by your vehicle.")
def initialize_climate(vins): def initialize_climate(vins):
@@ -159,11 +173,34 @@ def initialize_climate(vins):
def disable_climate(vin): def disable_climate(vin):
print("Turning climate off by timer!") logging.info("Turning climate off by timer!")
mqtt.engine_status[vin].do_run = False
mqtt.assumed_climate_state[vin] = "OFF" mqtt.assumed_climate_state[vin] = "OFF"
mqtt.update_car_data() mqtt.update_car_data()
def check_engine_status(vin):
endpoint_url = ""
engine_state_supported = False
for endpoint in supported_endpoints[vin]:
if "engine_state" == endpoint["id"]:
engine_state_supported = True
endpoint_url = endpoint["url"]
if not engine_state_supported:
# Exit thread as engine state is unsupported by car
return None
t = currentThread()
while getattr(t, "do_run", True):
engine_state = api_call(endpoint_url, "GET", vin, "engine_state", True)
if engine_state == "RUNNING":
mqtt.assumed_climate_state[vin] = "OFF"
mqtt.update_car_data()
break
time.sleep(5)
def api_call(url, method, vin, sensor_id=None, force_update=False): def api_call(url, method, vin, sensor_id=None, force_update=False):
global token_expires_at global token_expires_at
if datetime.now(util.TZ) >= token_expires_at: if datetime.now(util.TZ) >= token_expires_at:
@@ -176,36 +213,40 @@ def api_call(url, method, vin, sensor_id=None, force_update=False):
# Exception caught while getting data from volvo api, doing nothing # Exception caught while getting data from volvo api, doing nothing
return None return None
elif method == "GET": elif method == "GET":
print("Starting " + method + " call against " + url) logging.debug("Starting " + method + " call against " + url)
try: try:
response = session.get(url.format(vin), timeout=15) response = session.get(url.format(vin), timeout=15)
except requests.exceptions.RequestException as e: except requests.exceptions.RequestException as e:
print("Error getting data: " + str(e)) logging.error("Error getting data: " + str(e))
return "" return None
elif method == "POST": elif method == "POST":
print("Starting " + method + " call against " + url) logging.debug("Starting " + method + " call against " + url)
try: try:
response = session.post(url.format(vin), timeout=20) response = session.post(url.format(vin), timeout=20)
except requests.exceptions.RequestException as e: except requests.exceptions.RequestException as e:
print("Error getting data: " + str(e)) logging.error("Error getting data: " + str(e))
return "" return None
else: else:
print("Unkown method posted: " + method + ". Returning nothing") logging.error("Unkown method posted: " + method + ". Returning nothing")
return "" return None
logging.debug("Response status code: " + str(response.status_code))
if response.status_code == 200: if response.status_code == 200:
data = response.json() data = response.json()
if "debug" in settings: logging.debug(response.text)
if settings["debug"]:
print(response.text)
else: else:
logging.debug(response.text)
if url == CLIMATE_START_URL and response.status_code == 503: if url == CLIMATE_START_URL and response.status_code == 503:
print("Car in use, cannot start pre climatization") logging.warning("Car in use, cannot start pre climatization")
mqtt.assumed_climate_state[vin] = "OFF" mqtt.assumed_climate_state[vin] = "OFF"
mqtt.update_car_data() mqtt.update_car_data()
elif "extended-vehicle" in url and response.status_code == 403:
# Suppress 403 errors for unsupported extended-vehicle api cars
logging.debug("Suppressed 403 for extended-vehicle API")
return None
else: else:
print("API Call failed. Status Code: " + str(response.status_code) + ". Error: " + response.text) logging.error("API Call failed. Status Code: " + str(response.status_code) + ". Error: " + response.text)
return "" return None
return parse_api_data(data, sensor_id) return parse_api_data(data, sensor_id)
@@ -213,24 +254,26 @@ def cached_request(url, method, vin, force_update=False):
global cached_requests global cached_requests
if not util.keys_exists(cached_requests, vin + "_" + url): if not util.keys_exists(cached_requests, vin + "_" + url):
# No API Data cached, get fresh data from API # No API Data cached, get fresh data from API
print("Starting " + method + " call against " + url) logging.debug("Starting " + method + " call against " + url)
try: try:
response = session.get(url.format(vin), timeout=15) response = session.get(url.format(vin), timeout=15)
except requests.exceptions.RequestException as e: except requests.exceptions.RequestException as e:
print("Error getting data: " + str(e)) logging.error("Error getting data: " + str(e))
return None return None
data = {"response": response, "last_update": datetime.now(util.TZ)} data = {"response": response, "last_update": datetime.now(util.TZ)}
cached_requests[vin + "_" + url] = data cached_requests[vin + "_" + url] = data
else: else:
if (datetime.now(util.TZ) - cached_requests[vin + "_" + url]["last_update"]).total_seconds() >= settings["updateInterval"] \ if (datetime.now(util.TZ) - cached_requests[vin + "_" + url]["last_update"]).total_seconds() \
or (force_update and (datetime.now(util.TZ) - cached_requests[vin + "_" + url]["last_update"]).total_seconds() >= 2): >= settings["updateInterval"] or (force_update and
(datetime.now(util.TZ) - cached_requests[vin + "_" + url]
["last_update"]).total_seconds() >= 2):
# Old Data in Cache, or force mode active, updating # Old Data in Cache, or force mode active, updating
print("Starting " + method + " call against " + url) logging.debug("Starting " + method + " call against " + url)
try: try:
response = session.get(url.format(vin), timeout=15) response = session.get(url.format(vin), timeout=15)
except requests.exceptions.RequestException as e: except requests.exceptions.RequestException as e:
print("Error getting data: " + str(e)) logging.error("Error getting data: " + str(e))
return None return None
data = {"response": response, "last_update": datetime.now(util.TZ)} data = {"response": response, "last_update": datetime.now(util.TZ)}
cached_requests[vin + "_" + url] = data cached_requests[vin + "_" + url] = data
@@ -245,13 +288,14 @@ def parse_api_data(data, sensor_id=None):
if sensor_id == "battery_charge_level": if sensor_id == "battery_charge_level":
return data["batteryChargeLevel"]["value"] if util.keys_exists(data, "batteryChargeLevel") else None return data["batteryChargeLevel"]["value"] if util.keys_exists(data, "batteryChargeLevel") else None
elif sensor_id == "electric_range": elif sensor_id == "electric_range":
return data["electricRange"]["value"] if util.keys_exists(data, "electricRange") else None return util.convert_metric_values(data["electricRange"]["value"]) \
if util.keys_exists(data, "electricRange") else None
elif sensor_id == "charging_system_status": elif sensor_id == "charging_system_status":
return charging_system_states[data["chargingSystemStatus"]["value"]] if util.keys_exists(data, return charging_system_states[data["chargingSystemStatus"]["value"]] \
"chargingSystemStatus") else None if util.keys_exists(data, "chargingSystemStatus") else None
elif sensor_id == "charging_connection_status": elif sensor_id == "charging_connection_status":
return charging_connection_states[data["chargingConnectionStatus"]["value"]] if util.keys_exists(data, return charging_connection_states[data["chargingConnectionStatus"]["value"]] \
"chargingConnectionStatus") else None if util.keys_exists(data, "chargingConnectionStatus") else None
elif sensor_id == "estimated_charging_time": elif sensor_id == "estimated_charging_time":
if util.keys_exists(data, "chargingSystemStatus"): if util.keys_exists(data, "chargingSystemStatus"):
charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]] charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]]
@@ -259,19 +303,18 @@ def parse_api_data(data, sensor_id=None):
return data["estimatedChargingTime"]["value"] if util.keys_exists(data, "estimatedChargingTime") else "" return data["estimatedChargingTime"]["value"] if util.keys_exists(data, "estimatedChargingTime") else ""
else: else:
return 0 return 0
else:
return None return None
elif sensor_id == "estimated_charging_finish_time": elif sensor_id == "estimated_charging_finish_time":
if util.keys_exists(data, "chargingSystemStatus"): if util.keys_exists(data, "chargingSystemStatus"):
charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]] charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]]
if charging_system_state == "Charging": if charging_system_state == "Charging":
charging_time = int(data["estimatedChargingTime"]["value"] if util.keys_exists(data, "estimatedChargingTime") charging_time = int(
data["estimatedChargingTime"]["value"] if util.keys_exists(data, "estimatedChargingTime")
else 0) else 0)
charging_finished = datetime.now(util.TZ) + timedelta(minutes=charging_time) charging_finished = datetime.now(util.TZ) + timedelta(minutes=charging_time)
return format_datetime(charging_finished, format="medium", locale=settings["babelLocale"]) return format_datetime(charging_finished, format="medium", locale=settings["babelLocale"])
else: else:
return "" return ""
else:
return None return None
elif sensor_id == "lock_status": elif sensor_id == "lock_status":
return data["carLocked"]["value"] if util.keys_exists(data, "carLocked") else None return data["carLocked"]["value"] if util.keys_exists(data, "carLocked") else None
@@ -283,7 +326,8 @@ def parse_api_data(data, sensor_id=None):
multiplier = 1 multiplier = 1
elif multiplier < 1: elif multiplier < 1:
multiplier = 1 multiplier = 1
return int(data["odometer"]["value"]) * multiplier if util.keys_exists(data, "odometer") else None return util.convert_metric_values(int(data["odometer"]["value"]) * multiplier) \
if util.keys_exists(data, "odometer") else None
elif sensor_id == "window_front_left": elif sensor_id == "window_front_left":
return window_states[data["frontLeftWindowOpen"]["value"]] if util.keys_exists(data, "frontLeftWindowOpen") \ return window_states[data["frontLeftWindowOpen"]["value"]] if util.keys_exists(data, "frontLeftWindowOpen") \
else None else None
@@ -299,7 +343,8 @@ def parse_api_data(data, sensor_id=None):
elif sensor_id == "door_front_left": elif sensor_id == "door_front_left":
return door_states[data["frontLeftDoorOpen"]["value"]] if util.keys_exists(data, "frontLeftDoorOpen") else None return door_states[data["frontLeftDoorOpen"]["value"]] if util.keys_exists(data, "frontLeftDoorOpen") else None
elif sensor_id == "door_front_right": elif sensor_id == "door_front_right":
return door_states[data["frontRightDoorOpen"]["value"]] if util.keys_exists(data, "frontRightDoorOpen") else None return door_states[data["frontRightDoorOpen"]["value"]] \
if util.keys_exists(data, "frontRightDoorOpen") else None
elif sensor_id == "door_rear_left": elif sensor_id == "door_rear_left":
return door_states[data["rearLeftDoorOpen"]["value"]] if util.keys_exists(data, "rearLeftDoorOpen") else None return door_states[data["rearLeftDoorOpen"]["value"]] if util.keys_exists(data, "rearLeftDoorOpen") else None
elif sensor_id == "door_rear_right": elif sensor_id == "door_rear_right":
@@ -327,9 +372,6 @@ def parse_api_data(data, sensor_id=None):
fuel_amount = int(data["fuelAmount"]["value"]) fuel_amount = int(data["fuelAmount"]["value"])
if fuel_amount > 0: if fuel_amount > 0:
return fuel_amount return fuel_amount
else:
return None
else:
return None return None
elif sensor_id == "average_fuel_consumption": elif sensor_id == "average_fuel_consumption":
if util.keys_exists(data, "averageFuelConsumption"): if util.keys_exists(data, "averageFuelConsumption"):
@@ -343,9 +385,6 @@ def parse_api_data(data, sensor_id=None):
elif multiplier < 1: elif multiplier < 1:
multiplier = 1 multiplier = 1
return average_fuel_con * multiplier return average_fuel_con * multiplier
else:
return None
else:
return None return None
elif sensor_id == "average_speed": elif sensor_id == "average_speed":
if util.keys_exists(data, "averageSpeed"): if util.keys_exists(data, "averageSpeed"):
@@ -358,10 +397,7 @@ def parse_api_data(data, sensor_id=None):
divider = 1 divider = 1
elif divider < 1: elif divider < 1:
divider = 1 divider = 1
return average_speed / divider return util.convert_metric_values(average_speed / divider)
else:
return None
else:
return None return None
elif sensor_id == "location": elif sensor_id == "location":
coordinates = {} coordinates = {}
@@ -372,5 +408,11 @@ def parse_api_data(data, sensor_id=None):
"latitude": raw_data["coordinates"][1], "latitude": raw_data["coordinates"][1],
"gps_accuracy": 1} "gps_accuracy": 1}
return coordinates 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: else:
return None return None