node-red-contrib-mobius-flow-base 3.1.0 → 3.1.2

package/dist/nodes/mobius-connection.js

@@ -72,15 +72,24 @@ module.exports = function (RED) {
       this.password
     );
     this.apiClient.EngineWebSocket.clearAllCallbacks();
-    this.apiClient.EngineWebSocket.registerCallback('resource-cov', (response) => {
-      this.handleCOVEvents(response);
-    });
-    this.apiClient.EngineWebSocket.registerCallback('object-cov', (response) => {
-      this.handleObjectCOVEvents(response);
-    });
-    this.apiClient.EngineWebSocket.registerCallback('broadcast-command', (response) => {
-      this.handleBCMDEvents(response);
-    });
+    this.apiClient.EngineWebSocket.registerCallback(
+      'resource-cov',
+      (response) => {
+        this.handleCOVEvents(response);
+      }
+    );
+    this.apiClient.EngineWebSocket.registerCallback(
+      'object-cov',
+      (response) => {
+        this.handleObjectCOVEvents(response);
+      }
+    );
+    this.apiClient.EngineWebSocket.registerCallback(
+      'broadcast-command',
+      (response) => {
+        this.handleBCMDEvents(response);
+      }
+    );
     var node = this;
     node.serviceList = [];
     node.hasStarted = false;
