homebridge-simple-shelly
v0.0.2
Published
Minimal Homebridge Plugin for Shelly Devices
Downloads
17
Readme
homebridge-simple-shelly Plugin
homebridge-simple-shelly
is a Homebridge plugin with which you can switch ON/OFF the Shelly-device via Apple HomeKit.
The plugin is based on the common REST-API of the Shelly-device: Rest-API-Documentation
Installation
First of all you need to have Homebridge installed. Refer to the according README.md of this repository for instructions.
Then run the following command to install homebridge-simple-shelly
:
sudo npm install -g homebridge-simple-shelly
Configuration
| Parameter | Description | Required |
| -----------------------| ----------------------------------------------------------------------------------- |:--------:|
| name
| name of the accessory (also taken to call in "Siri") | ✓ |
| url
| url of the shelly device | ✓ |
| channel
| default 0
(Shelly2 as two channels, 0
or 1
) | |
| username
| if authentication is enabled on the Shelly, provide an username default admin
| |
| password
| if authentication is enabled on the Shelly, provide a password | |
Example of configuration:
{
"accessories": [
{
"accessory": "SimpleShelly",
"name": "Shelly Lamp",
"url": "http://192.168.1.1",
"channel": 0
}
]
}