node-red-contrib-homebridge-automation 0.2.1-beta.0 → 0.2.1-beta.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-homebridge-automation",
-  "version": "0.2.1-beta.0",
+  "version": "0.2.1-beta.2",
   "description": "NodeRED Automation for HomeBridge",
   "main": "src/HAP-NodeRed.js",
   "scripts": {

package/src/hbBaseNode.js

@@ -27,18 +27,9 @@ class HbBaseNode {
       this.on('hbReady', this.handleHbReady.bind(this))
     }
     this.on('close', this.handleClose.bind(this));
-    this.on('hbEvent', this.handleHBEventMessage.bind(this));
-  }
-
-  handleHBEventMessage(service) {
-    debug('hbEvent for', this.id, this.type, service.serviceName, JSON.stringify(service.values));
-
-    this.status({
-      text: JSON.stringify(service.values),
-      shape: 'dot',
-      fill: 'green',
-    });
-    this.send({ payload: service.values });
+    if (this.handleHBEventMessage) {
+      this.on('hbEvent', this.handleHBEventMessage.bind(this));
+    }
   }
 
   createMessage(service) {

package/src/hbConfigNode.js

@@ -26,36 +26,20 @@ class HBConfigNode {
 
       this.hapClient.on('instance-discovered', this.waitForNoMoreDiscoveries);
       this.hapClient.on('discovery-ended', this.hapClient.refreshInstances);
-      this.waitForNoMoreDiscoveries();
       this.on('close', this.close.bind(this));
       this.refreshInProcess = true; // Prevents multiple refreshes, hapClient kicks of a discovery on start
     }
   }
 
-  /**
-   * Start device discovery after monitor reports issues
-   */
-
-  refreshDevices = () => {
-    if (!this.refreshInProcess) {
-
-      this.monitor.finish();
-      this.debug('Monitor reported homebridge stability issues, refreshing devices');
-      this.hapClient.on('instance-discovered', this.waitForNoMoreDiscoveries);
-      this.hapClient.resetInstancePool();
-      this.waitForNoMoreDiscoveries();
-    }
-  };
-
   /**
    * Wait for no more instance discoveries to be made before publishing services
    */
