node-red-contrib-homebridge-automation 0.1.12-beta.27 → 0.1.12-beta.28

package/package.json

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

package/src/HAP-NodeRed.js

@@ -1,7 +1,5 @@
 var debug = require('debug')('hapNodeRed');
 
-// var register = require('./lib/register.js');
-
 const HBConfigNode = require('./hbConfigNode.js');
 const HbEventNode = require('./hbEventNode'); // Import the class
 const HbResumeNode = require('./hbResumeNode'); // Import the class
@@ -13,13 +11,6 @@ const HapDeviceRoutes = require('./HapDeviceRoutes');
 module.exports = function (RED) {
   var hbDevices;
 
-  /**
-   * hbConf - Configuration
-   *
-   * @param  {type} n description
-   * @return {type}   description
-   */
-
   class hbConfigNode extends HBConfigNode {
     constructor(config) {
       debug('hbConfigNode', config);
@@ -27,7 +18,6 @@ module.exports = function (RED) {
     }
   }
 
-  // console.log('Registering node types', "hb-conf", hbConfigNode);
   RED.nodes.registerType("hb-conf", hbConfigNode, {
     credentials: {
       password: {
@@ -36,11 +26,6 @@ module.exports = function (RED) {
     }
   });
 
-
-  /**
-   *  hbEventNode - description
-   * @param {*} n 
-   */
   class hbEventNode extends HbEventNode {
     constructor(config) {
       debug('hbEventNode', config);
@@ -50,9 +35,6 @@ module.exports = function (RED) {
 
   RED.nodes.registerType("hb-event", hbEventNode);
 
-  /**
-   * hbResumeNode - description
-   */
   class hbResumeNode extends HbResumeNode {
     constructor(config) {
       debug('hbResumeNode', config);
@@ -71,12 +53,6 @@ module.exports = function (RED) {
 
   RED.nodes.registerType("hb-control", hbControlNode);
 
-  /**
-   * hbStatus - description
-   *
-   * @param  {type} n description
-   * @return {type}   description
-   */
   class hbStatusNode extends HbStatusNode {
     constructor(config) {
       debug('hbStatusNode', config);

package/src/HapDeviceRoutes.js

@@ -33,7 +33,7 @@ class HapDeviceRoutes {
   getEvDeviceById(req, res) {
     debug('req', req.params.id);
     var evDevices = this.RED.nodes.getNode(req.params.id).evDevices;
-    debug('hbDevices', evDevices);
+    // debug('hbDevices', evDevices);
     debug("evDevices", evDevices.length);
     if (evDevices) {
       res.send(evDevices);
@@ -76,7 +76,7 @@ class HapDeviceRoutes {
 
   // GET /hap-device/ctDevices/
   getCtDevices(req, res) {
-    debug("ctDevices", this.hbDevices.toList({ perms: 'pw' }).length);
+    // debug("ctDevices", this.hbDevices.toList({ perms: 'pw' }).length);
     if (this.hbDevices) {
       res.send(this.hbDevices.toList({ perms: 'pw' }));
     } else {

package/src/hbBaseNode.js

@@ -58,116 +58,20 @@ class HbBaseNode {
     done();
   }
 
-  /*
-    registerNode() {
-      debug("Registering node:", this.fullName);
-      this.hbDevice = hbDevices.findDevice(this.device);
-  
-      if (!this.hbDevice) {
-        this.error(`Device not found: ${this.device}`);
-      } else {
-        this.deviceType = this.hbDevice.deviceType;
-      }
-    }
-  
-    handleClose(callback) {
-      debug('close', this.name);
-      callback();
-    }
-  
-    _convertHBcharacteristicToNode(hbMessage, node) {
-      let payload = {};
-      if (!hbMessage.payload) {
-        const device = hbDevices.findDevice(node.device);
-        if (device) {
-          hbMessage.forEach(characteristic => {
-            const charKey = `${characteristic.aid}.${characteristic.iid}`;
-            if (device.characteristics[charKey]) {
-              payload[device.characteristics[charKey].characteristic] = characteristic.value;
-            }
-          });
-        }
-      } else {
-        payload = hbMessage.payload;
-      }
-      return payload;
-    }
-  
-    _createControlMessage(payload, node, device) {
-      const response = [];
-      for (const key in payload) {
-        const characteristic = this._getKey(device.characteristics, key);
-        if (characteristic) {
-          response.push({
-            aid: device.aid,
-            iid: characteristic.iid,
-            value: payload[key],
-          });
-        } else {
-          this.warn(`Invalid characteristic: '${key}'. Available: ${device.descriptions}`);
-          node.status({ text: `Invalid characteristic: ${key}`, shape: 'ring', fill: 'yellow' });
-        }
-      }
-      return { characteristics: response };
-    }
-  
-    async _status(nrDevice, node, perms) {
-      try {
-        const device = hbDevices.findDevice(node.device, perms);
-        if (!device) throw new Error(`Device not found: ${nrDevice}`);
-  
-        const message = device.type === "00000110" || device.type === "00000111"
-          ? { "resource-type": "image", "image-width": 1920, "image-height": 1080 }
-          : `?id=${device.getCharacteristics}`;
-  
-        const status = device.type === "00000110" || device.type === "00000111"
-          ? await this.HAPresourceByDeviceIDAsync(device.id, JSON.stringify(message))
-          : await this.HAPstatusByDeviceIDAsync(device.id, message);
-  
-        node.status({ text: 'Success', shape: 'dot', fill: 'green' });
-        return device.type === "00000110" || device.type === "00000111"
-          ? { characteristics: { payload: this.btoa(status) } }
-          : status;
-      } catch (err) {
-        debug("Error in _status:", err);
-        node.status({ text: 'Error retrieving status', shape: 'ring', fill: 'red' });
-        throw err;
-      }
-    }
-  
-    async _register(node) {
-      try {
-        const device = hbDevices.findDevice(node.device, { perms: 'ev' });
-        if (device) {
-          const message = { characteristics: device.eventRegisters };
-          await hapEventByDeviceIDAsync(device.id, JSON.stringify(message));
-        }
-      } catch (err) {
-        debug("Error in _register:", err);
-        node.status({ text: 'Register error', shape: 'ring', fill: 'red' });
-      }
-    }
-  
-    _getKey(obj, value) {
-      return Object.values(obj).find(char => char.characteristic.toLowerCase() === value.toLowerCase()) || null;
-    }
-  
-    btoa(str) {
-      return Buffer.from(str.toString(), 'binary').toString('base64');
-    }
-  
-    async HAPresourceByDeviceIDAsync(deviceId, message) {
-      return new Promise((resolve, reject) => {
-        homebridge.HAPresourceByDeviceID(deviceId, message, (err, status) => err ? reject(err) : resolve(status));
-      });
-    }
-  
-    async HAPstatusByDeviceIDAsync(deviceId, message) {
-      return new Promise((resolve, reject) => {
-        homebridge.HAPstatusByDeviceID(deviceId, message, (err, status) => err ? reject(err) : resolve(status));
-      });
-    }
-    */
+  /**
+   * 
+   * @param {*} warning - Message to log and display in debug panel
+   * @param {*} statusText - Message to display under Node ( If not present, uses warning message text)
+   */
+  handleError(warning, statusText) {
+    this.warn(warning);
+    this.status({
+      text: (statusText ? statusText : warning),
+      shape: 'ring',
+      fill: 'red',
+    });
+  }
+
 }
 
 module.exports = HbBaseNode;

package/src/hbControlNode.js

@@ -9,8 +9,7 @@ class HbControlNode extends hbBaseNode {
   async handleInput(message, send) {
     debug('handleInput', message.payload, this.name);
     if (!this.hbDevice) {
-      this.error('HB not initialized');
-      this.status({ text: 'HB not initialized', shape: 'ring', fill: 'red' });
+      this.handleError('HB not initialized');
       return;
     }
 

package/src/hbResumeNode.js

@@ -6,30 +6,24 @@ class HbResumeNode extends HbBaseNode {
     super(config, RED);
 
     this.storedState = null;
-
-    // Set up input and command handlers
-    // this.on('input', this.handleInput.bind(this));
-    this.command = this.handleCommand.bind(this);
-
-    // Handle device registration
-    debug('hbResume - hbConfigNode', this.hbConfigNode);
   }
 
   handleInput(message, send) {
     debug('handleInput', message.payload, this.name);
 
     if (!this.hbDevice) {
-      this.warn('HB not initialized');
-      this.status({ text: 'HB not initialized', shape: 'ring', fill: 'red' });
+      this.handleError('HB not initialized');
       return;
     }
 
-    if (typeof message.payload !== 'object') {
+    if (typeof message.payload !== 'object' || typeof message.payload.On !== 'boolean') {
       const validNames = Object.keys(this.hbDevice.values)
         .filter(key => key !== 'ConfiguredName')
         .join(', ');
-      this.warn(`Payload should be a JSON object containing device characteristics and values, e.g. {"On":false, "Brightness":0}. Valid values: ${validNames}`);
-      this.status({ text: 'Invalid payload', shape: 'dot', fill: 'red' });
+      this.handleError(
+        `Invalid payload. Expected: {"On": false, "Brightness": 0}. Valid values: ${validNames}`,
+        'Invalid payload'
+      );
       return;
     }
 
@@ -37,18 +31,20 @@ class HbResumeNode extends HbBaseNode {
     // if off, if storedState, then send stored state else passthru
 
     if (message.payload.On) {
-      this.storedState = this.hbDevice.values;
-      debug('Storing', this.storedState);
-    } else if (!message.payload.On && this.storedState) {
-      debug('Restoring', this.storedState)
-      message.payload = { ...message.payload, ...this.storedState }
+      this.storedState = JSON.parse(JSON.stringify(this.hbDevice.values));
+      debug('Storing state', this.storedState);
+    } else if (this.storedState) {
+      debug('Restoring state', this.storedState);
+      message.payload = { ...this.storedState, ...message.payload };
       this.storedState = null;
     }
+
     this.status({
       text: JSON.stringify(message.payload),
       shape: 'dot',
       fill: 'green',
     });
+
     send(message);
   }
 

package/src/hbStatusNode.js

@@ -10,8 +10,7 @@ class HbStatusNode extends HbBaseNode {
     debug('handleInput', message.payload, this.name);
 
     if (!this.hbDevice) {
-      this.error('HB not initialized');
-      this.status({ text: 'HB not initialized', shape: 'ring', fill: 'red' });
+      this.handleError('HB not initialized');
       return;
     }
 

package/test/node-red/flows.json

@@ -26,8 +26,8 @@
         "targetType": "full",
         "statusVal": "payload",
         "statusType": "auto",
-        "x": 800,
-        "y": 140,
+        "x": 820,
+        "y": 40,
         "wires": []
     },
     {
@@ -43,8 +43,8 @@
         "targetType": "full",
         "statusVal": "payload",
         "statusType": "auto",
-        "x": 800,
-        "y": 260,
+        "x": 820,
+        "y": 100,
         "wires": []
     },
     {
@@ -68,8 +68,8 @@
         "topic": "",
         "payload": "",
         "payloadType": "date",
-        "x": 250,
-        "y": 140,
+        "x": 270,
+        "y": 40,
         "wires": [
             [
                 "3d7babac3a298e60"
@@ -86,8 +86,8 @@
         "Service": "Lightbulb",
         "device": "homebridge1C:22:3D:E3:CF:34TasmotaWest Bedroom00000043",
         "conf": "557aec8e8c47e61e",
-        "x": 480,
-        "y": 140,
+        "x": 500,
+        "y": 40,
         "wires": [
             [
                 "902c5887b6877df6"
@@ -104,8 +104,8 @@
         "Service": "Lightbulb",
         "device": "homebridge1C:22:3D:E3:CF:34TasmotaWest Bedroom00000043",
         "conf": "557aec8e8c47e61e",
-        "x": 480,
-        "y": 460,
+        "x": 500,
+        "y": 160,
         "wires": [
             [
                 "1093ab38b01fd39f"
@@ -125,8 +125,8 @@
         "targetType": "msg",
         "statusVal": "payload",
         "statusType": "auto",
-        "x": 800,
-        "y": 460,
+        "x": 820,
+        "y": 160,
         "wires": []
     },
     {
@@ -140,37 +140,10 @@
         "device": "homebridge1C:22:3D:E3:CF:34TasmotaWest Bedroom Fan00000040",
         "conf": "557aec8e8c47e61e",
         "outputs": 0,
-        "x": 810,
-        "y": 600,
+        "x": 510,
+        "y": 220,
         "wires": []
     },
-    {
-        "id": "d9f8181e9e6b3cfd",
-        "type": "inject",
-        "z": "caef1e7b5b399e80",
-        "name": "",
-        "props": [
-            {
-                "p": "payload"
-            },
-            {
-                "p": "topic",
-                "vt": "str"
-            }
-        ],
-        "repeat": "60",
-        "crontab": "",
-        "once": true,
-        "onceDelay": "60",
-        "topic": "",
-        "payload": "",
-        "payloadType": "date",
-        "x": 210,
-        "y": 460,
-        "wires": [
-            []
-        ]
-    },
     {
         "id": "6703815a8874b156",
         "type": "hb-control",
@@ -181,10 +154,14 @@
         "Service": "Lightbulb",
         "device": "homebridge1C:22:3D:E3:CF:34TasmotaWest Bedroom00000043",
         "conf": "557aec8e8c47e61e",
-        "outputs": 0,
-        "x": 800,
-        "y": 680,
-        "wires": []
+        "outputs": 1,
+        "x": 500,
+        "y": 300,
+        "wires": [
+            [
+                "f194fc4bcb1997a9"
+            ]
+        ]
     },
     {
         "id": "24660f9d2862cee9",
@@ -207,8 +184,8 @@
         "topic": "",
         "payload": "{\"On\": true, \"RotationSpeed\": 33}",
         "payloadType": "json",
-        "x": 190,
-        "y": 580,
+        "x": 90,
+        "y": 180,
         "wires": [
             [
                 "0ed3cd7e0d60beda"
@@ -236,8 +213,8 @@
         "topic": "",
         "payload": "{\"On\": false}",
         "payloadType": "json",
-        "x": 210,
-        "y": 640,
+        "x": 110,
+        "y": 240,
         "wires": [
             [
                 "0ed3cd7e0d60beda"
@@ -265,8 +242,8 @@
         "topic": "",
         "payload": "{\"On\": true}",
         "payloadType": "json",
-        "x": 350,
-        "y": 800,
+        "x": 110,
+        "y": 280,
         "wires": [
             [
                 "6703815a8874b156"
@@ -294,8 +271,8 @@
         "topic": "",
         "payload": "{\"On\": false}",
         "payloadType": "json",
-        "x": 350,
-        "y": 860,
+        "x": 110,
+        "y": 340,
         "wires": [
             [
                 "6703815a8874b156"
@@ -323,8 +300,8 @@
         "topic": "",
         "payload": "",
         "payloadType": "date",
-        "x": 520,
-        "y": 540,
+        "x": 320,
+        "y": 260,
         "wires": [
             [
                 "6703815a8874b156",
@@ -353,8 +330,8 @@
         "topic": "",
         "payload": "{\"Off\": false}",
         "payloadType": "json",
-        "x": 490,
-        "y": 920,
+        "x": 110,
+        "y": 380,
         "wires": [
             [
                 "6703815a8874b156"
@@ -382,8 +359,8 @@
         "topic": "",
         "payload": "{\"On\": true}",
         "payloadType": "json",
-        "x": 150,
-        "y": 340,
+        "x": 110,
+        "y": 80,
         "wires": [
             [
                 "452e3e6171aa7a25"
@@ -411,8 +388,8 @@
         "topic": "",
         "payload": "{\"On\": false}",
         "payloadType": "json",
-        "x": 150,
-        "y": 400,
+        "x": 110,
+        "y": 140,
         "wires": [
             [
                 "452e3e6171aa7a25"
@@ -431,11 +408,28 @@
         "conf": "557aec8e8c47e61e",
         "sendInitialState": true,
         "x": 500,
-        "y": 260,
+        "y": 100,
         "wires": [
             [
                 "a866ae0bb24ce682"
             ]
         ]
+    },
+    {
+        "id": "f194fc4bcb1997a9",
+        "type": "debug",
+        "z": "caef1e7b5b399e80",
+        "name": "debug 4",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": true,
+        "complete": "payload",
+        "targetType": "msg",
+        "statusVal": "payload",
+        "statusType": "auto",
+        "x": 800,
+        "y": 300,
+        "wires": []
     }
 ]