Python API for the Volkswagen WeConnect Services
Project description
WeConnect-python
Python API for the Volkswagen WeConnect 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
- VWsFriend: VWsFriend records statistics about your car (charging sessions, battery, trips, fueling, etc.) and displays them nicely. It also allows you to forward data from the car to other applications such as A better routeplanner and allows you to integrate your car into Apple HomeKit
- WeConnect-cli: A commandline interface to interact with WeConnect
- WeConnect-MQTT: A MQTT Client that provides WeConnect data to the MQTT Broker of your choice (e.g. your home automation solution such as ioBroker, FHEM or Home Assistant)
WARNING
Use this API with care. If you use it wrong (e.g. too many logins, repeated login attempts with wrong password, ...) your account may get blocked.
Install
pip3 install weconnect[Images]
The minimum required python version is 3.8
Getting started
- To get started have a look in the examples folder
Tested with
- Volkswagen ID.3 Modelyear 2021
- Volkswagen Passat GTE Modelyear 2021
Login & Consent
WeConnect-python is based on the new WeConnect API that was introduced with the new series of ID cars. If you use another car or hybrid you probably need to agree to the terms and conditions of the new WeConnect interface. Easiest to do so is by installing the Volkswagen app on your smartphone and login there. If necessary you will be asked to agree to the terms and conditions.
Reporting Issues
Please feel free to open an issue at GitHub Issue page to report problems you found.
Known Issues
- The API is in alpha state and may change unexpectedly at any time! Please conscider this and pin to a specific version if you depend on it.
- Examples and API documentation is missing
Credits
Inspired by TA2k/ioBroker.vw-connect that gave me a point to start working with the API
Seat, Cupra, Skoda IV, ...
Now owning a Skoda vehicle I'm about to make a rewrite of this library called CarConnectivity, I hope this will be ready for a first release in early 2025
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file weconnect_darkfox_dev-0.0.8.tar.gz.
File metadata
- Download URL: weconnect_darkfox_dev-0.0.8.tar.gz
- Upload date:
- Size: 134.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e18b3db6ecb223645d2baa0dab086230abe372f469d581b0b730f64454daf65c
|
|
| MD5 |
cd95c6b28a9615642ea293da7fa712f0
|
|
| BLAKE2b-256 |
d170eff7c179e7032bb1b57f02027f5b9ea4c82115ab212b454718c19a05b0c9
|
File details
Details for the file weconnect_darkfox_dev-0.0.8-py3-none-any.whl.
File metadata
- Download URL: weconnect_darkfox_dev-0.0.8-py3-none-any.whl
- Upload date:
- Size: 170.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e608bd8603131b8c85f9d7f3eb0c89d381b980abe2c79c1ce644f27dff65d2d4
|
|
| MD5 |
79eb230b0a0675babdceb88679d1d4ff
|
|
| BLAKE2b-256 |
52d0f31bbeed580ac1ea57b6153c988a49d44f7de19e8edaa4c85562b550e3ac
|
