node-red-contrib-homebridge-automation 0.3.0-beta.1 → 0.3.0-beta.11

package/README.md

@@ -9,59 +9,59 @@ The above Node-RED Flow, turns on my 'Outside Office' light when the powder room
 # Table of Contents
 
 <!--ts-->
-- [Homebridge Automation powered by Node-RED](#homebridge-automation-powered-by-node-red)
-- [Table of Contents](#table-of-contents)
-- [Introduction](#introduction)
-  - [Caveats](#caveats)
-  - [Changes](#changes)
-    - [Mar 18, 2019 - Version 0.0.39](#mar-18-2019---version-0039)
-    - [Mar 19, 2019 - Version 0.0.42](#mar-19-2019---version-0042)
-    - [Mar 31, 2019 - Version 0.0.](#mar-31-2019---version-00)
-    - [May 9, 2019 - Version 0.0.43](#may-9-2019---version-0043)
-    - [May 15, 2019 - Version 0.0.44](#may-15-2019---version-0044)
-    - [May 29, 2019 - Version 0.0.45](#may-29-2019---version-0045)
-    - [July 27, 2019 - Version 0.0.50](#july-27-2019---version-0050)
-    - [Feb 24, 2020 - Version 0.0.56](#feb-24-2020---version-0056)
-    - [Mar 18, 2020 - Version 0.0.59](#mar-18-2020---version-0059)
-    - [Oct 13, 2020 - Version 0.0.71](#oct-13-2020---version-0071)
-    - [Oct 24, 2020 - Version 0.0.71](#oct-24-2020---version-0071)
-    - [Nov 1, 2020 - Version 0.0.73](#nov-1-2020---version-0073)
-    - [Nov 13, 2020 - Version 0.0.76](#nov-13-2020---version-0076)
-    - [Feb 2, 2021 - Version 0.0.78](#feb-2-2021---version-0078)
-    - [Mar 9, 2021 - Version 0.0.80](#mar-9-2021---version-0080)
-    - [April 23, 2021 - Version 0.0.82](#april-23-2021---version-0082)
-    - [Dec 31, 2022 - Version 0.1.3](#dec-31-2022---version-013)
-    - [Jan 6, 2023 - Version 0.1.5](#jan-6-2023---version-015)
-    - [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.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)
-  - [1 - Install Node-RED and Homebridge](#1---install-node-red-and-homebridge)
-  - [2 - Prepare Homebridge for integration with Homebridge-Automation](#2---prepare-homebridge-for-integration-with-homebridge-automation)
-  - [3 - Install Homebridge-Automation into Node-Red](#3---install-homebridge-automation-into-node-red)
-  - [4 - Start Node-Red](#4---start-node-red)
-  - [5 - Initial setup and configuration inside Node-Red](#5---initial-setup-and-configuration-inside-node-red)
-  - [6 - Configure 'hb event' to receive updates from your Accessories](#6---configure-hb-event-to-receive-updates-from-your-accessories)
-- [Node-RED Homebridge-Automation Message Structure](#node-red-homebridge-automation-message-structure)
-  - [hb event](#hb-event)
-    - [Output](#output)
-  - [hb resume](#hb-resume)
-    - [input](#input)
-    - [output](#output-1)
-  - [hb status](#hb-status)
-    - [input](#input-1)
-    - [output](#output-2)
-  - [hb control](#hb-control)
-    - [Input](#input-2)
-- [Flows Shared from Community](#flows-shared-from-community)
-- [Donations](#donations)
-- [Troubleshooting / DEBUG MODE](#troubleshooting--debug-mode)
-  - [To start Node-RED in DEBUG mode, and output Homebridge-Automation debug logs start Node-RED like this.](#to-start-node-red-in-debug-mode-and-output-homebridge-automation-debug-logs-start-node-red-like-this)
+* [Homebridge Automation powered by Node-RED](#homebridge-automation-powered-by-node-red)
+* [Table of Contents](#table-of-contents)
+* [Introduction](#introduction)
+   * [Caveats](#caveats)
+   * [Changes](#changes)
+      * [Mar 18, 2019 - Version 0.0.39](#mar-18-2019---version-0039)
+      * [Mar 19, 2019 - Version 0.0.42](#mar-19-2019---version-0042)
+      * [Mar 31, 2019 - Version 0.0.](#mar-31-2019---version-00)
+      * [May 9, 2019 - Version 0.0.43](#may-9-2019---version-0043)
+      * [May 15, 2019 - Version 0.0.44](#may-15-2019---version-0044)
+      * [May 29, 2019 - Version 0.0.45](#may-29-2019---version-0045)
+      * [July 27, 2019 - Version 0.0.50](#july-27-2019---version-0050)
+      * [Feb 24, 2020 - Version 0.0.56](#feb-24-2020---version-0056)
+      * [Mar 18, 2020 - Version 0.0.59](#mar-18-2020---version-0059)
+      * [Oct 13, 2020 - Version 0.0.71](#oct-13-2020---version-0071)
+      * [Oct 24, 2020 - Version 0.0.71](#oct-24-2020---version-0071)
+      * [Nov 1, 2020 - Version 0.0.73](#nov-1-2020---version-0073)
+      * [Nov 13, 2020 - Version 0.0.76](#nov-13-2020---version-0076)
+      * [Feb 2, 2021 - Version 0.0.78](#feb-2-2021---version-0078)
+      * [Mar 9, 2021 - Version 0.0.80](#mar-9-2021---version-0080)
+      * [April 23, 2021 - Version 0.0.82](#april-23-2021---version-0082)
+      * [Dec 31, 2022 - Version 0.1.3](#dec-31-2022---version-013)
+      * [Jan 6, 2023 - Version 0.1.5](#jan-6-2023---version-015)
+      * [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.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)
+   * [1 - Install Node-RED and Homebridge](#1---install-node-red-and-homebridge)
+   * [2 - Prepare Homebridge for integration with Homebridge-Automation](#2---prepare-homebridge-for-integration-with-homebridge-automation)
+   * [3 - Install Homebridge-Automation into Node-Red](#3---install-homebridge-automation-into-node-red)
+   * [4 - Start Node-Red](#4---start-node-red)
+   * [5 - Initial setup and configuration inside Node-Red](#5---initial-setup-and-configuration-inside-node-red)
+   * [6 - Configure 'hb event' to receive updates from your Accessories](#6---configure-hb-event-to-receive-updates-from-your-accessories)
+* [Node-RED Homebridge-Automation Message Structure](#node-red-homebridge-automation-message-structure)
+   * [hb event](#hb-event)
+      * [Output](#output)
+   * [hb resume](#hb-resume)
+      * [input](#input)
+      * [output](#output-1)
+   * [hb status](#hb-status)
+      * [input](#input-1)
+      * [output](#output-2)
+   * [hb control](#hb-control)
+      * [Input](#input-2)
+* [Flows Shared from Community](#flows-shared-from-community)
+* [Donations](#donations)
+* [Troubleshooting / DEBUG MODE](#troubleshooting--debug-mode)
+   * [To start Node-RED in DEBUG mode, and output Homebridge-Automation debug logs start Node-RED like this.](#to-start-node-red-in-debug-mode-and-output-homebridge-automation-debug-logs-start-node-red-like-this)
 <!--te-->
 
 # Introduction
@@ -199,6 +199,7 @@ With a plugin, you can see if it supports Real Time events, by opening the Home
 
 - 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.1",
+  "version": "0.3.0-beta.11",
   "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,8 +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 {
@@ -16,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 = {
@@ -57,7 +56,6 @@ describe('HBConfigNode', () => {
   let mockConfig;
   let RED;
   let node;
-  let mockHapClient;
 
   beforeEach(() => {
     mockConfig = {
@@ -90,11 +88,10 @@ describe('HBConfigNode', () => {
   });
 });
 
-describe.only('from files', () => {
+describe('from files', () => {
   let mockConfig;
   let RED;
   let node;
-  let mockHapClient;
 
   beforeEach(() => {
     mockConfig = {
@@ -114,10 +111,10 @@ describe.only('from files', () => {
     node.log = console.log;
   });
 
-  test('Retrieve devices, and compare with current (v2)', async () => {
-    console.log('Reading Homebridge endpoints from file', process.cwd());
+  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}`);
+    // console.log(`Reading Homebridge endpoints from ${storagePath}`);
     const fileHbDevices = JSON.parse(fs.readFileSync(storagePath, 'utf8'));
 
     node.hapClient.getAllServices.mockResolvedValue(fileHbDevices);
@@ -126,7 +123,7 @@ describe.only('from files', () => {
     const result = node.toList({ perms: 'ev' });
 
     storagePath = path.join(process.cwd(), 'test/homebridge-automation-hbDevices-v2.json');
-    console.log(`Reading Homebridge results from ${storagePath}`);
+    // console.log(`Reading Homebridge results from ${storagePath}`);
     const fileResult = JSON.parse(fs.readFileSync(storagePath, 'utf8'));
     expect(result.length).toBe(107);
     expect(result).toEqual(fileResult);
@@ -138,9 +135,9 @@ describe.only('from files', () => {
   });
 
   test('Retrieve devices, and compare with future (v3)', async () => {
-    console.log('Reading Homebridge endpoints from file', process.cwd());
+    // 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}`);
+    // console.log(`Reading Homebridge endpoints from ${storagePath}`);
     const fileHbDevices = JSON.parse(fs.readFileSync(storagePath, 'utf8'));
 
     node.hapClient.getAllServices.mockResolvedValue(fileHbDevices);
@@ -149,7 +146,7 @@ describe.only('from files', () => {
     const result = node.toList({ perms: 'ev' });
 
     storagePath = path.join(process.cwd(), 'test/homebridge-automation-hbDevices-v3.json');
-    console.log(`Reading Homebridge results from ${storagePath}`);
+    // console.log(`Reading Homebridge results from ${storagePath}`);
     const fileResult = JSON.parse(fs.readFileSync(storagePath, 'utf8'));
     expect(result.length).toBe(107);
     expect(result).toEqual(fileResult);

package/src/hbControlNode.js

@@ -17,12 +17,12 @@ class HbControlNode extends hbBaseNode {
     const isCamera = this.hbDevice.type === 'CameraRTPStreamManagement';
     const payloadType = typeof message.payload;
 
-    // Validate payload
+    // Is the payload a valid JSON object?
+
     if (!isCamera && payloadType !== 'object') {
       const validNames = Object.keys(this.hbDevice.values)
         .filter(key => key !== 'ConfiguredName')
         .join(', ');
-
       this.error(
         `Invalid payload. Expected JSON object, e.g., {"On":false, "Brightness":0}. Valid values: ${validNames}`
       );
@@ -30,6 +30,16 @@ class HbControlNode extends hbBaseNode {
       return;
     }
 
+    // Validate payload
+    let keysToKeep = Object.keys(this.hbDevice.values);
+
+    Object.keys(message.payload).forEach(key => {
+      if (!keysToKeep.includes(key)) {
+        this.handleWarning(`Unhandled Characteristic '${key}'`);
+        delete message.payload[key];
+      }
+    });
+
     const results = [];
     let fill = 'green';
 
@@ -50,14 +60,15 @@ class HbControlNode extends hbBaseNode {
       } else {
         // Handle other characteristics
         try {
+          // debug('Setting value for', message.payload);
           const result = await this.hbDevice.setCharacteristicsByTypes(filterIfOff(message.payload));
+          // debug('Result', result.values);
           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}` });
+          this.error(`${error.message} for ${JSON.stringify(message.payload)}`);
+          results.push({ Error: `${error.message} for ${JSON.stringify(message.payload)}` });
           fill = 'red';
-          this.hbConfigNode.disconnectClientNodes(this.hbDevice.instance);
+          // this.hbConfigNode.disconnectClientNodes(this.hbDevice.instance);
         }
 
         /*