Commandline Interface to interact with the Volkswagen WeConnect Services
Reason this release was yanked:
Not compatible with VW-Servers anymore
Project description
WeConnect-cli
Commandline Interface to interact with the Volkswagen WeConnect Services
What is the purpose?
If you want to query data from weconnect you can use this command line interface to query the service. This commandline interface behaves like a user using the WeConnect ID App and the WeConnect secion on myvolkswagen.de. Use this if you want to work with the data from WeConnect.
Requirements
You need to install python 3 on your system: How to install python
How to install
If you want to use WeConnect-cli, the easiest way is to obtain it from PyPI. Just install instead using:
pip3 install weconnect-cli
Updates
If you want to update WeConnect-cli, the easiest way is:
pip3 install weconnect-cli --upgrade
How to use
Start weconnect-cli from the commandline:
weconnect-cli
You get all the usage information by using the --help command
weconnect-cli --help
With the "list" command you can get a list of all available information you can query
weconnect-cli list
/vehicles/WVWABCE1ZSD057394
/vehicles/WVWABCE1ZSD057394/vin
/vehicles/WVWABCE1ZSD057394/role
/vehicles/WVWABCE1ZSD057394/enrollmentStatus
/vehicles/WVWABCE1ZSD057394/model
/vehicles/WVWABCE1ZSD057394/nickname
/vehicles/WVWABCE1ZSD057394/capabilities
...
You can then pass the addresses to the "get" command:
weconnect-cli get /vehicles/WVWABCE1ZSD057394/model
ID.3
The "events" command allows you to monitor what is happening on the WeConnect Interface:
weconnect-cli events
2021-05-26 16:49:58.698570: /vehicles/WVWABCE1ZSD057394/status/accessStatus/overallStatus: new value: unsafe
2021-05-26 16:49:58.698751: /vehicles/WVWABCE1ZSD057394/status/accessStatus/doors/bonnet/lockState: new value: unknown lock state
2021-05-26 16:49:58.698800: /vehicles/WVWABCE1ZSD057394/status/accessStatus/doors/bonnet/openState: new value: closed
2021-05-26 16:49:58.698980: /vehicles/WVWABCE1ZSD057394/status/accessStatus/doors/frontLeft/lockState: new value: unlocked
2021-05-26 16:49:58.699056: /vehicles/WVWABCE1ZSD057394/status/accessStatus/doors/frontLeft/openState: new value: closed
Credentials
If you do not want to provide your username or password all the time you have to create a ".netrc" file at the appropriate location (usually this is your home folder):
machine volkswagen.de
login test@test.de
password testpassword123
You can also provide the location of the netrc file using the --netrc option
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.
Known Issues
- The Tool is in alpha state and may change unexpectedly at any time!
Related Projects:
- WeConnect-MQTT: MQTT Client that publishes data from Volkswagen WeConnect
- WeConnect-python: Python API to connect to Volkswagen WeConnect Services
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
Built Distribution
Hashes for weconnect_cli-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 90a2e53acb6fefd3195ab666df3602b56daffeb3920a545a9b138cf482560e91 |
|
MD5 | 73c669713058ab86c4bf7f8071acffd1 |
|
BLAKE2b-256 | 00737945fc6b3670120e2c2ec9adc5d9c0fdce04f7eaa201a5ddfcb123878259 |