https://github.com/mongoose-os-apps/shelly-homekit
Apple HomeKit firmware for Shelly's
https://github.com/mongoose-os-apps/shelly-homekit
firmware homekit shelly smarthome
Last synced: 5 months ago
JSON representation
Apple HomeKit firmware for Shelly's
- Host: GitHub
- URL: https://github.com/mongoose-os-apps/shelly-homekit
- Owner: mongoose-os-apps
- License: other
- Created: 2020-02-04T17:20:49.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-29T18:35:23.000Z (6 months ago)
- Last Synced: 2025-04-29T19:42:49.712Z (6 months ago)
- Topics: firmware, homekit, shelly, smarthome
- Language: C++
- Homepage:
- Size: 3.36 MB
- Stars: 1,950
- Watchers: 105
- Forks: 135
- Open Issues: 39
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS.md
Awesome Lists containing this project
- StarryDivineSky - mongoose-os-apps/shelly-homekit - HomeKit是一个专为Shelly系列设备开发的Apple HomeKit固件项目，能够将支持的Shelly硬件设备（如Shelly1、Shelly2、Shelly3、Shelly Plug等）接入Apple Home应用，实现通过iPhone或iPad进行智能控制。该项目基于Mongoose OS框架构建，通过将HomeKit协议集成到Shelly设备中，使其能够与Apple HomeKit生态系统无缝对接，支持开关控制、传感器数据读取及自动化场景联动功能。用户可通过固件刷写工具将HomeKit功能部署到兼容的Shelly设备上，设备将通过Wi-Fi或蓝牙与Apple设备建立连接，并在Home应用中以虚拟设备形式呈现，支持语音控制（如Siri指令）和自动化规则设置。项目特别优化了与Apple HomeKit的兼容性，支持多设备同步、状态实时反馈及低功耗模式，同时提供详细的安装指南和故障排查文档。需要注意的是，此固件仅适用于部分Shelly设备型号，且需确保设备固件版本符合要求。项目通过开源代码实现功能扩展，开发者可基于Mongoose OS框架进一步定制设备行为，例如添加新的传感器支持或调整通信协议参数。整体方案无需额外硬件，仅需通过软件更新即可实现HomeKit功能，适合智能家居爱好者和开发者快速构建兼容Apple生态的物联网设备。 (硬件_其他 / 资源传输下载)
README
[](https://opensource.org/licenses/Apache-2.0)
[](https://gitter.im/shelly-homekit/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
# Open Source Apple HomeKit Firmware for Shelly Devices
This firmware exposes Shelly devices as Apple HomeKit accessories.
Firmware is compatible with stock and can be uploaded via OTA (Watch a 2 minute [video](https://www.youtube.com/watch?v=BZc-kp4dDRw)), for more info take a look at the flashing wiki [here](https://github.com/mongoose-os-apps/shelly-homekit/wiki/Flashing#updating-from-stock-firmware).
Reverting to stock firmware is also possible [see here](https://github.com/mongoose-os-apps/shelly-homekit/wiki/Flashing#reverting-to-stock-firmware).
## Supported devices and features
### Gen 3 Devices
| |[1 G3] |[1PM G3] |[2PM G3] |[I4 G3] |[Mini1 G3]|[Mini1PM G3]|[PlugS G3]
|- |- |- |- |- |- |- |-
|Switch & Co.1 |✓ |✓ |✓ |✗ |✓ |✓ |✓
|Stateless Input2 |✓ |✓ |✓ |✓ |✓ |✓ |✗
|Sensors3 |✓ |✓ |✓ |✓ |✓ |✓ |✗
|Garage door opener |✓ |✓ |✓ |✗ |✓ |✓ |✗
|Roller shutter mode |✗ |✗ |✓ |✗ |✗ |✗ |✗
|Power measurement |✗ |✓ |✓ |✗ |✗ |✓ |✓
|Temperature/Humidity measurement4|✓ |✓ |✓ |✓ |✗ |✗ |✗
### Plus devices
| |[+1]|[+1Mini]|[+1PMMini]|[+1PM]|[+2PM]|+i4 [AC]/[DC]|[+Plug S]|[+Uni]
|- |- |- |- |- |- |- |- |-
|Switch & Co.1 |✓ |✓ |✓ |✓ |✓ |✗ |✓ |✓
|Stateless Input2 |✓ |✓ |✓ |✓ |✓ |✓ |✗ |✓
|Sensors3 |✓ |✓ |✓ |✓ |✓ |✓ |✗ |✓
|Garage door opener |✓ |✓ |✓ |✓ |✓ |✗ |✗ |✓
|Roller shutter mode |✗ |✗ |✗ |✗ |✓ |✗ |✗ |✗
|Power measurement |✗ |✗ |- |✓ |✓ |✗ |✓ |✗
|Temperature/Humidity measurement4|✓ |✗ |✗ |✓ |✓ |✓ |✗ |✓
### Light Controllers
| |[+RGBWPM]|
|-|-|
|Brightness control |✓|
|CCT |✓|
|RGB(W) |✓|
|Switch & Co 1 |✓|
|Power measurement |-|
### Pro devices
Currently not supported.
### Gen 1 switches
||[1]|1PM|[1L]|[Plug]|[PlugS]|2|2.5|i3|[UNI]|
|-|-|-|-|-|-|-|-|-|-|
|Switch & Co.1|✓|✓|✓|✓|✓|✓|✓|✗|✓|
|Stateless Input2|✓|✓|✓|✗|✗|✓|✓|✓|✓|
|Sensors3|✓|✓|✓|✗|✗|✓|✓|✓|✓|
|Temperature/Humidity measurement|✓4|✓4|✗|✗|✗|✗|✗|✗|✓|
|Garage door opener|✓|✓|✗|✗|✗|✓|✓|✗|✓|
|Roller shutter mode|✗|✗|✗|✗|✗|✗|✓|✗|✗|
|Power measurement|✗|✓|-|✓|✓|✗|✓|✗|✗|
### Gen 1 light bulbs / led strips
||[Duo]|[Duo RGBW]|[Vintage]|[RGBW2]|
|-|-|-|-|-|
|Brightness control|✓|✓|✓|✓|
|CCT|✓|✗|✗|✓|
|RGB(W)|✗|✓|✗|✓|
|Power measurement|-|-|-|-|
_Notes:_
_✓: supported_
_-: possible but not supported yet_
_✗: not possible_
_1: includes lock, outlet and valve_
_2: includes doorbell_
_3: includes motion, occupancy, contact, smoke, leak_
_4: with [Sensor AddOn/Shelly Plus AddOn](https://shop.shelly.cloud/temperature-sensor-addon-for-shelly-1-1pm-wifi-smart-home-automation#312)_ and DS18B20 sensor(s) (maximum 5 for Shelly Plus Addon, maximum 3 for Sensor AddOn) or 1 DHT sensor
Features that are not yet supported:
* Cloud connections: no Shelly Cloud, no MQTT
* Remote actions (web hooks)
* Valve with timer support
## Quick Start
### Updating from stock firmware
* **Important:** Please update to the latest stock firmware prior to converting to Shelly-HomeKit (1.5.1 or later on Plus/Gen3 Devices).
* Watch a 2 minute [video](https://www.youtube.com/watch?v=BZc-kp4dDRw).
* *New:* One link for all device types: `http://A.B.C.D/ota?url=http://shelly.rojer.cloud/update`
If that doesn't work (did you remember to have the stock firmware at the correct version), try the link for a specific model
* Gen 1 Devices:
* Shelly 1: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-Shelly1.zip`
* Shelly 1L: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-Shelly1L.zip`
* Shelly 1PM: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-Shelly1PM.zip`
* Shelly 2: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-Shelly2.zip`
_Note: Not for Shelly Dimmer 2!_
* Shelly 2.5: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-Shelly25.zip`
* Shelly Duo: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-ShellyDuo.zip`
* Shelly Duo RGBW (ColorBulb): `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-ShellyColorBulb.zip`
* Shelly i3: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-ShellyI3.zip`
* Shelly Plug: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-ShellyPlug.zip`
* Shelly Plug S: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-ShellyPlugS.zip`
* Shelly RGBW2: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-ShellyRGBW2.zip`
_Note: The Shelly must be in color mode to flash, flashing in white mode is not supported!_
* Shelly UNI: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-ShellyUNI.zip`
* Shelly Vintage: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-ShellyVintage.zip`
* Gen 2 Devices
* Shelly Plus 1: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-ShellyPlus1.zip`
* Shelly Plus 1 Mini: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-ShellyPlus1Mini.zip`
* Shelly Plus 1PM: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-ShellyPlus1PM.zip`
* Shelly Plus 1PM Mini: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-ShellyPlus1PMMini.zip`
* Shelly Plus 2PM: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-ShellyPlus2PM.zip`
* Shelly Plus Plug S: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-ShellyPlusPlugS.zip`
* Shelly Plus RGBWPM: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-ShellyPlusRGBWPM.zip`
* Shelly Plus I4 AC & DC: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-ShellyPlusI4.zip`
* Shelly Plus UNI: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-ShellyPlusUni.zip`
* Gen 3 Devices
* Shelly 1 Gen3: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-Shelly1Gen3.zip`
* Shelly 1PM Gen3: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-Shelly1PMGen3.zip`
* Shelly 2PM Gen3: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-Shelly2PMGen3.zip`
* Shelly I4 Gen3: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-ShellyI4Gen3.zip`
* Shelly Mini 1 Gen3: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-ShellyMini1Gen3.zip`
* Shelly Mini 1 PM Gen3: `http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-ShellyMini1PMGen3.zip`
* See [here](https://github.com/mongoose-os-apps/shelly-homekit/wiki/Flashing#updating-from-stock-firmware) for detailed instructions.
* Script [here](https://github.com/mongoose-os-apps/shelly-homekit/wiki/Flashing#Script) for an automated way to update your devices.
* ./flash_shelly.py hostname (for single device)
* ./flash_shelly.py -a (for all devices on the network)
## Documentation
See our [Wiki](https://github.com/mongoose-os-apps/shelly-homekit/wiki).
## Getting Support
If you'd like to report a bug or a missing feature, please use [GitHub issue tracker](https://github.com/mongoose-os-apps/shelly-homekit/issues).
Some of us can be found in the [Gitter chat room](https://gitter.im/shelly-homekit/community).
## Contributions and Development
Code contributions are welcome! Check out [open issues](https://github.com/mongoose-os-apps/shelly-homekit/issues) and feel free to pick one up.
See [here](https://github.com/mongoose-os-apps/shelly-homekit/wiki/Development) for development environment setup.
## Authors
See [here](AUTHORS.md).
## Support
If you like to show support for the project and support further development, consider a Donation to the current maintainer markib via [Paypal](https://www.paypal.com/donate/?hosted_button_id=RVFA9G5VMXRX8)
## License
This firmware is free software and is distributed under [Apache 2.0 license](LICENSE).
[1]: https://www.shelly.cloud/en/products/shop/1xs1
[+1]: https://www.shelly.cloud/en/products/shop/shelly-plus-1
[+1Mini]: https://www.shelly.cloud/en/products/shop/shelly-plus-1-mini
[+1PMMini]: https://www.shelly.cloud/en/products/shop/shelly-plus-1pm-mini
[+Uni]: https://www.shelly.cloud/en/products/shop/shelly-plus-uni
[Mini1 G3]: https://www.shelly.cloud/en/products/shop/shelly-1-mini-gen-3
[Mini1PM G3]: https://www.shelly.cloud/en/products/shop/shelly-1-pm-mini-gen3
[2PM G3]: https://www.shelly.cloud/en/products/shop/shelly-2pm-gen3
[1PM G3]: https://www.shelly.cloud/en/products/shop/shelly-1pm-gen3
[1 G3]: https://www.shelly.cloud/en/products/shop/shelly-1-gen3
[I4 G3]: https://www.shelly.cloud/en/products/shop/shelly-i4-gen3
[PlugS G3]: https://www.shelly.com/products/shelly-plug-s-gen3
[+1PM]: https://www.shelly.cloud/en/products/shop/shelly-plus-1-pm-2-pack/shelly-plus-1-pm
[+2PM]: https://www.shelly.cloud/en/products/shop/shelly-plus-2-pm
[+RGBWPM]: https://www.shelly.cloud/en/products/shop/shelly-plus-rgbw-pm
[+Plug S]: https://www.shelly.cloud/en/products/shop/shelly-plus-plug-s
[1L]: https://www.shelly.cloud/en/products/shop/shelly-1l
[Plug]: https://www.shelly.cloud/en/products/shop/1xplug
[PlugS]: https://www.shelly.cloud/en/products/shop/shelly-plug-s
[AC]: https://www.shelly.cloud/en-de/products/product-overview/splusi4x1
[DC]: https://www.shelly.cloud/en-de/products/product-overview/shelly-plus-i4-dc
[UNI]: https://www.shelly.cloud/en/products/shop/shelly-uni-1
[RGBW2]: https://www.shelly.cloud/en/products/shop/shelly-rgbw2-1
[Duo RGBW]: https://www.shelly.cloud/en/search?query=%22Shelly+Duo+-+RGBW%22
[Duo]: https://www.shelly.cloud/en/search?query=%22Shelly+Duo%22
[Vintage]: https://www.shelly.cloud/en/search?query=vintage