node-red-contrib-homebridge-automation 0.3.0-beta.0 → 0.3.0-beta.10

package/README.md

@@ -35,7 +35,9 @@ The above Node-RED Flow, turns on my 'Outside Office' light when the powder room
       * [Jan 11, 2023 - Version 0.1.7](#jan-11-2023---version-017)
       * [Jan 15, 2023 - Version 0.1.8](#jan-15-2023---version-018)
       * [Dec 15, 2024 - Version 0.2.0](#dec-15-2024---version-020)
-      * [April 15, 2025 - Version 0.2.2](#april-15-2025---version-022)
+      * [April 15, 2025 - Version 0.3.0](#april-15-2025---version-030)
+         * [Breaking Change](#breaking-change)
+         * [Fixes](#fixes)
 * [Backlog / Roadmap](#backlog--roadmap)
    * [Dropped items](#dropped-items)
 * [Installation Steps](#installation-steps)
@@ -187,10 +189,17 @@ With a plugin, you can see if it supports Real Time events, by opening the Home
 - With the change in connectivity to homebridge, please validate all your nodes are connected after the update.  And pay particular attention to `Camera` nodes, as for some devices the name has changed.
 - Testing and Development was completed on Node-RED version: v4.0.2 and Node.js  version: v20.18.1
 
-### April 15, 2025 - Version 0.2.2
+### April 15, 2025 - Version 0.3.0
+
+#### Breaking Change
+
+- Problem when choosing between multiple accessories with the same name #142. This fix has a breaking change for the name structure for Fans, Input Sources from TV's, and Camera's.  And these devices will need to be configured again.
+
+#### Fixes
 
 - Add common supported types Window, Window Covering, Light Sensor #151, tks @HDeKnop
 - HB-Control Node Turns Off then On when this message is received #152
+- Added `Debug logging` configuration option that creates a file `homebridge-automation-endpoints.json`, which contains all the homebridge devices discovered.  It can be used as part of troubleshooting device issues.
 
 # Backlog / Roadmap
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-homebridge-automation",
-  "version": "0.3.0-beta.0",
+  "version": "0.3.0-beta.10",
   "description": "NodeRED Automation for HomeBridge",
   "main": "src/HAP-NodeRed.js",
   "scripts": {
@@ -42,7 +42,7 @@
   "dependencies": {
     "better-queue": ">=3.8.12",
     "debug": "^4.3.7",
-    "@homebridge/hap-client": "^2.1.0-beta.5"
+    "@homebridge/hap-client": "^2.1.0"
   },
   "author": "NorthernMan54",
   "license": "ISC",

package/src/HAP-NodeRed.html

@@ -7,10 +7,23 @@
 	    <label for="node-config-input-macAddress"><i class="icon-wifi"></i> MAC Address (optional)</label>
 	    <input type="text" id="node-config-input-macAddress" placeholder="00:00:00:A1:2B:CC">
   </div>
+  <div class="form-row">
+    <label for="node-config-input-debug"><i class="icon-tag"></i>Debug Logging</label>
+    <input type="checkbox" id="node-config-input-debug" placeholder=false>
+</div>
 </script>
 
 <script type="text/x-red" data-help-name="hb-conf">
-  <p>This allows you to register your homebridge PIN</p>
+  <p>Configuration Node for Homebridge</p>
+  <h3>Settings</h3>
+  <dl class="message-properties">
+      <dt>PIN<span class="property-type">string</span></dt>
+      <dd>Please enter the PIN from your homebridge instances.  Please note that the same pin must be used for all instances.</dd>
+      <dt>MAC Address<span class="property-type">object</span></dt>
+      <dd>Optional - Not implemented</dd>
+      <dt>Debug Logging<span class="property-type">string</span></dt>
+      <dd>Enables debug logging and creates a file `homebridge-automation-endpoints.json`, which contains all the homebridge devices discovered.  It can be used as part of troubleshooting device issues.</dd>
+  </dl>
 </script>
 
 <script type="text/javascript">
@@ -36,6 +49,10 @@
         },
         required: false
       },
+      debug: {
+        value: false,
+        required: false
+      }
     },
     credentials: {
       password: {

package/src/hbConfigNode.js

@@ -2,6 +2,7 @@ const { HapClient } = require('@homebridge/hap-client');
 const debug = require('debug')('hapNodeRed:hbConfigNode');
 const fs = require('fs');
 const path = require('path');
+const process = require('process');
 
 class HBConfigNode {
   constructor(config, RED) {
@@ -10,6 +11,7 @@ class HBConfigNode {
     // Initialize properties
     this.username = config.username;
     this.macAddress = config.macAddress || '';
+    this.debugLogging = config.debug || false;
     this.users = {};
     this.homebridge = null;
     this.evDevices = [];
@@ -53,14 +55,14 @@ class HBConfigNode {
    */
   async handleReady() {
     const updatedDevices = await this.hapClient.getAllServices();
-    if (this.debug && updatedDevices && updatedDevices.length) {
+    if (this.debugLogging && updatedDevices && updatedDevices.length && process.uptime() < 300) {
       try {
-        const storagePath = path.join(process.cwd(), '/homebridge-automation-endpoints.json');
+        const storagePath = path.join(process.cwd(), 'homebridge-automation-endpoints.json');
         this.warn(`Writing Homebridge endpoints to ${storagePath}`);
         fs.writeFileSync(storagePath, JSON.stringify(updatedDevices, null, 2));
       } catch (e) {
         this.error(`Error writing Homebridge endpoints to file: ${e.message}`);
-      } 
+      }
     }
     // Fix broken uniqueId's from HAP-Client
     updatedDevices.forEach((service) => {
@@ -136,10 +138,12 @@ class HBConfigNode {
   async connectClientNodes() {
     debug('connect %s nodes', Object.keys(this.clientNodes).length);
     for (const [key, clientNode] of Object.entries(this.clientNodes)) {
-      // debug('_Register: %s type: %s', clientNode.type, clientNode.name, clientNode.instance);
-      const matchedDevice = this.hbDevices.find(service =>
-        clientNode.device === `${service.instance.name}${service.instance.username}${service.accessoryInformation.Manufacturer}${service.serviceName}${service.uuid.slice(0, 8)}`
-      );
+      // debug('_Register: %s type: "%s" "%s" "%s"', clientNode.type, clientNode.name, clientNode.instance, clientNode.device);
+      const matchedDevice = this.hbDevices.find(service => {
+        const friendlyName = (service.accessoryInformation.Name ? service.accessoryInformation.Name : service.serviceName);
+        const deviceIdentifier = `${service.instance.name}${service.instance.username}${service.accessoryInformation.Manufacturer}${friendlyName}${service.uuid.slice(0, 8)}`;
+        return clientNode.device === deviceIdentifier;
+      });
 
       if (matchedDevice) {
         clientNode.hbDevice = matchedDevice;
@@ -147,7 +151,7 @@ class HBConfigNode {
         clientNode.emit('hbReady', matchedDevice);
         debug('_Registered: %s type: %s', clientNode.type, matchedDevice.type, matchedDevice.serviceName);
       } else {
-        this.error(`ERROR: Device registration failed '${clientNode.fullName}'`);
+        this.error(`ERROR: Device registration failed '${clientNode.fullName}' - '${clientNode.device}'`);
       }
     };
 

package/src/hbConfigNode.test.js

@@ -1,6 +1,8 @@
-
-const { HapClient } = require('@homebridge/hap-client');
+// File: src/hbConfigNode.test.js
 const HBConfigNode = require('./hbConfigNode'); // Update the path as necessary
+const fs = require('fs');
+const path = require('path');
+const process = require('process');
 
 jest.mock('@homebridge/hap-client', () => {
   return {
@@ -14,11 +16,10 @@ jest.mock('@homebridge/hap-client', () => {
   };
 });
 
-describe.skip('Issue 142', () => {
+describe('Issue 142', () => {
   let mockConfig;
   let RED;
   let node;
-  let mockHapClient;
 
   beforeEach(() => {
     mockConfig = {
@@ -55,7 +56,6 @@ describe('HBConfigNode', () => {
   let mockConfig;
   let RED;
   let node;
-  let mockHapClient;
 
   beforeEach(() => {
     mockConfig = {
@@ -77,23 +77,84 @@ describe('HBConfigNode', () => {
 
   test('Retrieve devices', async () => {
     node.hapClient.getAllServices.mockResolvedValue(testhbDevices);
-    console.log('testhbDevices', testhbDevices);
     await node.handleReady();
     const result = node.toList({ perms: 'ev' });
     expect(result).toEqual(testhbDevicesResult);
 
     // Ensure the unsupported type was filtered out
     expect(result.find(device => device.name === 'Garage Sensor')).toBeUndefined();
-    expect(result.find(device => device.name === 'Kitchen Curtain')).toBeDefined();
-    expect(result.find(device => device.name === 'Livingroom Curtain')).toBeDefined();
+    // expect(result.find(device => device.name === 'Kitchen Curtain')).toBeDefined();
+    // expect(result.find(device => device.name === 'Livingroom Curtain')).toBeDefined();
   });
+});
+
+describe('from files', () => {
+  let mockConfig;
+  let RED;
+  let node;
+
+  beforeEach(() => {
+    mockConfig = {
+      username: '123-45-678',
+      macAddress: '00:11:22:33:44:55',
+    };
+
+    RED = {
+      nodes: {
+        createNode: jest.fn(),
+      },
+    };
 
-  test.skip('toList filters and maps camera devices correctly', () => {
+    node = new HBConfigNode(mockConfig, RED);
+    // node.debug = true;
+    node.warn = console.log;
+    node.log = console.log;
+  });
+
+  test.skip('Retrieve devices, and compare with current (v2)', async () => {
+    // console.log('Reading Homebridge endpoints from file', process.cwd());
+    var storagePath = path.join(process.cwd(), 'test/homebridge-automation-endpoints.json');
+    // console.log(`Reading Homebridge endpoints from ${storagePath}`);
+    const fileHbDevices = JSON.parse(fs.readFileSync(storagePath, 'utf8'));
+
+    node.hapClient.getAllServices.mockResolvedValue(fileHbDevices);
+    // console.log('testhbDevices', fileHbDevices);
+    await node.handleReady();
     const result = node.toList({ perms: 'ev' });
-    expect(result).toEqual(testhbDevicesResult);
+
+    storagePath = path.join(process.cwd(), 'test/homebridge-automation-hbDevices-v2.json');
+    // console.log(`Reading Homebridge results from ${storagePath}`);
+    const fileResult = JSON.parse(fs.readFileSync(storagePath, 'utf8'));
+    expect(result.length).toBe(107);
+    expect(result).toEqual(fileResult);
 
     // Ensure the unsupported type was filtered out
     expect(result.find(device => device.name === 'Garage Sensor')).toBeUndefined();
+    // expect(result.find(device => device.name === 'Kitchen Curtain')).toBeDefined();
+    // expect(result.find(device => device.name === 'Livingroom Curtain')).toBeDefined();
+  });
+
+  test('Retrieve devices, and compare with future (v3)', async () => {
+    // console.log('Reading Homebridge endpoints from file', process.cwd());
+    var storagePath = path.join(process.cwd(), 'test/homebridge-automation-endpoints.json');
+    // console.log(`Reading Homebridge endpoints from ${storagePath}`);
+    const fileHbDevices = JSON.parse(fs.readFileSync(storagePath, 'utf8'));
+
+    node.hapClient.getAllServices.mockResolvedValue(fileHbDevices);
+    // console.log('testhbDevices', fileHbDevices);
+    await node.handleReady();
+    const result = node.toList({ perms: 'ev' });
+
+    storagePath = path.join(process.cwd(), 'test/homebridge-automation-hbDevices-v3.json');
+    // console.log(`Reading Homebridge results from ${storagePath}`);
+    const fileResult = JSON.parse(fs.readFileSync(storagePath, 'utf8'));
+    expect(result.length).toBe(107);
+    expect(result).toEqual(fileResult);
+
+    // Ensure the unsupported type was filtered out
+    expect(result.find(device => device.name === 'Garage Sensor')).toBeUndefined();
+    // expect(result.find(device => device.name === 'Kitchen Curtain')).toBeDefined();
+    // expect(result.find(device => device.name === 'Livingroom Curtain')).toBeDefined();
   });
 });
 
@@ -2148,7 +2209,7 @@ const testhbDevicesResult = [
     name: 'Backyard',
     fullName: 'Backyard - Camera Rtp Stream Management',
     sortName: 'Backyard:CameraRTPStreamManagement',
-    uniqueId: '924c9390e6a89452936dfff957faa127d87e78e3c1b5084863495a184804fe56',
+    uniqueId: 'homebridge0E:89:A7:DA:D3:21EufyBackyard00000110',
     homebridge: 'homebridge',
     service: 'CameraRTPStreamManagement',
     manufacturer: 'Eufy'
@@ -2157,7 +2218,7 @@ const testhbDevicesResult = [
     name: 'Backyard',
     fullName: 'Backyard - Motion Sensor',
     sortName: 'Backyard:MotionSensor',
-    uniqueId: 'c9efb02acc5cabb2b164d4c479355551a6360345571b31de50e90f4a1fa42df6',
+    uniqueId: 'homebridge0E:89:A7:DA:D3:21EufyBackyard00000085',
     homebridge: 'homebridge',
     service: 'MotionSensor',
     manufacturer: 'Eufy'
@@ -2169,22 +2230,22 @@ const testhbDevicesResult = [
     "name": "Canoe 5036",
     "service": "CameraRTPStreamManagement",
     "sortName": "Canoe 5036:CameraRTPStreamManagement",
-    "uniqueId": "9959f43e6f32e451a9c13e0c028d863fa148c39cbbcb57f93d8d825fc31f8865",
+    "uniqueId": "ECI-T24F25C:EE:FE:4D:64:B4HikVisionCanoe 503600000110",
   },
   {
-    "fullName": "Canoe - Motion Sensor",
+    "fullName": "Canoe 5036 - Motion Sensor",
     "homebridge": "ECI-T24F2",
     "manufacturer": "HikVision",
-    "name": "Canoe",
+    "name": "Canoe 5036",
     "service": "MotionSensor",
-    "sortName": "Canoe:MotionSensor",
-    "uniqueId": "10dbaceb026b81f56c6226eca2c30b7ba06c29de632253972402bd3f489096f1",
+    "sortName": "Canoe 5036:MotionSensor",
+    "uniqueId": "ECI-T24F25C:EE:FE:4D:64:B4HikVisionCanoe 503600000085",
   },
   {
     name: 'Side door',
     fullName: 'Side door - Camera Rtp Stream Management',
     sortName: 'Side door:CameraRTPStreamManagement',
-    uniqueId: 'e8e6aec782cd554108e95e4a61b7fa4e941f2c63b9e656e6c828ac89e26e2dbd',
+    uniqueId: 'homebridge0E:89:A7:DA:D3:21EufySide door00000110',
     homebridge: 'homebridge',
     service: 'CameraRTPStreamManagement',
     manufacturer: 'Eufy'
@@ -2193,7 +2254,7 @@ const testhbDevicesResult = [
     name: 'Side door',
     fullName: 'Side door - Motion Sensor',
     sortName: 'Side door:MotionSensor',
-    uniqueId: 'f4827932577f2073ae5584a4a66607a1dd67af9b3e5bf22d59dffdc702d0f240',
+    uniqueId: 'homebridge0E:89:A7:DA:D3:21EufySide door00000085',
     homebridge: 'homebridge',
     service: 'MotionSensor',
     manufacturer: 'Eufy'

package/src/hbControlNode.js

@@ -53,7 +53,6 @@ class HbControlNode extends hbBaseNode {
           const result = await this.hbDevice.setCharacteristicsByTypes(filterIfOff(message.payload));
           results.push(result.values);
         } catch (error) {
-          console.log(error)
           this.error(`Failed to set value for "${JSON.stringify(message.payload)}": ${error.message}`);
           results.push({ 'Error': `Error: ${error.message}` });
           fill = 'red';