| Name | audiconnectpy JSON |
| Version |
1.5.6
JSON |
| download |
| home_page | None |
| Summary | Provides asynchronous authentication and access to Audi Connect |
| upload_time | 2024-04-14 16:25:36 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10.0 |
| license | GPL-3 |
| keywords |
connect
async
audi
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# audiconnectpy
[](https://github.com/cyr-ius/audiconnectpy/)
[](https://github.com/cyr-ius/audiconnectpy/releases/latest)
[](https://pypi.org/project/audiconnectpy/)
[](https://pypi.org/project/audiconnectpy/)
The audiconnect component provides an integration with the Audi Connect cloud service. It adds presence detection, sensors such as range, mileage, and fuel level, and provides car actions such as locking/unlocking and setting the pre-heater.
Note: Certain functions require special permissions from Audi, such as position update via GPS.
Credit for initial API discovery go to the guys at the ioBroker VW-Connect forum, who were able to figure out how the API and the PIN hashing works. Also some implementation credit to davidgiga1993 of the original AudiAPI Python package, on which some of this code is loosely based.
## Warning
Use this API with care. If you use it wrong (e.g. too many logins, repeated login attempts with wrong password, ...) your account may get blocked.
## Install
Use the PIP package manager
```bash
pip install audiconnectpy
```
Or manually download and install the last version from github
```bash
git clone https://github.com/cyr-ius/audiconnectpy.git
python setup.py install
```
## Get started
```python
# Import the audiconnectpy package.
from audiconnectpy import AudiConnect
async def main():
async with ClientSession() as session:
api = AudiConnect(session, VW_USERNAME, VW_PASSWORD, COUNTRY, SPIN)
await api.async_update()
print(api.vehicles)
if __name__ == "__main__":
loop = asyncio.get_event_loop()
loop.run_until_complete(main())
```
Have a look at the [example.py](https://github.com/cyr-ius/audiconnectpy/blob/master/example.py) for a more complete overview.
## Login & Consent
Audiconectpy is based on the new Carnet 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 My Audi interface. Easiest to do so is by installing the My Audi app on your smartphone and login there. If necessary you will be asked to agree to the terms and conditions.
## Credits
Inspired by :
- [arjenvrh/audi_connect_ha](https://github.com/arjenvrh/audi_connect_ha)
- [tknaller/openhab-addons](https://github.com/tknaller/openhab-addons)
- [davidgiga1993/AudiAPI](https://github.com/davidgiga1993/AudiAPI)
Raw data
{
"_id": null,
"home_page": null,
"name": "audiconnectpy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10.0",
"maintainer_email": null,
"keywords": "connect, async, audi",
"author": null,
"author_email": "Cyr-ius <cyr-ius@ipocus.net>",
"download_url": "https://files.pythonhosted.org/packages/ce/af/7e2d48628de260f83a39042ebba9f6d039c1862957d232c4ddffbd511fed/audiconnectpy-1.5.6.tar.gz",
"platform": "any",
"description": "# audiconnectpy\n\n[](https://github.com/cyr-ius/audiconnectpy/)\n[](https://github.com/cyr-ius/audiconnectpy/releases/latest)\n\n[](https://pypi.org/project/audiconnectpy/)\n[](https://pypi.org/project/audiconnectpy/)\n\nThe audiconnect component provides an integration with the Audi Connect cloud service. It adds presence detection, sensors such as range, mileage, and fuel level, and provides car actions such as locking/unlocking and setting the pre-heater.\n\nNote: Certain functions require special permissions from Audi, such as position update via GPS.\n\nCredit for initial API discovery go to the guys at the ioBroker VW-Connect forum, who were able to figure out how the API and the PIN hashing works. Also some implementation credit to davidgiga1993 of the original AudiAPI Python package, on which some of this code is loosely based.\n\n## Warning\n\nUse this API with care. If you use it wrong (e.g. too many logins, repeated login attempts with wrong password, ...) your account may get blocked.\n\n## Install\n\nUse the PIP package manager\n\n```bash\npip install audiconnectpy\n```\n\nOr manually download and install the last version from github\n\n```bash\ngit clone https://github.com/cyr-ius/audiconnectpy.git\npython setup.py install\n```\n\n## Get started\n\n```python\n# Import the audiconnectpy package.\nfrom audiconnectpy import AudiConnect\n\nasync def main():\n async with ClientSession() as session:\n api = AudiConnect(session, VW_USERNAME, VW_PASSWORD, COUNTRY, SPIN)\n await api.async_update()\n print(api.vehicles)\n\n\nif __name__ == \"__main__\":\n loop = asyncio.get_event_loop()\n loop.run_until_complete(main())\n```\n\nHave a look at the [example.py](https://github.com/cyr-ius/audiconnectpy/blob/master/example.py) for a more complete overview.\n\n## Login & Consent\n\nAudiconectpy is based on the new Carnet 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 My Audi interface. Easiest to do so is by installing the My Audi app on your smartphone and login there. If necessary you will be asked to agree to the terms and conditions.\n\n## Credits\n\nInspired by :\n\n- [arjenvrh/audi_connect_ha](https://github.com/arjenvrh/audi_connect_ha)\n- [tknaller/openhab-addons](https://github.com/tknaller/openhab-addons)\n- [davidgiga1993/AudiAPI](https://github.com/davidgiga1993/AudiAPI)\n",
"bugtrack_url": null,
"license": "GPL-3",
"summary": "Provides asynchronous authentication and access to Audi Connect",
"version": "1.5.6",
"project_urls": null,
"split_keywords": [
"connect",
" async",
" audi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "faaee548f3f41a22e7d4f0595a1cb1d7441800f7734a564ffc301093487376d3",
"md5": "1a3862586e7614a02966ad5b7690ba3b",
"sha256": "670e7e5af977ef774690b2ee3285a8c45541c6d3121273c478168f8b9923f105"
},
"downloads": -1,
"filename": "audiconnectpy-1.5.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1a3862586e7614a02966ad5b7690ba3b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10.0",
"size": 36953,
"upload_time": "2024-04-14T16:25:34",
"upload_time_iso_8601": "2024-04-14T16:25:34.827443Z",
"url": "https://files.pythonhosted.org/packages/fa/ae/e548f3f41a22e7d4f0595a1cb1d7441800f7734a564ffc301093487376d3/audiconnectpy-1.5.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ceaf7e2d48628de260f83a39042ebba9f6d039c1862957d232c4ddffbd511fed",
"md5": "90010be261839e8a3a271d651d3adb9d",
"sha256": "ae519a02c1deaae9776b166a1254bf8155cc246de0f27571880ecaf704048008"
},
"downloads": -1,
"filename": "audiconnectpy-1.5.6.tar.gz",
"has_sig": false,
"md5_digest": "90010be261839e8a3a271d651d3adb9d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10.0",
"size": 35550,
"upload_time": "2024-04-14T16:25:36",
"upload_time_iso_8601": "2024-04-14T16:25:36.626400Z",
"url": "https://files.pythonhosted.org/packages/ce/af/7e2d48628de260f83a39042ebba9f6d039c1862957d232c4ddffbd511fed/audiconnectpy-1.5.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-14 16:25:36",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "audiconnectpy"
}
