jorgefrazaocosta / shelly-homekit

Apple HomeKit firmware for Shelly switches

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), for more info take a look at the flashing wiki here.

Reverting to stock firmware is also possible see here.

Summary of supported devices and features:

• Shelly 1, Shelly 1PM
  • Switch/lock/outlet
  • Stateless input
  • Garage door opener mode
• Shelly 1L
  • Switch/lock/outlet
  • Stateless input
• Shelly Plug, Shelly Plug S
  • Switch/lock/outlet
• Shelly 2
  • Switch/lock/outlet
  • Stateless input
  • Garage door opener mode
• Shelly 2.5
  • Switch/lock/outlet
  • Stateless input
  • Garage door opener mode
  • Roller shutter mode
  • Power measurement
• Shelly i3
  • Stateless input

Features that are not yet supported:

• Shelly 1L, 1PM, 2, Plug, Plug S: power measurement
• Cloud connections: no Shelly Cloud, no MQTT
• Remote actions (web hooks)

Quick Start

Updating from stock firmware

• Important: Please update to the latest stock firmware prior to converting to Shelly-HomeKit.

• Watch a 2 minute video.

  • 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

  • Shelly 2.5: http://A.B.C.D/ota?url=http://rojer.me/files/shelly/shelly-homekit-Shelly25.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

• See here for detailed instructions.

• Script here 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 Wiki.

Getting Support

If you'd like to report a bug or a missing feature, please use GitHub issue tracker.

Some of us can be found in the Gitter chat room.

Contributions and Development

Code contributions are welcome! Check out open issues and feel free to pick one up.

See here for development environment setup.

Alternatively, you can support the project by donating:

Authors

See here.

License

This firmware is free software and is distributed under Apache 2.0 license.