{"id":28166700,"url":"https://github.com/tillsteinbach/carconnectivity-cli","last_synced_at":"2025-08-02T05:07:47.404Z","repository":{"id":267123643,"uuid":"900317892","full_name":"tillsteinbach/CarConnectivity-cli","owner":"tillsteinbach","description":"Commandline Interface to interact with your vehicle through its web APIs","archived":false,"fork":false,"pushed_at":"2025-07-07T11:36:57.000Z","size":46,"stargazers_count":10,"open_issues_count":6,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-20T17:21:45.401Z","etag":null,"topics":["cli","myskoda","telemetry","volkswagen","volkswagen-carnet","volkswagen-weconnect","weconnect"],"latest_commit_sha":null,"homepage":"https://github.com/tillsteinbach/CarConnectivity","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tillsteinbach.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["tillsteinbach"],"custom":["https://www.paypal.com/donate?hosted_button_id=2BVFF5GJ9SXAJ"]}},"created_at":"2024-12-08T13:26:20.000Z","updated_at":"2025-06-22T17:54:26.000Z","dependencies_parsed_at":"2024-12-08T14:32:53.039Z","dependency_job_id":"4e641dde-1a45-4d8b-8d7e-1e942b7d5b42","html_url":"https://github.com/tillsteinbach/CarConnectivity-cli","commit_stats":null,"previous_names":["tillsteinbach/carconnectivity-cli"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/tillsteinbach/CarConnectivity-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tillsteinbach%2FCarConnectivity-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tillsteinbach%2FCarConnectivity-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tillsteinbach%2FCarConnectivity-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tillsteinbach%2FCarConnectivity-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tillsteinbach","download_url":"https://codeload.github.com/tillsteinbach/CarConnectivity-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tillsteinbach%2FCarConnectivity-cli/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268337998,"owners_count":24234538,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-02T02:00:12.353Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","myskoda","telemetry","volkswagen","volkswagen-carnet","volkswagen-weconnect","weconnect"],"created_at":"2025-05-15T13:13:48.069Z","updated_at":"2025-08-02T05:07:47.385Z","avatar_url":"https://github.com/tillsteinbach.png","language":"Python","funding_links":["https://github.com/sponsors/tillsteinbach","https://www.paypal.com/donate?hosted_button_id=2BVFF5GJ9SXAJ"],"categories":[],"sub_categories":[],"readme":"\n\n# CarConnectivity Command Line Interface\n[![GitHub sourcecode](https://img.shields.io/badge/Source-GitHub-green)](https://github.com/tillsteinbach/CarConnectivity-cli/)\n[![GitHub release (latest by date)](https://img.shields.io/github/v/release/tillsteinbach/CarConnectivity-cli)](https://github.com/tillsteinbach/CarConnectivity-cli/releases/latest)\n[![GitHub](https://img.shields.io/github/license/tillsteinbach/CarConnectivity-cli)](https://github.com/tillsteinbach/CarConnectivity-cli/blob/master/LICENSE)\n[![GitHub issues](https://img.shields.io/github/issues/tillsteinbach/CarConnectivity-cli)](https://github.com/tillsteinbach/CarConnectivity-cli/issues)\n[![PyPI - Downloads](https://img.shields.io/pypi/dm/carconnectivity-cli?label=PyPI%20Downloads)](https://pypi.org/project/carconnectivity-cli/)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/carconnectivity-cli)](https://pypi.org/project/carconnectivity-cli/)\n[![Donate at PayPal](https://img.shields.io/badge/Donate-PayPal-2997d8)](https://www.paypal.com/donate?hosted_button_id=2BVFF5GJ9SXAJ)\n[![Sponsor at Github](https://img.shields.io/badge/Sponsor-GitHub-28a745)](https://github.com/sponsors/tillsteinbach)\n\n## CarConnectivity will become the successor of [WeConnect-python](https://github.com/tillsteinbach/WeConnect-python) in 2025 with similar functionality but support for other brands beyond Volkswagen!\n\n## Supported Car Brands\nCarConenctivity uses a plugin architecture to enable access to the services of various brands. Currently known plugins are:\n\n| Brand                             | Connector                                                                                                     |\n|-----------------------------------|---------------------------------------------------------------------------------------------------------------|\n| Skoda                             | [CarConnectivity-connector-skoda](https://github.com/tillsteinbach/CarConnectivity-connector-skoda)           |\n| Volkswagen                        | [CarConnectivity-connector-volkswagen](https://github.com/tillsteinbach/CarConnectivity-connector-volkswagen) |\n| [Tronity](https://www.tronity.io) | [CarConnectivity-connector-tronity](https://github.com/tillsteinbach/CarConnectivity-connector-tronity)       |\n\nIf you know of a connector not listed here let me know and I will add it to the list.\nIf you are a python developer and willing to implement a connector for a brand not listed here, let me know and I try to support you as good as possible\n\n## How to install\nYou first need a running [Python](https://www.python.org/downloads/) installation. Afterwards you can install CarConnectivity-cli with:\n```\npip install carconnectivity-cli\n```\nYou also need the right connector for your vehicle, e.g.\n```\npip install carconnectivity-connector-skoda\n```\nor you installed CarConnectivity-cli with all known connectors and plugins:\n```\npip3 install 'carconnectivity-cli[connectors,plugins]'\n```\nThe plugins will then become active when you add them to your configuration.\n\n## How to use\nStart by creating a carconnectivity.json configuration file\n\n### Configuration\nIn your carconnectivity.json configuration add a section for the connectors you like to use like this:\n```\n{\n    \"carConnectivity\": {\n        \"connectors\": [\n            {\n                \"type\": \"volkswagen\",\n                \"config\": {\n                    \"username\": \"test@test.de\",\n                    \"password\": \"testpassword123\"\n                }\n            },\n            {\n                \"type\": \"skoda\",\n                \"config\": {\n                    \"username\": \"test@test.de\",\n                    \"password\": \"testpassword123\"\n                }\n            }\n        ]\n    }\n}\n```\nThe detailed configuration options of the connectors can be found in their README files.\n\n### How to use the commandline interface\nStart carconnectivity-cli from the commandline, by default you will enter the interactive shell:\n```bash\ncarconnectivity-cli mycarconnectivity_config.json\n```\nYou get all the usage information by using the --help command\n```bash\ncarconnectivity-cli mycarconnectivity_config.json --help\n```\nWith 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)\n```bash\ncarconnectivity-cli mycarconnectivity_config.json list\n/garage/WVWABCE1ZSD057394\n/garage/WVWABCE1ZSD057394/vin\n/garage/WVWABCE1ZSD057394/type\n/garage/WVWABCE1ZSD057394/odometer\n/garage/WVWABCE1ZSD057394/model\n/garage/WVWABCE1ZSD057394/name\n...\n```\nYou can then pass the addresses to the \"get\" command:\n```bash\ncarconnectivity-cli mycarconnectivity_config.json get /garage/WVWABCE1ZSD057394/model\nID.3\n```\nor the \"set\" command:\n```bash\ncarconnectivity-cli mycarconnectivity_config.json /garage/WVWABCE1ZSD057394/climatisation/command stop\n```\nThe \"events\" command allows you to monitor what is happening on the WeConnect Interface:\n```bash\ncarconnectivity-cli mycarconnectivity_config.json events\n2021-05-26 16:49:58.698570: /garage/WVWABCE1ZSD057394/doors/lock_state: new value: unlocked\n2021-05-26 16:49:58.698751: /garage/WVWABCE1ZSD057394/doors/bonnet/lock_state: new value: unknown lock state\n2021-05-26 16:49:58.698800: /garage/WVWABCE1ZSD057394/doors/bonnet/open_state: new value: closed\n2021-05-26 16:49:58.698980: /garage/WVWABCE1ZSD057394/doors/frontLeft/lock_state: new value: unlocked\n2021-05-26 16:49:58.699056: /garage/WVWABCE1ZSD057394/doors/frontLeft/open_state: new value: closed\n```\n\n### S-PIN\nFor some commands (e.g. locking/unlocking supported on some cars) you need in addition to your login the so called S-PIN, you can provide it with the spin config option:\n\n### Interactive Shell\nYou can also use an interactive shell:\n```\ncarconnectivity-cli --username user@mail.de --password test123 shell\nWelcome! Type ? to list commands\nuser@mail.de@weconnect-sh:/$update\nupdate done\nuser@mail.de@weconnect-sh:/$cd garage\nuser@mail.de@weconnect-sh:/garage$ ls\n..\nWVWABCE1ZSD057394\nWVWABCE13SD057505\nuser@mail.de@weconnect-sh:/garage$ cd /garage/WVWABCE13SD057505/status/parkingPosition\nuser@mail.de@weconnect-sh:/garage/WVWABCE13SD057505/status/parkingPosition$ cat\n[parkingPosition] (last captured 2021-06-01T19:05:04+00:00)\n\tLatitude: 51.674535\n\tLongitude: 16.154376\nuser@mail.de@weconnect-sh:/garage/WVWABCE13SD057505/parking/parkingPosition$ exit\nBye\n```\n### Caching\nBy default carconnectivity-cli will cache (store) the data for 300 seconds before retrieving new data from the servers. This makes carconnectivity-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 max_age config 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. If you request too often you might be blocked for some time until you can generate requests again.\n\n### Credentials\nIf 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):\n```\nmachine volkswagen.de\nlogin test@test.de\npassword testpassword123\n```\nYou can also provide the location of the netrc file in the configuration.\n\nThe optional S-PIN needed for some commands can be provided in the account section:\n```\n# For WeConnect\nmachine volkswagen.de\nlogin test@test.de\npassword testpassword123\naccount 1234\n```\n\n## Tested with\n- Volkswagen ID.3 Modelyear 2021\n- Volkswagen Passat GTE Modelyear 2021\n- Skoda Enyaq RS Modelyear 2025\n\n## Reporting Issues\nPlease feel free to open an issue at [GitHub Issue page](https://github.com/tillsteinbach/carconnectivity-cli/issues) to report problems you found.\n\n### Known Issues\n- The Tool is in alpha state and may change unexpectedly at any time!\n\n## Related Projects:\n- [CarConnectivity-plugin-mqtt](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt): MQTT Client that publishes data from CarConnectivity to any MQTT broker.\n- [CarConnectivity](https://github.com/tillsteinbach/CarConnectivity): The underlying python API behind CarConnectivity-cli. If you are a developer and want to implement an application or service with vehicle telemetry data you can use [CarConnectivity-Library](https://github.com/tillsteinbach/CarConnectivity).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftillsteinbach%2Fcarconnectivity-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftillsteinbach%2Fcarconnectivity-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftillsteinbach%2Fcarconnectivity-cli/lists"}