From 6f373379aedff159dc9dbd0003fe1cc959e5580c Mon Sep 17 00:00:00 2001 From: Chester Date: Mon, 7 Mar 2022 21:12:55 +0100 Subject: [PATCH 1/2] Adding humidity sensor --- README.md | 83 +++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 56 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index d7f9994..dab610d 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,8 @@ This plugin currently supports the following services (and characteristics): | [ContactSensor](#contact-sensor) | Simple contact sensor, for example for windows | | [Doorbell](#doorbell) | Doorbell, sends message to devices on ring | | [Fan](#fan) | Simple on/off fan, may be extended in future | +| [GarageDoor](#garage-door) | Garage door opener | +| [HumiditySensor](#humidity-sensor) | Humidity sensor | | [Lightbulb](#lightbulb) | Everything, from simple light to dimmable, RGB and RGBW | | [MotionSensor](#motion-sensor) | Detects and reports motion | | [OccupancySensor](#occupancy-sensor) | Detects presence in a room | @@ -28,7 +30,6 @@ 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. @@ -156,6 +157,60 @@ For now this accessory only supports turning the fan on and off. Further improve } ``` +### Garage Door +This accessory is used for opening/closing garage doors or any other automatic gate. + +#### 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 + +Valid values for 'CurrentDoorState': +* OPEN = 0 +* CLOSED = 1 +* OPENING = 2 +* CLOSING = 3 +* STOPPED = 4 + +Valid values for 'TargetDoorState': +* OPEN = 0 +* CLOSED = 1 + +'ObstructionDetected' may be set 'true' if there is any physical problem opening/closing the door. + +#### Example +```json +{ + "type": "GarageDoor", + "name": "GarageRechts", + "currentdoorstate": "garage.rechts.cds", + "targetdoorstate": "garage.rechts.tds", + "obstructiondetected": "garage.rechts.od" +} +``` + +### Humidity sensor +This accessory is used for showing the current humidity value. + +#### Characteristics in addition to [common characteristics](#common-accessories-characteristics) +| Parameter | Possible values | Mandatory | Description | +|:-------------------|:----------------|:----------|:-------------------------------------| +| CurrentHumidity | \ | Yes | SHNG item to monitor humidity | + + +#### Example: +```json +{ + "type": "HumiditySensor", + "name": "Luftfeuchtigkeit Glashaus", + "CurrentHumidity": "Glashaus.Luftfeuchtigkeit" +} +``` + ### LightBulb Lightbulb can be as simple as a generic on/off light, but can also be as complex as a full RGBW led strip. @@ -400,32 +455,6 @@ 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. From 447e0a68ef7c4f82eadde6150875493e49ca2222 Mon Sep 17 00:00:00 2001 From: Chester Date: Tue, 8 Mar 2022 14:18:35 +0100 Subject: [PATCH 2/2] added GarageDoor and HumiditySensor --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index dab610d..acda71d 100644 --- a/README.md +++ b/README.md @@ -194,12 +194,12 @@ Valid values for 'TargetDoorState': ``` ### Humidity sensor -This accessory is used for showing the current humidity value. +This accessory shows the current relative humidity in %. #### Characteristics in addition to [common characteristics](#common-accessories-characteristics) -| Parameter | Possible values | Mandatory | Description | -|:-------------------|:----------------|:----------|:-------------------------------------| -| CurrentHumidity | \ | Yes | SHNG item to monitor humidity | +| Parameter | Possible values | Mandatory | Description | +|:-------------------|:----------------|:----------|:-----------------------------------------------| +| CurrentHumidity | \ | Yes | SHNG item to monitor relative humidity in % | #### Example: @@ -373,7 +373,7 @@ This accessory can monitor and change the on/off state of something. It is very ``` ### Temperature sensor -This sensor show the actual temperature. +This sensor shows the actual temperature. #### Characteristics in addition to [common characteristics](#common-accessories-characteristics) | Parameter | Possible values | Mandatory | Description |