README

homebridge-shelly-switch

homebridge-shelly-switch is a Homebridge plugin you can use to control your Shelly 1 in-wall switch. I've had it with only Shelly's CoAP not working reliably so I made a purely HTTP plugin. The configuration is a bit more cumbersome, but there's no magic, just HTTP calls in both ways.

Installation

npm -g install homebridge-shelly-switch

Configuration

An entry in config.json's "platforms" section is needed of the following basic form:

{
    "platform": "Shelly Switch",
    "devices": [
      {
        "name": "<e.g. Kitchen>",
        "ip": "<shelly's ip address>"
      }
    ]
}

Shelly Dimmer 2

To use with Shelly Dimmer 2 you will need to add deviceType:dimmer to the device configuration.

  {
    "name": "<e.g. Kitchen>",
    "deviceType": "dimmer",
    "ip": "<shelly's ip address>"
  }

If your shelly web interface is restricted with login and password, you need to add a authentication option with the value of <username>:<password> to device's config.

Example for when username and password are "admin" (not recommended!):

{
    "name": "<e.g. Kitchen>",
    "ip": "<shelly's ip address>",
    "authentication": "admin:admin"
}

Status notifications

Shellies have the ability to call action URLs in the event of switches changing their state. This frees the plugin from constantly polling the status of the switch, and instead will get pinged on the status update, which improves responsiveness of any HomeKit actions that could be performed, especially when using the physical switch or an automation. For example, if it's dark outside, after I turn on Kitchen light, kitchen counter lights turn on too.

If you want to set up the notifications, which is highly recommended, you need to add a notification_port option to the top plugin config dictionary with a specified HTTP port on which the plugin will listen.

Example:

{
    "platform": "Shelly Switch",
    "notification_port": 54220,
    ...
}

The action URLs you need to set up in Shelly configuration Actions section (for OUTPUT SWITCHED ON URL and OUTPUT SWITCHED OFF URL) shall be http://<homebridge-host-ip>:<notification_port>/status, e.g. http://192.168.0.1:54220/status.

Short and long press actions

If a device has a short- and long-pressable button, i.e. configured as either detached or momentary, a programmable button accessory will also appear for that switch, so you'll be able to set up custom actions in the Home app for them. They are expected to be triggered by Shelly launching http://<homebridge-host-ip>:<notification_port>/button/0/short and http://<homebridge-host-ip>:<notification_port>/button/0/long action URLs, configured in BUTTON SHORT PRESSED URL and BUTTON LONG PRESSED URL respectively.

Notes

Two and more relay switches are not yet supported. Will probably implement Shelly 2.5 in relay mode (as shutter mode is supported by my other plugin).

I'm also toying with an idea of setting up the action URLs in the switch settings automatically once status notifications are enabled.

Usage no npm install needed!