tillsteinbach/carconnectivity-mqtt repository overview

⁠CarConnectivity-MQTT

MQTT⁠ Client that publishes data from several vehicle services

⁠What is the purpose?

If you want to integrate data from your car, a standard protocol such as MQTT⁠ can be very helpful. This Client enables you to integrate with the MQTT Broker⁠ of your choice (e.g. your home automation solution such as ioBroker⁠, FHEM⁠ or Home Assistant⁠)

⁠How to install

⁠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⁠.

{
    "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
                }
            }
        ]
    }
}

⁠Using docker-compose

When using docker-compose configure CarConnectivity-MQTT like that:

services:
  carconnectivity-mqtt:
    image: "tillsteinbach/carconnectivity-mqtt:latest"
    volumes:
      - /path/to/your/config/carconnectivity.json:/carconnectivity.json

⁠Connectors & Plugins

CarConnectivity-MQTT comes with all officially maintained connectors and plugins preinstalled. If you need support for further connectors you can use the ADDITIONAL_INSTALLS variable to install additional connectors and plugins at runtime, e.g.:

...
  carconnectivity-mqtt:
    image: "tillsteinbach/carconnectivity-mqtt:latest"
    environment:
      - ADDITIONAL_INSTALLS=carconnectivity-connector-smartcar
...

⁠Other

⁠Home Assistant

To make Auto Discovery and further features available in Home Assistant also install CarConnectivity-plugin-mqtt_homeassistant⁠

pip3 install carconnectivity-plugin-mqtt_homeassistant

and add it to your config:

            {
                "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
                }
            },
            {
                "type": "mqtt_homeassistant", // Definition for the MQTT Home Assistant Compatibility
                "config": {}
            }

⁠Troubleshooting

If you face challenges the WebUI can help you find the problems: CarConnectivity-plugin-webui⁠. Install it with:

environment:
      - ADDITIONAL_INSTALLS=carconnectivity-plugin-webui

and add a plugin of "type": "webui" to your configuration.

⁠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.

...
  carconnectivity-mqtt:
    image: "tillsteinbach/carconnectivity-mqtt:latest"
    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.

⁠Pre-Releases

Pre releases are taged like versions, e.g. tillsteinbach/carconnectivity-mqtt:0.4a1, if you want to be at the current development version you can use the tillsteinbach/carconnectivity-mqtt:edge tag. Do not use this in a productive environment as it may break suddenly.

For the ADDITIONAL_INSTALLS pre releases can be installed with

environment:
      - ADDITIONAL_INSTALLS=--pre carconnectivity-connector-smartcar

⁠Without Docker

If you don't want to use docker you can obtain carconnectivity-mqtt also as a stand-alone application from PyPI⁠. Just install instead using:

pip install carconnectivity-plugin-mqtt
carconnectivity-mqtt carconnectivity.json

⁠Tested with

• Volkswagen ID.3 Modelyear 2021
• Volkswagen Passat GTE Modelyear 2021
• Skoda Enyaq RD Modelyear 2025
• Seat Leon
• Cupra Born
• Seat Mii

⁠Reporting Issues

Please feel free to open an issue at GitHub Issue page⁠ to report problems you found.

⁠More Questions?

Please see the wiki Wiki⁠ or start a discussion⁠.

⁠Known Issues

• The Tool is in alpha state and may change unexpectedly at any time!

⁠Related Projects:

• CarConnectivity-cli⁠: Commandline Interface to interact with the CarConnectivity Services
• CarConnectivity⁠: Python API to used in CarConnectivity-mqtt