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

package/.eslintrc.js

@@ -0,0 +1,24 @@
+module.exports = {
+  env: {
+    es6: true,
+    node: true,
+    mocha: true,
+  },
+  extends: ['eslint:recommended', 'plugin:mocha/recommended'],
+  globals: {
+    Atomics: 'readonly',
+    SharedArrayBuffer: 'readonly',
+  },
+  parserOptions: {
+    ecmaVersion: 2018,
+    sourceType: 'module',
+  },
+  plugins: ['mocha'],
+  rules: {
+    indent: ['error', 2, { SwitchCase: 1 }],
+    'linebreak-style': ['error', 'unix'],
+    quotes: ['error', 'single'],
+    semi: ['error', 'always'],
+    'no-console': 'off',
+  },
+};

package/.nycrc.json

@@ -0,0 +1,11 @@
+{
+  "reporter": [
+    "lcov",
+    "text-summary"
+  ],
+  "lines": 100,
+  "statements": 100,
+  "functions": 100,
+  "branches": 100,
+  "check-coverage": true
+}

package/.prettierrc

@@ -0,0 +1,6 @@
+{
+  "printWidth": 120,
+  "tabWidth": 2,
+  "trailingComma": "all",
+  "singleQuote": true
+}

package/README.md

@@ -60,7 +60,7 @@ The above Node-RED Flow, turns on my 'Outside Office' light when the powder room
    * [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)
 
 <!-- Created by https://github.com/ekalinin/github-markdown-toc -->
-<!-- Added by: runner, at: Fri Jul  5 02:40:07 UTC 2024 -->
+<!-- Added by: runner, at: Mon Jul  8 00:34:52 UTC 2024 -->
 
 <!--te-->
 

package/package.json

@@ -1,13 +1,16 @@
 {
   "name": "node-red-contrib-homebridge-automation",
-  "version": "0.1.12-beta.0",
+  "version": "0.1.12-beta.10",
   "description": "NodeRED Automation for HomeBridge",
   "main": "src/HAP-NodeRed.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
     "api": "documentation build HAP-NodeRed.js -f md --config docs/documentation.yml > docs/API.md",
-    "document": "./gh-md-toc --insert README.md; rm README.md.orig.* README.md.toc.*",
-    "watch": "nodemon"
+    "document": "./gh-md-toc --insert --no-backup --hide-footer README.md",
+    "watch": "nodemon",
+    "coverage": "nyc npm t",
+    "format": "prettier --write {.,test}/*.js *.html *.md",
+    "lint": "eslint {.,test}/*.js",
+    "test": "mocha \"test/**/*_spec.js\""
   },
   "keywords": [
     "node-red",
@@ -23,8 +26,22 @@
     "url": "git+https://github.com/NorthernMan54/node-red-contrib-homebridge-automation.git"
   },
   "devDependencies": {
-    "documentation": "^14.0.3",
+    "@types/node-red": "^0.20.7",
+    "@types/jest": "^29.5.12",
+    "documentation": "14.0.3",
+    "eslint": "^8.57.0",
+    "eslint-config-airbnb-typescript": "^18.0.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-import-newlines": "^1.4.0",
+    "eslint-plugin-jest": "^28.6.0",
+    "eslint-plugin-sort-exports": "^0.9.1",
+    "mocha": "^10.6.0",
+    "node-red": "^4.0.2",
+    "node-red-node-test-helper": "^0.3.4",
     "nodemon": "^3.1.4",
+    "nyc": "^17.0.0",
+    "prettier": "^3.3.2",
+    "rimraf": "^5.0.7",
     "semver": "^7.6.2"
   },
   "dependencies": {
@@ -44,7 +61,7 @@
     ],
     "ext": "js,html",
     "ignore": [],
