node-red-contrib-homebridge-automation 0.1.12-beta.39 → 0.1.12-beta.40

package/README.md

@@ -183,6 +183,7 @@ With a plugin, you can see if it supports Real Time events, by opening the Home
 ### Dec 15, 2024 - Version 0.2.0
 
 - Major code base refresh, and migration from hap-node-client to hap-client ( Potential fix for #120 )
+- Testing and Development was completed on Node-RED version: v4.0.2 and Node.js  version: v20.18.1
 
 # Backlog / Roadmap
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-homebridge-automation",
-  "version": "0.1.12-beta.39",
+  "version": "0.1.12-beta.40",
   "description": "NodeRED Automation for HomeBridge",
   "main": "src/HAP-NodeRed.js",
   "scripts": {
@@ -36,15 +36,13 @@
     "node-red": "^4.0.2",
     "node-red-node-test-helper": "^0.3.4",
     "nodemon": "^3.1.4",
-    "nyc": "^17.0.0",
-    "prettier": "^3.3.2",
     "rimraf": "^6.0.1",
     "semver": "^7.6.2"
   },
   "dependencies": {
     "better-queue": ">=3.8.12",
     "debug": "^4.3.5",
-    "@homebridge/hap-client": "2.0.5-beta.20"
+    "@homebridge/hap-client": "2.0.5-beta.21"
   },
   "author": "NorthernMan54",
   "license": "ISC",
@@ -58,7 +56,7 @@
     ],
     "ext": "js,html",
     "ignore": [],