-  waitForNoMoreDiscoveries = () => {
+  waitForNoMoreDiscoveries = (instance) => {
+    debug('Instance discovered: %s - %s %s:%s', instance?.name, instance?.username, instance?.ipAddress, instance?.port);
     if (!this.discoveryTimeout) {
       clearTimeout(this.discoveryTimeout);
       this.discoveryTimeout = setTimeout(() => {
         this.debug('No more instances discovered, publishing services');
-        this.hapClient.removeListener('instance-discovered', this.waitForNoMoreDiscoveries);
         this.handleReady();
         this.discoveryTimeout = null;
         this.refreshInProcess = false;
@@ -153,21 +137,17 @@ class HBConfigNode {
 
   async monitorDevices() {
     if (Object.keys(this.clientNodes).length) {
-      const uniqueDevices = new Set();
 
       const monitorNodes = Object.values(this.clientNodes)
-        .filter(node => ['hb-status', 'hb-control', 'hb-event', 'hb-resume'].includes(node.type)) // Filter by type
-        .filter(node => {
-          if (uniqueDevices.has(node.device)) {
-            return false; // Exclude duplicates
-          }
-          uniqueDevices.add(node.device);
-          return true; // Include unique devices
-        })
+        .filter(node => ['hb-status', 'hb-event', 'hb-resume'].includes(node.type)) // Filter by type
         .map(node => node.hbDevice) // Map to hbDevice property
         .filter(Boolean); // Remove any undefined or null values, if present;
-      debug('monitorNodes', Object.keys(monitorNodes).length);
+      this.log(`Connected to ${Object.keys(monitorNodes).length} Homebridge devices`);
       // console.log('monitorNodes', monitorNodes);
+      if (this.monitor) {
+        // This is kinda brute force, but it works
+        this.monitor.finish();
+      }
       this.monitor = await this.hapClient.monitorCharacteristics(monitorNodes);
       this.monitor.on('service-update', (services) => {
         services.forEach(service => {

package/src/hbConfigNode.test.js

@@ -2094,26 +2094,35 @@ describe('HBConfigNode', () => {
     ];
   });
 
-  test('toList filters and maps devices correctly', () => {
+  test('toList filters and maps camera devices correctly', () => {
     const result = node.toList({ perms: 'ev' });
     expect(result).toEqual([
       {
-        name: 'Living Room Light',
-        fullName: 'Living Room Light - Lightbulb',
-        sortName: 'Living Room Light:Lightbulb',
-        uniqueId: 'Bridge100:11:22:33:44:55AcmeLiving Room Light12345678',
-        homebridge: 'Bridge1',
-        service: 'Lightbulb',
-        manufacturer: 'Acme',
+        name: 'Backyard',
+        fullName: 'Backyard - CameraRTPStreamManagement',
+        sortName: 'Backyard:CameraRTPStreamManagement',
+        uniqueId: 'homebridge0E:89:A7:DA:D3:21EufyBackyard00000110',
+        homebridge: 'homebridge',
+        service: 'CameraRTPStreamManagement',
+        manufacturer: 'Eufy'
       },
       {
-        name: 'Kitchen Switch',
-        fullName: 'Kitchen Switch - Switch',
-        sortName: 'Kitchen Switch:Switch',
-        uniqueId: 'Bridge211:22:33:44:55:66AcmeKitchen Switch87654321',
-        homebridge: 'Bridge2',
-        service: 'Switch',
-        manufacturer: 'Acme',
+        name: 'Backyard',
+        fullName: 'Backyard - MotionSensor',
+        sortName: 'Backyard:MotionSensor',
+        uniqueId: 'homebridge0E:89:A7:DA:D3:21EufyBackyard00000085',
+        homebridge: 'homebridge',
+        service: 'MotionSensor',
+        manufacturer: 'Eufy'
+      },
+      {
+        "fullName": "Canoe 5036 - CameraRTPStreamManagement",
+        "homebridge": "ECI-T24F2",
+        "manufacturer": "HikVision",
+        "name": "Canoe 5036",
+        "service": "CameraRTPStreamManagement",
+        "sortName": "Canoe 5036:CameraRTPStreamManagement",
+        "uniqueId": "ECI-T24F25C:EE:FE:4D:64:B4HikVisionCanoe 503600000110",
       },
       {
         "fullName": "Canoe - MotionSensor",
@@ -2125,28 +2134,28 @@ describe('HBConfigNode', () => {
         "uniqueId": "ECI-T24F25C:EE:FE:4D:64:B4HikVisionCanoe00000085",
       },
       {
-        "fullName": "Canoe 5036 - CameraRTPStreamManagement",
-        "homebridge": "ECI-T24F2",
-        "manufacturer": "HikVision",
-        "name": "Canoe 5036",
-        "service": "CameraRTPStreamManagement",
-        "sortName": "Canoe 5036:CameraRTPStreamManagement",
-        "uniqueId": "ECI-T24F25C:EE:FE:4D:64:B4HikVisionCanoe 503600000110",
+        name: 'Kitchen Switch',
+        fullName: 'Kitchen Switch - Switch',
+        sortName: 'Kitchen Switch:Switch',
+        uniqueId: 'Bridge211:22:33:44:55:66AcmeKitchen Switch87654321',
+        homebridge: 'Bridge2',
+        service: 'Switch',
+        manufacturer: 'Acme',
       },
       {
-        name: 'Backyard',
-        fullName: 'Backyard - MotionSensor',
-        sortName: 'Backyard:MotionSensor',
-        uniqueId: 'homebridge0E:89:A7:DA:D3:21EufyBackyard00000085',
-        homebridge: 'homebridge',
-        service: 'MotionSensor',
-        manufacturer: 'Eufy'
+        name: 'Living Room Light',
+        fullName: 'Living Room Light - Lightbulb',
+        sortName: 'Living Room Light:Lightbulb',
+        uniqueId: 'Bridge100:11:22:33:44:55AcmeLiving Room Light12345678',
+        homebridge: 'Bridge1',
+        service: 'Lightbulb',
+        manufacturer: 'Acme',
       },
       {
-        name: 'Backyard',
-        fullName: 'Backyard - CameraRTPStreamManagement',
-        sortName: 'Backyard:CameraRTPStreamManagement',
-        uniqueId: 'homebridge0E:89:A7:DA:D3:21EufyBackyard00000110',
+        name: 'Side door',
+        fullName: 'Side door - CameraRTPStreamManagement',
+        sortName: 'Side door:CameraRTPStreamManagement',
+        uniqueId: 'homebridge0E:89:A7:DA:D3:21EufySide door00000110',
         homebridge: 'homebridge',
         service: 'CameraRTPStreamManagement',
         manufacturer: 'Eufy'
@@ -2160,15 +2169,6 @@ describe('HBConfigNode', () => {
         service: 'MotionSensor',
         manufacturer: 'Eufy'
       },
-      {
-        name: 'Side door',
-        fullName: 'Side door - CameraRTPStreamManagement',
-        sortName: 'Side door:CameraRTPStreamManagement',
-        uniqueId: 'homebridge0E:89:A7:DA:D3:21EufySide door00000110',
-        homebridge: 'homebridge',
-        service: 'CameraRTPStreamManagement',
-        manufacturer: 'Eufy'
-      }
     ]);
 
     // Ensure the unsupported type was filtered out

package/src/hbEventNode.js

@@ -18,6 +18,17 @@ class HbEventNode extends hbBaseNode {
       this.send({ ...this.createMessage(service) });
     }
   }
+
+  handleHBEventMessage(service) {
+    debug('hbEvent for', this.id, this.type, service.serviceName, JSON.stringify(service.values));
+
+    this.status({
+      text: JSON.stringify(service.values),
+      shape: 'dot',
+      fill: 'green',
+    });
+    this.send({ payload: service.values });
+  }
 }
 
 module.exports = HbEventNode;

package/src/hbStatusNode.js

@@ -32,6 +32,17 @@ class HbStatusNode extends HbBaseNode {
     }
 
   }
+
+  handleHBEventMessage(service) {
+    debug('hbEvent for', this.id, this.type, service.serviceName, JSON.stringify(service.values));
+
+    this.status({
+      text: JSON.stringify(service.values),
+      shape: 'dot',
+      fill: 'green',
+    });
+    this.send({ payload: service.values });
+  }
 }
 
 module.exports = HbStatusNode;

package/test/node-red/.config.nodes.json

@@ -429,7 +429,7 @@
     },
     "node-red-contrib-homebridge-automation": {
         "name": "node-red-contrib-homebridge-automation",
-        "version": "0.2.0",
+        "version": "0.2.1",
         "local": false,
         "user": false,
         "nodes": {

package/test/node-red/.config.nodes.json.backup

@@ -429,7 +429,7 @@
     },
     "node-red-contrib-homebridge-automation": {
         "name": "node-red-contrib-homebridge-automation",
-        "version": "0.1.12",
+        "version": "0.2.0",
         "local": false,
         "user": false,
         "nodes": {

package/test/node-red/.flows.json.backup

@@ -180,7 +180,7 @@
         "conf": "7e647d67.f33acc",
         "outputs": 1,
         "x": 500,
-        "y": 300,
+        "y": 320,
         "wires": [
             [
                 "f194fc4bcb1997a9"
@@ -825,7 +825,7 @@
         "Manufacturer": "Tasmota",
         "Service": "Lightbulb",
         "device": "homebridge1C:22:3D:E3:CF:34TasmotaMaster00000043",
-        "conf": "557aec8e8c47e61e",
+        "conf": "7e647d67.f33acc",
         "sendInitialState": true,
         "x": 170,
         "y": 280,
@@ -1882,7 +1882,8 @@
         "y": 140,
         "wires": [
             [
-                "49a103299064c61a"
+                "49a103299064c61a",
+                "4d03a7e3277b96e4"
             ]
         ]
     },

package/test/node-red/flows.json

@@ -180,7 +180,7 @@
         "conf": "7e647d67.f33acc",
         "outputs": 1,
         "x": 500,
-        "y": 300,
+        "y": 320,
         "wires": [
             [
                 "f194fc4bcb1997a9"
@@ -453,7 +453,7 @@
         "statusVal": "payload",
         "statusType": "auto",
         "x": 800,
-        "y": 300,
+        "y": 320,
         "wires": []
     },
     {
@@ -825,7 +825,7 @@
         "Manufacturer": "Tasmota",
         "Service": "Lightbulb",
         "device": "homebridge1C:22:3D:E3:CF:34TasmotaMaster00000043",
-        "conf": "557aec8e8c47e61e",
+        "conf": "7e647d67.f33acc",
         "sendInitialState": true,
         "x": 170,
         "y": 280,

package/test/node-red/settings.js

@@ -22,14 +22,14 @@
 
 module.exports = {
 
-/*******************************************************************************
- * Flow File and User Directory Settings
- *  - flowFile
- *  - credentialSecret
- *  - flowFilePretty
- *  - userDir
- *  - nodesDir
- ******************************************************************************/
+    /*******************************************************************************
+     * Flow File and User Directory Settings
+     *  - flowFile
+     *  - credentialSecret
+     *  - flowFilePretty
+     *  - userDir
+     *  - nodesDir
+     ******************************************************************************/
 
     /** The file containing the flows. If not set, defaults to flows_<hostname>.json **/
     flowFile: 'flows.json',
@@ -60,15 +60,15 @@ module.exports = {
      */
     //nodesDir: '/home/nol/.node-red/nodes',
 
-/*******************************************************************************
- * Security
- *  - adminAuth
- *  - https
- *  - httpsRefreshInterval
- *  - requireHttps
- *  - httpNodeAuth
- *  - httpStaticAuth
- ******************************************************************************/
+    /*******************************************************************************
+     * Security
+     *  - adminAuth
+     *  - https
+     *  - httpsRefreshInterval
+     *  - requireHttps
+     *  - httpNodeAuth
+     *  - httpStaticAuth
+     ******************************************************************************/
 
     /** To password protect the Node-RED editor and admin API, the following
      * property can be used. See https://nodered.org/docs/security.html for details.
@@ -125,22 +125,22 @@ module.exports = {
     //httpNodeAuth: {user:"user",pass:"$2a$08$zZWtXTja0fB1pzD4sHCMyOCMYz2Z6dNbM6tl8sJogENOMcxWV9DN."},
     //httpStaticAuth: {user:"user",pass:"$2a$08$zZWtXTja0fB1pzD4sHCMyOCMYz2Z6dNbM6tl8sJogENOMcxWV9DN."},
 
-/*******************************************************************************
- * Server Settings
- *  - uiPort
- *  - uiHost
- *  - apiMaxLength
- *  - httpServerOptions
- *  - httpAdminRoot
- *  - httpAdminMiddleware
- *  - httpAdminCookieOptions
- *  - httpNodeRoot
- *  - httpNodeCors
- *  - httpNodeMiddleware
- *  - httpStatic
- *  - httpStaticRoot
- *  - httpStaticCors
- ******************************************************************************/
+    /*******************************************************************************
+     * Server Settings
+     *  - uiPort
+     *  - uiHost
+     *  - apiMaxLength
+     *  - httpServerOptions
+     *  - httpAdminRoot
+     *  - httpAdminMiddleware
+     *  - httpAdminCookieOptions
+     *  - httpNodeRoot
+     *  - httpNodeCors
+     *  - httpNodeMiddleware
+     *  - httpStatic
+     *  - httpStaticRoot
+     *  - httpStaticCors
+     ******************************************************************************/
 
     /** the tcp port that the Node-RED web server is listening on */
     uiPort: process.env.PORT || 1880,
@@ -269,16 +269,16 @@ module.exports = {
     //     mode: "legacy", // legacy mode is for non-strict previous proxy determination logic (node-red < v4 compatible)
     // },
 
-/*******************************************************************************
- * Runtime Settings
- *  - lang
- *  - runtimeState
- *  - diagnostics
- *  - logging
- *  - contextStorage
- *  - exportGlobalContextKeys
- *  - externalModules
- ******************************************************************************/
+    /*******************************************************************************
+     * Runtime Settings
+     *  - lang
+     *  - runtimeState
+     *  - diagnostics
+     *  - logging
+     *  - contextStorage
+     *  - exportGlobalContextKeys
+     *  - externalModules
+     ******************************************************************************/
 
     /** Uncomment the following to run node-red in your preferred language.
      * Available languages include: en-US (default), ja, de, zh-CN, zh-TW, ru, ko
@@ -324,7 +324,7 @@ module.exports = {
              * trace - record very detailed logging + debug + info + warn + error + fatal errors
              * off - turn off all logging (doesn't affect metrics or audit)
              */
-            level: "info",
+            level: "debug",
             /** Whether or not to include metric events in the log output */
             metrics: false,
             /** Whether or not to include audit events in the log output */
@@ -381,11 +381,11 @@ module.exports = {
     },
 
 
-/*******************************************************************************
- * Editor Settings
- *  - disableEditor
- *  - editorTheme
- ******************************************************************************/
+    /*******************************************************************************
+     * Editor Settings
+     *  - disableEditor
+     *  - editorTheme
+     ******************************************************************************/
 
     /** The following property can be used to disable the editor. The admin API
      * is not affected by this option. To disable both the editor and the admin
@@ -468,28 +468,28 @@ module.exports = {
         },
     },
 
-/*******************************************************************************
- * Node Settings
- *  - fileWorkingDirectory
- *  - functionGlobalContext
- *  - functionExternalModules
- *  - functionTimeout
- *  - nodeMessageBufferMaxLength
- *  - ui (for use with Node-RED Dashboard)
- *  - debugUseColors
- *  - debugMaxLength
- *  - debugStatusLength
- *  - execMaxBufferSize
- *  - httpRequestTimeout
- *  - mqttReconnectTime
- *  - serialReconnectTime
- *  - socketReconnectTime
- *  - socketTimeout
- *  - tcpMsgQueueSize
- *  - inboundWebSocketTimeout
- *  - tlsConfigDisableLocalFiles
- *  - webSocketNodeVerifyClient
- ******************************************************************************/
+    /*******************************************************************************
+     * Node Settings
+     *  - fileWorkingDirectory
+     *  - functionGlobalContext
+     *  - functionExternalModules
+     *  - functionTimeout
+     *  - nodeMessageBufferMaxLength
+     *  - ui (for use with Node-RED Dashboard)
+     *  - debugUseColors
+     *  - debugMaxLength
+     *  - debugStatusLength
+     *  - execMaxBufferSize
+     *  - httpRequestTimeout
+     *  - mqttReconnectTime
+     *  - serialReconnectTime
+     *  - socketReconnectTime
+     *  - socketTimeout
+     *  - tcpMsgQueueSize
+     *  - inboundWebSocketTimeout
+     *  - tlsConfigDisableLocalFiles
+     *  - webSocketNodeVerifyClient
+     ******************************************************************************/
 
     /** The working directory to handle relative file paths from within the File nodes
      * defaults to the working directory of the Node-RED process.