node-red-contrib-homebridge-automation 0.3.0-beta.2 → 0.3.0-beta.20

package/README.md

@@ -199,6 +199,8 @@ 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.
+- Fix for some camara devices not outputing events
 
 # Backlog / Roadmap
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-homebridge-automation",
-  "version": "0.3.0-beta.2",
+  "version": "0.3.0-beta.20",
   "description": "NodeRED Automation for HomeBridge",
   "main": "src/HAP-NodeRed.js",
   "scripts": {
@@ -28,10 +28,10 @@
     "@types/node-red": "^1.3.5",
     "@types/jest": "^29.5.14",
     "@eslint/js": "^9.16.0",
-    "eslint": "^8.57.1",
-    "eslint-plugin-format": "^0.1.2",
-    "eslint-plugin-jest": "^28.8.3",
-    "globals": "^15.13.0",
+    "eslint": "^9.36.0",
+    "eslint-plugin-format": "^1.0.2",
+    "eslint-plugin-jest": "^29.0.1",
+    "globals": "^16.4.0",
     "jest": "^29.7.0",
     "node-red": "^4.0.2",
     "node-red-node-test-helper": "^0.3.4",
@@ -41,8 +41,8 @@
   },
   "dependencies": {
     "better-queue": ">=3.8.12",
-    "debug": "^4.3.7",
-    "@homebridge/hap-client": "^2.1.0-beta.5"
+    "debug": "^4.4.1",
+    "@homebridge/hap-client": "^3.1.1"
   },
   "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) => {
@@ -86,9 +88,9 @@ class HBConfigNode {
 
   toList(perms) {
     const supportedTypes = new Set([
-      'Battery', 'Carbon Dioxide Sensor', 'Carbon Monoxide Sensor', 'Camera Rtp Stream Management',
+      'Air Purifier', 'Air Quality Sensor', 'Battery', 'Carbon Dioxide Sensor', 'Carbon Monoxide Sensor', 'Camera Rtp Stream Management',
       'Doorbell', 'Fan', 'Fanv2', 'Garage Door Opener', 'Humidity Sensor', 'Input Source',
-      'Leak Sensor', 'Lightbulb', 'Lock Mechanism', 'Motion Sensor', 'Occupancy Sensor',
+      'Leak Sensor', 'Light Sensor', 'Lightbulb', 'Lock Mechanism', 'Motion Sensor', 'Occupancy Sensor',
       'Outlet', 'Smoke Sensor', 'Speaker', 'Stateless Programmable Switch', 'Switch',
       'Television', 'Temperature Sensor', 'Thermostat', 'Contact Sensor',
       'Window', 'Window Covering', 'Light Sensor'
@@ -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}'`);
       }
     };
 
@@ -170,8 +174,11 @@ class HBConfigNode {
       this.monitor = await this.hapClient.monitorCharacteristics(monitorNodes);
       this.monitor.on('service-update', (services) => {
         services.forEach(service => {
-          const eventNodes = Object.values(this.clientNodes).filter(clientNode =>
-            clientNode.config.device === `${service.instance.name}${service.instance.username}${service.accessoryInformation.Manufacturer}${service.serviceName}${service.uuid.slice(0, 8)}`
+          const eventNodes = Object.values(this.clientNodes).filter(clientNode => {
+            const deviceIdentifier = `${service.instance.name}${service.instance.username}${service.accessoryInformation.Manufacturer}${(service.accessoryInformation.Name ? service.accessoryInformation.Name : service.serviceName)}${service.uuid.slice(0, 8)}`;
+            // debug('service-update: compare', clientNode.config.device, deviceIdentifier);
+            return clientNode.config.device === deviceIdentifier;
+          }
           );
           // debug('service-update', service.serviceName, eventNodes);
           eventNodes.forEach(eventNode => eventNode.emit('hbEvent', service));

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 {
@@ -20,7 +20,6 @@ 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 = {
@@ -94,7 +92,6 @@ describe('from files', () => {
   let mockConfig;
   let RED;
   let node;
-  let mockHapClient;
 
   beforeEach(() => {
     mockConfig = {

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,12 +60,13 @@ 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);
         }