noe/homebridge-smarthomeng
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added garage door description

Browse Source
This commit is contained in:
Chester 2022-03-07 17:11:36 +01:00 committed by GitHub
parent 77df0609ca
commit 6b46c9cdb8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -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 | \<item> | Yes | | SHNG item to monitor the current door state |
| TargetDoorState | \<item> | Yes | | SHNG item to monitor and set the target position |
| ObstructionDetected | \<item> | 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.