Merge pull request #36 from pgerke/35-upgrade-to-homebridge-160

Regular Dependency Bump

.github/workflows/build.yml

@@ -13,14 +13,16 @@ jobs:
     strategy:
       matrix:
         # the Node.js versions to build on
-        node-version: [12.x, 13.x, 14.x, 15.x, 16.x]
+        node-version: [14.x, 16.x, 18.x]
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }} 
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
+      - name: Install latest npm
+        run: npm install -g npm && npm --version
       - name: Install dependencies
         run: npm ci
       - name: Build the project
@@ -39,14 +41,16 @@ jobs:
     strategy:
       matrix:
         # the Node.js versions to build on
-        node-version: [12.x, 13.x, 14.x, 15.x, 16.x]
+        node-version: [14.x, 16.x, 18.x]
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }} 
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
+      - name: Install latest npm
+        run: npm install -g npm && npm --version
       - name: Restore dependencies
         run: npm ci
       - name: Run linter
@@ -67,14 +71,16 @@ jobs:
     strategy:
       matrix:
         # the Node.js versions to build on
-        node-version: [12.x, 13.x, 14.x, 15.x, 16.x]
+        node-version: [14.x, 16.x, 18.x]
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }} 
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
+      - name: Install latest npm
+        run: npm install -g npm && npm --version
       - name: Restore dependencies
         run: npm ci
       - name: Run unit test

CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.4.1](https://github.com/pgerke/homebridge-freeathome-local-api/releases/tag/1.4.1) - 04.12.2022
+
+### Added
+
+- [#35](https://github.com/pgerke/homebridge-freeathome-local-api/issues/35):
+  Upgrade to Homebridge v1.6 and adapted NodeJS requirements. In accordance with the homebridge plugin verification criteria the [list of supported NodeJS](https://github.com/homebridge/homebridge/wiki/How-To-Update-Node.js) version has been updated. The plugin now officially supports NodeJS versions 14, 16 and 18. Please note, NodeJS version 12 is no longer supported.
+
+- [#34](https://github.com/pgerke/homebridge-freeathome-local-api/issues/34):
+  Added documentation to the README file about using TLS.
+
 ## [1.4.0](https://github.com/pgerke/homebridge-freeathome-local-api/releases/tag/1.4) - 09.10.2022
 
 ### Added

README.md

@@ -91,6 +91,18 @@ The following type mappings are supported:
 | ------------------------ | --------------- | ------------------- | ------------ |
 | 7: `FID_SWITCH_ACTUATOR` | Switch          | Outlet              | `Outlet`     |
 
+## Using Transport Layer Security (TLS)
+
+The plugin supports Transport Layer Security (TLS). By enabling TLS, the connection between the Homebridge plugin and the free@home System Access Point will be encrypted making it hard to read the data that is exchanged. Before you can use TLS, you'll need to initially create a TLS certificat in your System Access Point. To do so log in to the SysAP UI, go to _Settings -> free@home Settings -> Local API_ and click the _Create Certificate_ Button indicated by the red arrow in the image below.
+
+![System Access Point TLS](.doc/TLS%20Certificate.png)
+
+Then you can activate TLS in the Homebridge plugin by checking the corrensponding check box in the Homebridge plugin settings dialog as indicated by the upper red arrow in the image below. Please note that the TLS certificate generated by the System Access Point is a self-signed certificate. In order for the TLS handshake to complete successfully, you need to add the System Access Points TLS certificate to the trusted certificate store of the machine running Homebridge or the handshake will fail and the plugin will not start. Unfortunately, it is not possible at the moment to replace the System Access Points TLS certificate with a signed one.
+
+You can also choose to use TLS, but disable certificate verification by checking the corresponding check box in the Homebridge plugin settings dialog as indicated by the lower red arrow in the image below. Please note that disabling TLS verification presents a possible security risk. Your connection will still be encrypted, but the authenticity of the party presenting the certificate is not verified.
+
+![Homebridge Plugin Settings](.doc/Homebridge%20Settings%20Dialog.png)
+
 ## Requirements
 
 - free@home Access Point running firmware version >2.6.0