weconnect-cli 0.10.0

Commandline Interface to interact with the Volkswagen WeConnect Services

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, by default you will enter the interactive shell:

weconnect-cli --username [e-mail] --password test123

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 (use "list -s" if you want to see which attributes can be changed)

weconnect-cli --username [e-mail] --password test123 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 --username [e-mail] --password test123 get /vehicles/WVWABCE1ZSD057394/model
ID.3

or the "set" command:

weconnect-cli --username [e-mail] --password test123 set /vehicles/WVWABCE1ZSD057394/controls/climatization stop

The "events" command allows you to monitor what is happening on the WeConnect Interface:

weconnect-cli --username [e-mail] --password test123 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

Charging Stations

To obtain data for charging stations you have to add a location to search for in geo coordinates and a search radius in meters:

weconnect-cli -l 52.437132 10.796628 --chargingLocationRadius=500 get /chargingStations
ID:                  40a4b8d3-d534-422c-9cd8-81bbfa5b578f
Name:                VW Group Oebisfelder Straße Parkhaus Ost
Operator:            VW Group (Id: edd03be9-2df7-4fe3-be32-1573ba91aac0)
Latitude:            52.4370178
Longitude:           10.7977292
Distance:            76m
Address:             Oebisfelder Straße 1, 38448 Wolfsburg, Deutschland
Max. Charging Power: 50.0kW
Charging Spots: 2 items
	Availability: OCCUPIED
	Max. Charging Power: 22.0kW
	Connectors: 1 items
		Plug Type: Type2
		Max. Charging Power: 22.0kW

	Availability: AVAILABLE
	Max. Charging Power: 50.0kW
	Connectors: 1 items
		Plug Type: CCS
		Max. Charging Power: 50.0kW

Authentification:    RFID, APP, UNKNOWN, UNKNOWN
Options:             weCharge partner;

Interactive Shell

You can also use an interactive shell:

weconnect-cli --username [e-mail] --password test123 shell
Welcome! Type ? to list commands
[e-mail]@weconnect-sh:/$update
update done
[e-mail]@weconnect-sh:/$cd vehicles
[e-mail]@weconnect-sh:/vehicles$ ls
..
WVWABCE1ZSD057394
WVWABCE13SD057505
[e-mail]@weconnect-sh:/vehicles$ cd /vehicles/WVWABCE13SD057505/status/parkingPosition
[e-mail]@weconnect-sh:/vehicles/WVWABCE13SD057505/status/parkingPosition$ cat
[parkingPosition] (last captured 2021-06-01T19:05:04+00:00)
	Latitude: 51.674535
	Longitude: 16.154376
[e-mail]@weconnect-sh:/vehicles/WVWZZZ3CZME112096/status/parkingPosition$ exit
Bye

Caching

By default weconnect-cli will cache (store) the data for 300 seconds before retrieving new data from the servers. This makes weconnect-cli more responsive and at the same time does not cause unneccessary requests to the vw servers. If you want to increase the cache duration use --interval option. If you do not want to cache use --no-cache option. Please use the no-cache option with care. You are generating traffic with subsequent requests.

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 [e-mail]
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