Skip to content

Latest commit

 

History

History
57 lines (36 loc) · 1.98 KB

README.md

File metadata and controls

57 lines (36 loc) · 1.98 KB
Raw

homebridge-esphome-garagedoor

A simple HomeBridge plugin to make your garage door smart using a Shelly 1 and ESPHome. Based on this project.

Setup

You need a Shelly 1 and ESPHome environment to get started. Please follow the blog post linked above to get a working firmware for your Shelly. Once you are able to open and close your garage through the ESPHome WEB UI, you can install this plugin.

Add this configuration to your homebrige config.json file:

{
  "accessories": [
    {
      "name": "homebridge-esphome-garagedoor",
      "accessory": "GarageDoor",
      "host": "garagedoor.local",
      "port": 80
    }
  ]
}

Restart homebridge and enjoy the new garage door opener in HomeKit.

Limitations

The plugin is not able to expose OPENING or CLOSING statue to HomeKit, since we would need two contact sensors for that, but Shelly 1 only has one. It would be possible to use GPIO3, but ESPHome doesn't map it.

Build from sources

To build and run the plugin from sources, you need to install yarn first.

Clone the repo:

git clone git@github.com:madchicken/homebridge-esphome-garagedoor.git

Once you get it, run yarn command:

cd homebridge-esphome-garagedoor
yarn && yarn build

You should end up with a new dist/ folder containing the compiled version of the plugin.

License

Licensed under Apache 2.0

Contribute

Any PR is welcome to this project, so please, fork and open one if you can!

If otherwise, you simply enjoyed using this plugin, and you want to contribute in some way, you can always donate something!

Donate