CarConnectivity icon indicating copy to clipboard operation
CarConnectivity copied to clipboard

Python API to retrieve telemetry data from various car brands

CarConnectivity

GitHub sourcecode GitHub release (latest by date) GitHub GitHub issues PyPI - Downloads PyPI - Python Version Donate at PayPal Sponsor at Github

CarConnectivity will become the successor of WeConnect-python in 2025 with similar functionality but support for other brands beyond Volkswagen!

Python API to connect to various car services. If you are not a developer and ended up here you probably want to check out a project using this library (see below).

Projects in which the library is used

Supported Car Brands

CarConenctivity uses a connector plugin architecture to enable access to the services of various brands. Currently known connector plugins are:

Brand Connector Maintainer
Skoda CarConnectivity-connector-skoda tillsteinbach
Volkswagen CarConnectivity-connector-volkswagen tillsteinbach
Volkswagen (North America only) CarConnectivity-connector-volkswagen-na zackcornelius
Seat/Cupra CarConnectivity-connector-seatcupra tillsteinbach
Audi CarConnectivity-connector-audi acfischer42
Tronity CarConnectivity-connector-tronity tillsteinbach

If you know of a connector not listed here let me know and I will add it to the list. If you are a python developer and willing to implement a connector for a brand not listed here, let me know and I try to support you as good as possible

Supported Plugins

CarConenctivity uses a plugin architecture to enable connectivity to other services and protocols. Currently known plugins are:

Service or Protocol Connector Maintainer
WebUI (easy to use webinterface) CarConnectivity-plugin-webui tillsteinbach
MQTT CarConnectivity-plugin-mqtt tillsteinbach
Home Assistant MQTT CarConnectivity-plugin-mqtt_homeassistant tillsteinbach
A Better Routeplanner (ABRP) CarConnectivity-plugin-abrp tillsteinbach
Apple Homekit CarConnectivity-plugin-homekit tillsteinbach

If you know of a plugin not listed here let me know and I will add it to the list. If you are a python developer and willing to implement a plugin for a service not listed here, let me know and I try to support you as good as possible

Configuration

In your carconnectivity.json configuration add a section for the connectors you like to use like this:

{
    "carConnectivity": {
        "connectors": [
            {
                "type": "volkswagen",
                "config": {
                    "username": "[email protected]",
                    "password": "testpassword123"
                }
            },
            {
                "type": "skoda",
                "config": {
                    "username": "[email protected]",
                    "password": "testpassword123"
                }
            }
        ]
    }
}

The detailed configuration options of the connectors can be found in their README files.

Getting started