{"id":28087388,"url":"https://github.com/0x2321/deconz-homekit","last_synced_at":"2025-05-13T11:32:02.647Z","repository":{"id":292915701,"uuid":"978825094","full_name":"0x2321/deconz-homekit","owner":"0x2321","description":"A HomeKit bridge for deCONZ/Phoscon that allows you to control your Zigbee devices through Apple HomeKit.","archived":false,"fork":false,"pushed_at":"2025-05-12T19:50:41.000Z","size":83,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-12T20:28:24.455Z","etag":null,"topics":["deconz","deconz-rest-plugin","phoscon"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/0x2321.png","metadata":{"files":{"readme":"README.en.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-06T15:05:49.000Z","updated_at":"2025-05-12T19:50:45.000Z","dependencies_parsed_at":"2025-05-12T20:28:28.864Z","dependency_job_id":"86907f08-9b6e-41df-a590-6ccd3e47218e","html_url":"https://github.com/0x2321/deconz-homekit","commit_stats":null,"previous_names":["0x2321/deconz-homekit"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0x2321%2Fdeconz-homekit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0x2321%2Fdeconz-homekit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0x2321%2Fdeconz-homekit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0x2321%2Fdeconz-homekit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/0x2321","download_url":"https://codeload.github.com/0x2321/deconz-homekit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253932984,"owners_count":21986489,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["deconz","deconz-rest-plugin","phoscon"],"created_at":"2025-05-13T11:31:52.007Z","updated_at":"2025-05-13T11:32:02.612Z","avatar_url":"https://github.com/0x2321.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# deCONZ HomeKit Bridge\n\nA HomeKit bridge for deCONZ/Phoscon that allows you to control your Zigbee devices through Apple HomeKit.\n\n## Description\n\nThis project creates a bridge between deCONZ (a Zigbee gateway) and Apple HomeKit, allowing you to control your Zigbee devices using Apple's Home app, Siri, and other HomeKit-compatible applications. It supports a wide range of Zigbee devices including lights, sensors, and buttons.\n\n## Requirements\n\n* A running deCONZ/Phoscon gateway\n* Docker (for containerized deployment)\n\n## Installation\n\nThis application is designed to be installed and run via Docker only.\n\n### Using Docker\n\n1. Pull the Docker image:\n\n   ```bash\n   docker pull ghcr.io/0x2321/deconz-homekit:main\n   ```\n\n2. Run the container:\n\n   ```bash\n   docker run -d -e DECONZ_IP=\u003cyour-deconz-ip\u003e -e DECONZ_PORT=80 -v ./data:/data ghcr.io/0x2321/deconz-homekit:main\n   ```\n\n### Using Docker Compose\n\nCreate a `docker-compose.yaml` file with the following content:\n\n```yaml\nservices:\n  deconz-homekit:\n    image: ghcr.io/0x2321/deconz-homekit:main\n    container_name: deconz-homekit\n    restart: unless-stopped\n    environment:\n      - DECONZ_IP=\u003cyour-deconz-ip\u003e\n      - DECONZ_PORT=80\n    volumes:\n      - ./data:/data\n    network_mode: host\n```\n\nThen start the container with:\n\n```bash\ndocker-compose up -d\n```\n\n\u003e **Note:** The `./data` volume mount is used to persist the database file which stores the configuration and HomeKit pairing information. Make sure this directory exists and is writable.\n\n## Configuration\n\nThe application requires the following environment variables:\n\n* `DECONZ_IP`: The IP address of your deCONZ gateway\n* `DECONZ_PORT`: The port of your deCONZ gateway (default 80)\n\nOn first run, the application will attempt to obtain an API key from your deCONZ gateway. You'll need to press the \"Link\" button on your deCONZ gateway when prompted.\n\n## Usage\n\n1. Start the application using one of the installation methods above.\n2. The application will generate a HomeKit pairing code, which will be displayed in the logs.\n3. Open the Home app on your iOS device, tap \"Add Accessory\", and enter the pairing code.\n4. Once paired, your Zigbee devices will appear in the Home app and can be controlled through HomeKit.\n\n## Device Support\n\nThis bridge creates a seamless connection between your deCONZ/Phoscon Zigbee devices and Apple HomeKit. It translates the capabilities of your Zigbee devices into HomeKit accessories, allowing you to control them through the Apple Home app, Siri voice commands, and HomeKit automations.\n\n### Implementation Status\n\nThe tables below provide a comprehensive overview of all device types that can potentially be supported by this bridge. Each entry includes:\n\n- **Description**: A user-friendly explanation of the device type and its functionality\n- **deCONZ Type**: The internal identifier used by deCONZ to classify the device\n- **Implemented**: Current implementation status (✓ = fully implemented, ❌ = not yet implemented)\n\nDevices marked as implemented (✓) are fully functional in HomeKit and can be controlled through the Apple Home app. Devices not yet implemented (❌) are recognized by deCONZ but not currently exposed to HomeKit by this bridge.\n\nIf you have a specific device that's not yet implemented, consider contributing to the project or opening an issue on GitHub.\n\n### Sensors\n\nThe following table lists all **device sensor** classes:\n\n| Description              | deCONZ Type       | Implemented |\n|:-------------------------|:------------------|:-----------:|\n| Air Quality Sensor       | ZHAAirQuality     |      ❌      |\n| Alarm Sensor             | ZHAAlarm          |      ❌      |\n| Carbon Monoxide Sensor   | ZHACarbonMonoxide |      ❌      |\n| Consumption Meter        | ZHAConsumption    |      ❌      |\n| Fire Sensor              | ZHAFire           |      ❌      |\n| Humidity Sensor          | ZHAHumidity       |      ❌      |\n| Light Level Sensor       | ZHALightLevel     |      ❌      |\n| Open/Close Sensor        | ZHAOpenClose      |      ✓      |\n| Power Sensor             | ZHAPower          |      ❌      |\n| Presence (Motion) Sensor | ZHAPresence       |      ✓      |\n| Switch                   | ZHASwitch         |      ✓      |\n| Pressure Sensor          | ZHAPressure       |      ❌      |\n| Temperature Sensor       | ZHATemperature    |      ❌      |\n| Time Sensor              | ZHATime           |      ❌      |\n| Thermostat               | ZHAThermostat     |      ❌      |\n| Vibration Sensor         | ZHAVibration      |      ❌      |\n| Water Leak Sensor        | ZHAWater          |      ✓      |\n\n### Lights\n\nThe following table lists all **light** classes:\n\n| Description                                        | deCONZ Type              | Implemented |\n|:---------------------------------------------------|:-------------------------|:-----------:|\n| Basic light that can only be turned on or off      | On/Off Light             |      ✓      |\n| Light with brightness control                      | Dimmable Light           |      ✓      |\n| Light with adjustable white color temperature      | Color Temperature Light  |      ✓      |\n| Light with RGB color control                       | Color Light              |      ❌      |\n| Light with RGB and white color temperature control | Extended Color Light     |      ❌      |\n| Smart plug that can be turned on or off            | On/Off Plug-in Unit      |      ✓      |\n| Smart plug with power/brightness control           | Dimmable Plug-in Unit    |      ✓      |\n\n## Development\n\nFor development, you can use the watch mode to automatically rebuild and run the application when changes are detected:\n\n```bash\nmake watch\n```\n\n## License\n\nMIT License\n\nCopyright (c) 2025 Bastian Dietrich\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n## Acknowledgements\n\n* [brutella/hap](https://github.com/brutella/hap) - HomeKit Accessory Protocol implementation in Go\n* [deCONZ REST API](https://github.com/dresden-elektronik/deconz-rest-plugin) - The REST API for deCONZ\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0x2321%2Fdeconz-homekit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F0x2321%2Fdeconz-homekit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0x2321%2Fdeconz-homekit/lists"}