1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
# Volvo On Call
[](https://github.com/molobrakos/volvooncall/actions/workflows/ci.yml)
Retrieve statistics about your Volvo from the Volvo On Call (VOC) online service
No licence, public domain, no guarantees, feel free to use for anything. Please contribute improvements/bugfixes etc.
Also contains an MQTT gateway for publishing information and bidirectional communication with e.g. Home Assistant.
## system requirements
- At least python 3.10 or higher
> For contributors: The `pytype` project does not yet support Python 3.11, so you must use 3.10 to run tests locally.
## dependencies
To use just the API in `volvooncall.py` or the Home Assistant bindings in `dashboard.py`, simply install the package as
usual with pip:
```sh
pip install volvooncall
```
To use console features (i.e. the `voc` command documented below):
```sh
pip install volvooncall[console]
```
To use MQTT features:
```sh
pip install volvooncall[mqtt]
```
## how to use
```
> voc --help
Retrieve information from VOC
Usage:
voc (-h | --help)
voc --version
voc [-v|-vv] [options] list
voc [-v|-vv] [options] status
voc [-v|-vv] [options] trips
voc [-v|-vv] [options] owntracks
voc [-v|-vv] [options] print [<attribute>]
voc [-v|-vv] [options] (lock | unlock)
voc [-v|-vv] [options] heater (start | stop)
voc [-v|-vv] [options] engine (start | stop)
voc [-v|-vv] [options] call <method>
voc [-v|-vv] [options] mqtt
Options:
-u <username> VOC username
-p <password> VOC password
-r <region> VOC region (na, cn, etc.)
-s <url> VOC service URL
-i <vin> Vehicle VIN or registration number
-g Geolocate position
--owntracks_key=<key> Owntracks encryption password
-I <interval> Polling interval (seconds) [default: 300]
-h --help Show this message
-v,-vv Increase verbosity
--scandinavian_miles Report using Scandinavian miles instead of km ISO unit
--usa_units Report using USA units (miles, mph, mpg, gal, etc.)
--version Show version
```
Retrieving basic status:
```
> voc status
ABC123 (XC60/2014) ABCD1234567890 92891km (fuel 25% 210km)
position: 12.34567890,12.34567890
locked: yes
heater: off
```
Printing raw properties:
```
> voc print windows.frontLeftWindowOpen
False
./voc print fuelAmount
45
```
Printing some relevant iofo:
```
> voc dashboard
ABC123 Door lock: Locked
ABC123 Heater: Off
ABC123 Odometer: 12792 mil
ABC123 Fuel amount: 32 L
...
```
Periodically polling the VOC server and republishing all information to a MQTT server
```
> voc mqtt
```
Configuration file in `$HOME/.voc.conf`:
```
username: <username>
password: <password>
```
# credits
https://web.archive.org/web/20180817103553/https://paulpeelen.com/2013/02/08/volvo-on-call-voc-api/ and a lot of random contributors
|
