# VWsFriend
Volkswagen WeConnect© API visualization and control (HomeKit) inspired by TeslaMate https://docs.teslamate.org/
## What it looks like
<img src="https://raw.githubusercontent.com/tillsteinbach/VWsFriend/main/screenshots/teaser.gif" width="100%">
## Requirements
You need to install python 3 on your system: [How to install python](https://realpython.com/installing-python/). Minimum python version required is 3.8
To make use of all features you have to install and configure several depending projects (grafana, postgresql, ...) most users use the preconfigured docker images at: https://github.com/tillsteinbach/VWsFriend/
If you still want to setup everything on your own, please continue reading.
### Login & Consent
VWsFriend is based on the new WeConnect ID API that was introduced with the new series of ID cars. If you use another car or hybrid you probably need to agree to the terms and conditions of the WeConnect ID interface. Easiest to do so is by installing the WeConnect ID app on your smartphone and login there. If necessary you will be asked to agree to the terms and conditions.
## How to install
If you want to use VWsFriend, the easiest way is to obtain it from [PyPI](https://pypi.org/project/vwsfriend/). Just install using:
```bash
pip3 install vwsfriend
```
### Updates
If you want to update VWsFriend, the easiest way is:
```bash
pip3 install vwsfriend --upgrade
```
## Privacy
Depending on the data provided by your car usage profiles of the cars users can be made (including the locations of trips, refueling and charging). If you need to protect the privacy of the cars users please add ` --privacy no-locations` to the start parameters
## More information
More information can be found in the Wiki: https://github.com/tillsteinbach/VWsFriend/wiki
## ABPR (A better Route Planner) support
VWsFriend supports sending its data to ABPR out of the box. You just have to generate a user-token in ABRP and configure it for your car in the UI.
Connecting VWsFriend to ABRP enables you to use the current SoC, position, parking and charging state (feature availability depends on your car!) when planning routes in ABRP
If you only want to use the ABPR feature you can try:
```bash
vwsfriend -u user -p password --with-abrp
```
After vwsfriend is started open a browser at http://IP-ADDRESS:4000 and add your user-token in the settings of your car.
## VWsFriend with Apple Homekit support
<img src="https://raw.githubusercontent.com/tillsteinbach/VWsFriend/main/screenshots/homekit.jpg" width="200"><img src="https://raw.githubusercontent.com/tillsteinbach/VWsFriend/main/screenshots/homekit2.jpg" width="200"><img src="https://raw.githubusercontent.com/tillsteinbach/VWsFriend/main/screenshots/homekit3.jpg" width="200"><img src="https://raw.githubusercontent.com/tillsteinbach/VWsFriend/main/screenshots/homekit4.jpg" width="200">
```bash
vwsfriend --with-homekit
```
## VWsFriend with MQTT support (Experimental)
VWsFriend now includes [WeConnect-MQTT](https://github.com/tillsteinbach/WeConnect-mqtt). This enables to use the data from the servers at the same time inside VWsFriend and with MQTT and thus saves additional requests and load on the server.
If you want to know how to configure MQTT, see here: [WeConnect-MQTT Readme](https://github.com/tillsteinbach/WeConnect-mqtt/blob/main/README.md)
VWsFriend is using the same options as WeConnect-MQTT. Just select the options as described in WeConnect-MQTT and add those to VWsFriend when starting.
## Related projects
- [WeConnect-cli](https://github.com/tillsteinbach/WeConnect-cli): A commandline interface to interact with WeConnect
- [WeConnect-MQTT](https://github.com/tillsteinbach/WeConnect-mqtt): A MQTT Client that provides WeConnect data to the MQTT Broker of your choice (e.g. your home automation solution such as [ioBroker](https://www.iobroker.net), [FHEM](https://fhem.de) or [Home Assistant](https://www.home-assistant.io))
## Other
We Connect© Volkswagen AG
Raw data
{
"_id": null,
"home_page": "https://github.com/tillsteinbach/VWsFriend",
"name": "vwsfriend",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "weconnect, we connect, carnet, car net, volkswagen, vw, telemetry, smarthome",
"author": "Till Steinbach",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/5e/4e/c75adc7431b5a0af3bd66bcff14f85a929d2802e43d45b9e8700e85d9104/vwsfriend-0.24.7.tar.gz",
"platform": null,
"description": "# VWsFriend\nVolkswagen WeConnect\u00a9 API visualization and control (HomeKit) inspired by TeslaMate https://docs.teslamate.org/\n\n## What it looks like\n<img src=\"https://raw.githubusercontent.com/tillsteinbach/VWsFriend/main/screenshots/teaser.gif\" width=\"100%\">\n\n## Requirements\nYou need to install python 3 on your system: [How to install python](https://realpython.com/installing-python/). Minimum python version required is 3.8\n\nTo make use of all features you have to install and configure several depending projects (grafana, postgresql, ...) most users use the preconfigured docker images at: https://github.com/tillsteinbach/VWsFriend/\nIf you still want to setup everything on your own, please continue reading.\n\n### Login & Consent\nVWsFriend is based on the new WeConnect ID API that was introduced with the new series of ID cars. If you use another car or hybrid you probably need to agree to the terms and conditions of the WeConnect ID interface. Easiest to do so is by installing the WeConnect ID app on your smartphone and login there. If necessary you will be asked to agree to the terms and conditions.\n\n## How to install\nIf you want to use VWsFriend, the easiest way is to obtain it from [PyPI](https://pypi.org/project/vwsfriend/). Just install using:\n```bash\npip3 install vwsfriend\n```\n### Updates\nIf you want to update VWsFriend, the easiest way is:\n```bash\npip3 install vwsfriend --upgrade\n```\n\n## Privacy\nDepending on the data provided by your car usage profiles of the cars users can be made (including the locations of trips, refueling and charging). If you need to protect the privacy of the cars users please add ` --privacy no-locations` to the start parameters \n\n## More information\nMore information can be found in the Wiki: https://github.com/tillsteinbach/VWsFriend/wiki\n\n## ABPR (A better Route Planner) support\nVWsFriend supports sending its data to ABPR out of the box. You just have to generate a user-token in ABRP and configure it for your car in the UI.\nConnecting VWsFriend to ABRP enables you to use the current SoC, position, parking and charging state (feature availability depends on your car!) when planning routes in ABRP\nIf you only want to use the ABPR feature you can try:\n```bash\nvwsfriend -u user -p password --with-abrp\n```\nAfter vwsfriend is started open a browser at http://IP-ADDRESS:4000 and add your user-token in the settings of your car.\n\n## VWsFriend with Apple Homekit support\n<img src=\"https://raw.githubusercontent.com/tillsteinbach/VWsFriend/main/screenshots/homekit.jpg\" width=\"200\"><img src=\"https://raw.githubusercontent.com/tillsteinbach/VWsFriend/main/screenshots/homekit2.jpg\" width=\"200\"><img src=\"https://raw.githubusercontent.com/tillsteinbach/VWsFriend/main/screenshots/homekit3.jpg\" width=\"200\"><img src=\"https://raw.githubusercontent.com/tillsteinbach/VWsFriend/main/screenshots/homekit4.jpg\" width=\"200\">\n\n```bash\nvwsfriend --with-homekit\n```\n\n## VWsFriend with MQTT support (Experimental)\nVWsFriend now includes [WeConnect-MQTT](https://github.com/tillsteinbach/WeConnect-mqtt). This enables to use the data from the servers at the same time inside VWsFriend and with MQTT and thus saves additional requests and load on the server.\nIf you want to know how to configure MQTT, see here: [WeConnect-MQTT Readme](https://github.com/tillsteinbach/WeConnect-mqtt/blob/main/README.md)\nVWsFriend is using the same options as WeConnect-MQTT. Just select the options as described in WeConnect-MQTT and add those to VWsFriend when starting.\n\n## Related projects\n- [WeConnect-cli](https://github.com/tillsteinbach/WeConnect-cli): A commandline interface to interact with WeConnect\n- [WeConnect-MQTT](https://github.com/tillsteinbach/WeConnect-mqtt): A MQTT Client that provides WeConnect data to the MQTT Broker of your choice (e.g. your home automation solution such as [ioBroker](https://www.iobroker.net), [FHEM](https://fhem.de) or [Home Assistant](https://www.home-assistant.io))\n\n## Other\nWe Connect\u00a9 Volkswagen AG\n",
"bugtrack_url": null,
"license": "MIT",
"summary": null,
"version": "0.24.7",
"project_urls": {
"Bug Tracker": "https://github.com/tillsteinbach/VWsFriend/issues",
"Funding": "https://github.com/sponsors/VWsFriend",
"Homepage": "https://github.com/tillsteinbach/VWsFriend",
"Source": "https://github.com/tillsteinbach/VWsFriend"
},
"split_keywords": [
"weconnect",
" we connect",
" carnet",
" car net",
" volkswagen",
" vw",
" telemetry",
" smarthome"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f41162ca3c193767fcb65ab4ed61544a2041191643a667f59f3de0f60ceef665",
"md5": "4deb2aba85b09c3ad09ed7cbcb8b6520",
"sha256": "85a03ec77d71c20ff538c76a4850897659612958d621bd82be98c1cbf9339328"
},
"downloads": -1,
"filename": "vwsfriend-0.24.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4deb2aba85b09c3ad09ed7cbcb8b6520",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 225416,
"upload_time": "2024-09-14T14:58:41",
"upload_time_iso_8601": "2024-09-14T14:58:41.751379Z",
"url": "https://files.pythonhosted.org/packages/f4/11/62ca3c193767fcb65ab4ed61544a2041191643a667f59f3de0f60ceef665/vwsfriend-0.24.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5e4ec75adc7431b5a0af3bd66bcff14f85a929d2802e43d45b9e8700e85d9104",
"md5": "b0e288450fdf2a6f32a0e1785fc36c54",
"sha256": "14f6d3a34a570250b2370c038f3757dee27ffd12ceb65b989412f1d5c5e6bf70"
},
"downloads": -1,
"filename": "vwsfriend-0.24.7.tar.gz",
"has_sig": false,
"md5_digest": "b0e288450fdf2a6f32a0e1785fc36c54",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 171384,
"upload_time": "2024-09-14T14:58:43",
"upload_time_iso_8601": "2024-09-14T14:58:43.691820Z",
"url": "https://files.pythonhosted.org/packages/5e/4e/c75adc7431b5a0af3bd66bcff14f85a929d2802e43d45b9e8700e85d9104/vwsfriend-0.24.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-14 14:58:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tillsteinbach",
"github_project": "VWsFriend",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "vwsfriend"
}
JSON
