Skip to content

Latest commit

 

History

History
72 lines (40 loc) · 3.82 KB

README.md

File metadata and controls

72 lines (40 loc) · 3.82 KB

License Gitter

Apple HomeKit firmware for Shelly switches

This firmware exposes Shelly 1, Shelly 1PM, Shelly Plug, Shelly Plug S, Shelly 2 and Shelly 2.5 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.

At the moment only the following functionality is supported:

  • Switch functionality: all relevant models, with auto-off and separate input tile as an option. Configurable as Switch, Outlet or Lock.
  • Power measurement: Shelly 2.5
  • Roller-shutter mode: Shelly 2.5
  • Garage Door Opener: Shelly 1, Shelly 1PM, Shelly 2, Shelly 2.5

Reverting to stock firmware is also supported see here.

Note: Only HomeKit is supported, no Shelly Cloud, MQTT or web hooks for now.

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 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 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:

Donate via PayPal

Authors

See here.

License

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