diff --git a/README.md b/README.md index 2917cbd..d7f9994 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,7 @@ This plugin currently supports the following services (and characteristics): | [TemperatureSensor](#temperature-sensor) | Temperature sensor | | [Thermostat](#thermostat) | Thermostat with temperature sensor and heating state | | [WindowCovering](#window-covering) | Window covering (shutters, blinds, ...) | +| [GarageDoor](#garage-door) | Garage door opener | Other accessories are being worked on and will be added as soon as ready. @@ -399,6 +400,32 @@ The above optional parameters allow you to specify the neede range for your devi } ``` +### Garage Door +This accessory type can be used for opening/closing garage doors or any automatic gates. + +#### Characteristics in addition to [common characteristics](#common-accessories-characteristics) +| Parameter | Possible values | Mandatory | Default | Description | +|:---------------------------|:----------------|:----------|:--------|:------------------------------------------------------------------| +| CurrentDoorState | \ | Yes | | SHNG item to monitor the current door state | +| TargetDoorState | \ | Yes | | SHNG item to monitor and set the target position | +| ObstructionDetected | \ | No | | SHNG item to monitor if the door is blocked | + +#### Additional comments + +CurrentDoorState can be OPEN, CLOSED, OPENING, CLOSING and STOPPED. TargetDoorState can be OPEN or CLOSED. +ObstructionDetected can be set to true if there is a physical problem opening/closing the door. + +#### Example +```json +{ + "type": "GarageDoor", + "name": "GarageRechts", + "currentdoorstate": "garage.rechts.cds", + "targetdoorstate": "garage.rechts.tds", + "obstructiondetected": "garage.rechts.od" +} +``` + ### Example configuration file This is an example config file which just uses this plugin and some example SmartHomeNG items.