| Name | carconnectivity-plugin-homekit JSON |
| Version |
0.2.1
JSON |
| download |
| home_page | None |
| Summary | CarConnectivity plugin for integrating the cars data into the Apple Home ecosystem |
| upload_time | 2025-02-20 15:41:12 |
| 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 Homekit
[](https://github.com/tillsteinbach/CarConnectivity-plugin-homekit/)
[](https://github.com/tillsteinbach/CarConnectivity-plugin-homekit/releases/latest)
[](https://github.com/tillsteinbach/CarConnectivity-plugin-homekit/blob/master/LICENSE)
[](https://github.com/tillsteinbach/CarConnectivity-plugin-homekit/issues)
[](https://pypi.org/project/carconnectivity-plugin-homekit/)
[](https://pypi.org/project/carconnectivity-plugin-homekit/)
[](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 automatically integrate the data collected from your vehicle into Apple Home this plugin will help you.
<img src="https://raw.githubusercontent.com/tillsteinbach/CarConnectivity-plugin-homekit/main/screenshots/homekit.jpg" width="200"><img src="https://raw.githubusercontent.com/tillsteinbach/CarConnectivity-plugin-homekit/main/screenshots/homekit2.jpg" width="200"><img src="https://raw.githubusercontent.com/tillsteinbach/CarConnectivity-plugin-homekit/main/screenshots/homekit3.jpg" width="200"><img src="https://raw.githubusercontent.com/tillsteinbach/CarConnectivity-plugin-homekit/main/screenshots/homekit4.jpg" width="200">
### Install using PIP
If you want to use the CarConnectivity Plugin for Homekit, the easiest way is to obtain it from [PyPI](https://pypi.org/project/carconnectivity-plugin-homekit/). Just install it using:
```bash
pip3 install carconnectivity-plugin-homekit
```
after you installed CarConnectivity
## Configuration
In your carconnectivity.json configuration add a section for the homekit plugin like this. A documentation of all possible config options can be found [here](https://github.com/tillsteinbach/CarConnectivity-plugin-homekit/tree/main/doc/Config.md).
```
{
"carConnectivity": {
"connectors": [
...
]
"plugins": [
{
"type": "homekit",
"config": {}
}
]
}
}
```
## Adding to ios
After CarConnectivity is started the first time with the Homekit plugin enabled it will display a QR-Code and the pin-code in the console. Use the QR code or the pin to add the bridge to the Home app. Afterwards all accessories your car offers are added to the Home app.
## A note to Docker users
CarConnectivity with Homekit will need Host or Macvlan Mode for the container. This is necessary as the bridge mode will not forward multicast which is necessary for Homekit to work. Host mode is not working on macOS. The reson is that the network is still virtualized.
If you do not like to share the host network with CarConnectivity you can use macvlan mode. In macvlan mode CarConnectivity will appear as a seperate computer in the network.
### Example Docker Compose configuration
The following configuration uses host mode network
```
services:
carconnectivity:
image: "tillsteinbach/carconnectivity-mqtt:latest"
restart: unless-stopped
environment:
- TZ=Europe/Berlin
- LANG=de_DE
- LC_ALL=de_DE
- ADDITIONAL_INSTALLS=--pre carconnectivity-connector-skoda carconnectivity-plugin-homekit
network_mode: host
volumes:
- /home/myuser/docker-compose/smarthome/carconnectivity/carconnectivity.json:/carconnectivity.json
- carconnectivity_data:/root/.carconnectivity
volumes:
carconnectivity_data:
```
## Updates
If you want to update, the easiest way is:
```bash
pip3 install carconnectivity-plugin-homekit --upgrade
```
Raw data
{
"_id": null,
"home_page": null,
"name": "carconnectivity-plugin-homekit",
"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/1e/5c/7e9c06ae794736105c135fe4de174e1d60e44a2d91f5d91344c93ef437d5/carconnectivity_plugin_homekit-0.2.1.tar.gz",
"platform": null,
"description": "\n\n# CarConnectivity Plugin for Homekit\n[](https://github.com/tillsteinbach/CarConnectivity-plugin-homekit/)\n[](https://github.com/tillsteinbach/CarConnectivity-plugin-homekit/releases/latest)\n[](https://github.com/tillsteinbach/CarConnectivity-plugin-homekit/blob/master/LICENSE)\n[](https://github.com/tillsteinbach/CarConnectivity-plugin-homekit/issues)\n[](https://pypi.org/project/carconnectivity-plugin-homekit/)\n[](https://pypi.org/project/carconnectivity-plugin-homekit/)\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 automatically integrate the data collected from your vehicle into Apple Home this plugin will help you.\n\n<img src=\"https://raw.githubusercontent.com/tillsteinbach/CarConnectivity-plugin-homekit/main/screenshots/homekit.jpg\" width=\"200\"><img src=\"https://raw.githubusercontent.com/tillsteinbach/CarConnectivity-plugin-homekit/main/screenshots/homekit2.jpg\" width=\"200\"><img src=\"https://raw.githubusercontent.com/tillsteinbach/CarConnectivity-plugin-homekit/main/screenshots/homekit3.jpg\" width=\"200\"><img src=\"https://raw.githubusercontent.com/tillsteinbach/CarConnectivity-plugin-homekit/main/screenshots/homekit4.jpg\" width=\"200\">\n\n### Install using PIP\nIf you want to use the CarConnectivity Plugin for Homekit, the easiest way is to obtain it from [PyPI](https://pypi.org/project/carconnectivity-plugin-homekit/). Just install it using:\n```bash\npip3 install carconnectivity-plugin-homekit\n```\nafter you installed CarConnectivity\n\n## Configuration\nIn your carconnectivity.json configuration add a section for the homekit plugin like this. A documentation of all possible config options can be found [here](https://github.com/tillsteinbach/CarConnectivity-plugin-homekit/tree/main/doc/Config.md).\n```\n{\n \"carConnectivity\": {\n \"connectors\": [\n ...\n ]\n \"plugins\": [\n {\n \"type\": \"homekit\",\n \"config\": {}\n }\n ]\n }\n}\n```\n\n## Adding to ios\nAfter CarConnectivity is started the first time with the Homekit plugin enabled it will display a QR-Code and the pin-code in the console. Use the QR code or the pin to add the bridge to the Home app. Afterwards all accessories your car offers are added to the Home app.\n\n## A note to Docker users\nCarConnectivity with Homekit will need Host or Macvlan Mode for the container. This is necessary as the bridge mode will not forward multicast which is necessary for Homekit to work. Host mode is not working on macOS. The reson is that the network is still virtualized.\nIf you do not like to share the host network with CarConnectivity you can use macvlan mode. In macvlan mode CarConnectivity will appear as a seperate computer in the network.\n\n### Example Docker Compose configuration\nThe following configuration uses host mode network\n```\nservices:\n carconnectivity:\n image: \"tillsteinbach/carconnectivity-mqtt:latest\"\n restart: unless-stopped\n environment:\n - TZ=Europe/Berlin\n - LANG=de_DE\n - LC_ALL=de_DE\n - ADDITIONAL_INSTALLS=--pre carconnectivity-connector-skoda carconnectivity-plugin-homekit\n network_mode: host\n volumes:\n - /home/myuser/docker-compose/smarthome/carconnectivity/carconnectivity.json:/carconnectivity.json\n - carconnectivity_data:/root/.carconnectivity\nvolumes:\n carconnectivity_data:\n```\n## Updates\nIf you want to update, the easiest way is:\n```bash\npip3 install carconnectivity-plugin-homekit --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 integrating the cars data into the Apple Home ecosystem",
"version": "0.2.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d6901c21fdb54810249d36dcc82193df3a5bc920ac07df0b6d2efa23c18473df",
"md5": "d50e01f0bf1303f8d2af24b4613ad1ce",
"sha256": "b6e829be500e065e7982d88a374801cd40f30eb16cacd8b1f6b726f608193636"
},
"downloads": -1,
"filename": "carconnectivity_plugin_homekit-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d50e01f0bf1303f8d2af24b4613ad1ce",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 31923,
"upload_time": "2025-02-20T15:41:10",
"upload_time_iso_8601": "2025-02-20T15:41:10.832502Z",
"url": "https://files.pythonhosted.org/packages/d6/90/1c21fdb54810249d36dcc82193df3a5bc920ac07df0b6d2efa23c18473df/carconnectivity_plugin_homekit-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1e5c7e9c06ae794736105c135fe4de174e1d60e44a2d91f5d91344c93ef437d5",
"md5": "1a70962f56accc605711d5be132c5338",
"sha256": "1f5474f6f3358f9af26c1bd064f86650987cbfafc1af5dde4e797982aca41cc1"
},
"downloads": -1,
"filename": "carconnectivity_plugin_homekit-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "1a70962f56accc605711d5be132c5338",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 1038502,
"upload_time": "2025-02-20T15:41:12",
"upload_time_iso_8601": "2025-02-20T15:41:12.611932Z",
"url": "https://files.pythonhosted.org/packages/1e/5c/7e9c06ae794736105c135fe4de174e1d60e44a2d91f5d91344c93ef437d5/carconnectivity_plugin_homekit-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-20 15:41:12",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "carconnectivity-plugin-homekit"
}
