elyeu-shelly-ng5 v1.6.1

homebridge-shelly-ng

Homebridge plugin for Shelly, enabling HomeKit support for the next generation of Shelly devices.

For the first generation, see homebridge-shelly.

Supported devices

• Shelly Plus 1
• Shelly Plus 1 PM
• Shelly Plus 2 PM
• Shelly Plus I4
• Shelly Plus I4 DC
• Shelly Plus Plug US
• Shelly Pro 1
• Shelly Pro 1 PM
• Shelly Pro 2
• Shelly Pro 2 PM
• Shelly Pro 3
• Shelly Pro 4 PM

Installation

Either install this plugin through Homebridge Config UI X or manually by following these instructions:

1. Install Homebridge by following the instructions.
2. Install this plugin by running npm install -g homebridge-shelly-ng.
3. Add this plugin to the Homebridge config.json:

   "platforms": [
     {
       "platform": "ShellyNG",
       "name": "Shelly NG"
     }
   ]

By default, devices will be discovered on your local network using mDNS and WebSockets will then be used to communicate with them.

Configuration

The following configuration options are available. Note that they are all optional.

{
  "devices": [
    {
      "id": "e.g. shellyplus1-abcdef123456",
      "name": "My Device",
      "exclude": false,
      "hostname": "e.g. 192.168.1.200",
      "password": "pa$$word",
      "switch:0": {
        "exclude": false,
        "type": "switch"
      },
      "switch:1": {
        "exclude": false,
        "type": "outlet"
      },
      "switch:2": {
        "exclude": false,
        "type": "switch"
      },
      "switch:3": {
        "exclude": false,
        "type": "switch"
      },
      "cover:0": {
        "exclude": false,
        "type": "windowCovering"
      }
    }
  ],
  "mdns": {
    "enable": true,
    "interface": "e.g. eth0 or 192.168.1.100"
  },
  "websocket": {
    "requestTimeout": 10,
    "pingInterval": 60,
    "reconnectInterval": [ 5, 10, 30, 60, 300, 600 ]
  }
}

See below for descriptions of each configuration option.