| Name | carconnectivity-plugin-mqtt-homeassistant JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | CarConnectivity plugin for improving compatibiity with Home Assistant |
| upload_time | 2025-03-10 17:28:29 |
| 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 Plugin for MQTT compatibility with Home Assistant
[](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt_homeassistant/)
[](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt_homeassistant/releases/latest)
[](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt_homeassistant/blob/master/LICENSE)
[](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt_homeassistant/issues)
[](https://pypi.org/project/carconnectivity-plugin-mqtt_homeassistant/)
[](https://pypi.org/project/carconnectivity-plugin-mqtt_homeassistant/)
[](https://www.paypal.com/donate?hosted_button_id=2BVFF5GJ9SXAJ)
[](https://github.com/sponsors/tillsteinbach)
[CarConnectivity](https://github.com/tillsteinbach/CarConnectivity) is a python API to connect to various car services. If you want to provide data to Home Assistant the [CarConnectivity MQTT Plugin](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt) will enable the MQTT protocol. In order to improve the compatibility with Home Assistant, this plugin adds the Home Assistant Device Discovery for automatically provisioning devices in Home Assistant and adds further topics specifically for Home Assistant.
<img src="https://raw.githubusercontent.com/tillsteinbach/CarConnectivity-plugin-mqtt_homeassistant/main/screenshots/homeassistant1.png" width="600">
### Install using PIP
If you want to use the CarConnectivity Plugin for Home Assistant, the easiest way is to obtain it from [PyPI](https://pypi.org/project/carconnectivity-plugin-mqtt_homeassistant/). Just install it using:
```bash
pip3 install carconnectivity-plugin-mqtt_homeassistant
```
after you installed [CarConnectivity](https://github.com/tillsteinbach/CarConnectivity) and the [CarConnectivity MQTT Plugin](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt).
### Install in your CarConnectivity Docker Container
Add `carconnectivity-plugin-mqtt_homeassistant` to the `ADDITIONAL_INSTALLS` environment variable (multiple entries can be separated by a space).
```
...
carconnectivity-mqtt:
image: "tillsteinbach/carconnectivity-mqtt:latest"
environment:
- ADDITIONAL_INSTALLS=carconnectivity-plugin-mqtt_homeassistant
...
```
## Configuration
In your carconnectivity.json configuration add a section for the mqtt_homeassistant plugin like this. A documentation of all possible config options can be found [here](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt_homeassistant/tree/main/doc/Config.md).
```
{
"carConnectivity": {
"connectors": [
...
]
"plugins": [
{
"type": "mqtt", // Definition for the MQTT Connection
"config": {
"broker": "192.168.0.123", // Broker hostname or IP address
"username": "testuser", // Broker username to login
"password": "testuser" // Broker password to login
}
},
{
"type": "mqtt_homeassistant",
"config": {}
}
]
}
}
```
Afterwards you start CarConnectivity in your preferred way, e.g. using
```bash
carconnectivity-mqtt carconnectivity.json
```
Once the device is created in Home Assistant all Entities will display as "Not Available". The reason is that Home Assistant does not know the states yet. In order trigger a resend of all topics, restart CarConnectivity. This will make all entities available.
## Updates
If you want to update, the easiest way is:
```bash
pip3 install carconnectivity-plugin-mqtt_homeassistant --upgrade
```
Raw data
{
"_id": null,
"home_page": null,
"name": "carconnectivity-plugin-mqtt-homeassistant",
"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/9a/e9/4d6b2db95dec99a50dcdca872dbcade3919ab8aaed06961d3581d28f7358/carconnectivity_plugin_mqtt_homeassistant-0.1.1.tar.gz",
"platform": null,
"description": "\n\n# CarConnectivity Plugin for MQTT compatibility with Home Assistant\n[](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt_homeassistant/)\n[](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt_homeassistant/releases/latest)\n[](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt_homeassistant/blob/master/LICENSE)\n[](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt_homeassistant/issues)\n[](https://pypi.org/project/carconnectivity-plugin-mqtt_homeassistant/)\n[](https://pypi.org/project/carconnectivity-plugin-mqtt_homeassistant/)\n[](https://www.paypal.com/donate?hosted_button_id=2BVFF5GJ9SXAJ)\n[](https://github.com/sponsors/tillsteinbach)\n\n[CarConnectivity](https://github.com/tillsteinbach/CarConnectivity) is a python API to connect to various car services. If you want to provide data to Home Assistant the [CarConnectivity MQTT Plugin](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt) will enable the MQTT protocol. In order to improve the compatibility with Home Assistant, this plugin adds the Home Assistant Device Discovery for automatically provisioning devices in Home Assistant and adds further topics specifically for Home Assistant.\n\n<img src=\"https://raw.githubusercontent.com/tillsteinbach/CarConnectivity-plugin-mqtt_homeassistant/main/screenshots/homeassistant1.png\" width=\"600\">\n\n### Install using PIP\nIf you want to use the CarConnectivity Plugin for Home Assistant, the easiest way is to obtain it from [PyPI](https://pypi.org/project/carconnectivity-plugin-mqtt_homeassistant/). Just install it using:\n```bash\npip3 install carconnectivity-plugin-mqtt_homeassistant\n```\nafter you installed [CarConnectivity](https://github.com/tillsteinbach/CarConnectivity) and the [CarConnectivity MQTT Plugin](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt).\n\n### Install in your CarConnectivity Docker Container\nAdd `carconnectivity-plugin-mqtt_homeassistant` to the `ADDITIONAL_INSTALLS` environment variable (multiple entries can be separated by a space).\n```\n...\n carconnectivity-mqtt:\n image: \"tillsteinbach/carconnectivity-mqtt:latest\"\n environment:\n - ADDITIONAL_INSTALLS=carconnectivity-plugin-mqtt_homeassistant\n...\n```\n## Configuration\nIn your carconnectivity.json configuration add a section for the mqtt_homeassistant plugin like this. A documentation of all possible config options can be found [here](https://github.com/tillsteinbach/CarConnectivity-plugin-mqtt_homeassistant/tree/main/doc/Config.md).\n```\n{\n \"carConnectivity\": {\n \"connectors\": [\n ...\n ]\n \"plugins\": [\n {\n \"type\": \"mqtt\", // Definition for the MQTT Connection\n \"config\": {\n \"broker\": \"192.168.0.123\", // Broker hostname or IP address\n \"username\": \"testuser\", // Broker username to login\n \"password\": \"testuser\" // Broker password to login\n }\n },\n {\n \"type\": \"mqtt_homeassistant\",\n \"config\": {}\n }\n ]\n }\n}\n```\nAfterwards you start CarConnectivity in your preferred way, e.g. using\n```bash\ncarconnectivity-mqtt carconnectivity.json\n```\n\nOnce the device is created in Home Assistant all Entities will display as \"Not Available\". The reason is that Home Assistant does not know the states yet. In order trigger a resend of all topics, restart CarConnectivity. This will make all entities available.\n\n## Updates\nIf you want to update, the easiest way is:\n```bash\npip3 install carconnectivity-plugin-mqtt_homeassistant --upgrade\n```\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": "CarConnectivity plugin for improving compatibiity with Home Assistant",
"version": "0.1.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f7c51cfaa87c0fb0a6143fbfeb740660f00fba6c74a42f7e39de16d262d7bdc5",
"md5": "0d7b00d0287e4b2ac1890c74ff0cb5b4",
"sha256": "863da3d4c0aa608c22451ea5970e0037a72caf1806e9ff4855885ef191549f4a"
},
"downloads": -1,
"filename": "carconnectivity_plugin_mqtt_homeassistant-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0d7b00d0287e4b2ac1890c74ff0cb5b4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 13638,
"upload_time": "2025-03-10T17:28:27",
"upload_time_iso_8601": "2025-03-10T17:28:27.880955Z",
"url": "https://files.pythonhosted.org/packages/f7/c5/1cfaa87c0fb0a6143fbfeb740660f00fba6c74a42f7e39de16d262d7bdc5/carconnectivity_plugin_mqtt_homeassistant-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9ae94d6b2db95dec99a50dcdca872dbcade3919ab8aaed06961d3581d28f7358",
"md5": "0d661411f5a3653229c25b20a256e8fb",
"sha256": "d26d5e559a104db85430ec99aa925fa1464a44be3189b0a1425af00c0a7de7dd"
},
"downloads": -1,
"filename": "carconnectivity_plugin_mqtt_homeassistant-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "0d661411f5a3653229c25b20a256e8fb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 1716836,
"upload_time": "2025-03-10T17:28:29",
"upload_time_iso_8601": "2025-03-10T17:28:29.478550Z",
"url": "https://files.pythonhosted.org/packages/9a/e9/4d6b2db95dec99a50dcdca872dbcade3919ab8aaed06961d3581d28f7358/carconnectivity_plugin_mqtt_homeassistant-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-10 17:28:29",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "carconnectivity-plugin-mqtt-homeassistant"
}
