Merge pull request #21 from Foxi352/dependabot/npm_and_yarn/ws-8.17.1

Bump ws from 8.12.1 to 8.17.1

README.md

@@ -1,7 +1,11 @@
 # homebridge-smarthomeng
- 
+
-**Version v2 is a complete rewrite from scratch and a breaking update.**  
+[![npm](https://badgen.net/npm/v/homebridge-smarthomeng)](https://www.npmjs.com/package/homebridge-smarthomeng)
-You need to adapt your `config.json` !
+[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
+[![npm](https://badgen.net/badge/homebridge/>=1.3.5/green)](https://www.npmjs.com/package/homebridge-smarthomeng)
+[![npm](https://badgen.net/npm/node/homebridge-smarthomeng)](https://www.npmjs.com/package/homebridge-smarthomeng)
+[![npm](https://badgen.net/npm/dt/homebridge-smarthomeng)](https://www.npmjs.com/package/homebridge-smarthomeng)
+[![npm](https://badgen.net/npm/dm/homebridge-smarthomeng)](https://www.npmjs.com/package/homebridge-smarthomeng)
 
 ## Currently supported accessories
 This plugin currently supports the following services (and characteristics):
@@ -11,6 +15,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                              |
@@ -21,32 +27,15 @@ This plugin currently supports the following services (and characteristics):
 | [Thermostat](#thermostat)                | Thermostat with temperature sensor and heating state    |
 | [WindowCovering](#window-covering)       | Window covering (shutters, blinds, ...)                 |
 
-Other accessories are being worked on and will be added as soon as ready.
 
 ## Requirements
 * [SmartHomeNG](https://github.com/smarthomeNG/smarthome)
-* [homebridge](https://www.npmjs.com/package/homebridge)
+* [Node.js >=14.18.1](https://nodejs.org/en/)
+* [Homebridge](https://homebridge.io)
 
-## Installation
+## Installation of plugin
-### Install nodejs >=14.18.1
-See [NodeJS](https://nodejs.org/en/) website for details depending on your OS.
 
-### Install libavahi-compat-libdnssd-dev lib
+Use [Homebridge Config UI X](https://github.com/oznu/homebridge-config-ui-x#readme) or install manually using ```npm install -g homebridge-smarthomeng```
-For me i needed these libraries to be installed for my homebridge to work. See their [Homepage](https://homebridge.io) for installation instructions.  
-Below is what i did on my Debian Bullseye installation:
-
-
-	sudo apt install libavahi-compat-libdnssd-dev
-
-
-### Install homebridge >=1.3.5 from NPM repository
-
-	npm install -g homebridge --unsafe-perm
-
-
-### Install this plugin from NPM repository
-
-	npm install -g homebridge-smarthomeng --unsafe-perm
 
 
 ## Configuration
@@ -55,13 +44,13 @@ If you already have a working homebridge installation just add the platform sect
 ### Platform configuration
 The following parameters are available to configure the plugin as platform in homebridge.
 
-| Parameter | Possible values                        | Mandatory | Description                                         |
+| Parameter | Possible values                        | Mandatory | Default | Description                         |
-|:----------|:---------------------------------------|:----------|:----------------------------------------------------|
+|:----------|:---------------------------------------|:----------|:--------|:------------------------------------|
-| platform  | Any \<string>                          | Yes       | Internal name of your platform                      |
+| platform  | Any \<string>                          | Yes       |         | Internal name of your platform      |
-| name      | Any \<string>                          | Yes       | Visible name in HomeKit                             |
+| name      | Any \<string>                          | Yes       |         | Visible name in HomeKit             |
-| host      | IP address or FQDN of your SHNG server | Yes       | Your SHNG host                                      |
+| host      | IP address or FQDN of your SHNG server | Yes       |         | Your SHNG host                      |
-| port      | Port \<number>                         | No        | Listening port of websocket module. Default is 2424 |
+| port      | Port \<number>                         | No        | 2424    | Listening port of websocket module. |
-| tls       | \<boolean>                             | No        | Should TLS encryption be used. Defaults is 'false'  |
+| tls       | \<boolean>                             | No        | False   | Should TLS encryption be used.      |
 
 #### Example configuration:
 ```json
@@ -92,6 +81,25 @@ The following characteristics are valid for all accessories:
     "model": "Motion 360 KNX",
 }
 ```
+
+### Contact sensor
+This sensor shows the open / closed state of a contact (door, window, generic ...).
+
+#### Characteristics in addition to [common characteristics](#common-accessories-characteristics) 
+| Parameter    | Possible values | Mandatory | Description                      |
+|:-------------|:----------------|:----------|:---------------------------------|
+| ContactState | \<item>         | Yes       | SHNG item to monitor for contact |
+
+
+#### Example:
+```json
+{
+    "type": "ContactSensor",
+    "name": "Window kitchen",
+    "ContactState": "EG.Kueche.Fenster"
+}
+```
+
 ### Doorbell
 A doorbell is an accessory that simply sends a message to all devices enrolled in the home that someone rang the doorbell.
 HomeKit displays a message that "This accessory is not currently supported by the Home app.".
@@ -114,9 +122,10 @@ Further investigation is needed, but for now it still works.
 For now this accessory only supports turning the fan on and off. Further improvements are possible, but i don't have the needed hardware for testing.
 
 #### Characteristics in addition to [common characteristics](#common-accessories-characteristics) 
-| Parameter | Possible values | Mandatory | Description                            |
+| Parameter     | Possible values | Mandatory | Description                                     |
-|:----------|:----------------|:----------|:---------------------------------------|
+|:--------------|:----------------|:----------|:------------------------------------------------|
-| Active    | \<item>         | Yes       | SHNG item to set and get the fan state |
+| Active        | \<item>         | Yes       | SHNG item to set and get the fan state.         |
+| RotationSpeed | \<item>         | No        | SHNG item to set and get the fan rotation speed |
 
 #### Example:
 
@@ -128,6 +137,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 | 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
+ 
+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 shows the current relative humidity in %.
+
+#### Characteristics in addition to [common characteristics](#common-accessories-characteristics) 
+| Parameter          | Possible values | Mandatory | Description                                    |
+|:-------------------|:----------------|:----------|:-----------------------------------------------|
+| CurrentHumidity    | \<item>         | Yes       | SHNG item to monitor relative humidity in %    |
+
+
+#### 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.
 
@@ -180,6 +243,25 @@ The above optional min and max parameters allow you to specify the neede range f
 }
 ```
 
+### Motion sensor
+This sensor is tripped if it detects motion in a room.
+
+#### Characteristics in addition to [common characteristics](#common-accessories-characteristics) 
+| Parameter      | Possible values | Mandatory | Description                     |
+|:---------------|:----------------|:----------|:--------------------------------|
+| MotionDetected | \<item>         | Yes       | SHNG item to monitor for motion |
+
+
+#### Example:
+```json
+{
+    "type": "MotionSensor",
+    "name": "Movement hallway",
+    "MotionDetected": "EG.Flur.Bewegung"
+}
+```
+
+
 ### Occupancy sensor
 This sensor is tripped if it detects presence in a room.
 
@@ -200,59 +282,6 @@ This sensor is tripped if it detects presence in a room.
 }
 ```
 
-### Motion sensor
-This sensor is tripped if it detects motion in a room.
-
-#### Characteristics in addition to [common characteristics](#common-accessories-characteristics) 
-| Parameter      | Possible values | Mandatory | Description                     |
-|:---------------|:----------------|:----------|:--------------------------------|
-| MotionDetected | \<item>         | Yes       | SHNG item to monitor for motion |
-
-
-#### Example:
-```json
-{
-    "type": "MotionSensor",
-    "name": "Movement hallway",
-    "MotionDetected": "EG.Flur.Bewegung"
-}
-```
-
-### Contact sensor
-This sensor shows the open / closed state of a contact (door, window, generic ...).
-
-#### Characteristics in addition to [common characteristics](#common-accessories-characteristics) 
-| Parameter    | Possible values | Mandatory | Description                      |
-|:-------------|:----------------|:----------|:---------------------------------|
-| ContactState | \<item>         | Yes       | SHNG item to monitor for contact |
-
-
-#### Example:
-```json
-{
-    "type": "ContactSensor",
-    "name": "Window kitchen",
-    "ContactState": "EG.Kueche.Fenster"
-}
-```
-
-### Switch
-This accessory can monitor and change the on/off state of something. It is very similar to an outlet.
-
-#### Characteristics in addition to [common characteristics](#common-accessories-characteristics) 
-| Parameter | Possible values | Mandatory | Description                             |
-|:----------|:----------------|:----------|:----------------------------------------|
-| On        | \<item>         | Yes       | SHNG item to switch something on or off |
-
-
-#### Example:
-```json
-{
-    "type": "Switch",
-    "name": "Music living-room",
-    "On": "EG.Stube.Radio"
-}
-```
 
 ### Outlet
 This accessory can monitor and change the on/off state of a wall outlet. The outlet can be generic, a light, a fan, ...
@@ -305,8 +334,26 @@ Valid values for 'TargetState':
 }
 ```
 
+### Switch
+This accessory can monitor and change the on/off state of something. It is very similar to an outlet.
+
+#### Characteristics in addition to [common characteristics](#common-accessories-characteristics) 
+| Parameter | Possible values | Mandatory | Description                             |
+|:----------|:----------------|:----------|:----------------------------------------|
+| On        | \<item>         | Yes       | SHNG item to switch something on or off |
+
+
+#### Example:
+```json
+{
+    "type": "Switch",
+    "name": "Music living-room",
+    "On": "EG.Stube.Radio"
+}
+```
+
 ### 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                          |
@@ -357,9 +404,11 @@ This accessory type can be used for shutters or blinds. Because the differnce be
 | TargetPosition             | \<item>         | Yes       |         | SHNG item to monitor and set the target position                  |
 | CurrentPositionMin         | \<number>       | No        | 0       | Your device's minimum value for current position                  |
 | CurrentPositionMax         | \<number>       | No        | 100     | Your device's maximum value for current position                  |
+| CurrentPositionDecimals    | \<number>       | No        | 0       | Number of decimals to round to                                    |
 | CurrentPositionInverted    | \<boolean>      | No        | false   | Should the values be inverted, ex: 0 for Homekit = 100 for device |
 | TargetPositionMin          | \<number>       | No        | 0       | Your device's minimum value for target position                   |
 | TargetPositionMax          | \<number>       | No        | 100     | Your device's maximum value for target position                   |
+| TargetPositionDecimals     | \<number>       | No        | 0       | Number of decimals to round to                                    |
 | TargetPositionInverted     | \<boolean>      | No        | false   | Should the values be inverted, ex: 0 for Homekit = 100 for device |
 | CurrentHorizontalTiltAngle | \<item>         | No        |         | SHNG item to monitor current horizontal tilt angle                |       
 | TargetHorizontalTiltAngle  | \<item>         | No        |         | SHNG item to monitor and set the target horizontal tilt angle     |

package.json

@@ -2,15 +2,15 @@
   "private": false,
   "displayName": "SmartHomeNG",
   "name": "homebridge-smarthomeng",
-  "version": "2.0.2",
+  "version": "2.0.8",
-  "description": "A short description about what your plugin does.",
+  "description": "SmartHomeNG plugin for Homebridge",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
-    "url": "git://github.com/Foxi352/homebridge-smarthomeng2.git"
+    "url": "git://github.com/Foxi352/homebridge-smarthomeng.git"
   },
   "bugs": {
-    "url": "https://github.com/Foxi352/homebridge-smarthomeng2/issues"
+    "url": "https://github.com/Foxi352/homebridge-smarthomeng/issues"
   },
   "engines": {
     "node": ">=14.18.1",
@@ -27,17 +27,17 @@
     "homebridge-plugin"
   ],
   "dependencies": {
-    "ws": "^8.4.2"
+    "ws": "^8.12.1"
   },
   "devDependencies": {
-    "@types/node": "^16.10.9",
+    "@types/node": "^18.13.0",
-    "@typescript-eslint/eslint-plugin": "^5.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.52.0",
-    "@typescript-eslint/parser": "^5.0.0",
+    "@typescript-eslint/parser": "^5.52.0",
-    "eslint": "^8.0.1",
+    "eslint": "^8.34.0",
-    "homebridge": "^1.3.5",
+    "homebridge": "^1.6.0",
-    "nodemon": "^2.0.13",
+    "nodemon": "^2.0.20",
-    "rimraf": "^3.0.2",
+    "rimraf": "^4.1.2",
-    "ts-node": "^10.3.0",
+    "ts-node": "^10.9.1",
-    "typescript": "^4.4.4"
+    "typescript": "^4.9.5"
   }
 }

src/Accessories/Fan.ts

@@ -13,6 +13,7 @@ export class Fan implements AccessoryPlugin {
 
     public name: string;
     private active = false;
+    private rotationSpeed = 100;
 
     constructor(private readonly platform: SmartHomeNGPlatform, private readonly accessory) {
         this.name = accessory.name;
@@ -22,14 +23,20 @@ export class Fan implements AccessoryPlugin {
         this.deviceService.getCharacteristic(this.platform.Characteristic.Active)
             .onGet(this.getActive.bind(this))
             .onSet(this.setActive.bind(this));
+        this.platform.shng.addMonitor(accessory.active, this.shngActiveCallback.bind(this));
+
+        if (accessory.rotationspeed) {
+            this.deviceService.getCharacteristic(this.platform.Characteristic.RotationSpeed)
+                .onGet(this.getRotationSpeed.bind(this))
+                .onSet(this.setRotationSpeed.bind(this));
+            this.platform.shng.addMonitor(accessory.rotationspeed, this.shngRotationSpeedCallback.bind(this));
+        }
 
         this.informationService =
             new this.platform.Service.AccessoryInformation()
                 .setCharacteristic(this.platform.Characteristic.Manufacturer, accessory.manufacturer)
                 .setCharacteristic(this.platform.Characteristic.Model, accessory.model)
                 .setCharacteristic(this.platform.Characteristic.SerialNumber, accessory.active);
-
-        this.platform.shng.addMonitor(accessory.active, this.shngCallback.bind(this));
         this.platform.log.info("Fan '%s' created!", accessory.name);
     }
 
@@ -52,8 +59,19 @@ export class Fan implements AccessoryPlugin {
         this.platform.shng.setItem(this.accessory.active, this.active);
     }
 
-    shngCallback(value: unknown): void {
+    getRotationSpeed(): Nullable<CharacteristicValue> {
-        this.platform.log.debug('shngCallback:', this.accessory.name, '=', value, '(' + typeof value + ')');
+        this.platform.log.info('getRotationSpeed:', this.accessory.name, 'is currently', this.rotationSpeed);
+        return this.rotationSpeed;
+    }
+
+    setRotationSpeed(value: CharacteristicValue) {
+        this.rotationSpeed = value as number;
+        this.platform.log.info('setRotationSpeed:', this.accessory.name, 'was set to', this.rotationSpeed);
+        this.platform.shng.setItem(this.accessory.rotationspeed, this.rotationSpeed);
+    }
+
+    shngActiveCallback(value: unknown): void {
+        this.platform.log.debug('shngActiveCallback:', this.accessory.name, '=', value, '(' + typeof value + ')');
         if (typeof value === 'boolean') {
             this.active = value;
             this.deviceService.updateCharacteristic(this.platform.Characteristic.Active, this.active);
@@ -61,4 +79,14 @@ export class Fan implements AccessoryPlugin {
             this.platform.log.warn('Unknown type ', typeof value, 'received for', this.accessory.name + ':', value);
         }
     }
+
+    shngRotationSpeedCallback(value: unknown): void {
+        this.platform.log.debug('shngRotationSpeedCallback:', this.accessory.name, '=', value, '(' + typeof value + ')');
+        if (typeof value === 'number') {
+            this.rotationSpeed = value;
+            this.deviceService.updateCharacteristic(this.platform.Characteristic.RotationSpeed, this.rotationSpeed);
+        } else {
+            this.platform.log.warn('Unknown type ', typeof value, 'received for', this.accessory.name + ':', value);
+        }
+    }
 }

src/Accessories/GarageDoor.ts

@@ -0,0 +1,130 @@
+import {
+    AccessoryPlugin,
+    CharacteristicValue,
+    Service,
+    Nullable,
+} from 'homebridge';
+
+import { SmartHomeNGPlatform } from '../platform';
+
+export class GarageDoor implements AccessoryPlugin {
+    private readonly deviceService: Service;
+    private readonly informationService: Service;
+
+    public name: string;
+    private targetDoorState = this.platform.Characteristic.CurrentDoorState.CLOSED;
+    private currentDoorState = this.platform.Characteristic.CurrentDoorState.STOPPED;
+    private obstructionDetected = false;
+
+    constructor(private readonly platform: SmartHomeNGPlatform, private readonly accessory) {
+        this.name = accessory.name;
+        this.deviceService = new this.platform.Service.GarageDoorOpener(accessory.name);
+
+        // create handlers for required characteristics
+        this.informationService =
+            new this.platform.Service.AccessoryInformation()
+                .setCharacteristic(this.platform.Characteristic.Manufacturer, accessory.manufacturer)
+                .setCharacteristic(this.platform.Characteristic.Model, accessory.model)
+                .setCharacteristic(this.platform.Characteristic.SerialNumber, accessory.currentdoorstate);
+
+        if (accessory.currentdoorstate) {
+            this.platform.shng.addMonitor(accessory.currentdoorstate, this.shngCurrentDoorStateCallback.bind(this));
+            this.deviceService.getCharacteristic(this.platform.Characteristic.CurrentDoorState)
+                .onGet(this.getCurrentDoorState.bind(this))
+                .onSet(this.setCurrentDoorState.bind(this));
+        } else {
+            this.platform.log.error('GarageDoor: missing \"currentdoorstate\" in config.json!');
+        }
+
+        if (accessory.targetdoorstate) {
+            this.platform.shng.addMonitor(accessory.targetdoorstate, this.shngTargetDoorStateCallback.bind(this));
+            this.deviceService.getCharacteristic(this.platform.Characteristic.TargetDoorState)
+                .onGet(this.getTargetDoorState.bind(this))
+                .onSet(this.setTargetDoorState.bind(this));
+        } else {
+            this.platform.log.error('GarageDoor: missing \"targetdoorstate\" in config.json!');
+        }
+
+        if (accessory.obstructiondetected) {
+            this.platform.shng.addMonitor(accessory.obstructiondetected, this.shngObstructionDetectedCallback.bind(this));
+            this.deviceService.getCharacteristic(this.platform.Characteristic.ObstructionDetected)
+                .onGet(this.getObstructionDetected.bind(this))
+                .onSet(this.setObstructionDetected.bind(this));
+
+        }
+
+        this.platform.log.info("GarageDoor '%s' created!", accessory.name);
+    }
+
+    identify(): void {
+        this.platform.log.info('Identify!');
+    }
+
+    getServices(): Service[] {
+        return [this.informationService, this.deviceService];
+    }
+
+    getCurrentDoorState(): Nullable<CharacteristicValue> {
+        this.platform.log.info('getCurrentDoorState:', this.accessory.name, 'is currently', this.currentDoorState);
+        return this.currentDoorState;
+    }
+
+    setCurrentDoorState(value: CharacteristicValue) {
+        this.currentDoorState = value as number;
+        this.platform.log.info('setCurrentDoorState:', this.accessory.name, 'was set to', this.currentDoorState);
+        this.platform.shng.setItem(this.accessory.currentdoorstate, this.currentDoorState);
+    }
+
+    getTargetDoorState(): Nullable<CharacteristicValue> {
+        this.platform.log.info('getTargetDoorState:', this.accessory.name, 'is currently', this.targetDoorState);
+        return this.targetDoorState;
+    }
+
+    setTargetDoorState(value: CharacteristicValue) {
+        this.targetDoorState = value as number;
+        this.platform.log.info('setTargetDoorState:', this.accessory.name, 'was set to', this.targetDoorState);
+        this.platform.shng.setItem(this.accessory.targetdoorstate, this.targetDoorState);
+    }
+
+    getObstructionDetected(): Nullable<CharacteristicValue> {
+        this.platform.log.info('getObstructionDetected:', this.accessory.name, 'is currently', this.obstructionDetected);
+        return this.obstructionDetected;
+    }
+
+    setObstructionDetected(value: CharacteristicValue) {
+        this.obstructionDetected = value as boolean;
+        this.platform.log.info('setObstructionDetected:', this.accessory.name, 'was set to', this.obstructionDetected);
+        this.platform.shng.setItem(this.accessory.obstructiondetected, this.obstructionDetected);
+    }
+
+    shngCurrentDoorStateCallback(value: unknown): void {
+        this.platform.log.debug('shngCurrentDoorStateCallback:', this.accessory.name, '=', value, '(' + typeof value + ')');
+        if (typeof value === 'number') {
+            this.currentDoorState = value;
+            this.deviceService.updateCharacteristic(this.platform.Characteristic.CurrentDoorState, this.currentDoorState);
+
+        } else {
+            this.platform.log.warn('Unknown type ', typeof value, 'received for', this.accessory.name + ':', value);
+        }
+    }
+
+    shngTargetDoorStateCallback(value: unknown): void {
+        this.platform.log.debug('shngTargetDoorStateCallback:', this.accessory.name, '=', value, '(' + typeof value + ')');
+        if (typeof value === 'number') {
+            this.targetDoorState = value;
+            this.deviceService.updateCharacteristic(this.platform.Characteristic.TargetDoorState, this.targetDoorState);
+        } else {
+            this.platform.log.warn('Unknown type ', typeof value, 'received for', this.accessory.name + ':', value);
+        }
+    }
+
+    shngObstructionDetectedCallback(value: unknown): void {
+        this.platform.log.debug('shngObstructionDetectedCallback:', this.accessory.name, '=', value, '(' + typeof value + ')');
+        if (typeof value === 'boolean') {
+            this.obstructionDetected = value;
+            this.deviceService.updateCharacteristic(this.platform.Characteristic.ObstructionDetected, this.obstructionDetected);
+        } else {
+            this.platform.log.warn('Unknown type ', typeof value, 'received for', this.accessory.name + ':', value);
+        }
+    }
+}

src/Accessories/HumiditySensor.ts

@@ -0,0 +1,59 @@
+import {
+    AccessoryPlugin,
+    CharacteristicValue,
+    Service,
+    Nullable,
+} from 'homebridge';
+
+import { SmartHomeNGPlatform } from '../platform';
+
+export class HumiditySensor implements AccessoryPlugin {
+    private readonly deviceService: Service;
+    private readonly informationService: Service;
+
+    public name: string;
+    private currentHumidity = 0;
+
+    constructor(private readonly platform: SmartHomeNGPlatform, private readonly accessory) {
+        this.name = accessory.name;
+        this.deviceService = new this.platform.Service.HumiditySensor(accessory.name);
+
+        // create handlers for required characteristics
+        this.deviceService.getCharacteristic(this.platform.Characteristic.CurrentRelativeHumidity)
+            .onGet(this.getCurrentHumidity.bind(this));
+
+        this.informationService =
+            new this.platform.Service.AccessoryInformation()
+                .setCharacteristic(this.platform.Characteristic.Manufacturer, accessory.manufacturer)
+                .setCharacteristic(this.platform.Characteristic.Model, accessory.model)
+                .setCharacteristic(this.platform.Characteristic.SerialNumber, accessory.currenthumidity);
+
+        this.platform.shng.addMonitor(accessory.currenthumidity, this.shngCallback.bind(this));
+        this.platform.log.info('HumiditySensor', accessory.name, 'created!');
+    }
+
+    identify(): void {
+        this.platform.log.info('Identify!');
+    }
+
+    getServices(): Service[] {
+        return [this.informationService, this.deviceService];
+    }
+
+    getCurrentHumidity(): Nullable<CharacteristicValue> {
+        this.platform.log.debug('getCurrentHumidity:', this.accessory.name, '=', this.currentHumidity);
+        return this.currentHumidity;
+    }
+
+    shngCallback(value: unknown): void {
+        this.platform.log.debug('shngCallback:', this.accessory.name, '=', value, '(' + typeof value + ')');
+        if (typeof value === 'number') {
+            this.currentHumidity = value;
+        } else {
+            this.platform.log.warn('Unknown type', typeof value, 'received for', this.accessory.name + ':', value);
+        }
+        this.deviceService.updateCharacteristic(this.platform.Characteristic.CurrentRelativeHumidity, this.currentHumidity);
+    }
+}
+
+

src/Accessories/VideoDoorbell.ts

@@ -29,7 +29,7 @@ export class Doorbell implements AccessoryPlugin {
                 .setCharacteristic(this.platform.Characteristic.SerialNumber, accessory.singlepress);
 
         this.platform.shng.addMonitor(accessory.contactstate, this.shngCallback.bind(this));
-        this.platform.log.info('ContactSensor', accessory.name, 'created!');
+        this.platform.log.info('Doorbell', accessory.name, 'created!');
     }
 
     identify(): void {

src/Accessories/WindowCovering.ts

@@ -12,8 +12,10 @@ export class WindowCovering implements AccessoryPlugin {
     private readonly informationService: Service;
 
     public name: string;
-    private currentPosition = 0; private currentPositionMin = 0; private currentPositionMax = 100; private currentPositionInverted = false;
+    private currentPosition = 0; private currentPositionMin = 0; private currentPositionMax = 100;
-    private targetPosition = 0; private targetPositionMin = 0; private targetPositionMax = 100; private targetPositionInverted = false;
+    private currentPositionDecimals = 0; private currentPositionInverted = false;
+    private targetPosition = 0; private targetPositionMin = 0; private targetPositionMax = 100;
+    private targetPositionDecimals = 0; private targetPositionInverted = false;
     private positionState = this.platform.Characteristic.PositionState.STOPPED;
     private currentHorizontalTiltAngle = 0; private targetHorizontalTiltAngle = 0;
     private currentVerticalTiltAngle = 0; private targetVerticalTiltAngle = 0;
@@ -70,9 +72,11 @@ export class WindowCovering implements AccessoryPlugin {
 
         this.currentPositionMax = accessory.currentpositionmax ? accessory.currentpositionmax : this.currentPositionMax;
         this.currentPositionMin = accessory.currentpositionmin ? accessory.currentpositionmin : this.currentPositionMin;
+        this.currentPositionDecimals = accessory.currentpositiondecimals ? accessory.currentpositiondecimals : this.currentPositionDecimals;
         this.currentPositionInverted = accessory.currentpositioninverted ? accessory.currentpositioninverted : this.currentPositionInverted;
         this.targetPositionMax = accessory.targetpositionmax ? accessory.targetpositionmax : this.targetPositionMax;
         this.targetPositionMin = accessory.targetpositionmin ? accessory.targetpositionmin : this.targetPositionMin;
+        this.targetPositionDecimals = accessory.targetpositiondecimals ? accessory.targetpositiondecimals : this.targetPositionDecimals;
         this.targetPositionInverted = accessory.targetpositioninverted ? accessory.targetpositioninverted : this.targetPositionInverted;
         this.platform.log.info("WindowCovering '%s' created!", accessory.name);
     }
@@ -107,7 +111,7 @@ export class WindowCovering implements AccessoryPlugin {
             value as number,
             0, 100,
             this.targetPositionMin, this.targetPositionMax,
-            this.targetPositionInverted,
+            this.targetPositionDecimals, this.targetPositionInverted,
         );
         this.platform.shng.setItem(this.accessory.targetposition, transposedTarget);
     }
@@ -152,7 +156,7 @@ export class WindowCovering implements AccessoryPlugin {
                 value as number,
                 this.currentPositionMin, this.currentPositionMax,
                 0, 100,
-                this.currentPositionInverted,
+                0, this.currentPositionInverted,
             );
             this.deviceService.updateCharacteristic(this.platform.Characteristic.CurrentPosition, this.currentPosition);
         } else {
@@ -169,7 +173,7 @@ export class WindowCovering implements AccessoryPlugin {
                 value as number,
                 this.targetPositionMin, this.targetPositionMax,
                 0, 100,
-                this.targetPositionInverted,
+                0, this.targetPositionInverted,
             );
             this.deviceService.updateCharacteristic(this.platform.Characteristic.TargetPosition, this.targetPosition);
         } else {
@@ -235,9 +239,14 @@ export class WindowCovering implements AccessoryPlugin {
         );
     }
 
-    convertRange(value: number, oldmin: number, oldmax: number, newmin: number, newmax: number, inverted: boolean): number {
+    // eslint-disable-next-line max-len
+    convertRange(value: number, oldmin: number, oldmax: number, newmin: number, newmax: number, decimals: number, inverted: boolean): number {
         let result = (((value - oldmin) * (newmax - newmin)) / (oldmax - oldmin)) + newmin;
-        result = Math.round(result);
+        if(decimals > 0) {
+            result = parseFloat(result.toFixed(decimals));
+        } else {
+            result = Math.round(result);
+        }
         if (inverted) {
             result = newmax - result;
         }
@@ -246,6 +255,7 @@ export class WindowCovering implements AccessoryPlugin {
             'from range', oldmin, '-', oldmax,
             'to', newmin, '-', newmax,
             'with inverted', inverted,
+            'and', decimals, 'decimals',
             '=', result,
         );
         return result;

src/platform.ts

@@ -21,6 +21,8 @@ import { Doorbell } from './Accessories/Doorbell';
 import { SecuritySystem } from './Accessories/SecuritySystem';
 import { OccupancySensor } from './Accessories/OccupancySensor';
 import { MotionSensor } from './Accessories/MotionSensor';
+import { GarageDoor } from './Accessories/GarageDoor';
+import { HumiditySensor } from './Accessories/HumiditySensor';
 
 function uncapitalizeKeys(obj): Record<string, unknown> {
     function isObject(o: unknown): boolean {
@@ -73,87 +75,100 @@ export class SmartHomeNGPlatform implements StaticPlatformPlugin {
 
         // convert all configured accessory keys to lowercase to tolerate user case errors
         const accessories = JSON.parse(JSON.stringify(uncapitalizeKeys(this.config.accessories)));
-
+        this.log.debug(accessories);
-        for (const accessory of accessories) {
+        if (Object.keys(accessories).length > 0) {
-            if (!accessory.manufacturer) {
+            for (const accessory of accessories) {
-                accessory.manufacturer = 'SmartHomeNG';
+                if (!accessory.manufacturer) {
-            }
+                    accessory.manufacturer = 'SmartHomeNG';
-            if (!accessory.model) {
+                }
-                accessory.model = 'SHNG Item';
+                if (!accessory.model) {
-            }
+                    accessory.model = 'SHNG Item';
-
+                }
-            if (accessory.type !== '') {
+
-                this.log.info('Parsing accessory:', accessory.name, 'of type', accessory.type);
+                if (accessory.type !== '') {
-                // set lo lowercase to ignore user case errors
+                    this.log.info('Parsing accessory:', accessory.name, 'of type', accessory.type);
-                switch (accessory.type.toLowerCase()) {
+                    // set lo lowercase to ignore user case errors
-
+                    switch (accessory.type.toLowerCase()) {
-                    // Presence sensor
+
-                    case 'occupancysensor':
+                        // Presence sensor
-                        devices.push(new OccupancySensor(this, accessory));
+                        case 'occupancysensor':
-                        break;
+                            devices.push(new OccupancySensor(this, accessory));
-                    // Motion sensor
+                            break;
-                    case 'motionsensor':
+                        // Motion sensor
-                        devices.push(new MotionSensor(this, accessory));
+                        case 'motionsensor':
-                        break;
+                            devices.push(new MotionSensor(this, accessory));
-
+                            break;
-                    // Contact sensor
+
-                    case 'contactsensor':
+                        // Contact sensor
-                        devices.push(new ContactSensor(this, accessory));
+                        case 'contactsensor':
-                        break;
+                            devices.push(new ContactSensor(this, accessory));
-
+                            break;
-                    // Doorbell
+
-                    case 'doorbell':
+                        // Doorbell
-                        devices.push(new Doorbell(this, accessory));
+                        case 'doorbell':
-                        break;
+                            devices.push(new Doorbell(this, accessory));
-
+                            break;
-                    // Doorbell
+
-                    case 'securitysystem':
+                        // Security system
-                        devices.push(new SecuritySystem(this, accessory));
+                        case 'securitysystem':
-                        break;
+                            devices.push(new SecuritySystem(this, accessory));
-
+                            break;
-                    // Switch
+
-                    case 'switch':
+                        // Switch
-                        devices.push(new Switch(this, accessory));
+                        case 'switch':
-                        break;
+                            devices.push(new Switch(this, accessory));
-
+                            break;
-                    // Lightbulb
+
-                    case 'lightbulb':
+                        // Lightbulb
-                        devices.push(new Lightbulb(this, accessory));
+                        case 'lightbulb':
-                        break;
+                            devices.push(new Lightbulb(this, accessory));
-
+                            break;
-                    // Outlet
+
-                    case 'outlet':
+                        // Outlet
-                        devices.push(new Outlet(this, accessory));
+                        case 'outlet':
-                        break;
+                            devices.push(new Outlet(this, accessory));
-
+                            break;
-                    // Fan (uses Fanv2)
+
-                    case 'fan':
+                        // Fan (uses Fanv2)
-                        devices.push(new Fan(this, accessory));
+                        case 'fan':
-                        break;
+                            devices.push(new Fan(this, accessory));
-
+                            break;
-                    // TemperatureSensor
+
-                    case 'temperaturesensor':
+                        // Temperature sensor
-                        devices.push(new TemperatureSensor(this, accessory));
+                        case 'temperaturesensor':
-                        break;
+                            devices.push(new TemperatureSensor(this, accessory));
-
+                            break;
-                    // Thermostat
+
-                    case 'thermostat':
+                        // Thermostat
-                        devices.push(new Thermostat(this, accessory));
+                        case 'thermostat':
-                        break;
+                            devices.push(new Thermostat(this, accessory));
-
+                            break;
-                    // WindowCovering
+
-                    case 'windowcovering':
+                        // WindowCovering
-                        devices.push(new WindowCovering(this, accessory));
+                        case 'windowcovering':
-                        break;
+                            devices.push(new WindowCovering(this, accessory));
-
+                            break;
-                    // Show error for (yet ?) unsupported device
+
-                    default:
+                        // Garage door
-                        this.log.warn('Accessory type', accessory.type, 'for', accessory.name, 'not recognized !');
+                        case 'garagedoor':
-                        break;
+                            devices.push(new GarageDoor(this, accessory));
+                            break;
+
+                        // Humidity sensor
+                        case 'humiditysensor':
+                            devices.push(new HumiditySensor(this, accessory));
+                            break;
+
+                        // Show error for (yet ?) unsupported device
+                        default:
+                            this.log.warn('Accessory type', accessory.type, 'for', accessory.name, 'not recognized !');
+                            break;
+                    }
+                } else {
+                    this.log.warn('Ignoring accessory (no type given): ' + accessory);
                 }
-            } else {
-                this.log.warn('Ignoring accessory (no type given): ' + accessory);
             }
+
         }
         callback(devices);
         this.log.debug('Finished building accessories list');