| Name | carconnectivity JSON |
| Version |
0.3
JSON |
| download |
| home_page | None |
| Summary | Library for retrieving information from car connectivity services |
| upload_time | 2025-02-19 20:41:09 |
| maintainer | None |
| docs_url | None |
| author | Till Steinbach |
| requires_python | >=3.9 |
| license | MIT License
Copyright (c) 2021 Till Steinbach
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
|
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# CarConnectivity
[](https://github.com/tillsteinbach/CarConnectivity/)
[](https://github.com/tillsteinbach/CarConnectivity/releases/latest)
[](https://github.com/tillsteinbach/CarConnectivity/blob/master/LICENSE)
[](https://github.com/tillsteinbach/CarConnectivity/issues)
[](https://pypi.org/project/carconnectivity/)
[](https://pypi.org/project/carconnectivity/)
[](https://www.paypal.com/donate?hosted_button_id=2BVFF5GJ9SXAJ)
[](https://github.com/sponsors/tillsteinbach)
## 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!
Python API to connect to various car services. If you are not a developer and ended up here you probably want to check out a project using this library (see below).
## Projects in which the library is used
- [CarConnectivity-cli](https://github.com/tillsteinbach/CarConnectivity-cli): A commandline interface to interact with your Vehicles
- [CarConnectivity-MQTT](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt): A MQTT Client that provides Vehicle 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))
## Supported Car Brands
CarConenctivity uses a connector plugin architecture to enable access to the services of various brands. Currently known connector plugins are:
| Brand | Connector |
|----------------------------------|---------------------------------------------------------------------------------------------------------------|
| Skoda | [CarConnectivity-connector-skoda](https://github.com/tillsteinbach/CarConnectivity-connector-skoda) |
| Volkswagen | [CarConnectivity-connector-volkswagen](https://github.com/tillsteinbach/CarConnectivity-connector-volkswagen) |
| [Troniy](https://www.tronity.io) | [CarConnectivity-connector-tronity](https://github.com/tillsteinbach/CarConnectivity-connector-tronity) |
If you know of a connector not listed here let me know and I will add it to the list.
If 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
## Supported Plugins
CarConenctivity uses a plugin architecture to enable connectivity to other services and protocols. Currently known plugins are:
| Service of Protocol | Connector |
|------------------------------|---------------------------------------------------------------------------------------------------|
| MQTT | [CarConnectivity-plugin-mqtt](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt) |
| A Better Routeplanner (ABRP) | [CarConnectivity-plugin-abrp](https://github.com/tillsteinbach/CarConnectivity-plugin-abrp) |
| Apple Homekit | [CarConnectivity-plugin-homekit](https://github.com/tillsteinbach/CarConnectivity-plugin-homekit) |
If you know of a plugin not listed here let me know and I will add it to the list.
If you are a python developer and willing to implement a plugin for a service not listed here, let me know and I try to support you as good as possible
## Configuration
In your carconnectivity.json configuration add a section for the connectors you like to use like this:
```
{
"carConnectivity": {
"connectors": [
{
"type": "volkswagen",
"config": {
"username": "test@test.de"
"password": "testpassword123"
}
},
{
"type": "skoda",
"config": {
"username": "test@test.de"
"password": "testpassword123"
}
}
]
}
}
```
The detailed configuration options of the connectors can be found in their README files.
## Getting started
- To get started have a look in the [examples folder](https://github.com/tillsteinbach/CarConnectivity/tree/main/examples)
Raw data
{
"_id": null,
"home_page": null,
"name": "carconnectivity",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Till Steinbach",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/7b/28/0dfac2cf1e58f5757e861c609542131845a311959a68e2602a6f87ff9f63/carconnectivity-0.3.tar.gz",
"platform": null,
"description": "\n\n# CarConnectivity\n[](https://github.com/tillsteinbach/CarConnectivity/)\n[](https://github.com/tillsteinbach/CarConnectivity/releases/latest)\n[](https://github.com/tillsteinbach/CarConnectivity/blob/master/LICENSE)\n[](https://github.com/tillsteinbach/CarConnectivity/issues)\n[](https://pypi.org/project/carconnectivity/)\n[](https://pypi.org/project/carconnectivity/)\n[](https://www.paypal.com/donate?hosted_button_id=2BVFF5GJ9SXAJ)\n[](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\nPython API to connect to various car services. If you are not a developer and ended up here you probably want to check out a project using this library (see below).\n\n## Projects in which the library is used\n- [CarConnectivity-cli](https://github.com/tillsteinbach/CarConnectivity-cli): A commandline interface to interact with your Vehicles\n- [CarConnectivity-MQTT](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt): A MQTT Client that provides Vehicle 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## Supported Car Brands\nCarConenctivity uses a connector plugin architecture to enable access to the services of various brands. Currently known connector 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| [Troniy](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## Supported Plugins\nCarConenctivity uses a plugin architecture to enable connectivity to other services and protocols. Currently known plugins are:\n\n| Service of Protocol | Connector |\n|------------------------------|---------------------------------------------------------------------------------------------------|\n| MQTT | [CarConnectivity-plugin-mqtt](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt) |\n| A Better Routeplanner (ABRP) | [CarConnectivity-plugin-abrp](https://github.com/tillsteinbach/CarConnectivity-plugin-abrp) |\n| Apple Homekit | [CarConnectivity-plugin-homekit](https://github.com/tillsteinbach/CarConnectivity-plugin-homekit) |\n\nIf you know of a plugin 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 plugin for a service not listed here, let me know and I try to support you as good as possible\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## Getting started\n- To get started have a look in the [examples folder](https://github.com/tillsteinbach/CarConnectivity/tree/main/examples)\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2021 Till Steinbach\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "Library for retrieving information from car connectivity services",
"version": "0.3",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "11f1ebe5a41d8ed8ecdb86abbfdfddb5cf5f1d9a84fb1e42cd190181dea9fb6e",
"md5": "312f6b29395c477824adacf1c3941e73",
"sha256": "9dccf273e2a6befa2339a1110f97f2c04d91395ba30080d568fef988a7a5e10e"
},
"downloads": -1,
"filename": "carconnectivity-0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "312f6b29395c477824adacf1c3941e73",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 51317,
"upload_time": "2025-02-19T20:41:08",
"upload_time_iso_8601": "2025-02-19T20:41:08.334698Z",
"url": "https://files.pythonhosted.org/packages/11/f1/ebe5a41d8ed8ecdb86abbfdfddb5cf5f1d9a84fb1e42cd190181dea9fb6e/carconnectivity-0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7b280dfac2cf1e58f5757e861c609542131845a311959a68e2602a6f87ff9f63",
"md5": "e85608e9415967de4d164a359e30d06a",
"sha256": "ab237668039858fb19560782be630593829af540867071d35117699db61e014c"
},
"downloads": -1,
"filename": "carconnectivity-0.3.tar.gz",
"has_sig": false,
"md5_digest": "e85608e9415967de4d164a359e30d06a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 43579,
"upload_time": "2025-02-19T20:41:09",
"upload_time_iso_8601": "2025-02-19T20:41:09.777687Z",
"url": "https://files.pythonhosted.org/packages/7b/28/0dfac2cf1e58f5757e861c609542131845a311959a68e2602a6f87ff9f63/carconnectivity-0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-19 20:41:09",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "carconnectivity"
}