-    "exec": "DEBUG=hapNodeRed ~/npm/bin/node-red",
+    "exec": "DEBUG=hapNodeRed,hapNodeJSClient ~/npm/bin/node-red",
     "signal": "SIGTERM",
     "env": {
       "NODE_OPTIONS": "--trace-warnings"

package/src/HAP-NodeRed.js

@@ -180,7 +180,7 @@ module.exports = function (RED) {
     node.command = function (event) {
       // False messages can be received from accessories with multiple services
       // if (Object.keys(_convertHBcharactericToNode(event, node)).length > 0) {
-      debug("hbEvent", node.name, event);
+      // debug("hbEvent", node.name, event);
       if (event.status === true && event.value !== undefined) {
         node.state = Object.assign(node.state, _convertHBcharactericToNode([event], node));
         var msg = {
@@ -194,7 +194,7 @@ module.exports = function (RED) {
           _rawEvent: event
         };
         node.status({
-          text: JSON.stringify(msg.payload),
+          text: JSON.stringify(msg.payload).slice(0, 30) + '...',
           shape: 'dot',
           fill: 'green'
         });
@@ -233,7 +233,7 @@ module.exports = function (RED) {
         }, function (err, message) {
           if (!err) {
             node.state = _convertHBcharactericToNode(message.characteristics, node);
-            debug("hbEvent received: %s = %s", node.fullName, JSON.stringify(message.characteristics), node.state);
+            debug("hbEvent received: %s = %s", node.fullName, JSON.stringify(message.characteristics).slice(0, 80) + '...');
             if (node.sendInitialState) {
               var msg = {
                 name: node.name,
@@ -246,7 +246,7 @@ module.exports = function (RED) {
                 _rawMessage: message,
               };
               node.status({
-                text: JSON.stringify(msg.payload),
+                text: JSON.stringify(msg.payload).slice(0, 30) + '...',
                 shape: 'dot',
                 fill: 'green'
               });
@@ -366,7 +366,7 @@ module.exports = function (RED) {
             }, newMsg));
             debug("hbResume.input: %s output", node.fullName, JSON.stringify(newMsg));
             node.status({
-              text: JSON.stringify(newMsg.payload),
+              text: JSON.stringify(newMsg.payload).slice(0, 30) + '...',
               shape: 'dot',
               fill: 'green'
             });
@@ -380,9 +380,9 @@ module.exports = function (RED) {
             node.lastPayload = JSON.parse(JSON.stringify(msg.payload)); // store value not reference
           }
         } else {
-          node.error("Homebridge not initialized", this.msg);
+          node.error("Homebridge not initialized - 1", this.msg);
           node.status({
-            text: 'Homebridge not initialized',
+            text: 'Homebridge not initialized -1',
             shape: 'ring',
             fill: 'red'
           });
@@ -448,7 +448,7 @@ module.exports = function (RED) {
         }, function (err, message) {
           if (!err) {
             node.state = _convertHBcharactericToNode(message.characteristics, node);
-            debug("hbResume received: %s = %s", node.fullName, JSON.stringify(message.characteristics), node.state);
+            debug("hbResume received: %s = %s", node.fullName, JSON.stringify(message.characteristics).slice(0, 80) + '...');
           } else {
             node.error(err);
           }
@@ -505,37 +505,23 @@ module.exports = function (RED) {
 
     node.on('input', function (msg) {
       this.msg = msg;
-      var device;
-
-      try {
-        if (msg.name) {
-          device = hbDevices.findDeviceByName(msg.name, {
-            perms: 'pw'
-          });
-        } else {
-          device = hbDevices.findDevice(node.device, {
-            perms: 'pw'
-          });
-        }
-      } catch (err) {
-        var error = "Homebridge not initialized";
-        node.status({
-          text: error,
-          shape: 'ring',
-          fill: 'red'
-        });
-        node.error(error, this.msg);
-        return;
-      }
-
-      _control.call(this, node, device, msg.payload, function (err, data) {
-        // debug('hbControl [%s] - [%s]', err, data); // Images produce alot of noise
-        if (!err && data && (device.type == '00000110' || device.type == '00000111')) {
-          // debug('hbControl', err, data); // Images produce alot of noise
-          const msg = {};
+      _control.call(this, node, msg.payload, function (err, data) {
+        // debug('hbControl complete [%s] - [%s]', node, node.hbDevice); // Images produce alot of noise
+        if (!err && data && (node.deviceType == '00000110' || node.deviceType == '00000111')) {
+          const msg = {
+            name: node.name,
+            payload: node.state,
+            _device: node.device,
+            _confId: node.confId
+          };
+          if (node.hbDevice) {
+            msg.Homebridge = node.hbDevice.homebridge;
+            msg.Manufacturer = node.hbDevice.manufacturer;
+            msg.Service = node.hbDevice.deviceType;
+          }
           msg.payload = data;
           node.send(msg);
-        } else {
+        } else if (err) {
           node.error(err, this.msg);
         }
       }.bind(this));
@@ -547,13 +533,18 @@ module.exports = function (RED) {
     });
 
     node.conf.register(node, function () {
-      // debug("hbControl.register:", node.fullName, node);
-      switch (node.service) {
-        case "Camera Control": // Camera Control
-          debug("hbControl camera");
-          break;
-        default:
-          debug("node.conf.register", node.service);
+      debug("hbControl.register:", node.fullName);
+      this.hbDevice = hbDevices.findDevice(node.device);
+    //  console.log('hbControl Register', this.hbDevice)
+      if (this.hbDevice) {
+        node.hbDevice = this.hbDevice;
+        node.deviceType = this.hbDevice.type;
+        // Register for events
+        node.listener = node.command;
+        // node.eventName = this.hbDevice.host + this.hbDevice.port + this.hbDevice.aid;
+      } else {
+        node.error("437:Can't find device " + node.device, null);
+        // this.error("Missing device " + node.device);
       }
     });
   }
@@ -599,7 +590,7 @@ module.exports = function (RED) {
         perms: 'pr'
       }, function (err, message) {
         if (!err) {
-          debug("hbStatus received: %s = %s", JSON.stringify(node.fullName), JSON.stringify(message), JSON.stringify(node.hbDevice));
+          debug("hbStatus received: %s = %s", JSON.stringify(node.fullName), JSON.stringify(message).slice(0, 80) + '...', JSON.stringify(node.hbDevice));
           this.msg.name = node.name;
           this.msg._rawMessage = message;
           this.msg.payload = _convertHBcharactericToNode(message.characteristics, node);
@@ -612,7 +603,7 @@ module.exports = function (RED) {
             this.msg._confId = node.confId;
           }
           node.status({
-            text: JSON.stringify(this.msg.payload),
+            text: JSON.stringify(this.msg.payload).slice(0, 30) + '...',
             shape: 'dot',
             fill: 'green'
           });
@@ -656,7 +647,7 @@ module.exports = function (RED) {
   });
 
   RED.httpAdmin.get('/hap-device/evDevices/:id', RED.auth.needsPermission('hb-event.read'), function (req, res) {
-    if (evDevices) {
+    if (evDevices && hbDevices) {
       debug("evDevices", hbDevices.toList({
         perms: 'ev'
       }).length);
@@ -815,6 +806,9 @@ module.exports = function (RED) {
     // debug("_status", new Error(), hbDevices);
     var error;
     try {
+      if (!hbDevices) {
+        throw new Error('hbDevices not initialized');
+      }
       var device = hbDevices.findDevice(node.device, perms);
       if (device) {
         // debug("device.type", device.type);
@@ -828,7 +822,7 @@ module.exports = function (RED) {
             };
             debug("_status Control %s -> %s", device.id, JSON.stringify(message));
             homebridge.HAPresourceByDeviceID(device.id, JSON.stringify(message), function (err, status) {
-              debug("status", err);
+              // debug("status", err);
               if (!err) {
                 debug("_status Controlled %s:%s ->", device.host, device.port);
                 node.status({
@@ -894,8 +888,8 @@ module.exports = function (RED) {
         callback(error);
       } // end of device if
     } catch (err) {
-      debug('_status', err);
-      error = "Homebridge not initialized";
+      // debug('_status', err);
+      error = "Homebridge not initialized -2";
       node.status({
         text: error,
         shape: 'ring',
@@ -915,25 +909,33 @@ module.exports = function (RED) {
    * @return {type}          description
    */
 
-  function _control(node, device, payload, callback) {
+  function _control(node, payload, callback) {
     try {
+      if (!hbDevices) {
+        throw new Error('hbDevices not initialized');
+      }
+      var device = hbDevices.findDevice(node.device, {
+        perms: 'pw'
+      });
       if (device) {
         var message;
+        // console.log('device.type', device.type)
         switch (device.type) {
           case "00000110": // Camera RTPStream Management
           case "00000111": // Camera Control
             message = {
               "resource-type": "image",
               "image-width": 1920,
-              "image-height": 1080
+              "image-height": 1080,
+              "aid": node.hbDevice.aid
             };
-            debug("Control %s ->", device.id, JSON.stringify(message));
+            debug("Control %s ->", device.id, node.fullName, JSON.stringify(message));
             homebridge.HAPresourceByDeviceID(device.id, JSON.stringify(message), function (err, status) {
               if (!err) {
-                debug("Controlled %s ->", device.id, JSON.stringify(payload));
-                debug("Payload %s ->", device.id, status);
+                //  debug("Controlled %s ->", device.id, JSON.stringify(payload));
+                //  debug("Payload %s ->", device.id, status);
                 node.status({
-                  text: JSON.stringify(payload),
+                  text: JSON.stringify(payload).slice(0, 30) + '...',
                   shape: 'dot',
                   fill: 'green'
                 });
@@ -963,7 +965,7 @@ module.exports = function (RED) {
                   if (!err && status && status.characteristics[0].status === 0) {
                     debug("Controlled %s ->", device.id, JSON.stringify(status));
                     node.status({
-                      text: JSON.stringify(payload),
+                      text: JSON.stringify(payload).slice(0, 30) + '...',
                       shape: 'dot',
                       fill: 'green'
                     });
@@ -975,7 +977,7 @@ module.exports = function (RED) {
                   } else if (!err) {
                     debug("Controlled %s ->", device.id, payload);
                     node.status({
-                      text: JSON.stringify(payload),
+                      text: JSON.stringify(payload).slice(0, 30) + '...',
                       shape: 'dot',
                       fill: 'green'
                     });
@@ -1028,7 +1030,7 @@ module.exports = function (RED) {
         callback(error);
       }
     } catch (err) {
-      var error = "Homebridge not initialized";
+      var error = "Homebridge not initialized - 3 "+ err;
       node.status({
         text: error,
         shape: 'ring',

package/src/lib/Accessory.js

@@ -17,14 +17,21 @@ function Accessory(devices, context) {
   this.homebridge = context.homebridge;
   this.id = context.id;
   this.services = [];
-  devices.services.forEach(function(element) {
+  devices.services.forEach(function (element) {
     // debug("Service", element);
     switch (element.type.substring(0, 8)) {
       case "0000003E": // Accessory Information
         this.info = information(element.characteristics);
         break;
- //     case "00000110": // Camera RTPStream Management generates duplicates
- //       break;
+      case "00000110": // Camera RTPStream Management generates duplicates
+        var service = new Service(element, this);
+        // console.log('services', this.services);
+        if (this.services.some(e => e.type === '00000110')) {
+
+        } else {
+          this.services.push(service);
+        }
+        break;
       case "000000D9": // Input Source from webosTV has a dummy input source
         var service = new Service(element, this);
         if (service.name !== "dummy") {
@@ -39,7 +46,7 @@ function Accessory(devices, context) {
   // debug("Info", this.info);
 }
 
-Accessory.prototype.toList = function(context) {
+Accessory.prototype.toList = function (context) {
   var list = [];
   // debug("toList", context);
   context.aid = this.aid;
@@ -109,7 +116,7 @@ Accessory.prototype.toList = function(context) {
 
 function information(characteristics) {
   var result = {};
-  characteristics.forEach(function(characteristic) {
+  characteristics.forEach(function (characteristic) {
     if (characteristic.description) {
       var key = characteristic.description.replace(/ /g, '').replace(/\./g, '_');
       result[key] = characteristic.value;

package/test/flows.js

@@ -0,0 +1,42 @@
+const Flows = {
+  getDefault: function (options) {
+    let defaultFlow = [
+      {
+        id: 'status1',
+        type: 'hb-status',
+        name: 'StatusNode1',
+        Homebridge: 'homebridge',
+        Manufacturer: 'TestModule',
+        Service: 'Switch',
+        device: 'homebridgeAA:BB:CC:DD:EE:FF0StatusNode100000049',
+        conf: 'conf1',
+        wires: [['n2']],
+      },
+      {
+        id: 'control1',
+        type: 'hb-control',
+        name: 'ControlNode1',
+        Homebridge: 'homebridge',
+        Manufacturer: 'TestModule',
+        Service: 'Outlet',
+        device: 'homebridgeAA:BB:CC:DD:EE:FF0ControlNode1h00000047',
+        conf: 'conf1',
+        outputs: 0,
+        wires: [],
+      },
+      {
+        id: 'conf1',
+        type: 'hb-conf',
+        username: '031-45-154',
+        macAddress: 'AA:BB:CC:DD:EE:FF',
+      },
+      { id: 'n2', type: 'helper' },
+      { id: 'n3', type: 'helper' },
+    ];
+
+    defaultFlow[0] = Object.assign(defaultFlow[0], options);
+    return defaultFlow;
+  },
+};
+
+module.exports = Flows;

package/test/test_spec.js

@@ -0,0 +1,40 @@
+// var should = require('should');
+var os = require('os');
+var path = require('path');
+var helper = require('node-red-node-test-helper');
+helper.init(require.resolve('node-red'), { userDir: os.tmpdir() });
+
+var flows = require('./flows');
+var hapNode = require('../src/HAP-NodeRed.js');
+
+describe('HAP node', function () {
+  before(function (done) {
+    helper.startServer(done);
+  });
+
+  after(function (done) {
+    helper.stopServer(done);
+  });
+
+  afterEach(function () {
+    helper.unload();
+  });
+
+  it('should be loaded', function (done) {
+    var flow = flows.getDefault();
+
+    helper.load(hapNode, flow, function () {
+      var conf1 = helper.getNode('conf1');
+      conf1.should.have.property('macAddress', 'AA:BB:CC:DD:EE:FF');
+      var stat1 = helper.getNode('status1');
+      stat1.should.have.property('name', 'StatusNode1');
+      var ctl1 = helper.getNode('control1');
+      ctl1.should.have.property('name', 'ControlNode1');
+      var logEvents = helper.log().args.filter(function (evt) {
+        return evt[0].type == 'hb-conf' || evt[0].type == 'hb-status';
+      });
+      logEvents.should.have.length(0);
+      done();
+    });
+  });
+});