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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-homebridge-automation",
-  "version": "0.1.12-beta.26",
+  "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

@@ -23,6 +23,9 @@ class HbBaseNode {
     if (this.handleInput) {
       this.on('input', this.handleInput.bind(this));
     }
+    if (this.handleHbReady) {
+      this.on('hbReady', this.handleHbReady.bind(this))
+    }
     this.on('close', this.handleClose.bind(this));
     this.on('hbEvent', this.handleHBEventMessage.bind(this));
   }
@@ -55,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

@@ -6,11 +6,10 @@ class HbControlNode extends hbBaseNode {
     super(config, RED);
   }
 
-  async handleInput(message) {
+  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/hbEventNode.js

@@ -5,7 +5,6 @@ class HbEventNode extends hbBaseNode {
   constructor(config, RED) {
     super(config, RED);
     this.sendInitialState = config.sendInitialState === true;
-    this.on('hbReady', this.handleHbReady.bind(this))
   }
 
   handleHbReady(service) {

package/src/hbResumeNode.js

@@ -5,140 +5,49 @@ class HbResumeNode extends HbBaseNode {
   constructor(config, RED) {
     super(config, RED);
 
-
-    this.state = null;
-    this.lastMessageTime = null;
-    this.lastMessageValue = null;
-    this.lastPayload = { On: false };
-    this.timeout = 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);
-    // debug('hbResume - hbConfigNode', this.configNode.hbConfigNode);
-
-  }
-
-  handleHBEventMessage(service) {
-    debug('topic for', this.id, service.serviceName, service.values);
-
-    this.status({
-      text: JSON.stringify(service.values),
-      shape: 'dot',
-      fill: 'green',
-    });
-    this.send({ payload: service.values });
+    this.storedState = null;
   }
 
-  handleInput(msg, send) {
-    this.msg = msg;
-    debug("hbResume.input: %s input", this.fullName, JSON.stringify(msg));
+  handleInput(message, send) {
+    debug('handleInput', message.payload, this.name);
 
-    if (typeof msg.payload === "object") {
-      if (this.hbDevice) {
-        const message = this._createControlMessage.call(this, msg.payload, this, this.hbDevice);
-
-        if (message.characteristics.length > 0) {
-          let newMsg;
-          if (!msg.payload.On) {
-            if (this.lastPayload.On) {
-              newMsg = {
-                name: this.name,
-                _device: this.device,
-                _confId: this.confId,
-                payload: this.state,
-                Homebridge: this.hbDevice?.homebridge,
-                Manufacturer: this.hbDevice?.manufacturer,
-                Type: this.hbDevice?.deviceType,
-              };
-            } else {
-              this.state = JSON.parse(JSON.stringify(msg.payload));
-              newMsg = msg;
-            }
-          } else {
-            newMsg = msg;
-          }
+    if (!this.hbDevice) {
+      this.handleError('HB not initialized');
+      return;
+    }
 
-          send(newMsg.payload.On ? newMsg : { ...newMsg, payload: { On: false } });
-          debug("hbResume.input: %s output", this.fullName, JSON.stringify(newMsg));
-          this.updateStatus(newMsg.payload);
-          this.lastMessageValue = newMsg.payload;
-          this.lastMessageTime = Date.now();
-          this.lastPayload = JSON.parse(JSON.stringify(msg.payload));
-        }
-      } else {
-        this.handleError("Homebridge not initialized - 1");
-      }
-    } else {
+    if (typeof message.payload !== 'object' || typeof message.payload.On !== 'boolean') {
+      const validNames = Object.keys(this.hbDevice.values)
+        .filter(key => key !== 'ConfiguredName')
+        .join(', ');
       this.handleError(
-        "Payload should be a JSON object containing device characteristics and values, e.g., {\"On\":false, \"Brightness\":0 }"
+        `Invalid payload. Expected: {"On": false, "Brightness": 0}. Valid values: ${validNames}`,
+        'Invalid payload'
       );
+      return;
     }
-  }
-
-  handleCommand(event) {
-    const payload = { ...this.state, ...this._convertHBcharactericToNode([event], this) };
-    debug("hbResume.event: %s %s -> %s", this.fullName, JSON.stringify(this.state), JSON.stringify(payload));
-
-    if (event.status === true && event.value !== undefined) {
-      if (Date.now() - this.lastMessageTime > 5000) {
-        debug("hbResume.update: %s - updating stored event >5", this.fullName, payload);
-        this.state = JSON.parse(JSON.stringify(payload));
-      }
-    } else if (event.status === true) {
-      this.updateStatus({ text: 'connected', shape: 'dot', fill: 'green' });
-    } else {
-      this.updateStatus({ text: `disconnected: ${event.status}`, shape: 'ring', fill: 'red' });
-    }
-  }
-
-  handleDeviceRegistration() {
-    debug("hbResume.register:", this.fullName);
-    this.hbDevice = hbDevices.findDevice(this.device, { perms: 'pw' });
-
-    if (this.hbDevice) {
-      this._status(this.device, this, { perms: 'pw' }, (err, message) => {
-        if (!err) {
-          this.state = this._convertHBcharactericToNode(message.characteristics, this);
-          debug("hbResume received: %s = %s", this.fullName, JSON.stringify(message.characteristics).slice(0, 80) + '...');
-        } else {
-          this.error(err);
-        }
-      });
-
-      this.deviceType = this.hbDevice.deviceType;
-      this.listener = this.command;
-      this.eventName = [];
 
-      this.hbDevice.eventRegisters.forEach((event) => {
-        homebridge.on(this.hbDevice.id + event.aid + event.iid, this.command);
-        this.eventName.push(this.hbDevice.id + event.aid + event.iid);
-      });
+    // if on, store the current values object to storedState before passing
+    // if off, if storedState, then send stored state else passthru
 
-      this.updateStatus({ text: 'connected', shape: 'dot', fill: 'green' });
-      this.resetTimeout(30000);
-    } else {
-      this.error(`Can't find device ${this.device}`);
+    if (message.payload.On) {
+      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;
     }
-  }
 
-  updateStatus(status) {
-    this.status(status);
-    this.resetTimeout(10000);
-  }
+    this.status({
+      text: JSON.stringify(message.payload),
+      shape: 'dot',
+      fill: 'green',
+    });
 
-  resetTimeout(duration) {
-    clearTimeout(this.timeout);
-    this.timeout = setTimeout(() => this.status({}), duration);
+    send(message);
   }
 
-  handleError(message) {
-    this.error(message, this.msg);
-    this.updateStatus({ text: message, shape: 'ring', fill: 'red' });
-  }
 }
 
 module.exports = HbResumeNode;

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,39 +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": [
-            [
-                "452e3e6171aa7a25"
-            ]
-        ]
-    },
     {
         "id": "6703815a8874b156",
         "type": "hb-control",
@@ -183,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",
@@ -209,8 +184,8 @@
         "topic": "",
         "payload": "{\"On\": true, \"RotationSpeed\": 33}",
         "payloadType": "json",
-        "x": 190,
-        "y": 580,
+        "x": 90,
+        "y": 180,
         "wires": [
             [
                 "0ed3cd7e0d60beda"
@@ -238,8 +213,8 @@
         "topic": "",
         "payload": "{\"On\": false}",
         "payloadType": "json",
-        "x": 210,
-        "y": 640,
+        "x": 110,
+        "y": 240,
         "wires": [
             [
                 "0ed3cd7e0d60beda"
@@ -267,8 +242,8 @@
         "topic": "",
         "payload": "{\"On\": true}",
         "payloadType": "json",
-        "x": 350,
-        "y": 800,
+        "x": 110,
+        "y": 280,
         "wires": [
             [
                 "6703815a8874b156"
@@ -296,8 +271,8 @@
         "topic": "",
         "payload": "{\"On\": false}",
         "payloadType": "json",
-        "x": 350,
-        "y": 860,
+        "x": 110,
+        "y": 340,
         "wires": [
             [
                 "6703815a8874b156"
@@ -325,8 +300,8 @@
         "topic": "",
         "payload": "",
         "payloadType": "date",
-        "x": 520,
-        "y": 540,
+        "x": 320,
+        "y": 260,
         "wires": [
             [
                 "6703815a8874b156",
@@ -355,8 +330,8 @@
         "topic": "",
         "payload": "{\"Off\": false}",
         "payloadType": "json",
-        "x": 490,
-        "y": 920,
+        "x": 110,
+        "y": 380,
         "wires": [
             [
                 "6703815a8874b156"
@@ -384,8 +359,8 @@
         "topic": "",
         "payload": "{\"On\": true}",
         "payloadType": "json",
-        "x": 150,
-        "y": 340,
+        "x": 110,
+        "y": 80,
         "wires": [
             [
                 "452e3e6171aa7a25"
@@ -413,8 +388,8 @@
         "topic": "",
         "payload": "{\"On\": false}",
         "payloadType": "json",
-        "x": 150,
-        "y": 400,
+        "x": 110,
+        "y": 140,
         "wires": [
             [
                 "452e3e6171aa7a25"
@@ -433,7 +408,7 @@
         "conf": "557aec8e8c47e61e",
         "sendInitialState": true,
         "x": 500,
-        "y": 260,
+        "y": 100,
         "wires": [
             [
                 "a866ae0bb24ce682"
@@ -441,32 +416,20 @@
         ]
     },
     {
-        "id": "56633636bd2e624c",
-        "type": "inject",
+        "id": "f194fc4bcb1997a9",
+        "type": "debug",
         "z": "caef1e7b5b399e80",
-        "name": "",
-        "props": [
-            {
-                "p": "payload"
-            },
-            {
-                "p": "topic",
-                "vt": "str"
-            }
-        ],
-        "repeat": "60",
-        "crontab": "",
-        "once": true,
-        "onceDelay": "60",
-        "topic": "",
-        "payload": "",
-        "payloadType": "date",
-        "x": 190,
-        "y": 280,
-        "wires": [
-            [
-                "452e3e6171aa7a25"
-            ]
-        ]
+        "name": "debug 4",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": true,
+        "complete": "payload",
+        "targetType": "msg",
+        "statusVal": "payload",
+        "statusType": "auto",
+        "x": 800,
+        "y": 300,
+        "wires": []
     }
 ]