node-red-contrib-homebridge-automation 0.1.11 → 0.1.12-beta.1

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/.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "10:00"
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: documentation
+    versions:
+    - 13.2.0
+    - 13.2.1

package/.github/npm-version-script.js

@@ -0,0 +1,93 @@
+#!/bin/env node
+
+/**
+ * This scripts queries the npm registry to pull out the latest version for a given tag.
+ */
+
+const fs = require("fs");
+const semver = require("semver");
+const child_process = require("child_process");
+const assert = require("assert");
+
+const BRANCH_VERSION_PATTERN = /^([A-Za-z]*)-(\d+.\d+.\d+)$/
+
+// Load the contents of the package.json file
+const packageJSON = JSON.parse(fs.readFileSync("package.json", "utf8"));
+
+let refArgument = process.argv[2];
+let tagArgument = process.argv[3] || "latest";
+
+if (refArgument == null) {
+  console.error("ref argument is missing");
+  console.error("Usage: npm-version-script.js <ref> [tag]");
+  process.exit(1);
+}
+
+/**
+ * Queries the NPM registry for the latest version for the provided tag.
+ * @param tag The tag to query for.
+ * @returns {string} Returns the version.
+ */
+function getTagVersionFromNpm(tag) {
+  try {
+    return child_process.execSync(`npm info ${packageJSON.name} version --tag="${tag}"`).toString("utf8").trim();
+  } catch (e) {
+    console.error(`Failed to query the npm registry for the latest version for tag: ${tag}`);
+    // throw e;
+    return "0.0.0";
+  }
+}
+
+function desiredTargetVersion(ref) {
+  // ref is a GitHub action ref string
+  if (ref.startsWith("refs/pull/")) {
+    throw Error("The version script was executed inside a PR!");
+  }
+
+  assert(ref.startsWith("refs/heads/"))
+  let branchName = ref.slice("refs/heads/".length);
+
+  let results = branchName.match(BRANCH_VERSION_PATTERN);
+  if (results != null) {
+    if (results[1] !== tagArgument) {
+      console.warn(`The base branch name (${results[1]}) differs from the tag name ${tagArgument}`);
+    }
+
+    return results[2];
+  }
+
+  // legacy mode were we use the `betaVersion` property in the package.json
+  if (branchName === "beta" && packageJSON.betaVersion) {
+    return packageJSON.betaVersion
+  }
+
+  // legacy mode were we use the `alphaVersion` property in the package.json
+  if (branchName === "alpha" && packageJSON.alphaVersion) {
+    return packageJSON.alphaVersion
+  }
+
+  throw new Error(`Malformed branch name for ref: ${ref}. Can't derive the base version. Use a branch name like: beta-x.x.x or alpha-x.x.x`);
+}
+
+// derive the base version from the branch ref
+const baseVersion = desiredTargetVersion(refArgument);
+
+// query the npm registry for the latest version of the provided tag name
+const latestReleasedVersion = getTagVersionFromNpm(tagArgument); // e.g. 0.7.0-beta.12
+const latestReleaseBase = semver.inc(latestReleasedVersion, "patch"); // will produce 0.7.0 (removing the preid, needed for the equality check below)
+
+let publishTag;
+if (semver.eq(baseVersion, latestReleaseBase)) { // check if we are releasing another version for the latest beta or alpha
+  publishTag = latestReleasedVersion; // set the current latest beta or alpha to be incremented
+} else {
+  publishTag = baseVersion; // start of with a new beta or alpha version
+}
+
+// save the package.json
+packageJSON.version = publishTag;
+fs.writeFileSync("package.json", JSON.stringify(packageJSON, null, 2));
+
+// perform the same change to the package-lock.json
+const packageLockJSON = JSON.parse(fs.readFileSync("package-lock.json", "utf8"));
+packageLockJSON.version = publishTag;
+fs.writeFileSync("package-lock.json", JSON.stringify(packageLockJSON, null, 2));

package/.github/workflows/Build and Publish.yml

