0.1.2 • Published 4 years ago

homebridge-garagedoor-supla v0.1.2

Weekly downloads
9
License
MIT
Repository
github
Last release
4 years ago

homebridge-garagedoor-supla

mit license npm npm

Homebridge plugin to control a garage door using via SUpla service

Check state , open , close functions are supportes

Installation

  1. Install Homebridge: npm install -g homebridge
  2. Install this plugin: npm install -g homebridge-garagedoor-suppla
  3. Update your config file.

Configuration

Configuration sample:

"accessories": [
        {
            "name": "Garage Door",
            "serial": "SUPLA 000001",
            "host": "svr29.supla.org",
            "port": 443,
            "open_close": {
                "code": "<YOUR LINK COD>",
                "action": "<open-close(YOUR ACTION CODE)>",
                "path": "/direct/<YOUR ID>"
            },
            "close_state": {
                "code": "YOUR LINK CODE",
                "action": "<read(YOUR ACTION CODE)>",
                "path": "/direct/<YOUR ID>"
            },
            "open_state": {
                "code": "YOUR LINK CODE",
                "action": "<read(YOUR ACTION CODE)>",
                "path": "/direct/<YOUR ID>"
            },
            "status_update_delay": "15",
            "poll_state_delay": 2,
            "check_cmd_delay": 3,
            "accessory": "SuplaGarageDoorOpener"
        }
    ]
]

Info:

FieldDescription
accessoryMust always be "GarageCommand" (required)
nameName of the Garage Door (required)
open_close"open-close command. See below(required)
close_statecheck close state command. See below(required)
open_statecheck open state command. See below
status_update_delayTime to check door in opening/closing/stopped state (defaults to 15 seconds)
poll_state_delayTime for polling for the garage door's state (0 or empty - disables polling)
check_cmd_delayDelay for checking the state after command (default 3 sec) - this is to disable unnecessary notifications

How to get the commands:

curl -s -H "Content-Type: application/json" -H "Accept: application/json" -X PATCH -d '{"code":"YOUR LINK CODE","action":"read"}' https://svr29.supla.org/direct/5

The open, close, and state commands must return the following verbs: OPEN, CLOSED, OPENING, CLOSING, STOPPED.

FAQ

Can I have multiple garage doors?

Yes! but this is a feature of homebridge, not the plugin. Add another accessory block with a different name than your other garage door.
If using homebridge-config-ui-x you can do this in the plugin settings.

What is the STOPPED status?

STOPPED is a valid status for a door to be in. Home App dispolays this state as OPEN ( which technically is correct ). Most of the other apps show the correct state