homebridge-http-lock-ultimate v1.0.1

homebridge-http-lock-ultimate

Description

This homebridge plugin exposes a web-based locking device to Apple's HomeKit. Using simple HTTP requests with post, body and header support, the plugin allows you to lock/unlock the device, i.e. Shelly 1 devices.

Installation

1. Install homebridge
2. Install this plugin: npm install -g homebridge-http-lock-ultimate
3. Update your config.json file

Configuration examples

Configuration example for a Shelly 1 device controlled via Get Requests in local network. Resets it's state to locked automatically after 5 Seconds

"accessories": [
     {
      "accessory": "HTTPLockUltimate",
      "name": "Front Door",
      "resetLock": "true",
      "resetLockTime": "5",
      "http_method": "GET",
      "openURL": "http://192.168.X.XX/relay/0?turn=on",
      "closeURL": "http://192.168.X.XX/relay/0?turn=off"
      }
]

This is a configuration example for a Shelly 1 device controlled via Post Requests to Shelly Cloud. Get's locked automatically after 5 Seconds.

"accessories": [
     {
      "accessory": "HTTPLockUltimate",
      "name": "Front Door",
      "autoLock": "true",
      "autoLockDelay": "5",
      "http_method": "POST",
      "openURL": "https:/your.server.address/device/relay/control/",
      "openHeader": {
          "Content-Type": "application/x-www-form-urlencoded"
      },
      "openBody": "turn=on&channel=0&id=XXXXXXX&auth_key=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
      "closeURL": "https://your.server.address/device/relay/control/",
      "closeHeader": {
          "Content-Type": "application/x-www-form-urlencoded"
      },
      "closeBody": "turn=off&channel=0&id=XXXXXXX&auth_key=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
      }
]

Core

Optional fields

Additional options