Skip to main content

Communicate with Volkswagen Connect

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 Volkswagen 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',
    'trip_refuel_average_speed',
    'trip_refuel_average_electric_consumption',
    'trip_refuel_average_fuel_consumption',
    'trip_refuel_duration',
    'trip_refuel_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-5.4.7.tar.gz (82.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

volkswagencarnet-5.4.7-py3-none-any.whl (58.5 kB view details)

Uploaded Python 3

File details

Details for the file volkswagencarnet-5.4.7.tar.gz.

File metadata

  • Download URL: volkswagencarnet-5.4.7.tar.gz
  • Upload date:
  • Size: 82.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for volkswagencarnet-5.4.7.tar.gz
Algorithm Hash digest
SHA256 9ddc0d82813845530d6d581aff01c097185b0db0f09c42197d49b06945f573e2
MD5 ab314ee3de8a801db7c912570b49e4b1
BLAKE2b-256 2cc782dd516561e2f0e84ddb145043cf149eff4e2f8f7aa77d8a85abc691a335

See more details on using hashes here.

Provenance

The following attestation bundles were made for volkswagencarnet-5.4.7.tar.gz:

Publisher: release.yaml on robinostlund/volkswagencarnet

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file volkswagencarnet-5.4.7-py3-none-any.whl.

File metadata

File hashes

Hashes for volkswagencarnet-5.4.7-py3-none-any.whl
Algorithm Hash digest
SHA256 b19412cdf94aff8bbe00b24d9f130b42cf0aa20cd77f426e67b7ad139aa79cc0
MD5 5e01792ab3de2cf59a606c3e3b6dd19c
BLAKE2b-256 a21a0ba0fe53c1d85a8aefb16b3a25bc405f4e696d01d92aafe45bea5f2c4ed9

See more details on using hashes here.

Provenance

The following attestation bundles were made for volkswagencarnet-5.4.7-py3-none-any.whl:

Publisher: release.yaml on robinostlund/volkswagencarnet

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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