Skip to main content

Python API for the Volkswagen WeConnect Services

Project description

WeConnect-python

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

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

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

In an effort to try to make WeConnect-python also to work with latest generation of vehicles from other volkswagen brands I'm looking for users to temporarily share access to their accounts. If you are willing to support please send me a message.

  • Already tried: Cupra Born (The API looks a bit different, maybe it is older, I will check again in some weeks), thanks to the user initdebugs

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

weconnect-0.60.5.tar.gz (131.3 kB view details)

Uploaded Source

Built Distribution

weconnect-0.60.5-py3-none-any.whl (167.1 kB view details)

Uploaded Python 3

File details

Details for the file weconnect-0.60.5.tar.gz.

File metadata

  • Download URL: weconnect-0.60.5.tar.gz
  • Upload date:
  • Size: 131.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for weconnect-0.60.5.tar.gz
Algorithm Hash digest
SHA256 88683e5c77220bd94d3cf5d85302bc128ee306d31730a579c1aad4ddb1a5d058
MD5 0667f005a8da7e4f7c4524b915a6f5a7
BLAKE2b-256 1b1ae983c82bebbacb85be11e514f5e85d40756f9b945762cde03ffb724e9ea3

See more details on using hashes here.

File details

Details for the file weconnect-0.60.5-py3-none-any.whl.

File metadata

  • Download URL: weconnect-0.60.5-py3-none-any.whl
  • Upload date:
  • Size: 167.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for weconnect-0.60.5-py3-none-any.whl
Algorithm Hash digest
SHA256 acef1415d0eb8e823fcdb5c5a15175118dce870a817354768cdfc217c1c0228a
MD5 b988e06d4da7f41315c1243ae2faaf36
BLAKE2b-256 f46531b429bb4c5567f9ebb566c12e6d4404294902b9df3543fa19e9886707ec

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page