@@ -0,0 +1,119 @@
+name: "Build, Publish and Release"
+ 
+ #
+ # Automatically publish beta releases on pushes, require a manual workflow action for production releases
+ #
+ # Does the following
+ # 1 - Run the documentation script against the package
+ # 2 - Create the npm package using the package.json version tag ( or for beta releases, adds a beta tag and increments as needed )
+ # 3 - Publish the npm package
+ # 4 - For releases against the main branch, create a github release as well
+
+on:
+  push:
+    branches: [beta-*.*.*, beta]
+  workflow_dispatch:
+
+jobs:
+  get_tags:
+    runs-on: ubuntu-latest
+
+    steps:
+    # checkout repo
+    - uses: actions/checkout@v4
+
+    # get branch / tag name
+    - name: Get Branch / Tag Name
+      id: get_branch
+      run: |
+        export BRANCH_NAME=$(if [[ ${GITHUB_REF} =~ "refs/tags/" ]]; then echo ${GITHUB_REF/refs\/tags\//}; else echo ${GITHUB_REF/refs\/heads\//}; fi)
+        echo $BRANCH_NAME
+        echo "BRANCH_NAME=${BRANCH_NAME}" >> $GITHUB_OUTPUT
+
+    # generate the image tag
+    - name: Get Image Tag
+      id: get_tag
+      run: |
+        export TARGET_IMAGE_TAG=$(if [ "${{ steps.get_branch.outputs.BRANCH_NAME }}" = "main" ]; then echo "main"; else echo "${{ steps.get_branch.outputs.BRANCH_NAME }}" | awk -F- '{ print $1 }'; fi)
+        echo $TARGET_IMAGE_TAG
+        echo "TARGET_IMAGE_TAG=${TARGET_IMAGE_TAG}" >> $GITHUB_OUTPUT
+
+    outputs:
+      BRANCH_NAME: ${{ steps.get_branch.outputs.BRANCH_NAME }}
+      TARGET_IMAGE_TAG: ${{ steps.get_tag.outputs.TARGET_IMAGE_TAG }}
+
+  create_documentation:
+    runs-on: ubuntu-latest
+
+    steps:
+    # checkout repo
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal access token.
+        fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository.
+
+    - uses: actions/setup-node@v4
+      with:
+        node-version: lts/*
+
+    - name: Retrieve github-markdown-toc
+      run: |
+        wget -q https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc
+        chmod a+x gh-md-toc
+
+    - name: Create Table of Contents
+      run: |
+        npm run-script document --if-present
+        rm gh-md-toc
+
+    - name: Commit files
+      run: |
+        git config --local user.email "github-actions[bot]@users.noreply.github.com"
+        git config --local user.name "github-actions[bot]"
+        git add *
+        git commit -a -m "Update TOC" || true
+
+    - name: Push changes
+      uses: ad-m/github-push-action@master
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        branch: ${{ github.ref }}
+
+  publish_prod_release:
+    needs: [get_tags, create_documentation]
+    name: Publish Release Version
+    if: ${{ needs.get_tags.outputs.BRANCH_NAME == 'main' }}
+    uses: homebridge/.github/.github/workflows/npm-publish.yml@latest
+    with:
+      install_cmd: npm ci
+    secrets:
+      npm_auth_token: ${{ secrets.npm_token }}
+
+  publish_test_release:
+    needs: [get_tags, create_documentation]
+    name: Publish Test Version - ${{ needs.get_tags.outputs.BRANCH_NAME }}
+    if: ${{ needs.get_tags.outputs.BRANCH_NAME != 'main' }}
+    uses: homebridge/.github/.github/workflows/npm-publish.yml@latest
+    with:
+      tag: ${{ needs.get_tags.outputs.TARGET_IMAGE_TAG }}
+      dynamically_adjust_version: true
+      npm_version_command: 'pre'
+      pre_id: ${{ needs.get_tags.outputs.TARGET_IMAGE_TAG }}
+    secrets:
+      npm_auth_token: ${{ secrets.npm_token }}
+
+  publish_github_release:
+    needs: [publish_prod_release]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Create Release
+      uses: softprops/action-gh-release@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        tag_name: ${{ needs.publish_prod_release.outputs.NPM_VERSION }}
+        name: Release ${{ needs.publish_prod_release.outputs.NPM_VERSION }}
+        generate_release_notes: true
+        draft: false
+        prerelease: false

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: sgracey, at: Sun 19 Mar 2023 11:30:14 EDT -->
+<!-- Added by: runner, at: Fri Jul  5 02:43:29 UTC 2024 -->
 
 <!--te-->
 

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "node-red-contrib-homebridge-automation",
-  "version": "0.1.11",
+  "version": "0.1.12-beta.1",
   "description": "NodeRED Automation for HomeBridge",
-  "main": "HAP-NodeRed.js",
+  "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.*"
+    "document": "./gh-md-toc --insert README.md; rm README.md.orig.* README.md.toc.*",
+    "watch": "nodemon"
   },
   "keywords": [
     "node-red",
@@ -14,7 +14,7 @@
   ],
   "node-red": {
     "nodes": {
-      "HAP-NodeRed": "HAP-NodeRed.js"
+      "HAP-NodeRed": "src/HAP-NodeRed.js"
     }
   },
   "repository": {
@@ -22,17 +22,40 @@
     "url": "git+https://github.com/NorthernMan54/node-red-contrib-homebridge-automation.git"
   },
   "devDependencies": {
-    "documentation": "^14.0.1"
+    "@types/node-red": "^0.20.7",
+    "documentation": "14.0.3",
+    "eslint": "^9.6.0",
+    "eslint-plugin-mocha": "^10.4.3",
+    "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": {
     "better-queue": ">=3.8.12",
-    "debug": "^4.3.4",
-    "hap-node-client": ">=0.2.4"
+    "debug": "^4.3.5",
+    "hap-node-client": ">=0.2.7"
   },
   "author": "NorthernMan54",
   "license": "ISC",
   "bugs": {
     "url": "https://github.com/NorthernMan54/node-red-contrib-homebridge-automation/issues"
   },
-  "homepage": "https://github.com/NorthernMan54/node-red-contrib-homebridge-automation#readme"
+  "homepage": "https://github.com/NorthernMan54/node-red-contrib-homebridge-automation#readme",
+  "nodemonConfig": {
+    "watch": [
+      "src"
+    ],
+    "ext": "js,html",
+    "ignore": [],
+    "exec": "DEBUG=hapNodeRed ~/npm/bin/node-red",
+    "signal": "SIGTERM",
+    "env": {
+      "NODE_OPTIONS": "--trace-warnings"
+    }
+  }
 }

package/{HAP-NodeRed.js → src/HAP-NodeRed.js}

@@ -504,17 +504,42 @@ module.exports = function (RED) {
     var node = this;
 
     node.on('input', function (msg) {
-      const payload = {};
       this.msg = msg;
-      Object.keys(msg.payload).sort().forEach(function (key) {
-        payload[key] = msg.payload[key];
-      });
-      _control.call(this, node, msg.payload, function (err, data) {
+      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) {
+        if (!err && data && (device.type == '00000110' || device.type == '00000111')) {
+          // debug('hbControl', err, data); // Images produce alot of noise
+          const msg = {};
+          msg.payload = data;
+          node.send(msg);
+        } else {
           node.error(err, this.msg);
         }
       }.bind(this));
+
     });
 
     node.on('close', function (callback) {
@@ -525,9 +550,10 @@ module.exports = function (RED) {
       // debug("hbControl.register:", node.fullName, node);
       switch (node.service) {
         case "Camera Control": // Camera Control
-          // debug("hbControl camera");
+          debug("hbControl camera");
           break;
         default:
+          debug("node.conf.register", node.service);
       }
     });
   }
@@ -573,7 +599,7 @@ module.exports = function (RED) {
         perms: 'pr'
       }, function (err, message) {
         if (!err) {
-          debug("hbStatus received: %s = %s", JSON.stringify(node.fullName), JSON.stringify(message));
+          debug("hbStatus received: %s = %s", JSON.stringify(node.fullName), JSON.stringify(message), JSON.stringify(node.hbDevice));
           this.msg.name = node.name;
           this.msg._rawMessage = message;
           this.msg.payload = _convertHBcharactericToNode(message.characteristics, node);
@@ -581,7 +607,7 @@ module.exports = function (RED) {
           if (node.hbDevice) {
             this.msg.Homebridge = node.hbDevice.homebridge;
             this.msg.Manufacturer = node.hbDevice.manufacturer;
-            this.msg.Service = node.hbDevice.deviceType;
+            this.msg.Service = node.hbDevice.service;
             this.msg._device = node.device;
             this.msg._confId = node.confId;
           }
@@ -630,10 +656,10 @@ module.exports = function (RED) {
   });
 
   RED.httpAdmin.get('/hap-device/evDevices/:id', RED.auth.needsPermission('hb-event.read'), function (req, res) {
-    debug("evDevices", hbDevices.toList({
-      perms: 'ev'
-    }).length);
     if (evDevices) {
+      debug("evDevices", hbDevices.toList({
+        perms: 'ev'
+      }).length);
       res.send(hbDevices.toList({
         perms: 'ev'
       }));
@@ -800,11 +826,11 @@ module.exports = function (RED) {
               "image-width": 1920,
               "image-height": 1080
             };
-            debug("Control %s:%s ->", device.host, device.port, JSON.stringify(message));
-            homebridge.HAPresource(device.host, device.port, JSON.stringify(message), function (err, status) {
-              // debug("status", btoa(status));
+            debug("_status Control %s -> %s", device.id, JSON.stringify(message));
+            homebridge.HAPresourceByDeviceID(device.id, JSON.stringify(message), function (err, status) {
+              debug("status", err);
               if (!err) {
-                debug("Controlled %s:%s ->", device.host, device.port);
+                debug("_status Controlled %s:%s ->", device.host, device.port);
                 node.status({
                   text: 'sent',
                   shape: 'dot',
@@ -868,6 +894,7 @@ module.exports = function (RED) {
         callback(error);
       } // end of device if
     } catch (err) {
+      debug('_status', err);
       error = "Homebridge not initialized";
       node.status({
         text: error,
@@ -888,11 +915,8 @@ module.exports = function (RED) {
    * @return {type}          description
    */
 
-  function _control(node, payload, callback) {
+  function _control(node, device, payload, callback) {
     try {
-      var device = hbDevices.findDevice(node.device, {
-        perms: 'pw'
-      });
       if (device) {
         var message;
         switch (device.type) {
@@ -907,6 +931,7 @@ module.exports = function (RED) {
             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);
                 node.status({
                   text: JSON.stringify(payload),
                   shape: 'dot',
@@ -994,14 +1019,13 @@ module.exports = function (RED) {
             }
         } // End of switch
       } else {
-        var err = 'Device not available';
-        node.error(err);
+        var error = 'Device not available';
         node.status({
-          text: err,
+          text: error,
           shape: 'ring',
           fill: 'red'
         });
-        callback(err);
+        callback(error);
       }
     } catch (err) {
       var error = "Homebridge not initialized";

package/{lib → src/lib}/Accessory.js

@@ -23,8 +23,8 @@ function Accessory(devices, context) {
       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
+ //       break;
       case "000000D9": // Input Source from webosTV has a dummy input source
         var service = new Service(element, this);
         if (service.name !== "dummy") {

package/{lib → src/lib}/Homebridges.js

@@ -56,3 +56,13 @@ Homebridges.prototype.findDevice = function(node, opt) {
   }
   return (list.find(x => x.uniqueId === node));
 };
+
+Homebridges.prototype.findDeviceByName = function(name, opt) {
+  var list = [];
+  for (var index in this.homebridges) {
+    var homebridge = this.homebridges[index];
+    // list.push(homebridge.toList());
+    list = list.concat(homebridge.toList(opt));
+  }
+  return (list.find(x => x.name === name));
+};

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('../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();
+    });
+  });
+});

package/beta.sh

@@ -1,16 +0,0 @@
-#! /bin/sh
-
-npm audit
-npm audit fix
-#if npm audit; then
-  npm run-script document
-  rm *orig* *toc\.*
-  git add .
-  # npm version patch -m "$1" --force
-  npm version prerelease --preid beta -m "$1" --force
-  npm publish --tag beta
-  git commit -m "$1"
-  git push origin beta --tags
-#else
-#  echo "Not publishing due to security vulnerabilites"
-#fi

package/example.js

@@ -1,83 +0,0 @@
-var Queue = require('better-queue');
-
-var q = new Queue(function(input, cb) {
-  console.log('Loop', input);
-  cb(null, input * -1);
-}, {
-  concurrent: 3
-});
-
-for (var i = 0; i < 10; i++) {
-  q.push(i, function(err, result) {
-    console.log('Done', result);
-  });
-}
-
-
-
-// add jobs using the familiar Array API
-
-
-
-/*
-
-q.push(
-  function(cb) {
-    results.push('four')
-    cb()
-  },
-  function(cb) {
-    results.push('five')
-    cb()
-  }
-)
-
-// jobs can accept a callback or return a promise
-q.push(function() {
-  return new Promise(function(resolve, reject) {
-    results.push('one')
-    resolve()
-  })
-})
-
-q.unshift(function(cb) {
-  results.push('one')
-  cb()
-})
-
-q.splice(2, 0, function(cb) {
-  results.push('three')
-  cb()
-})
-
-// use the timeout feature to deal with jobs that
-// take too long or forget to execute a callback
-q.timeout = 100
-
-q.on('timeout', function(next, job) {
-  console.log('job timed out:', job.toString().replace(/\n/g, ''))
-  next()
-})
-
-q.push(function(cb) {
-  setTimeout(function() {
-    console.log('slow job finished')
-    cb()
-  }, 200)
-})
-
-q.push(function(cb) {
-  console.log('forgot to execute callback')
-})
-
-// get notified when jobs complete
-q.on('success', function(result, job) {
-  console.log('job finished processing:', job.toString().replace(/\n/g, ''))
-})
-
-// begin processing, get notified on end / failure
-q.start(function(err) {
-  if (err) throw err
-  console.log('all done:', results)
-})
-*/