@@ -98,12 +107,20 @@ module.exports = function (RED) {
       this.log(`Connected to ${n.host}`);
       this.apiClient.getHubId((err, hubId) => {
         if (err) {
-          node.error('Mobius error getting hub ID' + JSON.stringify(err));
+          node.error(
+            `Mobius error getting hub ID: ${err.code}, ${
+              err.message ? err.message : ''
+            }`
+          );
         } else {
           node.hubId = hubId;
           this.apiClient.discover(node.hubId, (err, response) => {
             if (err) {
-              node.error('Mobius error discovering service list' + JSON.stringify(err));
+              node.error(
+                `Mobius error discovering service list: ${err.code}, ${
+                  err.message ? err.message : ''
+                }`
+              );
             } else {
               node.serviceList = response.data;
               node.hasStarted = true;
@@ -380,8 +397,22 @@ module.exports = function (RED) {
      * @param  {Function} func      - The function used to test the resource values
      * @param  {Function} callback  - function(err, [object]) {}
      */
-    node.filterObjectsByRIDValue = function (uri, pids, rid, limit, func, callback) {
-      this.apiClient.filterObjectsByRIDValue(uri, pids, rid, limit, func, callback);
+    node.filterObjectsByRIDValue = function (
+      uri,
+      pids,
+      rid,
+      limit,
+      func,
+      callback
+    ) {
+      this.apiClient.filterObjectsByRIDValue(
+        uri,
+        pids,
+        rid,
+        limit,
+        func,
+        callback
+      );
     };
 
     /**
@@ -389,9 +420,9 @@ module.exports = function (RED) {
      * @param {*} password - The new password
      * @param {*} callback - Callback when complete, function(err, [object]) {}
      */
-    node.changeAdminPassword = function(password, callback) {
+    node.changeAdminPassword = function (password, callback) {
       this.apiClient.changeAdminPassword(password, callback);
-    }
+    };
 
     /**
      * Subscribe to a resource COV
@@ -523,8 +554,20 @@ module.exports = function (RED) {
      * @param  {number} timeout     - Optional timeout in ms which overrides the default timeout if > 0
      * @param  {Function} callback  - Callback when complete
      */
-    node.sendDirectCommand = function (uri, cid, commandData, timeout, callback) {
-      this.apiClient.sendDirectCommand(uri, cid, commandData, timeout, callback);
+    node.sendDirectCommand = function (
+      uri,
+      cid,
+      commandData,
+      timeout,
+      callback
+    ) {
+      this.apiClient.sendDirectCommand(
+        uri,
+        cid,
+        commandData,
+        timeout,
+        callback
+      );
     };
 
     /**
@@ -546,8 +589,19 @@ module.exports = function (RED) {
      * @param {Object} config       - The new object configuration, structure given by {ins: string, pid: string, uiname: string, rids: array}
      * @param {Function} callback   - Callback when complete
      */
-    node.updateObjectInServiceConfig = function (hid, sid, pid, ins, config, callback) {
-      this.apiClient.updateObject(`${hid}/${sid}/${pid}/${ins}`, config, callback);
+    node.updateObjectInServiceConfig = function (
+      hid,
+      sid,
+      pid,
+      ins,
+      config,
+      callback
+    ) {
+      this.apiClient.updateObject(
+        `${hid}/${sid}/${pid}/${ins}`,
+        config,
+        callback
+      );
     };
 
     /**
@@ -557,7 +611,7 @@ module.exports = function (RED) {
      */
     node.getNodeConfig = function (uri, callback) {
       this.apiClient.getNodeConfig(uri, callback);
-    }
+    };
 
     /**
      * Get the list of services on a hub
@@ -566,7 +620,7 @@ module.exports = function (RED) {
      */
     node.getNodeConfigTree = function (hid, callback) {
       this.apiClient.getNodeConfigTree(hid, callback);
-    }
+    };
 
     /**
      * Get the list of services on a hub
@@ -575,11 +629,11 @@ module.exports = function (RED) {
      */
     node.getProfileByPid = function (hid, pid, callback) {
       this.apiClient.getProfileByPid(hid, pid, callback);
-    }
+    };
 
     node.getAllObjectProfiles = function (hid, callback) {
       this.apiClient.getAllObjectProfiles(hid, callback);
-    }
+    };
   }
 
   RED.nodes.registerType('mobius connection', MobiusConnectionNode);
@@ -602,8 +656,12 @@ module.exports = function (RED) {
 
       let pid = req.query.pid;
       if (conn === null || !conn.connected) {
-        RED.log.error('Discover objects failed - could not to connect to MOBiUS hub.');
-        throw new Error('Discover objects failed - could not to connect to MOBiUS hub.');
+        RED.log.error(
+          'Discover objects failed - could not to connect to MOBiUS hub.'
+        );
+        throw new Error(
+          'Discover objects failed - could not to connect to MOBiUS hub.'
+        );
       } else {
         uiFuncs
           .discoverDevicesByPID(RED, conn, hid, spids, pid)
@@ -626,8 +684,12 @@ module.exports = function (RED) {
       let hid = req.query.hid;
       let spid = req.query.spid;
       if (conn === null || !conn.connected) {
-        RED.log.error('Discover services failed - could not to connect to MOBiUS hub.');
-        throw new Error('Discover services failed - could not to connect to MOBiUS hub.');
+        RED.log.error(
+          'Discover services failed - could not to connect to MOBiUS hub.'
+        );
+        throw new Error(
+          'Discover services failed - could not to connect to MOBiUS hub.'
+        );
       } else {
         uiFuncs
           .discoverServicesBySPID(RED, conn, hid, spid)
@@ -641,13 +703,20 @@ module.exports = function (RED) {
     }
   );
 
-    // Register the endpoint for node-red mobius discovery in node-red node config pages
-    RED.httpAdmin.get('/mdiscover', RED.auth.needsPermission('serial.read'), function (req, res) {
+  // Register the endpoint for node-red mobius discovery in node-red node config pages
+  RED.httpAdmin.get(
+    '/mdiscover',
+    RED.auth.needsPermission('serial.read'),
+    function (req, res) {
       let conn = RED.nodes.getNode(req.query.mobius);
       let uri = req.query.uri;
       if (conn === null || !conn.connected) {
-        RED.log.error('Discover services failed - could not to connect to MOBiUS hub.');
-        throw new Error('Discover services failed - could not to connect to MOBiUS hub.');
+        RED.log.error(
+          'Discover services failed - could not to connect to MOBiUS hub.'
+        );
+        throw new Error(
+          'Discover services failed - could not to connect to MOBiUS hub.'
+        );
       } else {
         uiFuncs
           .discover(conn, uri)
@@ -658,16 +727,24 @@ module.exports = function (RED) {
             throw err;
           });
       }
-    });
+    }
+  );
 
-    // Register the endpoint for node-red get resource options for object type
-    RED.httpAdmin.get('/mgetresourceoptions', RED.auth.needsPermission('serial.read'), function (req, res) {
+  // Register the endpoint for node-red get resource options for object type
+  RED.httpAdmin.get(
+    '/mgetresourceoptions',
+    RED.auth.needsPermission('serial.read'),
+    function (req, res) {
       let conn = RED.nodes.getNode(req.query.mobius);
       let hid = req.query.hid;
       let pid = req.query.pid;
       if (conn === null || !conn.connected) {
-        RED.log.error('Fetching resource options failed - could not to connect to MOBiUS hub.');
-        throw new Error('Fetching resource options failed - could not to connect to MOBiUS hub.');
+        RED.log.error(
+          'Fetching resource options failed - could not to connect to MOBiUS hub.'
+        );
+        throw new Error(
+          'Fetching resource options failed - could not to connect to MOBiUS hub.'
+        );
       } else {
         uiFuncs
           .getResourceOptions(conn, hid, pid)
@@ -678,15 +755,23 @@ module.exports = function (RED) {
             throw err;
           });
       }
-    });
-  
-    // Register the endpoint for node-red mobius discovery in node-red node config pages
-    RED.httpAdmin.get('/mgetservices', RED.auth.needsPermission('serial.read'), function (req, res) {
+    }
+  );
+
+  // Register the endpoint for node-red mobius discovery in node-red node config pages
+  RED.httpAdmin.get(
+    '/mgetservices',
+    RED.auth.needsPermission('serial.read'),
+    function (req, res) {
       let conn = RED.nodes.getNode(req.query.mobius);
       let hid = req.query.hid;
       if (conn === null || !conn.connected) {
-        RED.log.error('Get services failed - could not to connect to MOBiUS hub.');
-        throw new Error('Get services failed - could not to connect to MOBiUS hub.');
+        RED.log.error(
+          'Get services failed - could not to connect to MOBiUS hub.'
+        );
+        throw new Error(
+          'Get services failed - could not to connect to MOBiUS hub.'
+        );
       } else {
         uiFuncs
           .getServiceList(conn, hid)
@@ -697,15 +782,23 @@ module.exports = function (RED) {
             RED.log.warn(`Get services failed - ${err}`);
           });
       }
-    });
-  
-    RED.httpAdmin.get('/mgetobjects', RED.auth.needsPermission('serial.read'), function (req, res) {
+    }
+  );
+
+  RED.httpAdmin.get(
+    '/mgetobjects',
+    RED.auth.needsPermission('serial.read'),
+    function (req, res) {
       let conn = RED.nodes.getNode(req.query.mobius);
       let hid = req.query.hid;
       let sid = req.query.sid;
       if (conn === null || !conn.connected) {
-        RED.log.error('Get objects failed - could not to connect to MOBiUS hub.');
-        throw new Error('Get objects failed - could not to connect to MOBiUS hub.');
+        RED.log.error(
+          'Get objects failed - could not to connect to MOBiUS hub.'
+        );
+        throw new Error(
+          'Get objects failed - could not to connect to MOBiUS hub.'
+        );
       } else {
         uiFuncs
           .getConfigObjectsList(conn, hid, sid)
@@ -713,12 +806,20 @@ module.exports = function (RED) {
             res.json(response);
           })
           .catch((err) => {
-            RED.log.warn(`Get objects failed on service ${req.query.sid} ${err ? ` - ${JSON.stringify(err)}` : ''}`);
+            RED.log.warn(
+              `Get objects failed on service ${req.query.sid}: ${err.code}, ${
+                err.message ? err.message : ''
+              }`
+            );
           });
       }
-    });
-  
-    RED.httpAdmin.get('/mgethid', RED.auth.needsPermission('serial.read'), function (req, res) {
+    }
+  );
+
+  RED.httpAdmin.get(
+    '/mgethid',
+    RED.auth.needsPermission('serial.read'),
+    function (req, res) {
       let conn = RED.nodes.getNode(req.query.mobius);
       if (conn === null || !conn.connected) {
         RED.log.error('Get hid failed - could not to connect to MOBiUS hub.');
@@ -726,23 +827,27 @@ module.exports = function (RED) {
       } else {
         res.json(conn.hubId);
       }
-    });
+    }
+  );
 
-    RED.httpAdmin.get('/mgetconnected', RED.auth.needsPermission('serial.read'), function (req, res) {
+  RED.httpAdmin.get(
+    '/mgetconnected',
+    RED.auth.needsPermission('serial.read'),
+    function (req, res) {
       let conn = RED.nodes.getNode(req.query.mobius);
       if (conn === null) {
         res.json(false);
       } else {
         res.json(conn.connected);
       }
-    });
-
-    RED.httpAdmin.get('/common/*', function (req, res) {
-      var options = {
-        root: __dirname + '/common/',
-        dotfiles: 'deny',
-      };
-      res.sendFile(req.params[0], options);
-    });
+    }
+  );
 
+  RED.httpAdmin.get('/common/*', function (req, res) {
+    var options = {
+      root: __dirname + '/common/',
+      dotfiles: 'deny',
+    };
+    res.sendFile(req.params[0], options);
+  });
 };

package/dist/nodes/mobius-discover-object-list.html

@@ -24,7 +24,10 @@ ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.
 -->
 
-<script type="text/x-red" data-template-name="mobius discover object list">
+<script
+  type="text/x-red"
+  data-template-name="mobius discover object list"
+>
   <div class="form-row">
     <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
     <input type="text" id="node-input-name" placeholder="Name">
@@ -138,7 +141,7 @@ POSSIBILITY OF SUCH DAMAGE.
     },
     oneditprepare: function () {
       var node = this;
-      let mobiusSrvc = $("#node-input-connection").val();
+      let mobiusSrvc = $('#node-input-connection').val();
 
       /** Create the subs container and populate it */
       $('#node-input-subs-container')
@@ -167,15 +170,21 @@ POSSIBILITY OF SUCH DAMAGE.
             }).appendTo(row);
 
             // *** MOBSEARCH *** //
-            var searchField = $('<a class="searchbutton" style="margin-left: 5px; vertical-align: middle"><i id="node-lookup-instance-icon" class="fa fa-search"></i></a>').appendTo(row);
+            var searchField = $(
+              '<a class="searchbutton" style="margin-left: 5px; vertical-align: middle"><i id="node-lookup-instance-icon" class="fa fa-search"></i></a>'
+            ).appendTo(row);
             // *** END MOBSEARCH *** //
 
             var typeField = $('<select/>', {
               class: 'node-input-sub-type',
               style: 'width:auto; margin-left: 5px; text-align: center;',
             }).appendTo(row);
-            typeField.append($('<option></option>').val('include').text('Include'));
-            typeField.append($('<option></option>').val('exclude').text('Exclude'));
+            typeField.append(
+              $('<option></option>').val('include').text('Include')
+            );
+            typeField.append(
+              $('<option></option>').val('exclude').text('Exclude')
+            );
 
             // Populate the new stat
             uriField.val(subscription.uri);
@@ -184,10 +193,10 @@ POSSIBILITY OF SUCH DAMAGE.
             // *** MOBSEARCH *** //
 
             if (!node.subscriptions[i]) {
-              node.subscriptions[i] = {uri: '', type: 'include'}
+              node.subscriptions[i] = { uri: '', type: 'include' };
             }
 
-            addMobsearchListButton(mobiusSrvc, searchField, i, mobsearchOpts)
+            addMobsearchListButton(mobiusSrvc, searchField, i, mobsearchOpts);
             // *** END MOBSEARCH *** //
           },
         });
