tillsteinbach/weconnect-mqtt repository overview

⁠WeConnect-MQTT

MQTT⁠ Client that publishes data from Volkswagen WeConnect Services

⁠What is the purpose?

If you want to integrate data from your WeConnect enabled 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

⁠Using docker-compose

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

version: '3.3'

services:
  weconnect-mqtt:
    image: "tillsteinbach/weconnect-mqtt:latest"
    restart: unless-stopped
    environment:
      - TZ=Europe/Berlin
      - LC_ALL=de_DE
      - [email protected]
      - PASSWORD=myvwidpassword
      - BROKER_ADDRESS=192.168.0.1
      - ADDITIONAL_PARAMETERS=--mqtt-username test --mqtt-password test

⁠S-PIN

For some commands (e.g. locking/unlocking supported on some cars) you need in addition to your login the so called S-PIN, you can provide it with the --spin option:

ADDITIONAL_PARAMETERS=--mqtt-username test --mqtt-password test  --spin 1234

⁠Times

By default the times coming from the car are UTC isoformat. You can convert times to your local timezone by adding --convert-times. Convert times will use the timezone specified in TZ variable. You can format times in your local format by adding --timeformat to ADDITIONAL_PARAMETERS. 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 ADDITIONAL_PARAMETERS.

⁠Without Docker

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

pip install weconnect-mqtt

⁠Tested with

• Volkswagen ID.3 Modelyear 2021
• Volkswagen Passat GTE Modelyear 2021

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

• WeConnect-cli⁠: Commandline Interface to interact with the Volkswagen WeConnect Services
• WeConnect-python⁠: Python API to connect to Volkswagen WeConnect Services
• VWsFriend⁠: VWsFriend is a software to visualize and record statistics of your car and allows control via HomeKit