-    "exec": "DEBUG=hapNodeRed* ~/npm/bin/node-red -u test/node-red",
+    "exec": "DEBUG=hapNodeRed* ~/npm/bin/node-red -v -u test/node-red",
     "signal": "SIGTERM",
     "env": {
       "NODE_OPTIONS": "--trace-warnings"

package/src/hbConfigNode.js

@@ -1,6 +1,5 @@
 const { HapClient } = require('@homebridge/hap-client');
 const debug = require('debug')('hapNodeRed:hbConfigNode');
-const { Log } = require('./lib/logger.js');
 
 class HBConfigNode {
   constructor(config, RED) {
@@ -16,14 +15,13 @@ class HBConfigNode {
       this.ctDevices = [];
       this.hbDevices = [];
       this.clientNodes = [];
-      this.log = new Log(console, true);
+      //  this.log = new Log(console, true);
       this.discoveryTimeout = null;
 
       // Initialize HAP client
       this.hapClient = new HapClient({
         config: { debug: false },
-        pin: config.username,
-        logger: this.log,
+        pin: config.username
       });
 
       this.hapClient.on('instance-discovered', this.waitForNoMoreDiscoveries);
@@ -42,7 +40,7 @@ class HBConfigNode {
     if (!this.refreshInProcess) {
 
       this.monitor.finish();
-      this.log.debug('[hb-config] Monitor reported homebridge stability issues, refreshing devices');
+      this.debug('Monitor reported homebridge stability issues, refreshing devices');
       this.hapClient.on('instance-discovered', this.waitForNoMoreDiscoveries);
       this.hapClient.resetInstancePool();
       this.waitForNoMoreDiscoveries();
@@ -56,7 +54,7 @@ class HBConfigNode {
     if (!this.discoveryTimeout) {
       clearTimeout(this.discoveryTimeout);
       this.discoveryTimeout = setTimeout(() => {
-        this.log.debug('[hb-config] No more instances discovered, publishing services');
+        this.debug('No more instances discovered, publishing services');
         this.hapClient.removeListener('instance-discovered', this.waitForNoMoreDiscoveries);
         this.handleReady();
         this.discoveryTimeout = null;
@@ -81,7 +79,7 @@ class HBConfigNode {
 
     this.evDevices = this.toList({ perms: 'ev' });
     this.ctDevices = this.toList({ perms: 'pw' });
-    this.log.info(`[hb-config] Devices initialized: evDevices: ${this.evDevices.length}, ctDevices: ${this.ctDevices.length}`);
+    this.log(`Devices initialized: evDevices: ${this.evDevices.length}, ctDevices: ${this.ctDevices.length}`);
     this.handleDuplicates(this.evDevices);
     this.connectClientNodes();
   }
@@ -117,10 +115,10 @@ class HBConfigNode {
       const { fullName, uniqueId } = endpoint;
 
       if (seen.has(fullName)) {
-        this.log.warn(`[hb-config] Duplicate device name detected: ${fullName}`);
+        this.warn(`Duplicate device name detected: ${fullName}`);
       }
       if (seen.has(uniqueId)) {
-        this.log.error(`[hb-config] Duplicate uniqueId detected: ${uniqueId}`);
+        this.error(`Duplicate uniqueId detected: ${uniqueId}`);
       }
 
       seen.set(fullName, true);
@@ -148,7 +146,7 @@ class HBConfigNode {
         clientNode.emit('hbReady', matchedDevice);
         debug('_Registered: %s type: %s', matchedDevice.type, matchedDevice.serviceName, matchedDevice.instance);
       } else {
-        console.error('ERROR: Device registration failed', clientNode.name);
+        this.error(`ERROR: Device registration failed ${clientNode.name}`);
       }
     };
 
@@ -200,7 +198,7 @@ class HBConfigNode {
   disconnectClientNodes(instance) {
     debug('disconnectClientNodes', `${instance.ipAddress}:${instance.port}`);
     const clientNodes = Object.values(this.clientNodes).filter(clientNode => {
-      return `${clientNode.hbDevice.instance.ipAddress}:${clientNode.hbDevice.instance.port}` === `${instance.ipAddress}:${instance.port}`;
+      return `${clientNode.hbDevice?.instance.ipAddress}:${clientNode.hbDevice?.instance.port}` === `${instance.ipAddress}:${instance.port}`;
     });
 
     clientNodes.forEach(clientNode => {
@@ -212,7 +210,7 @@ class HBConfigNode {
   reconnectClientNodes(instance) {
     debug('reconnectClientNodes', `${instance.ipAddress}:${instance.port}`);
     const clientNodes = Object.values(this.clientNodes).filter(clientNode => {
-      return `${clientNode.hbDevice.instance.ipAddress}:${clientNode.hbDevice.instance.port}` === `${instance.ipAddress}:${instance.port}`;
+      return `${clientNode.hbDevice?.instance.ipAddress}:${clientNode.hbDevice?.instance.port}` === `${instance.ipAddress}:${instance.port}`;
     });
 
     clientNodes.forEach(clientNode => {

package/src/hbConfigNode.test.js

@@ -1,185 +0,0 @@
-const debug = require('debug')('hapNodeRed:JEST');
-
-const HBConfigNode = require('./hbConfigNode.js');
-
-describe("toList", () => {
-  var hbConfigNode;
-  createNode = function () {
-  };
-  beforeAll(async () => {
-    // eslint-disable-next-line no-console
-    console.log('init');
-    hbConfigNode = new HBConfigNode({ jest: true });
-  });
-
-  test("should return an empty array when inputs is empty", () => {
-    const inputs = [];
-    const perms = [];
-    const result = hbConfigNode.toList(inputs, perms);
-    expect(result).toEqual([]);
-  });
-
-  test("should map inputs to the expected output format", () => {
-    const inputs = [
-      {
-        "aid": 167,
-        "iid": 8,
-        "uuid": "00000040-0000-1000-8000-0026BB765291",
-        "type": "Fan",
-        "humanType": "Fan",
-        "serviceName": "Bunkie Fan",
-        "serviceCharacteristics": [
-          {
-            "aid": 167,
-            "iid": 10,
-            "uuid": "00000025-0000-1000-8000-0026BB765291",
-            "type": "On",
-            "serviceType": "Fan",
-            "serviceName": "Bunkie Fan",
-            "description": "On",
-            "value": 1,
-            "format": "bool",
-            "perms": [
-              "ev",
-              "pr",
-              "pw"
-            ],
-            "canRead": true,
-            "canWrite": true,
-            "ev": true
-          },
-          {
-            "aid": 167,
-            "iid": 11,
-            "uuid": "000000E3-0000-1000-8000-0026BB765291",
-            "type": "ConfiguredName",
-            "serviceType": "Fan",
-            "serviceName": "Bunkie Fan",
-            "description": "Configured Name",
-            "value": "Bunkie Fan",
-            "format": "string",
-            "perms": [
-              "ev",
-              "pr",
-              "pw"
-            ],
-            "canRead": true,
-            "canWrite": true,
-            "ev": true
-          },
-          {
-            "aid": 167,
-            "iid": 12,
-            "uuid": "00000029-0000-1000-8000-0026BB765291",
-            "type": "RotationSpeed",
-            "serviceType": "Fan",
-            "serviceName": "Bunkie Fan",
-            "description": "Rotation Speed",
-            "value": 33,
-            "format": "float",
-            "perms": [
-              "ev",
-              "pr",
-              "pw"
-            ],
-            "unit": "percentage",
-            "maxValue": 100,
-            "minValue": 0,
-            "minStep": 1,
-            "canRead": true,
-            "canWrite": true,
-            "ev": true
-          }
-        ],
-        "accessoryInformation": {
-          "Manufacturer": "Tasmota",
-          "Model": "Sonoff iFan03",
-          "Name": "Bunkie Fan",
-          "Serial Number": "302D6B-jessie",
-          "Firmware Revision": "9.5.0tasmota"
-        },
-        "values": {
-          "On": 1,
-          "ConfiguredName": "Bunkie Fan",
-          "RotationSpeed": 33
-        },
-        "instance": {
-          "name": "homebridge",
-          "username": "1C:22:3D:E3:CF:34",
-          "ipAddress": "192.168.1.11",
-          "port": 35215,
-          "services": [],
-          "connectionFailedCount": 0
-        },
-        "uniqueId": "9fd9e494282f14d80d438aad8ffde153893f99a97195b816749786e9a012aa2f"
-      },
-      // Add more inputs here if needed
-    ];
-
-    const perms = { perms: 'ev' };
-
-    const result = hbConfigNode.toList(inputs, perms);
-    /*
-    {
-    "homebridge": "homebridge",
-    "host": "192.168.1.11",
-    "port": 35215,
-    "id": "1C:22:3D:E3:CF:34",
-    "manufacturer": "Tasmota",
-    "aid": 75,
-    "type": "00000043",
-    "name": "West Bedroom",
-    "service": "Lightbulb",
-    "fullName": "West Bedroom - Lightbulb",
-    "sortName": "West Bedroom:Lightbulb",
-    "uniqueId": "homebridge1C:22:3D:E3:CF:34TasmotaWest Bedroom00000043",
-    "descriptions": "On",
-    "characteristics": {
-        "75.10": {
-            "characteristic": "On",
-            "iid": 10
-        }
-    },
-    "getCharacteristics": "75.10",
-    "eventRegisters": [{
-        "aid": 75,
-        "iid": 10,
-        "ev": true
-    }]
-    }
-        */
-
-    expect(result).toHaveLength(1);
-    console.log(result);
-    /*
-    expect(result).toEqual([
-      {
-        uniqueId: "1",
-        serviceName: "Service 1",
-        characteristics: [
-          {
-            id: "1.1",
-            type: "Type 1",
-            description: "Description 1",
-            value: "Value 1",
-            format: "Format 1",
-            unit: "Unit 1",
-            perms: ["perm1", "perm2"],
-            canRead: true,
-            canWrite: false,
-            ev: true
-          },
-          // Add more expected characteristics here if needed
-        ]
-      },
-      // Add more expected outputs here if needed
-    ]);
-    */
-  });
-
-  afterAll(async () => {
-    // eslint-disable-next-line no-console
-    console.log('destroy');
-    // await hap.destroy();
-  });
-});

package/src/lib/logger.js

@@ -1,31 +0,0 @@
-export class Log {
-
-  constructor(logger, debugMode) {
-    this.logger = logger;
-    this.debugMode = debugMode;
-  }
-
-  debug(msg) {
-    if (this.debugMode) {
-      this.logger.info(msg);
-    } else {
-      this.logger.debug(msg);
-    }
-  }
-
-  info(msg) {
-    this.logger.info(msg);
-  }
-
-  warn(msg) {
-    this.logger.warn(msg);
-  }
-
-  error(msg) {
-    this.logger.error(msg);
-  }
-
-  log(msg) {
-    this.logger.info(msg);
-  }
-}