Compare commits

...
72 Commits
Author SHA1 Message Date
Linus Dietz f661985865 Add average fuel consumption multiplier for #30 // Rewrite README.md settings section 2023-06-27 07:56:54 +02:00
Linus Dietz da2d8395ec Optimize filter for average speed 2023-06-27 07:16:29 +02:00
Linus Dietz 4bd6a7a991 Add divider option for average speed 2023-06-26 14:23:53 +02:00
Linus Dietz 988fb3bd21 Add new empty setting options to settings.json 2023-06-26 14:12:24 +02:00
Linus DietzandGitHub 15fd137cc6 Add thanks to for sunroof endpoint 2023-06-26 12:59:01 +02:00
Linus Dietz af4eeb3a72 Change sunroof data endpoint 2023-06-26 12:37:56 +02:00
Linus Dietz cae32d7745 Bump version 2023-06-26 12:24:10 +02:00
Linus DietzandGitHub f1b265740b Add XC90 2023 T8 2023-06-26 12:10:52 +02:00
Linus Dietz bb689c3ee2 Fix sunroof data path 2023-06-26 11:44:14 +02:00
Linus DietzandGitHub 75363b5c0f Add new sensors 2023-06-26 11:28:27 +02:00
Linus DietzandGitHub 91eb8a9429 Add badges 2023-06-26 10:45:22 +02:00
Linus DietzandGitHub 638cfcd730 Add readme image 2023-06-26 09:32:27 +02:00
Linus Dietz 983e84e6fe Add readme image 2023-06-26 09:27:29 +02:00
Linus DietzandGitHub f8eb7cee41 Add lovelace sample 2023-06-26 09:25:46 +02:00
Linus Dietz 1e071154c5 Bump version 2023-06-26 08:55:23 +02:00
Linus Dietz 6d938eab7a Filter zero data from volvo api 2023-06-26 08:50:30 +02:00
Linus Dietz 86980408e7 Filter zero data from volvo api 2023-06-26 08:43:20 +02:00
Linus Dietz a0800db907 Change average speed icon 2023-06-26 08:37:41 +02:00
Linus Dietz d5565cd52a Move windows and doors to binary_sensor domain 2023-06-26 08:36:50 +02:00
Linus DietzandGitHub 9f5b4f4017 Only build on new release 2023-06-26 08:17:51 +02:00
Linus Dietz 689d3e84e7 Add statistics endpoint to cached responses 2023-06-26 08:11:08 +02:00
Linus Dietz c095c39462 Bump version for release #30, #31, #32 2023-06-26 07:59:18 +02:00
Linus Dietz c72e99bcf8 Add average fuel consumption and average speed #30 2023-06-26 07:57:11 +02:00
Linus Dietz c5ed7b7971 Fix cached wget requirements.txt for HA Addon 2023-06-26 07:30:09 +02:00
Linus Dietz 43d09cb2f4 Send heartbeat after device creation timeout 2023-06-26 07:18:31 +02:00
Linus Dietz b7794d837b Fix offline devices after HA reboot 2023-06-26 07:16:41 +02:00
Linus Dietz 5d57979849 Add timezone option for HA Addon 2023-06-25 20:17:51 +02:00
Linus DietzandGitHub b1ef7e8e46 Add TZ link 2023-06-25 19:49:38 +02:00
Linus DietzandGitHub 07213aba18 Update README.md 2023-06-25 12:33:37 +02:00
Linus Dietz 71b8c59ba8 Fix unlockstate for multiple car usage 2023-06-25 07:22:15 +02:00
Linus Dietz 50b5eb9863 Add mqtt availability 2023-06-24 20:06:59 +02:00
Linus DietzandGitHub 02793accfa Update README.md 2023-06-24 19:53:03 +02:00
Linus Dietz 4d8b5e5006 Optimize lock/unlock behaviour 2023-06-24 19:47:02 +02:00
Linus Dietz e8315ba0fd Merge remote-tracking branch 'origin/main' into main 2023-06-24 18:08:09 +02:00
Linus Dietz 4fca54b19f Add broker port to ha addon conf 2023-06-24 18:07:59 +02:00
Linus DietzandGitHub a411a1a59d Add broker Port 2023-06-24 18:06:15 +02:00
Linus Dietz a51ba25061 Add mqtt broker port option 2023-06-24 18:02:56 +02:00
Linus Dietz 1d37b3aca7 Revert "Bump version"
This reverts commit 1574fa96
2023-06-24 17:54:09 +02:00
Linus Dietz 1574fa968c Bump version 2023-06-24 17:53:12 +02:00
Linus Dietz aeea34b438 Bump version 2023-06-24 16:54:06 +02:00
Linus Dietz 1ccd140400 Reduce api calls in force update mode 2023-06-24 16:51:29 +02:00
Linus Dietz f4aef07e55 Optimize climate timer for multiple cars 2023-06-24 16:37:51 +02:00
Linus Dietz 8f6d664264 Fix wrong climate time duration 2023-06-24 16:35:44 +02:00
Linus DietzandGitHub 2b510d4e1b Add xc40 BEV 2022 2023-06-24 15:27:49 +02:00
Linus Dietz 5c0216465e Fix missing entities after HA restart 2023-06-24 11:44:50 +02:00
Linus Dietz d9ad484c69 Improve lock entity response time while locking/unlocking 2023-06-24 10:08:56 +02:00
Linus Dietz 28721384f7 Rework caching storage 2023-06-24 10:07:51 +02:00
Linus Dietz c7a883d781 Catch volvo api exceptions 2023-06-24 08:54:44 +02:00
Linus Dietz 023d8d2096 Rework response caching 2023-06-24 08:34:40 +02:00
Linus DietzandGitHub 64d0640282 Merge pull request #26 from jverdeyen/docker-compose-example
Added docker-compose.yml example
2023-06-23 14:09:04 +02:00
Joeri Verdeyen 39c748fe1a Added docker-compose.yml example 2023-06-23 13:56:30 +02:00
Linus Dietz 429c49c3f8 Merge remote-tracking branch 'origin/main' into main 2023-06-23 12:43:29 +02:00
Linus Dietz 68de908e05 Fix if multiplier is an empty string 2023-06-23 12:43:22 +02:00
Linus DietzandGitHub 5027b54de0 Update README.md 2023-06-23 12:40:31 +02:00
Linus DietzandGitHub 13cf419022 Update README.md 2023-06-23 12:36:39 +02:00
Linus DietzandGitHub d5a542b8cf Update README.md 2023-06-23 12:35:23 +02:00
Linus Dietz 7103b30da2 Make odometer multiplier configurable 2023-06-23 12:31:38 +02:00
Linus Dietz c34e090bfd Rename tyre to tire 2023-06-23 12:04:36 +02:00
Linus Dietz ec8c3cea5f Add fuel level 2023-06-23 12:01:14 +02:00
Linus DietzandGitHub 7bbf39d8a9 Update issue templates 2023-06-23 11:50:33 +02:00
Linus DietzandGitHub 67f0d382b8 Update issue templates 2023-06-23 11:50:05 +02:00
Linus Dietz 506be2a145 Bump version 2023-06-23 10:59:35 +02:00
Linus DietzandGitHub 92c67e31aa Update README.md 2023-06-23 10:26:04 +02:00
Linus Dietz 42c9349ca8 Rework try to catch battery charge state from connected-vehicle v2 if no energy api is available 2023-06-23 10:13:57 +02:00
Linus Dietz 1c4fbb649d Try to catch battery charge state from connected-vehicle v2 if no energy api is available // Fix assumed climate state 2023-06-23 09:47:04 +02:00
Linus DietzandGitHub 5275b53685 Update README.md 2023-06-23 09:31:58 +02:00
Linus Dietz ce1f779e3e Add support for charging connection state, tyre state, and engine state 2023-06-23 09:24:15 +02:00
Linus Dietz 17853210c3 Create only sensors that are supported by the car // Rework sensor creation 2023-06-23 08:58:24 +02:00
Linus Dietz b3ab5acf0f Fix #22 - multiply odometer by ten 2023-06-23 07:13:41 +02:00
Linus DietzandGitHub 4a2f9bb6f8 Update README.md 2023-06-22 20:51:03 +02:00
Linus Dietz 53114e9d6c Bump version 2023-06-22 19:33:04 +02:00
Linus Dietz bbc6ccb840 cleanup api data handling 2023-06-22 19:22:54 +02:00
18 changed files with 635 additions and 357 deletions
+5
View File
@@ -0,0 +1,5 @@
CONF_updateInterval=300
CONF_babelLocale='de'
CONF_mqtt='@json {"broker": "mqtt", "username": "", "password": ""}'
CONF_volvoData='@json {"username": "", "password": "", "vin": "", "vccapikey": ""}'
TZ='Europe/Berlin'
+30
View File
@@ -0,0 +1,30 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: Dielee
---
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Version info**
The version you are using and the method you are using (Docker container/HA Addon/Cloned repo)
**Additional context**
Add any other context about the problem here.
+20
View File
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.
+1 -1
View File
@@ -11,7 +11,7 @@ name: Create and publish a Docker image
on:
release:
types: [created, edited]
types: [created]
workflow_dispatch:
env:
+2 -1
View File
@@ -1,3 +1,4 @@
.idea
venv
src/settings.dev.json
src/settings.dev.json
.env
+128 -12
View File
@@ -1,17 +1,37 @@
# Volvo2Mqtt
![Supports aarch64 Architecture][aarch64-shield]
![Supports amd64 Architecture][amd64-shield]
![Supports armhf Architecture][armhf-shield]
![Supports armv7 Architecture][armv7-shield]
![Supports i386 Architecture][i386-shield]
<br>
![Project Maintenance][maintenance-shield]
[![GitHub Release][releases-shield]][releases]
[![GitHub Activity][commits-shield]][commits]
This component establishes a connection between the newer AAOS Volvo cars and Home Assistant via MQTT.<br>
Maybe this component works also with other Volvo cars. Please try out the native Volvo [integration](https://www.home-assistant.io/integrations/volvooncall/) before using this component! If the native component doesn't work for your car, try this mqtt bridge.
<p>
Home Assistant thread can be found [here](https://community.home-assistant.io/t/volvo2mqtt-connect-your-aaos-volvo/585699).
## Confirmed working with
- XC40 BEV (2023)
- XC40 BEV (2022)
- XC40 PHEV (2021)
- V60 T8 PHEV (2023)
- C40 PHEV (2023)
- C40 PHEV (2022)
- XC90 T8 PHEV (2023)
- XC60 PHEV (2023)
- XC60 PHEV (2022)
- XC90 PHEV T8 (2023)
- V90 PHEV T8 (2019)*
*only partly working
Please let me know if your car works with this addon so I can expand the list!<br>
Please let me know if your car works with this addon so I can expand the list!
## Supported features
- Lock/unlock car
@@ -19,7 +39,17 @@ Please let me know if your car works with this addon so I can expand the list!
- Sensor "Battery Charge Level"
- Sensor "Electric Range"
- Sensor "Charging System Status"
- Sensor "Charging Connection Status"
- Sensor "Estimated Charging Finish Time"
- Sensor "Door Lock Status (All doors, tank lid, and engine hood)"
- Sensor "Window Lock Status (All windows and sunroof - Thanks to @navet)"
- Sensor "Engine Status"
- Sensor "Odometer"
- Sensor "Tire Status"
- Sensor "Fuel Status"
- Sensor "Average Fuel Consumption"
- Sensor "Average Speed"
- Car Device Tracker
- Multiple cars
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)
@@ -30,7 +60,7 @@ NOTE: Energy status currently available only for cars in the Europe / Middle Eas
Just install this addon with the following command.
Please note to fill in your settings inside the environment variables.
`docker run --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`
`docker run -d --pull=always -e CONF_updateInterval=300 -e CONF_babelLocale='de' -e CONF_mqtt='@json {"broker": "", "username": "", "password": "", "port": 1883}' -e CONF_volvoData='@json {"username": "", "password": "", "vin": "", "vccapikey": "", "odometerMultiplier": 1, "averageSpeedDivider": 1, "averageFuelConsumptionMultiplier": 1}' -e TZ='Europe/Berlin' --name volvo2mqtt ghcr.io/dielee/volvo2mqtt:latest`
<b>HA Add-On:</b><br>
@@ -38,15 +68,101 @@ Please note to fill in your settings inside the environment variables.
Here is what every option means:
| Name | Type | Default | Description |
| -------------------- | :-------: | :----------: | --------------------------------------------------------------- |
| `CONF_updateInterval` | `int` | **required** | Update intervall in seconds. |
| `CONF_babelLocale` | `string` | **required** | Select your country from this [list](https://www.ibm.com/docs/en/radfws/9.7?topic=overview-locales-code-pages-supported). "Locale name" is the column you need! |
| `CONF_mqtt` | `json` | **required** | Broker = Mqtt Broker IP / Username and Passwort are optional! |
| `CONF_volvoData` | `json` | **required** | Username and password are REQUIRED. Car vin can be a single vin or a list of multiple vins like `["vin1", "vin2"]`. If no vin is provided, <b>ALL</b> of your vehicles will be used. Vccapi key is REQUIRED. Get your Vccapi key from [here](https://developer.volvocars.com/account/). |
| `CONF_debug` | `string` | | Debug option (true/false) - optional! |
| `TZ` | `string` | | Container timezone eg "Europe/Berlin" |
| Environment Variable Name | Type | Json Option | Default | Description |
| ------------------------- | :-------: | :-----------------------------------: | :----------: | --------------------------------------------------------------- |
| `CONF_updateInterval` | `int` | | **required** | Update intervall in seconds. |
| `CONF_babelLocale` | `string` | | **required** | Select your country from this [list](https://www.ibm.com/docs/en/radfws/9.7?topic=overview-locales-code-pages-supported). "Locale name" is the column you need! |
| `CONF_mqtt` | `json` | `broker` | **required** | Your MQTT Broker IP. Eg. 192.168.0.5.
| `CONF_mqtt` | `json` | `port` | 1883 | Your MQTT Broker Port. If no value is given, port 1883 will be used. |
| `CONF_mqtt` | `json` | `username` | optional | MQTT Username for your broker.
| `CONF_mqtt` | `json` | `password` | optional | MQTT Password for your broker.
| `CONF_volvoData` | `json` | `username` | **required** | Normally your email address to login into the Volvo App.
| `CONF_volvoData` | `json` | `password` | **required** | Your password to login into the Volvo App.
| `CONF_volvoData` | `json` | `vin` | optional | A single VIN like "VIN1" or a list of VINs like "["VIN1", "VIN2"]". Leave this empty if you don't know your VIN. The addon will use every car that is tied to your account.
| `CONF_volvoData` | `json` | `vccapikey` | **required** | API key linked with your volvo developer account. Get your Vccapi key from [here](https://developer.volvocars.com/account/)
| `CONF_volvoData` | `json` | `odometerMultiplier` | optional | The multiplier value for the odometer value, as the volvo api delivers inconsistent data. For some cars this setting is 10, for some 1. Try what's right for your car. If you leave it empty, the multiplier will be 1.
| `CONF_volvoData` | `json` | `averageSpeedDivider` | optional | The divider value for the average speed value, as the volvo api delivers inconsistent data. For some cars this setting is 10, for some 1. Try what's right for your car. If you leave it empty, the divider will be 1.
| `CONF_volvoData` | `json` | `averageFuelConsumptionMultiplier` | optional | The multiplier value for the average fuel consumption value, as the volvo api delivers inconsistent data. For some cars this setting is 10, for some 1. Try what's right for your car. If you leave it empty, the multiplier will be 1.
| `CONF_debug` | `string` | | optional | Debug option (true/false). Normally you don't need this. |
| `TZ` | `string` | | **required** | Container timezone eg "Europe/Berlin" from [here](https://docs.diladele.com/docker/timezones.html)|
If you like my work:
## Lovelace sample card
<details>
<summary>Show me more!</summary><blockquote>
<br>
![alt text](https://raw.githubusercontent.com/Dielee/volvo2mqtt/main/img/lovelace_sample.png)<br>
<details>
<summary>Lovelace card sample</summary>
```
type: vertical-stack
title: Autostatus
cards:
- type: custom:vertical-stack-in-card
cards:
- type: custom:mushroom-lock-card
entity: lock.volvo_<your vin>_lock_status
name: Verrigelungsstatus
- type: horizontal-stack
cards:
- type: custom:mushroom-entity-card
entity: sensor.volvo_<your vin>_electric_range
name: Reichweite
layout: vertical
- type: custom:mushroom-entity-card
entity: sensor.volvo_<your vin>_battery_charge_level
name: Batteriestatus
layout: vertical
- type: custom:mushroom-entity-card
entity: sensor.volvo_<your vin>_estimated_charging_time
layout: vertical
name: Ladezeit
- type: horizontal-stack
cards:
- type: custom:mushroom-entity-card
entity: switch.volvo_<your vin>_climate_status
tap_action:
action: toggle
layout: vertical
name: Klimatisieren/Heizen
- type: custom:mushroom-template-card
primary: Daten aktualisieren
secondary: '{{ states(''sensor.volvo_<your vin>_last_data_update'')}}'
icon: mdi:update
layout: vertical
entity: button.volvo_<your vin>_update_data
- type: conditional
conditions:
- entity: sensor.volvo_<your vin>_estimated_charging_time
state_not: '0'
card:
type: custom:mushroom-entity-card
entity: sensor.volvo_<your vin>_estimated_charging_finish_time
name: Ladung vorraussichtlich abgeschlossen
show_name: true
- type: map
entities:
- entity: device_tracker.volvo_<your vin>_location
default_zoom: 16
dark_mode: false
hours_to_show: 0
auto_fit: true
aspect_ratio: '16:9'
```
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/U7U8MFXCF)
</details>
</blockquote></details>
[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
[releases]: https://github.com/Dielee/volvo2mqtt/releases
[releases-shield]: https://img.shields.io/github/release/Dielee/volvo2mqtt.svg
[maintenance-shield]: https://img.shields.io/maintenance/yes/2023.svg
[commits-shield]: https://img.shields.io/github/commit-activity/y/Dielee/volvo2mqtt.svg
[commits]: https://github.com/Dielee/volvo2mqtt/commits/main
+24
View File
@@ -0,0 +1,24 @@
version: '3'
services:
app:
build: .
env_file:
- .env
# environment:
# CONF_updateInterval: 300
# CONF_babelLocale: 'de'
# CONF_mqtt: '@json {"broker": "mqtt", "username": "", "password": ""}'
# CONF_volvoData: '@json {"username": "", "password": "", "vin": "", "vccapikey": ""}'
# TZ: 'Europe/Berlin'
links:
- mqtt
depends_on:
- mqtt
mqtt:
container_name: mqtt
image: eclipse-mosquitto
expose:
- 1883
command: [ "/usr/sbin/mosquitto", "-c", "/mosquitto-no-auth.conf" ]
Binary file not shown.

After

Width:  |  Height:  |  Size: 107 KiB

+2 -1
View File
@@ -1,4 +1,5 @@
requests~=2.29.0
dynaconf~=3.1.12
paho-mqtt~=1.6.1
Babel~=2.12.1
Babel~=2.12.1
pytz~=2023.3
+1 -1
View File
@@ -8,7 +8,7 @@ RUN apk add --no-cache python3 bash py3-pip
WORKDIR /volvoAAOS2mqtt
# download requirements.txt
RUN wget https://raw.githubusercontent.com/Dielee/volvo2mqtt/main/requirements.txt
RUN wget --no-cache https://raw.githubusercontent.com/Dielee/volvo2mqtt/main/requirements.txt
# install dependencies
RUN pip install -r requirements.txt
+11 -1
View File
@@ -1,6 +1,6 @@
name: "Volvo2Mqtt"
description: "Volvo AAOS MQTT bridge"
version: "1.2.1"
version: "1.5.6"
slug: "volvo2mqtt"
init: false
url: "https://github.com/Dielee/volvo2mqtt"
@@ -8,9 +8,11 @@ apparmor: true
options:
updateInterval: 300
babelLocale: null
TZ: null
debug: false
mqtt:
broker: null
port: 1883
username: ""
password: ""
volvoData:
@@ -18,12 +20,17 @@ options:
password: null
vin: ""
vccapikey: null
odometerMultiplier: 1
averageSpeedDivider: 1
averageFuelConsumptionMultiplier: 1
schema:
updateInterval: int(10,)
babelLocale: str
TZ: str
debug: bool
mqtt:
broker: str
port: int(1,)
username: str?
password: str?
volvoData:
@@ -31,6 +38,9 @@ schema:
password: str
vin: str?
vccapikey: str
odometerMultiplier: int(1,)
averageSpeedDivider: int(1,)
averageFuelConsumptionMultiplier: int(1,)
arch:
- aarch64
- amd64
+46 -34
View File
@@ -1,6 +1,6 @@
from config import settings
VERSION = "v1.2.1"
VERSION = "v1.5.6"
OAUTH_URL = "https://volvoid.eu.volvocars.com/as/token.oauth2"
VEHICLES_URL = "https://api.volvocars.com/connected-vehicle/v1/vehicles"
@@ -14,43 +14,55 @@ CAR_UNLOCK_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/co
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"
TYRE_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/tyres"
ENGINE_STATE_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/engine-status"
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"
STATISTICS_URL = "https://api.volvocars.com/connected-vehicle/v2/vehicles/{0}/statistics"
availability_topic = "volvoAAOS2mqtt/availability"
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_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}
]
charging_connection_states = {"CONNECTION_STATUS_DISCONNECTED": "Disconnected", "CONNECTION_STATUS_UNSPECIFIED": "Unspecified",
"CONNECTION_STATUS_CONNECTED_DC": "Connected DC", "CONNECTION_STATUS_CONNECTED_AC": "Connected AC"}
supported_switches = [
{"name": "Air Conditioning", "id": "climate_status", "icon": "air-conditioner"},
]
window_states = {"CLOSED": "OFF", "OPEN": "ON"}
door_states = {"CLOSED": "OFF", "OPEN": "ON"}
supported_locks = [
{"name": "Lock state", "id": "lock_status", "icon": "lock", "url": LOCK_STATE_URL}
supported_entities = [
{"name": "Battery Charge Level", "domain": "sensor", "id": "battery_charge_level", "unit": "%", "icon": "car-battery", "url": RECHARGE_STATE_URL},
{"name": "Battery Charge Level", "domain": "sensor", "id": "battery_charge_level", "unit": "%", "icon": "car-battery", "url": BATTERY_CHARGE_STATE_URL},
{"name": "Electric Range", "domain": "sensor", "id": "electric_range", "unit": "km" if settings["babelLocale"] != "en_US" else "mi", "icon": "map-marker-distance", "url": RECHARGE_STATE_URL},
{"name": "Estimated Charging Time", "domain": "sensor", "id": "estimated_charging_time", "unit": "minutes", "icon": "timer-sync-outline", "url": RECHARGE_STATE_URL},
{"name": "Charging System Status", "domain": "sensor", "id": "charging_system_status", "icon": "ev-station", "url": RECHARGE_STATE_URL},
{"name": "Charging Connection Status", "domain": "sensor", "id": "charging_connection_status", "icon": "ev-plug-ccs2", "url": RECHARGE_STATE_URL},
{"name": "Estimated Charging Finish Time", "domain": "sensor", "id": "estimated_charging_finish_time", "icon": "timer-sync-outline", "url": RECHARGE_STATE_URL},
{"name": "Odometer", "domain": "sensor", "id": "odometer", "unit": "km" if settings["babelLocale"] != "en_US" else "mi", "icon": "counter", "url": ODOMETER_STATE_URL},
{"name": "Last Data Update", "domain": "sensor", "id": "last_data_update", "icon": "timer", "url": ""},
{"name": "Window Front Left", "domain": "binary_sensor", "device_class": "window", "id": "window_front_left", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
{"name": "Window Front Right", "domain": "binary_sensor", "device_class": "window", "id": "window_front_right", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
{"name": "Window Rear Left", "domain": "binary_sensor", "device_class": "window", "id": "window_rear_left", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
{"name": "Window Rear Right", "domain": "binary_sensor", "device_class": "window", "id": "window_rear_right", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
{"name": "Door Front Left", "domain": "binary_sensor", "device_class": "door", "id": "door_front_left", "icon": "car-door-lock", "url": LOCK_STATE_URL},
{"name": "Door Front Right", "domain": "binary_sensor", "device_class": "door", "id": "door_front_right", "icon": "car-door-lock", "url": LOCK_STATE_URL},
{"name": "Door Rear Left", "domain": "binary_sensor", "device_class": "door", "id": "door_rear_left", "icon": "car-door-lock", "url": LOCK_STATE_URL},
{"name": "Door Rear Right", "domain": "binary_sensor", "device_class": "door", "id": "door_rear_right", "icon": "car-door-lock", "url": LOCK_STATE_URL},
{"name": "Tailgate", "domain": "binary_sensor", "device_class": "door", "id": "tailgate", "icon": "car-door-lock", "url": LOCK_STATE_URL},
{"name": "Engine Hood", "domain": "binary_sensor", "device_class": "door", "id": "engine_hood", "icon": "car-door-lock", "url": LOCK_STATE_URL},
{"name": "Tank Lid", "domain": "binary_sensor", "device_class": "door", "id": "tank_lid", "icon": "car-door-lock", "url": LOCK_STATE_URL},
{"name": "Sunroof", "domain": "binary_sensor", "device_class": "door", "id": "sunroof", "icon": "car-door-lock", "url": WINDOWS_STATE_URL},
{"name": "Air Conditioning", "domain": "switch", "id": "climate_status", "icon": "air-conditioner"},
{"name": "Lock state", "domain": "lock", "id": "lock_status", "icon": "lock", "url": LOCK_STATE_URL},
{"name": "Force Update Data", "domain": "button", "id": "update_data", "icon": "update", "url": ""},
{"name": "Location", "domain": "device_tracker", "id": "location", "icon": "map-marker-radius", "url": LOCATION_STATE_URL},
{"name": "Tire Front Left", "domain": "sensor", "id": "tyre_front_left", "icon": "car-tire-alert", "url": TYRE_STATE_URL},
{"name": "Tire Front Right", "domain": "sensor", "id": "tyre_front_right", "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": "Engine State", "domain": "sensor", "id": "engine_state", "icon": "engine", "url": ENGINE_STATE_URL},
{"name": "Fuel Level", "domain": "sensor", "id": "fuel_level", "unit": "liters", "icon": "fuel", "url": FUEL_STATE_URL},
{"name": "Average Fuel Consumption", "domain": "sensor", "id": "average_fuel_consumption", "unit": "liters", "icon": "fuel", "url": STATISTICS_URL},
{"name": "Average Speed", "domain": "sensor", "id": "average_speed", "unit": "km/h" if settings["babelLocale"] != "en_US" else "mp/h", "icon": "speedometer", "url": STATISTICS_URL}
]
supported_buttons = [
{"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}
]
+3
View File
@@ -1,9 +1,12 @@
from volvo import authorize
from mqtt import update_loop, connect
from const import VERSION
from util import set_tz
if __name__ == '__main__':
print("Starting volvo2mqtt version " + VERSION)
set_tz()
authorize()
connect()
update_loop()
+99 -146
View File
@@ -2,28 +2,34 @@ import time
import paho.mqtt.client as mqtt
import json
import volvo
import util
from threading import Thread, Timer
from datetime import datetime
from babel.dates import format_datetime
from config import settings
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
CAR_UNLOCK_URL, availability_topic
mqtt_client: mqtt.Client
subscribed_topics = []
assumed_climate_state = {}
last_data_update = None
climate_timer: Timer
climate_timer = {}
def connect():
client = mqtt.Client("volvoAAOS2mqtt")
client.will_set(availability_topic, "offline", 0, False)
if settings["mqtt"]["username"] and settings["mqtt"]["password"]:
client.username_pw_set(settings["mqtt"]["username"], settings["mqtt"]["password"])
client.connect(settings["mqtt"]["broker"])
port = 1883
if util.keys_exists(settings["mqtt"], "port"):
conf_port = settings["mqtt"]["port"]
if isinstance(conf_port, int):
if conf_port > 0:
port = settings["mqtt"]["port"]
client.connect(settings["mqtt"]["broker"], port)
client.loop_start()
client.on_message = on_message
client.on_disconnect = on_disconnect
@@ -34,6 +40,7 @@ def connect():
def on_connect(client, userdata, flags, rc):
send_heartbeat()
if len(subscribed_topics) > 0:
for topic in subscribed_topics:
mqtt_client.subscribe(topic)
@@ -44,182 +51,128 @@ def on_disconnect(client, userdata, rc):
def on_message(client, userdata, msg):
if msg.topic in subscribed_topics:
try:
vin = msg.topic.split('/')[2].split('_')[0]
payload = msg.payload.decode("UTF-8")
if "climate_status" in msg.topic:
global assumed_climate_state, climate_timer
if payload == "ON":
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
climate_timer = Timer(1 * 60, volvo.disable_climate, (vin, ))
climate_timer.start()
update_car_data()
elif payload == "OFF":
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":
volvo.api_call(CAR_LOCK_URL, "POST", vin)
update_car_data()
elif payload == "UNLOCK":
volvo.api_call(CAR_UNLOCK_URL, "POST", vin)
update_car_data()
elif "update_data" in msg.topic:
if payload == "PRESS":
update_car_data(True)
except IndexError:
print("Error - Cannot get vin from MQTT topic!")
return None
payload = msg.payload.decode("UTF-8")
if "climate_status" in msg.topic:
global assumed_climate_state, climate_timer
if payload == "ON":
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
climate_timer[vin] = Timer(30 * 60, volvo.disable_climate, (vin, ))
climate_timer[vin].start()
update_car_data()
elif payload == "OFF":
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[vin].is_alive():
climate_timer[vin].cancel()
update_car_data()
elif "lock_status" in msg.topic:
if payload == "LOCK":
volvo.api_call(CAR_LOCK_URL, "POST", vin)
update_car_data(True, {"entity_id": "lock_status", "vin": vin, "state": "LOCKED"})
elif payload == "UNLOCK":
volvo.api_call(CAR_UNLOCK_URL, "POST", vin)
update_car_data(True, {"entity_id": "lock_status", "vin": vin, "state": "UNLOCKED"})
elif "update_data" in msg.topic:
if payload == "PRESS":
update_car_data(True)
def update_loop():
create_ha_devices()
while True:
print("Sending mqtt update...")
send_heartbeat()
update_car_data()
print("Mqtt update done. Next run in " + str(settings["updateInterval"]) + " seconds.")
time.sleep(settings["updateInterval"])
def update_car_data(force_update=False):
def update_car_data(force_update=False, overwrite={}):
global last_data_update
last_data_update = format_datetime(datetime.now(), format="medium", locale=settings["babelLocale"])
last_data_update = format_datetime(datetime.now(util.TZ), 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 entity in volvo.supported_endpoints[vin]:
if entity["domain"] == "button":
continue
for lock in supported_locks:
state = volvo.api_call(lock["url"], "GET", vin, lock["id"], force_update)
mqtt_client.publish(
f"homeassistant/lock/{vin}_{lock['id']}/state",
state
)
ov_entity_id = ""
ov_vin = ""
ov_state = ""
if bool(overwrite):
ov_entity_id = overwrite["entity_id"]
ov_vin = overwrite["vin"]
ov_state = overwrite["state"]
for switch in supported_switches:
if switch["id"] == "climate_status":
if entity["id"] == "climate_status":
state = assumed_climate_state[vin]
else:
state = "OFF"
mqtt_client.publish(
f"homeassistant/switch/{vin}_{switch['id']}/state",
state
)
for sensor in supported_sensors:
if sensor["id"] == "last_data_update":
elif entity["id"] == "last_data_update":
state = last_data_update
else:
state = volvo.api_call(sensor["url"], "GET", vin, sensor["id"], force_update)
if entity["id"] == ov_entity_id and vin == ov_vin:
state = ov_state
else:
state = volvo.api_call(entity["url"], "GET", vin, entity["id"], force_update)
if entity["domain"] == "device_tracker":
topic = f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/attributes"
else:
topic = f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/state"
mqtt_client.publish(
f"homeassistant/sensor/{vin}_{sensor['id']}/state",
state
topic,
json.dumps(state) if isinstance(state, dict) else state
)
def create_ha_devices():
global subscribed_topics
for vin in volvo.vins:
device = volvo.get_vehicle_details(vin)
for device_tracker in supported_device_trackers:
for entity in volvo.supported_endpoints[vin]:
config = {
"name": device_tracker['name'],
"object_id": f"volvo_{vin}_{device_tracker['id']}",
"name": entity['name'],
"object_id": f"volvo_{vin}_{entity['id']}",
"schema": "state",
"icon": f"mdi:{device_tracker['icon']}",
"state_topic": f"homeassistant/device_tracker/{vin}_{device_tracker['id']}/state",
"icon": f"mdi:{entity['icon']}",
"state_topic": f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/state",
"device": device,
"unique_id": f"volvoAAOS2mqtt_{vin}_{device_tracker['id']}",
"json_attributes_topic": f"homeassistant/device_tracker/{vin}_{device_tracker['id']}/attributes"
"unique_id": f"volvoAAOS2mqtt_{vin}_{entity['id']}",
"availability_topic": availability_topic
}
mqtt_client.publish(
f"homeassistant/device_tracker/volvoAAOS2mqtt/{vin}_{device_tracker['id']}/config",
json.dumps(config),
)
if entity.get("device_class"):
config["device_class"] = entity["device_class"]
for button in supported_buttons:
command_topic = f"homeassistant/button/{vin}_{button['id']}/command"
config = {
"name": button['name'],
"object_id": f"volvo_{vin}_{button['id']}",
"schema": "state",
"icon": f"mdi:{button['icon']}",
"state_topic": f"homeassistant/button/{vin}_{button['id']}/state",
"command_topic": command_topic,
"device": device,
"unique_id": f"volvoAAOS2mqtt_{vin}_{button['id']}",
}
mqtt_client.publish(
f"homeassistant/button/volvoAAOS2mqtt/{vin}_{button['id']}/config",
json.dumps(config),
)
subscribed_topics.append(command_topic)
mqtt_client.subscribe(command_topic)
if entity.get("unit"):
config["unit_of_measurement"] = entity["unit"]
for lock in supported_locks:
command_topic = f"homeassistant/lock/{vin}_{lock['id']}/command"
config = {
"name": lock['name'],
"object_id": f"volvo_{vin}_{lock['id']}",
"schema": "state",
"icon": f"mdi:{lock['icon']}",
"state_topic": f"homeassistant/lock/{vin}_{lock['id']}/state",
"command_topic": command_topic,
"optimistic": False,
"device": device,
"unique_id": f"volvoAAOS2mqtt_{vin}_{lock['id']}",
}
mqtt_client.publish(
f"homeassistant/lock/volvoAAOS2mqtt/{vin}_{lock['id']}/config",
json.dumps(config),
)
subscribed_topics.append(command_topic)
mqtt_client.subscribe(command_topic)
if entity.get("domain") == "device_tracker":
config["json_attributes_topic"] = f"homeassistant/{entity['domain']}/{vin}_{entity['id']}/attributes"
for switch in supported_switches:
command_topic = f"homeassistant/switch/{vin}_{switch['id']}/command"
config = {
"name": switch['name'],
"object_id": f"volvo_{vin}_{switch['id']}",
"schema": "state",
"icon": f"mdi:{switch['icon']}",
"state_topic": f"homeassistant/switch/{vin}_{switch['id']}/state",
"command_topic": command_topic,
"optimistic": False,
"device": device,
"unique_id": f"volvoAAOS2mqtt_{vin}_{switch['id']}",
}
mqtt_client.publish(
f"homeassistant/switch/volvoAAOS2mqtt/{vin}_{switch['id']}/config",
json.dumps(config),
)
subscribed_topics.append(command_topic)
mqtt_client.subscribe(command_topic)
for sensor in supported_sensors:
config = {
"name": sensor['name'],
"object_id": f"volvo_{vin}_{sensor['id']}",
"schema": "state",
"icon": f"mdi:{sensor['icon']}",
"state_topic": f"homeassistant/sensor/{vin}_{sensor['id']}/state",
"device": device,
"unique_id": f"volvoAAOS2mqtt_{vin}_{sensor['id']}",
}
if "unit" in sensor:
config["unit_of_measurement"] = sensor["unit"]
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/sensor/volvoAAOS2mqtt/{vin}_{sensor['id']}/config",
f"homeassistant/{entity['domain']}/volvoAAOS2mqtt/{vin}_{entity['id']}/config",
json.dumps(config),
retain=True
)
time.sleep(2)
send_heartbeat()
def send_heartbeat():
mqtt_client.publish(availability_topic, "online")
+6 -1
View File
@@ -1,8 +1,10 @@
{
"updateInterval": 300,
"babelLocale": "de",
"TZ": "Europe/Berlin",
"mqtt": {
"broker": "",
"port": 1883,
"username": "",
"password": ""
},
@@ -10,6 +12,9 @@
"username": "",
"password": "",
"vin": "",
"vccapikey": ""
"vccapikey": "",
"odometerMultiplier": "",
"averageSpeedDivider": "",
"averageFuelConsumptionMultiplier": ""
}
}
+6 -3
View File
@@ -5,12 +5,15 @@ configuration:
babelLocale:
name: Babel locale
description: Select your country code or take a look at the GitHub repo for more infos!
TZ:
name: Timezone
description: Set your local timezone eg. "Europe/Berlin" or "America/New_York"
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.
description: Broker is your mqtt broker IP eg "192.168.0.1". Mqtt username and password are optional. Broker port can be changed. If no value is given, port 1883 will be used.
volvoData:
name: Volvo 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!
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!
+36
View File
@@ -0,0 +1,36 @@
import pytz
import os
from config import settings
TZ = None
def keys_exists(element, *keys):
""""
Check if *keys (nested) exists in `element` (dict).
Thanks stackoverflow: https://stackoverflow.com/questions/43491287/elegant-way-to-check-if-a-nested-key-exists-in-a-dict
"""
if not isinstance(element, dict):
raise AttributeError('keys_exists() expects dict as first argument.')
if len(keys) == 0:
raise AttributeError('keys_exists() expects at least two arguments, one given.')
_element = element
for key in keys:
try:
_element = _element[key]
except KeyError:
return False
return True
def set_tz():
global TZ
env_tz = os.environ.get("TZ")
settings_tz = settings.get("TZ")
if env_tz:
TZ = pytz.timezone(env_tz)
elif settings_tz:
TZ = pytz.timezone(settings_tz)
else:
raise Exception("No timezone setting found! Please read the README!")
+215 -156
View File
@@ -1,42 +1,40 @@
import requests
from datetime import datetime, timedelta
import mqtt
import util
from datetime import datetime, timedelta
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_STATE_URL, \
WINDOWS_STATE_URL, LOCK_STATE_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, \
WINDOWS_STATE_URL, LOCK_STATE_URL, TYRE_STATE_URL, supported_entities, BATTERY_CHARGE_STATE_URL, \
STATISTICS_URL
session = requests.Session()
session.headers = {
"vcc-api-key": settings["volvoData"]["vccapikey"],
"content-type": "application/json",
"accept": "*/*"
"vcc-api-key": settings["volvoData"]["vccapikey"],
"content-type": "application/json",
"accept": "*/*"
}
token_expires_at: datetime
refresh_token = None
vins = []
recharge_cached_api_response = {}
recharge_api_last_update = {}
window_cached_api_response = {}
window_api_last_update = {}
door_cached_api_response = {}
door_api_last_update = {}
supported_endpoints = {}
cached_requests = {}
def authorize():
headers = {
"authorization": "Basic aDRZZjBiOlU4WWtTYlZsNnh3c2c1WVFxWmZyZ1ZtSWFEcGhPc3kxUENhVXNpY1F0bzNUUjVrd2FKc2U0QVpkZ2ZJZmNMeXc=",
"content-type": "application/x-www-form-urlencoded",
"accept": "application/json"
"authorization": "Basic aDRZZjBiOlU4WWtTYlZsNnh3c2c1WVFxWmZyZ1ZtSWFEcGhPc3kxUENhVXNpY1F0bzNUUjVrd2FKc2U0QVpkZ2ZJZmNMeXc=",
"content-type": "application/x-www-form-urlencoded",
"accept": "application/json"
}
body = {
"username": settings.volvoData["username"],
"password": settings.volvoData["password"],
"grant_type": "password",
"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"],
"grant_type": "password",
"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"
}
auth = requests.post(OAUTH_URL, data=body, headers=headers)
if auth.status_code == 200:
@@ -44,10 +42,11 @@ def authorize():
session.headers.update({'authorization': "Bearer " + data["access_token"]})
global token_expires_at, refresh_token
token_expires_at = datetime.now() + timedelta(seconds=(data["expires_in"] - 30))
token_expires_at = datetime.now(util.TZ) + timedelta(seconds=(data["expires_in"] - 30))
refresh_token = data["refresh_token"]
get_vehicles()
check_supported_endpoints()
else:
message = auth.json()
raise Exception(message["error_description"])
@@ -57,14 +56,14 @@ def refresh_auth():
print("Refreshing credentials")
global refresh_token
headers = {
"authorization": "Basic aDRZZjBiOlU4WWtTYlZsNnh3c2c1WVFxWmZyZ1ZtSWFEcGhPc3kxUENhVXNpY1F0bzNUUjVrd2FKc2U0QVpkZ2ZJZmNMeXc=",
"content-type": "application/x-www-form-urlencoded",
"accept": "application/json"
"authorization": "Basic aDRZZjBiOlU4WWtTYlZsNnh3c2c1WVFxWmZyZ1ZtSWFEcGhPc3kxUENhVXNpY1F0bzNUUjVrd2FKc2U0QVpkZ2ZJZmNMeXc=",
"content-type": "application/x-www-form-urlencoded",
"accept": "application/json"
}
body = {
"grant_type": "refresh_token",
"refresh_token": refresh_token
"grant_type": "refresh_token",
"refresh_token": refresh_token
}
auth = requests.post(OAUTH_URL, data=body, headers=headers)
if auth.status_code == 200:
@@ -72,7 +71,7 @@ def refresh_auth():
session.headers.update({'authorization': "Bearer " + data["access_token"]})
global token_expires_at
token_expires_at = datetime.now() + timedelta(seconds=(data["expires_in"] - 30))
token_expires_at = datetime.now(util.TZ) + timedelta(seconds=(data["expires_in"] - 30))
refresh_token = data["refresh_token"]
@@ -112,19 +111,19 @@ def get_vehicle_details(vin):
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}",
}
"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}",
}
"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)
@@ -132,6 +131,28 @@ def get_vehicle_details(vin):
return device
def check_supported_endpoints():
global supported_endpoints
for vin in vins:
supported_endpoints[vin] = []
for entity in supported_entities:
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
continue
if entity.get('url'):
state = api_call(entity["url"], "GET", vin, entity["id"])
else:
state = ""
if state is not None:
print("Success! " + entity["name"] + " is supported by your vehicle.")
supported_endpoints[vin].append(entity)
else:
print("Failed, " + entity["name"] + " is unfortunately not supported by your vehicle.")
def initialize_climate(vins):
for vin in vins:
mqtt.assumed_climate_state[vin] = "OFF"
@@ -145,24 +166,29 @@ def disable_climate(vin):
def api_call(url, method, vin, sensor_id=None, force_update=False):
global token_expires_at
if datetime.now() >= token_expires_at:
if datetime.now(util.TZ) >= token_expires_at:
refresh_auth()
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)
if url in [RECHARGE_STATE_URL, WINDOWS_STATE_URL, LOCK_STATE_URL, TYRE_STATE_URL, STATISTICS_URL]:
# Minimize API calls for endpoints with multiple values
response = cached_request(url, method, vin, force_update)
if response is None:
# Exception caught while getting data from volvo api, doing nothing
return None
elif method == "GET":
print("Starting " + method + " call against " + url)
response = session.get(url.format(vin), timeout=15)
try:
response = session.get(url.format(vin), timeout=15)
except requests.exceptions.RequestException as e:
print("Error getting data: " + str(e))
return ""
elif method == "POST":
print("Starting " + method + " call against " + url)
response = session.post(url.format(vin), timeout=20)
try:
response = session.post(url.format(vin), timeout=20)
except requests.exceptions.RequestException as e:
print("Error getting data: " + str(e))
return ""
else:
print("Unkown method posted: " + method + ". Returning nothing")
return ""
@@ -175,143 +201,176 @@ def api_call(url, method, vin, sensor_id=None, force_update=False):
else:
if url == CLIMATE_START_URL and response.status_code == 503:
print("Car in use, cannot start pre climatization")
mqtt.assumed_climate_state = "OFF"
mqtt.assumed_climate_state[vin] = "OFF"
mqtt.update_car_data()
else:
print("API Call failed. Status Code: " + str(response.status_code) + ". Error: " + response.text)
return ""
state = parse_api_data(data, sensor_id)
if not state:
return ""
else:
return state
return parse_api_data(data, sensor_id)
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
def cached_request(url, method, vin, force_update=False):
global cached_requests
if not util.keys_exists(cached_requests, vin + "_" + url):
# No API Data 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)
try:
response = session.get(url.format(vin), timeout=15)
door_cached_api_response[vin] = response
door_api_last_update[vin] = datetime.now()
except requests.exceptions.RequestException as e:
print("Error getting data: " + str(e))
return None
data = {"response": response, "last_update": datetime.now(util.TZ)}
cached_requests[vin + "_" + url] = data
else:
if (datetime.now(util.TZ) - cached_requests[vin + "_" + url]["last_update"]).total_seconds() >= settings["updateInterval"] \
or (force_update and (datetime.now(util.TZ) - cached_requests[vin + "_" + url]["last_update"]).total_seconds() >= 2):
# Old Data in Cache, or force mode active, updating
print("Starting " + method + " call against " + url)
try:
response = session.get(url.format(vin), timeout=15)
except requests.exceptions.RequestException as e:
print("Error getting data: " + str(e))
return None
data = {"response": response, "last_update": datetime.now(util.TZ)}
cached_requests[vin + "_" + url] = data
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]
response = cached_requests[vin + "_" + url]["response"]
return response
def parse_api_data(data, sensor_id=None):
data = data["data"]
if sensor_id == "battery_charge_level":
return data["data"].get("batteryChargeLevel").get("value")
return data["batteryChargeLevel"]["value"] if util.keys_exists(data, "batteryChargeLevel") else None
elif sensor_id == "electric_range":
return data["data"].get("electricRange").get("value")
return data["electricRange"]["value"] if util.keys_exists(data, "electricRange") else None
elif sensor_id == "charging_system_status":
if "chargingSystemStatus" in data["data"]:
return charging_system_states[data["data"].get("chargingSystemStatus").get("value")]
else:
return ""
return charging_system_states[data["chargingSystemStatus"]["value"]] if util.keys_exists(data,
"chargingSystemStatus") else None
elif sensor_id == "charging_connection_status":
return charging_connection_states[data["chargingConnectionStatus"]["value"]] if util.keys_exists(data,
"chargingConnectionStatus") else None
elif sensor_id == "estimated_charging_time":
if "chargingSystemStatus" in data["data"]:
charging_system_state = charging_system_states[data["data"]["chargingSystemStatus"]["value"]]
if util.keys_exists(data, "chargingSystemStatus"):
charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]]
if charging_system_state == "Charging":
return data["data"]["estimatedChargingTime"]["value"]
return data["estimatedChargingTime"]["value"] if util.keys_exists(data, "estimatedChargingTime") else ""
else:
return 0
else:
return ""
return None
elif sensor_id == "estimated_charging_finish_time":
if "chargingSystemStatus" in data["data"]:
charging_system_state = charging_system_states[data["data"].get("chargingSystemStatus").get("value")]
if util.keys_exists(data, "chargingSystemStatus"):
charging_system_state = charging_system_states[data["chargingSystemStatus"]["value"]]
if charging_system_state == "Charging":
charging_time = int(data["data"].get("estimatedChargingTime").get("value"))
charging_finished = datetime.now() + timedelta(minutes=charging_time)
charging_time = int(data["estimatedChargingTime"]["value"] if util.keys_exists(data, "estimatedChargingTime")
else 0)
charging_finished = datetime.now(util.TZ) + timedelta(minutes=charging_time)
return format_datetime(charging_finished, format="medium", locale=settings["babelLocale"])
else:
return ""
else:
return None
elif sensor_id == "lock_status":
return data["carLocked"]["value"] if util.keys_exists(data, "carLocked") else None
elif sensor_id == "odometer":
multiplier = 1
if util.keys_exists(settings["volvoData"], "odometerMultiplier"):
multiplier = settings["volvoData"]["odometerMultiplier"]
if isinstance(multiplier, str):
multiplier = 1
elif multiplier < 1:
multiplier = 1
return int(data["odometer"]["value"]) * multiplier if util.keys_exists(data, "odometer") else None
elif sensor_id == "window_front_left":
return window_states[data["frontLeftWindowOpen"]["value"]] if util.keys_exists(data, "frontLeftWindowOpen") \
else None
elif sensor_id == "window_front_right":
return window_states[data["frontRightWindowOpen"]["value"]] if util.keys_exists(data, "frontRightWindowOpen") \
else None
elif sensor_id == "window_rear_left":
return window_states[data["rearLeftWindowOpen"]["value"]] if util.keys_exists(data, "rearLeftWindowOpen") \
else None
elif sensor_id == "window_rear_right":
return window_states[data["rearRightWindowOpen"]["value"]] if util.keys_exists(data, "rearRightWindowOpen") \
else None
elif sensor_id == "door_front_left":
return door_states[data["frontLeftDoorOpen"]["value"]] if util.keys_exists(data, "frontLeftDoorOpen") else None
elif sensor_id == "door_front_right":
return door_states[data["frontRightDoorOpen"]["value"]] if util.keys_exists(data, "frontRightDoorOpen") else None
elif sensor_id == "door_rear_left":
return door_states[data["rearLeftDoorOpen"]["value"]] if util.keys_exists(data, "rearLeftDoorOpen") else None
elif sensor_id == "door_rear_right":
return door_states[data["rearRightDoorOpen"]["value"]] if util.keys_exists(data, "rearRightDoorOpen") else None
elif sensor_id == "tailgate":
return door_states[data["tailGateOpen"]["value"]] if util.keys_exists(data, "tailGateOpen") else None
elif sensor_id == "sunroof":
return door_states[data["sunRoofOpen"]["value"]] if util.keys_exists(data, "sunRoofOpen") else None
elif sensor_id == "engine_hood":
return door_states[data["hoodOpen"]["value"]] if util.keys_exists(data, "hoodOpen") else None
elif sensor_id == "tank_lid":
return door_states[data["tankLidOpen"]["value"]] if util.keys_exists(data, "tankLidOpen") else None
elif sensor_id == "tyre_front_left":
return data["frontLeftTyrePressure"]["value"] if util.keys_exists(data, "frontLeftTyrePressure") else None
elif sensor_id == "tyre_front_right":
return data["frontRightTyrePressure"]["value"] if util.keys_exists(data, "frontRightTyrePressure") else None
elif sensor_id == "tyre_rear_left":
return data["rearLeftTyrePressure"]["value"] if util.keys_exists(data, "rearLeftTyrePressure") else None
elif sensor_id == "tyre_rear_right":
return data["rearRightTyrePressure"]["value"] if util.keys_exists(data, "rearRightTyrePressure") else None
elif sensor_id == "engine_state":
return data["engineRunning"]["value"] if util.keys_exists(data, "engineRunning") else None
elif sensor_id == "fuel_level":
if util.keys_exists(data, "fuelAmount"):
fuel_amount = int(data["fuelAmount"]["value"])
if fuel_amount > 0:
return fuel_amount
else:
return None
else:
return None
elif sensor_id == "average_fuel_consumption":
if util.keys_exists(data, "averageFuelConsumption"):
average_fuel_con = float(data["averageFuelConsumption"]["value"])
if average_fuel_con > 0:
multiplier = 1
if util.keys_exists(settings["volvoData"], "averageFuelConsumptionMultiplier"):
multiplier = settings["volvoData"]["averageFuelConsumptionMultiplier"]
if isinstance(multiplier, str):
multiplier = 1
elif multiplier < 1:
multiplier = 1
return average_fuel_con * multiplier
else:
return None
else:
return None
elif sensor_id == "average_speed":
if util.keys_exists(data, "averageSpeed"):
average_speed = int(data["averageSpeed"]["value"])
if average_speed > 1:
divider = 1
if util.keys_exists(settings["volvoData"], "averageSpeedDivider"):
divider = settings["volvoData"]["averageSpeedDivider"]
if isinstance(divider, str):
divider = 1
elif divider < 1:
divider = 1
return average_speed / divider
else:
return None
else:
return None
elif sensor_id == "lock_status":
return data["data"].get("carLocked").get("value")
elif sensor_id == "odometer":
return data["data"].get("odometer").get("value")
elif sensor_id == "window_front_left":
return data["data"].get("frontLeftWindowOpen").get("value")
elif sensor_id == "window_front_right":
return data["data"].get("frontRightWindowOpen").get("value")
elif sensor_id == "window_rear_left":
return data["data"].get("rearLeftWindowOpen").get("value")
elif sensor_id == "window_rear_right":
return data["data"].get("rearRightWindowOpen").get("value")
elif sensor_id == "door_front_left":
return data["data"].get("frontLeftDoorOpen").get("value")
elif sensor_id == "door_front_right":
return data["data"].get("frontRightDoorOpen").get("value")
elif sensor_id == "door_rear_left":
return data["data"].get("rearLeftDoorOpen").get("value")
elif sensor_id == "door_rear_right":
return data["data"].get("rearRightDoorOpen").get("value")
elif sensor_id == "tailgate":
return data["data"].get("tailGateOpen").get("value")
elif sensor_id == "engine_hood":
return data["data"].get("hoodOpen").get("value")
elif sensor_id == "tank_lid":
return data["data"].get("tankLidOpen").get("value")
elif sensor_id == "location":
coordinates = {}
if "geometry" in data["data"]:
raw_data = data["data"].get("geometry").get("coordinates")
coordinates = {"longitude": raw_data[0], "latitude": raw_data[1], "gps_accuracy": 1}
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
else:
return ""
return None