https://github.com/tillsteinbach/carconnectivity
Python API to retrieve telemetry data from various car brands
https://github.com/tillsteinbach/carconnectivity
api api-client api-rest carnet myskoda skoda skoda-connect telemetry telemetry-collection telemetry-data vehicle volkswagen volkswagen-weconnect weconnect weconnect-python weconnect-users
Last synced: 5 months ago
JSON representation
Python API to retrieve telemetry data from various car brands
- Host: GitHub
- URL: https://github.com/tillsteinbach/carconnectivity
- Owner: tillsteinbach
- License: mit
- Created: 2024-12-04T19:32:04.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-05-01T06:48:36.000Z (5 months ago)
- Last Synced: 2025-05-01T07:35:06.938Z (5 months ago)
- Topics: api, api-client, api-rest, carnet, myskoda, skoda, skoda-connect, telemetry, telemetry-collection, telemetry-data, vehicle, volkswagen, volkswagen-weconnect, weconnect, weconnect-python, weconnect-users
- Language: Python
- Homepage:
- Size: 186 KB
- Stars: 64
- Watchers: 12
- Forks: 6
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# CarConnectivity
[](https://github.com/tillsteinbach/CarConnectivity/)
[](https://github.com/tillsteinbach/CarConnectivity/releases/latest)
[](https://github.com/tillsteinbach/CarConnectivity/blob/master/LICENSE)
[](https://github.com/tillsteinbach/CarConnectivity/issues)
[](https://pypi.org/project/carconnectivity/)
[](https://pypi.org/project/carconnectivity/)
[](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!
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
- [CarConnectivity-cli](https://github.com/tillsteinbach/CarConnectivity-cli): A commandline interface to interact with your Vehicles
- [CarConnectivity-MQTT](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt): A MQTT Client that provides Vehicle data to the MQTT Broker 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))
## 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 |
|----------------------------------|---------------------------------------------------------------------------------------------------------------|
| Skoda | [CarConnectivity-connector-skoda](https://github.com/tillsteinbach/CarConnectivity-connector-skoda) |
| Volkswagen | [CarConnectivity-connector-volkswagen](https://github.com/tillsteinbach/CarConnectivity-connector-volkswagen) |
| Seat/Cupra | [CarConnectivity-connector-seatcupra](https://github.com/tillsteinbach/CarConnectivity-connector-seatcupra) |
| [Tronity](https://www.tronity.io) | [CarConnectivity-connector-tronity](https://github.com/tillsteinbach/CarConnectivity-connector-tronity) |
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 |
|----------------------------------|-------------------------------------------------------------------------------------------------------------------------|
| WebUI (easy to use webinterface) | [CarConnectivity-plugin-webui](https://github.com/tillsteinbach/CarConnectivity-plugin-webui) |
| MQTT | [CarConnectivity-plugin-mqtt](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt) |
| Home Assistant MQTT | [CarConnectivity-plugin-mqtt_homeassistant](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt_homeassistant) |
| A Better Routeplanner (ABRP) | [CarConnectivity-plugin-abrp](https://github.com/tillsteinbach/CarConnectivity-plugin-abrp) |
| Apple Homekit | [CarConnectivity-plugin-homekit](https://github.com/tillsteinbach/CarConnectivity-plugin-homekit) |
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": "test@test.de"
"password": "testpassword123"
}
},
{
"type": "skoda",
"config": {
"username": "test@test.de"
"password": "testpassword123"
}
}
]
}
}
```
The detailed configuration options of the connectors can be found in their README files.
## Getting started
- To get started have a look in the [examples folder](https://github.com/tillsteinbach/CarConnectivity/tree/main/examples)