Skip to main content

Communicate with Volkswagen WeConnect

Project description

Volkswagen Carnet

buy me a coffee

Release PyPi Version CodeStyle Known Vulnerabilities CodeQL codecov

Downloads a day Downloads a week Downloads a month

Help Wanted

As i don't have a car with we connect anymore i would appreciate if it would be possible to get help to keep this repository maintained. So if you feel that you have some time over and is interested in helping out with this. Please feel to contact me! Thanks

Information

Retrieve statistics about your Volkswagen from the Volkswagen Carnet online service

No licence, public domain, no guarantees, feel free to use for anything. Please contribute improvements/bugfixes etc.

Thanks to

For supporting and helping in this project.

Other related repositories

Installation

[venv-python3] user@localhost:~
$ pip install volkswagencarnet

Example

#!/usr/bin/env python3
from volkswagencarnet.vw_connection import Connection
import pprint
import asyncio
import logging

from aiohttp import ClientSession

logging.basicConfig(level=logging.DEBUG)

VW_USERNAME='test@example.com'
VW_PASSWORD='mysecretpassword'


COMPONENTS = {
    'sensor': 'sensor',
    'binary_sensor': 'binary_sensor',
    'lock': 'lock',
    'device_tracker': 'device_tracker',
    'switch': 'switch',
    'climate': 'climate'
}

RESOURCES = [
    'position',
    'distance',
    'electric_climatisation',
    'combustion_climatisation',
    'window_heater',
    'combustion_engine_heating',
    'charging',
    'adblue_level',
    'battery_level',
    'fuel_level',
    'service_inspection',
    'oil_inspection',
    'last_connected',
    'charging_time_left',
    'electric_range',
    'combustion_range',
    'combined_range',
    'charge_max_ampere',
    'climatisation_target_temperature',
    'external_power',
    'parking_light',
    'climatisation_without_external_power',
    'door_locked',
    'trunk_locked',
    'request_in_progress',
    'windows_closed',
    'sunroof_closed',
    'trip_last_average_speed',
    'trip_last_average_electric_consumption',
    'trip_last_average_fuel_consumption',
    'trip_last_duration',
    'trip_last_length'
]

def is_enabled(attr):
    """Return true if the user has enabled the resource."""
    return attr in RESOURCES

async def main():
    """Main method."""
    async with ClientSession(headers={'Connection': 'keep-alive'}) as session:
        connection = Connection(session, VW_USERNAME, VW_PASSWORD)
        if await connection.doLogin():
            if await connection.update():
                # Print overall state
                pprint.pprint(connection._state)

                # Print vehicles
                for vehicle in connection.vehicles:
                    pprint.pprint(vehicle)

                # get all instruments
                instruments = set()
                for vehicle in connection.vehicles:
                    dashboard = vehicle.dashboard(mutable=True)

                    for instrument in (
                            instrument
                            for instrument in dashboard.instruments
                            if instrument.component in COMPONENTS
                            and is_enabled(instrument.slug_attr)):

                        instruments.add(instrument)

                # Output all supported instruments
                for instrument in instruments:
                    print(f'name: {instrument.full_name}')
                    print(f'str_state: {instrument.str_state}')
                    print(f'state: {instrument.state}')
                    print(f'supported: {instrument.is_supported}')
                    print(f'attr: {instrument.attr}')
                    print(f'attributes: {instrument.attributes}')

if __name__ == "__main__":
    loop = asyncio.get_event_loop()
    # loop.run(main())
    loop.run_until_complete(main())

Development

I'd strongly advise installing the git pre-commit hook using pre-commit install. See pre-commit.com for details. Some basic checks are performed before you commit the code, so code style issues will be visible and fixable before creating the PR. Git pre-commit hooks can always be skipped using the --no-verify flag to git commit, if there is something preventing you from actually fixing the reported (and non-auto-fixed) issues.

Decent test coverage for any new or changed code is also much appreciated :)

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

volkswagencarnet-4.4.64b2.tar.gz (69.9 kB view details)

Uploaded Source

Built Distribution

volkswagencarnet-4.4.64b2-py3-none-any.whl (54.5 kB view details)

Uploaded Python 3

File details

Details for the file volkswagencarnet-4.4.64b2.tar.gz.

File metadata

  • Download URL: volkswagencarnet-4.4.64b2.tar.gz
  • Upload date:
  • Size: 69.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for volkswagencarnet-4.4.64b2.tar.gz
Algorithm Hash digest
SHA256 457bbd1ca814e498b710da6b1d2157877c13ce23b0ffab355086bbc8e8468f51
MD5 6c39c92edb9864d4fedcb33c7fa4f5af
BLAKE2b-256 0484387b2ba511ded8fc71713f4899befe76710ffb85a6e83231835be1554dd2

See more details on using hashes here.

Provenance

File details

Details for the file volkswagencarnet-4.4.64b2-py3-none-any.whl.

File metadata

File hashes

Hashes for volkswagencarnet-4.4.64b2-py3-none-any.whl
Algorithm Hash digest
SHA256 c1955961086b06ef7df899ba68cc195935b5e2ed71f1904faead593abf90d28b
MD5 850c6f57a88f1567f5024c269fb49c4c
BLAKE2b-256 db3f26aabf7005b8c81269eac785190b0965c5a24e8027a2e8ecde2cac11ddb5

See more details on using hashes here.

Provenance

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