Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tillsteinbach/carconnectivity-plugin-mqtt
Plugin for connecting CarConnectivity with MQTT brokers. Enables vehicle telemetry of various brands in MQTT
https://github.com/tillsteinbach/carconnectivity-plugin-mqtt
car mqtt mqtt-client mqtt-protocol mqtt-publisher skoda smart-home smarthome telemetry telemetry-client telemetry-data volkswagen
Last synced: 17 days ago
JSON representation
Plugin for connecting CarConnectivity with MQTT brokers. Enables vehicle telemetry of various brands in MQTT
- Host: GitHub
- URL: https://github.com/tillsteinbach/carconnectivity-plugin-mqtt
- Owner: tillsteinbach
- License: mit
- Created: 2024-12-31T10:59:19.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2025-01-18T17:42:24.000Z (18 days ago)
- Last Synced: 2025-01-18T18:04:26.766Z (18 days ago)
- Topics: car, mqtt, mqtt-client, mqtt-protocol, mqtt-publisher, skoda, smart-home, smarthome, telemetry, telemetry-client, telemetry-data, volkswagen
- Language: Python
- Homepage: https://github.com/tillsteinbach/CarConnectivity
- Size: 99.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CarConnectivity Plugin for MQTT
[](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt/)
[](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt/releases/latest)
[](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt/blob/master/LICENSE)
[](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt/issues)
[](https://pypi.org/project/carconnectivity-plugin-mqtt/)
[](https://pypi.org/project/carconnectivity-plugin-mqtt/)
[](https://hub.docker.com/r/tillsteinbach/carconnectivity-mqtt)
[](https://hub.docker.com/r/tillsteinbach/carconnectivity-mqtt)
[](https://www.paypal.com/donate?hosted_button_id=2BVFF5GJ9SXAJ)
[](https://github.com/sponsors/tillsteinbach)
## CarConnectivity will become the successor of [WeConnect-python](https://github.com/tillsteinbach/WeConnect-python) in 2025 with similar functionality but support for other brands beyond Volkswagen!
[CarConnectivity](https://github.com/tillsteinbach/CarConnectivity) is a python API to connect to various car services. If you want to publish the data collected from your vehicle in a standard protocol such as [MQTT](https://mqtt.org) this plugin will help you. This Client enables you to integrate with the [MQTT Broker](https://mqtt.org/software/) of your choice (e.g. your home automation solution such as [ioBroker](https://www.iobroker.net), [FHEM](https://fhem.de) or [Home Assistant](https://www.home-assistant.io))
## How to install
### Install using PIP
If you want to use CarConnectivity-mqtt, the easiest way is to obtain it from [PyPI](https://pypi.org/project/carconnectivity-plugin-mqtt/). Just install instead using:
```bash
pip3 install carconnectivity-plugin-mqtt
```
### Connectors & Plugins
In order to connect vehciles from various brands, you need to install connector, e.g. with:
```bash
pip3 install carconnectivity-connector-volkswagen
pip3 install carconnectivity-connector-skoda
```
### Create config file
Create a carconnectivity.json config file like this (Example if you have a Volkswagen and a MySkoda account). A documentation of all possible config options can be found [here](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt/tree/main/doc/Config.md).
```json
{
"carConnectivity": {
"log_level": "error", // set the global log level, you can set individual log levels in the connectors and plugins
"connectors": [
{
"type": "skoda", // Definition for a MySkoda account
"config": {
"interval": 600, // Interval in which the server is checked in seconds
"username": "[email protected]", // Username of your MySkoda Account
"password": "testpassword123" // Password of your MySkoda Account
}
},
{
"type": "volkswagen", // Definition for a Volkswagen account
"config": {
"interval": 300, // Interval in which the server is checked in seconds
"username": "[email protected]", // Username of your Volkswagen Account
"password": "testpassword123" // Username of your Volkswagen Account
}
}
],
"plugins": [
{
"type": "mqtt", // Definition for the MQTT Connection
"config": {
"broker": "192.168.0.123", // Broker hostname or IP address
"username": "testuser", // Broker username to login
"password": "testuser", // Broker password to login
}
}
]
}
}
```
### Startup
When using docker-compose configure CarConnectivity-MQTT like that:
```bash
carconnectivity-mqtt carconnectivity.json
```
### Updates
If you want to update, the easiest way is:
```bash
pip3 install carconnectivity-plugin-mqtt --upgrade
pip3 install carconnectivity-connector-volkswagen --upgrade
pip3 install carconnectivity-connector-skoda --upgrade
```
## With Docker
There is also a Docker image to easily host CarConnectivity-MQTT: [See on Dockerhub](https://hub.docker.com/r/tillsteinbach/carconnectivity-mqtt)
## Other
### Times
By default the times coming from the car are UTC isoformat. You can convert times to your local timezone by adding `convert-times` to your config. Convert times will use the timezone specified in `TZ` variable.
You can format times in your local format by adding `timeformat` to your config. This will use the default Date/Time format of your locale setting (`LC_ALL` variable). If you want to set a specific format add e.g. `timeformat '%a %d %b %Y %T'` to your config.
```yml
...
carconnectivity-mqtt:
image: "tillsteinbach/carconnectivity-mqtt:edge"
environment:
- TZ=Europe/Berlin
- LANG=de_DE
- LC_ALL=de_DE
...
```
### Using Miles or Farenheit
CarConnectivity will guess your desired temperature or range/speed unit based on the systems locale. If it does not match what you want, you can set a different locale in your `carconnectivity.json` json config.
### Credentials
If you do not want to provide your username or password inside the configuration you have to create a ".netrc" file at the appropriate location (usually this is your home folder):
```
# For MQTT broker
machine mymqttbroker
login [email protected]
password testpassword123
```
In this case the configuration needs to look like this:
```
{
"carConnectivity": {
"connectors": [
...
]
"plugins": [
{
"type": "mqtt",
"config": {
"broker": "mymqttbroker"
}
}
]
}
}
```
You can also provide the location of the netrc file in the configuration.
```
{
"carConnectivity": {
"connectors": [
...
]
"plugins": [
{
"type": "mqtt",
"config": {
"broker": "mymqttbroker"
"netrc": "/some/path/on/your/filesystem"
}
}
]
}
}
```