@@ -198,7 +207,7 @@ POSSIBILITY OF SUCH DAMAGE.
       if (!node.subscriptions) {
         node.subscriptions = [(subscription = { uri: '', type: 'include' })];
       }
-      
+
       // *** MOBSEARCH *** //
 
       mobsearchOpts = {
@@ -244,7 +253,9 @@ POSSIBILITY OF SUCH DAMAGE.
       }
       var editorRow = $('#dialog-form>div.node-input-subs-container-row');
       height -=
-        4 * (parseInt(editorRow.css('marginTop')) + parseInt(editorRow.css('marginBottom')));
+        4 *
+        (parseInt(editorRow.css('marginTop')) +
+          parseInt(editorRow.css('marginBottom')));
 
       $('#node-input-subs-container').editableList('height', height);
     },
@@ -270,7 +281,10 @@ POSSIBILITY OF SUCH DAMAGE.
   });
 </script>
 
-<script type="text/x-red" data-help-name="mobius discover object list">
+<script
+  type="text/x-red"
+  data-help-name="mobius discover object list"
+>
     <p>Discover MOBiUS objects and return a filtered list of objects or URIs.</p>
 
     <h3>Configuration Page</h3>

package/dist/nodes/mobius-discover-object-list.js

@@ -126,7 +126,11 @@ module.exports = function (RED) {
         let objectList = [];
         try {
           const hid = node.hid === '' ? node.serviceConn.hubId : node.hid;
-          const profiles = await discoverProfiles(node.serviceConn, hid, node.subscriptions);
+          const profiles = await discoverProfiles(
+            node.serviceConn,
+            hid,
+            node.subscriptions
+          );
 
           for await (let entry of profiles.entries()) {
             let discoverParams = {};
@@ -150,15 +154,28 @@ module.exports = function (RED) {
               };
             }
             try {
-              let objects = await filterObjectsByRIDValue(node.serviceConn, discoverParams);
+              let objects = await filterObjectsByRIDValue(
+                node.serviceConn,
+                discoverParams
+              );
               for (let lp = 0; lp < objects.value.length; lp++) {
                 objects.value[lp][
                   'uri'
                 ] = `${serviceURI}/${objects.value[lp].pid}/${objects.value[lp].ins}`;
-                objectList.push(objects.value[lp]);
+                if (
+                  isIncluded(
+                    `${objects.value[lp]['uri']}`,
+                    node.subscriptions
+                  ) &&
+                  !isExcluded(`${objects.value[lp]['uri']}`, node.subscriptions)
+                ) {
+                  objectList.push(objects.value[lp]);
+                }
               }
             } catch (err) {
-              node.warn(`Discover object failed for service (${serviceURI}) - ${err.message}`);
+              node.warn(
+                `Discover object failed for service (${serviceURI}) - ${err.message}`
+              );
             }
           }
 
@@ -185,10 +202,7 @@ module.exports = function (RED) {
             let profiles = await discover(serviceConn, `${hid}/${sid}`);
             let pids = [];
             for (const pid of profiles.data) {
-              if (
-                isIncluded(`${hid}/${sid}/${pid}/#`, subscriptions) &&
-                !isExcluded(`${hid}/${sid}/${pid}/#`, subscriptions)
-              ) {
+              if (isIncluded(`${hid}/${sid}/${pid}/#`, subscriptions)) {
                 pids.push(pid);
               }
             }
@@ -198,7 +212,9 @@ module.exports = function (RED) {
           }
         } else {
           RED.log.warn(
-            `Failed to discover objects for service ${service.id.split('/')[1]} as it is offline.`
+            `Failed to discover objects for service ${
+              service.id.split('/')[1]
+            } as it is offline.`
           );
         }
       }
@@ -240,7 +256,10 @@ module.exports = function (RED) {
   function isIncluded(uri, subscriptions) {
     let include = false;
     for (const subscription of subscriptions) {
-      if (subscription.type === 'include' && validateSubscription(subscription.uri)) {
+      if (
+        subscription.type === 'include' &&
+        validateSubscription(subscription.uri)
+      ) {
         if (matchTopic(subscription.uri, uri)) {
           include = true;
         }
@@ -252,7 +271,10 @@ module.exports = function (RED) {
   function isExcluded(uri, subscriptions) {
     let exclude = false;
     for (const subscription of subscriptions) {
-      if (subscription.type === 'exclude' && validateSubscription(subscription.uri)) {
+      if (
+        subscription.type === 'exclude' &&
+        validateSubscription(subscription.uri)
+      ) {
         if (matchTopic(subscription.uri, uri)) {
           exclude = true;
         }
@@ -280,12 +302,23 @@ module.exports = function (RED) {
   function matchTopic(filter, topic) {
     const filterArray = filter.split('/');
     const topicArray = topic.split('/');
-    const length = filterArray.length < topicArray.length ? filterArray.length : topicArray.length;
+    const length =
+      filterArray.length < topicArray.length
+        ? filterArray.length
+        : topicArray.length;
 
     for (let i = 0; i < length; ++i) {
       const left = filterArray[i];
       const right = topicArray[i];
-      if (!(left === right || left === '+' || left === '#' || right === '+' || right === '#')) {
+      if (
+        !(
+          left === right ||
+          left === '+' ||
+          left === '#' ||
+          right === '+' ||
+          right === '#'
+        )
+      ) {
         return false;
       }
     }

package/dist/nodes/mobius-get-multi-object.js

@@ -28,7 +28,7 @@
 'use strict';
 
 module.exports = function (RED) {
-  function MobiusFlowNode (n) {
+  function MobiusFlowNode(n) {
     RED.nodes.createNode(this, n);
     this.mobjects = n.mobjects;
     this.serviceConn = RED.nodes.getNode(n.connection);
@@ -38,7 +38,7 @@ module.exports = function (RED) {
       node.status({
         fill: 'red',
         shape: 'ring',
-        text: 'Disconnected'
+        text: 'Disconnected',
       });
 
       node.serviceConn.register(node);
@@ -47,7 +47,7 @@ module.exports = function (RED) {
         node.status({
           fill: 'green',
           shape: 'ring',
-          text: 'Busy'
+          text: 'Busy',
         });
 
         for (const mobject of node.mobjects) {
@@ -55,7 +55,7 @@ module.exports = function (RED) {
             node.status({
               fill: 'yellow',
               shape: 'dot',
-              text: 'URIs not Valid'
+              text: 'URIs not Valid',
             });
             if (done) {
               return done();
@@ -71,17 +71,21 @@ module.exports = function (RED) {
             node.status({
               fill: 'green',
               shape: 'dot',
-              text: 'Done'
+              text: 'Done',
             });
-            node.send({ ...msg, topic: msg.topic, payload: values});
+            node.send({ ...msg, topic: msg.topic, payload: values });
           })
           .catch((err) => {
             node.status({
               fill: 'yellow',
               shape: 'dot',
-              text: 'Error: ' + JSON.stringify(err.code)
+              text: 'Error: ' + JSON.stringify(err.code),
             });
-            node.error('Mobius error reading object ' + JSON.stringify(err));
+            node.error(
+              `Mobius error reading object: ${err.code}, ${
+                err.message ? err.message : ''
+              }`
+            );
           })
           .finally(() => {
             if (done) {
@@ -98,7 +102,7 @@ module.exports = function (RED) {
     }
   }
 
-  function validateResourceURI (uri) {
+  function validateResourceURI(uri) {
     let parts = uri.split('/');
     for (let lp = 0; lp < parts.length; lp++) {
       if (parts[lp] === null || parts[lp] === '') {
@@ -111,7 +115,7 @@ module.exports = function (RED) {
     return false;
   }
 
-  function readObject (node, uri) {
+  function readObject(node, uri) {
     return new Promise((resolve, reject) => {
       node.serviceConn.readObject(uri, (err, response) => {
         if (err) {

package/dist/nodes/mobius-get-multi-resource.js

@@ -90,7 +90,11 @@ module.exports = function (RED) {
               shape: 'dot',
               text: 'Error: ' + JSON.stringify(err.code),
             });
-            node.error('Mobius error reading resource ' + JSON.stringify(err));
+            node.error(
+              `Mobius error reading resource: ${err.code}, ${
+                err.message ? err.message : ''
+              }`
+            );
           })
           .finally(() => {
             if (done) {
@@ -129,7 +133,11 @@ module.exports = function (RED) {
           if (node.sendFormat === 'array') {
             resolve(response.data.pv);
           } else {
-            resolve({ uri: uri, pv: response.data.pv, name: response.data.name });
+            resolve({
+              uri: uri,
+              pv: response.data.pv,
+              name: response.data.name,
+            });
           }
         }
       });