node-red-contrib-mobius-flow-base 2.5.91 → 3.0.0-beta.12

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

@@ -53,10 +53,13 @@ POSSIBILITY OF SUCH DAMAGE.
       <option value="array">Array of Items</option>
     </select>
   </div>
-  <div class="form-row node-input-subs-container-row">
+  <div id="node-input-subs-container-row" class="form-row node-input-subs-container-row">
     <label for="node-input-subs-container" style="width:105px;float:left;"><i class="fa fa-bars"></i> Discover</label>
       <ol id="node-input-subs-container"></ol>
   </div>
+
+  <div id="mobsearch"></div>
+
   <div class="form-row">
     <label for="node-input-useRIDValueFiltering" style="width:178px;float:left;"><i class="fa fa-filter"></i> Filter by Resource Value</label>
     <input type="checkbox" id="node-input-useRIDValueFiltering" style="display: inline-block; width: auto; vertical-align: top;">
@@ -77,196 +80,252 @@ POSSIBILITY OF SUCH DAMAGE.
   </div>
 </script>
 
+<script src="common/mobsearch.js"></script>
+
 <script type="text/javascript">
   RED.nodes.registerType('mobius discover object list', {
     category: 'mobius',
     defaults: {
-      name: {value:""},
-      useRIDValueFiltering: {value: false},
-      func: {value:""},
-      limit: {value:100, validate:RED.validators.number()},
-      rid: {value: "", validate:function(v) {
-        if(v === '') { return true; }
-        if(v.length === 2) { return true; }
-        return false;
-      }},
-      output: {value: "objects", required: true},
-      send: {value: "individual", required: true},
-      subscriptions: {value:[{uri: '', type: 'include'}]},
-      hid: {value: "", validate:function(v) {
-        if(v === '') { return true; }
-        if(v.length === 6) { return true; }
-        return false;
-      }},
-      connection: {type:"mobius connection", required:true}
+      name: { value: '' },
+      useRIDValueFiltering: { value: false },
+      func: { value: '' },
+      limit: { value: 100, validate: RED.validators.number() },
+      rid: {
+        value: '',
+        validate: function (v) {
+          if (v === '') {
+            return true;
+          }
+          if (v.length === 2) {
+            return true;
+          }
+          return false;
+        },
+      },
+      output: { value: 'objects', required: true },
+      send: { value: 'individual', required: true },
+      subscriptions: { value: [{ uri: '', type: 'include' }] },
+      hid: {
+        value: '',
+        validate: function (v) {
+          if (v === '') {
+            return true;
+          }
+          if (v.length === 6) {
+            return true;
+          }
+          return false;
+        },
+      },
+      connection: { type: 'mobius connection', required: true },
     },
-    color:"#9ee3fa",
-    inputs:1,
-    outputs:1,
-    outputLabels: ["MOBiUS objects or URIs"],
-    icon: "mobius.png",
-    align: "left",
+    color: '#9ee3fa',
+    inputs: 1,
+    outputs: 1,
+    outputLabels: ['MOBiUS objects or URIs'],
+    icon: 'mobius.png',
+    align: 'left',
     paletteLabel: 'discover object list',
-    label: function() {
-      if(this.name) {
+    label: function () {
+      if (this.name) {
         return this.name;
       } else {
-        return "discover object list";
+        return 'discover object list';
       }
     },
-    labelStyle: function() {
-      return this.name ? "node_label_italic":"";
+    labelStyle: function () {
+      return this.name ? 'node_label_italic' : '';
     },
     oneditprepare: function () {
       var node = this;
+      let mobiusSrvc = $("#node-input-connection").val();
 
       /** Create the subs container and populate it */
-      $('#node-input-subs-container').css('min-height', '200px').css('min-width', '345px').editableList ({
-        addButton: "add uri",
-        removable: true,
-        sortable: true,
-        addItem: function (container, i, subscription) {
-          container.css({
-            overflow: 'hidden',
-            whiteSpace: 'nowrap'
-          });
+      $('#node-input-subs-container')
+        .css('min-height', '200px')
+        .css('min-width', '345px')
+        .editableList({
+          addButton: 'add uri',
+          removable: true,
+          sortable: true,
+          addItem: function (container, i, subscription) {
+            container.css({
+              overflow: 'hidden',
+              whiteSpace: 'nowrap',
+            });
 
-          // Add a default subscription if it does not exist
-          if (!subscription.hasOwnProperty("uri")) {
-            subscription = {uri: '', type: 'include'};
-          }
+            // Add a default subscription if it does not exist
+            if (!subscription.hasOwnProperty('uri')) {
+              subscription = { uri: '', type: 'include' };
+            }
 
-          var row = $('<div>URI</div>').appendTo(container);
-          var uriField = $('<input/>',{class: "node-input-sub-uri", type: "text", style: "width: 170px; margin-left: 5px; text-align: left;"}).appendTo(row);
-          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'));
+            var row = $('<div>URI</div>').appendTo(container);
+            var uriField = $('<input/>', {
+              class: 'node-input-sub-uri',
+              type: 'text',
+              style: 'width: 150px; margin-left: 5px; text-align: left;',
+            }).appendTo(row);
 
-          // Populate the new stat
-          uriField.val(subscription.uri);
-          typeField.val(subscription.type);
-        }
-      });
+            // *** 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);
+            // *** END MOBSEARCH *** //
 
-      $('.red-ui-editableList-addButton').css('margin-left', '105px')
+            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'));
+
+            // Populate the new stat
+            uriField.val(subscription.uri);
+            typeField.val(subscription.type);
+
+            // *** MOBSEARCH *** //
+
+            if (!node.subscriptions[i]) {
+              node.subscriptions[i] = {uri: '', type: 'include'}
+            }
+
+            addMobsearchListButton(searchField, i, mobsearchOpts)
+            // *** END MOBSEARCH *** //
+          },
+        });
+
+      $('.red-ui-editableList-addButton').css('margin-left', '105px');
 
       // If no stat exists, create a default one
       if (!node.subscriptions) {
-        node.subscriptions = [subscription = {uri: '', type: 'include'}];
+        node.subscriptions = [(subscription = { uri: '', type: 'include' })];
       }
+      
+      // *** MOBSEARCH *** //
+
+      mobsearchOpts = {
+        htmlElementId: 'mobsearch',
+        list: node.subscriptions,
+        containerRowName: 'node-input-subs-container-row',
+        containerName: 'node-input-subs-container',
+        containerSecondFieldName: 'node-input-sub-type',
+      };
+      initMobsearch.toIns_listed(mobiusSrvc, mobsearchOpts);
+
+      // *** END MOBSEARCH *** //
+
       // Populate list with all saved filters
       for (let i = 0; i < node.subscriptions.length; i++) {
         let subscription = node.subscriptions[i];
-        $("#node-input-subs-container").editableList('addItem', subscription);
+        $('#node-input-subs-container').editableList('addItem', subscription);
       }
 
       function showRIDFilterInputs() {
-        if($("#node-input-useRIDValueFiltering").is(':checked')) {
-          $("#use-rid-filter-row").show();
+        if ($('#node-input-useRIDValueFiltering').is(':checked')) {
+          $('#use-rid-filter-row').show();
         } else {
-          $("#use-rid-filter-row").hide();
+          $('#use-rid-filter-row').hide();
         }
       }
       showRIDFilterInputs();
-      $("#node-input-useRIDValueFiltering").change(function() {
+      $('#node-input-useRIDValueFiltering').change(function () {
         showRIDFilterInputs();
       });
 
       this.editor = RED.editor.createEditor({
         id: 'node-input-func-editor',
         mode: 'ace/mode/javascript',
-        value: this.func
+        value: this.func,
       });
     },
     oneditresize(size) {
-      var rows = $("#dialog-form>div:not(.node-input-subs-container-row)");
+      var rows = $('#dialog-form>div:not(.node-input-subs-container-row)');
       var height = size.height;
-      for (var i=0; i<rows.size(); i++) {
+      for (var i = 0; i < rows.size(); i++) {
         height -= $(rows[i]).outerHeight(true);
       }
-      var editorRow = $("#dialog-form>div.node-input-subs-container-row");
-      height -= 4 * ((parseInt(editorRow.css("marginTop"))+parseInt(editorRow.css("marginBottom"))));
+      var editorRow = $('#dialog-form>div.node-input-subs-container-row');
+      height -=
+        4 * (parseInt(editorRow.css('marginTop')) + parseInt(editorRow.css('marginBottom')));
 
-      $("#node-input-subs-container").editableList('height',height);
+      $('#node-input-subs-container').editableList('height', height);
     },
-    oneditsave: function() {
-      let subscriptions = $("#node-input-subs-container").editableList('items');
+    oneditsave: function () {
+      let subscriptions = $('#node-input-subs-container').editableList('items');
       let node = this;
-      node.subscriptions= [];
+      node.subscriptions = [];
       subscriptions.each(function (i) {
         var subscription = $(this);
-        let uri = subscription.find(".node-input-sub-uri").val();
-        let type = subscription.find(".node-input-sub-type").val();
-        node.subscriptions.push({uri: uri, type: type});
+        let uri = subscription.find('.node-input-sub-uri').val();
+        let type = subscription.find('.node-input-sub-type').val();
+        node.subscriptions.push({ uri: uri, type: type });
       });
 
       this.func = this.editor.getValue();
       this.editor.destroy();
       delete this.editor;
     },
-    oneditcancel: function() {
+    oneditcancel: function () {
       this.editor.destroy();
       delete this.editor;
-    }
+    },
   });
 </script>
 
 <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>
+    <p>Discover MOBiUS objects and return a filtered list of objects or URIs.</p>
 
-  <h3>Configuration Page</h3>
-  <dl class="message-properties">
-    <dt>MOBiUS <span class="property-type">node</span></dt>
-    <dd>Shared MOBiUS connection for communication with the MOBiUS Hub.</dd>
-    <dt>HID <span class="property-type">string</span></dt>
-    <dd>Optional Mobius hub ID to use for discovery. Leave empty to use the local HID.</dd>
-    <dt>Output <span class="property-type">option</span></dt>
-    <dd>Output full MOBiUS objects or MOBiUS object URIs.</dd>
-    <dt>Send <span class="property-type">option</span></dt>
-    <dd>Send the outputs individually or as a single array.</dd>
-    <dt>Discover <span class="property-type">string</span></dt>
-    <dd>The MOBiUS URI of the objects to discover. This may contain MQTT type wildcards.</dd>
-    <dt>Filter by Resource Value <span class="property-type">checkbox</span></dt>
-    <dd>If checked the returned objects are also filtered by the value of a single resource.</dd>
-    <dt>RID <span class="property-type">string</span></dt>
-    <dd>The MOBiUS Object Resource ID of the resource to test.</dd>
-    <dt class="optional">Limit <span class="property-type">number</span></dt>
-    <dd>The maximum number of objects to return. Defaults to 100.</dd>
-    <dt>Function <span class="property-type">string</span></dt>
-    <dd>JavaScript used to test the resource value.</dd>
-</dl>
+    <h3>Configuration Page</h3>
+    <dl class="message-properties">
+      <dt>MOBiUS <span class="property-type">node</span></dt>
+      <dd>Shared MOBiUS connection for communication with the MOBiUS Hub.</dd>
+      <dt>HID <span class="property-type">string</span></dt>
+      <dd>Optional Mobius hub ID to use for discovery. Leave empty to use the local HID.</dd>
+      <dt>Output <span class="property-type">option</span></dt>
+      <dd>Output full MOBiUS objects or MOBiUS object URIs.</dd>
+      <dt>Send <span class="property-type">option</span></dt>
+      <dd>Send the outputs individually or as a single array.</dd>
+      <dt>Discover <span class="property-type">string</span></dt>
+      <dd>The MOBiUS URI of the objects to discover. This may contain MQTT type wildcards.</dd>
+      <dt>Filter by Resource Value <span class="property-type">checkbox</span></dt>
+      <dd>If checked the returned objects are also filtered by the value of a single resource.</dd>
+      <dt>RID <span class="property-type">string</span></dt>
+      <dd>The MOBiUS Object Resource ID of the resource to test.</dd>
+      <dt class="optional">Limit <span class="property-type">number</span></dt>
+      <dd>The maximum number of objects to return. Defaults to 100.</dd>
+      <dt>Function <span class="property-type">string</span></dt>
+      <dd>JavaScript used to test the resource value.</dd>
+  </dl>
 
-  <h3>Inputs</h3>
-  <ol class="node-ports">
-    <li>Input message to trigger discovery
-      <dl class="message-properties">
-        <dt class="optional">topic <span class="property-type">string</span></dt>
-        <dd>Topic is passed through to output.</dd>
-      </dl>
-    </li>
-  </ol>
+    <h3>Inputs</h3>
+    <ol class="node-ports">
+      <li>Input message to trigger discovery
+        <dl class="message-properties">
+          <dt class="optional">topic <span class="property-type">string</span></dt>
+          <dd>Topic is passed through to output.</dd>
+        </dl>
+      </li>
+    </ol>
 
-  <h3>Outputs</h3>
-  <ol class="node-ports">
-    <li>Array of URIs discovered.
-      <dl class="message-properties">
-        <dt>topic <span class="property-type">string</span></dt>
-        <dd>When outputting individual items the topic will be the object URI and when outputting arrays the topic is passed through from input.</dd>
-        <dt>payload <span class="property-type">array</span></dt>
-        <dd>Array or individual list of discovered objects or URIs.</dd>
-      </dl>
-    </li>
-  </ol>
+    <h3>Outputs</h3>
+    <ol class="node-ports">
+      <li>Array of URIs discovered.
+        <dl class="message-properties">
+          <dt>topic <span class="property-type">string</span></dt>
+          <dd>When outputting individual items the topic will be the object URI and when outputting arrays the topic is passed through from input.</dd>
+          <dt>payload <span class="property-type">array</span></dt>
+          <dd>Array or individual list of discovered objects or URIs.</dd>
+        </dl>
+      </li>
+    </ol>
 
-  <h3>Details</h3>
-  <p>
-    The <code>Function</code> configuration property is string containing the JavaScript expression used to test the resource value. The expression must return <b>true</b> or <b>false</b>.
-    The actual value of the resource is represented in the expression by <code>$PV</code>. A few examples are shown below:</br>
-    <code>return $PV === 5;</code><br>
-    <code>return $PV > 10 && $PV < 100;</code><br>
-    <code>return $PV.includes('test-string');</code>
-  </p>
+    <h3>Details</h3>
+    <p>
+      The <code>Function</code> configuration property is string containing the JavaScript function used to test the resource value. The function must return <b>true</b> or <b>false</b>.
+      A few examples are shown below (The name v is used to represent the resource values in the following example. You can use any identifier of your choice):</br>
+      <code>(v) => { return v === 5; }</code><br>
+      <code>function test (v) { return v > 10 && v < 100; }</code><br>
+      <code>(v) => { return v.includes('test-string'); }</code>
+    </p>
 
-  <br>
-  <p align="center" style="color:#000080">iaconnects © 2019</p>
+    <br>
+    <p align="center" style="color:#000080">iaconnects © 2019</p>
 </script>

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

@@ -121,7 +121,7 @@ module.exports = function (RED) {
       return new Promise(async (resolve, reject) => {
         let objectList = [];
         try {
-          const hid = node.hid === '' ? node.serviceConn.service.srvcAPI.status.hubId : node.hid;
+          const hid = node.hid === '' ? node.serviceConn.hubId : node.hid;
           const profiles = await discoverProfiles(node.serviceConn, hid, node.subscriptions);
 
           for await (let entry of profiles.entries()) {
@@ -141,12 +141,12 @@ module.exports = function (RED) {
                 uri: serviceURI,
                 pids: pids,
                 rid: '00',
-                func: 'return true;',
+                func: '(v) => { return true; }',
                 limit: 512,
               };
             }
             try {
-              let objects = await discover(node.serviceConn, discoverParams);
+              let objects = await filterObjectsByRIDValue(node.serviceConn, discoverParams);
               for (let lp = 0; lp < objects.value.length; lp++) {
                 objects.value[lp][
                   'uri'
@@ -174,13 +174,13 @@ module.exports = function (RED) {
     return new Promise(async (resolve) => {
       let discoveredProfiles = new Map();
       let services = await discover(serviceConn, hid);
-      for (const service of services.value) {
+      for (const service of services.data) {
         if (service.status === 'online') {
           let sid = service.id.split('/')[1];
           if (isIncluded(`${hid}/${sid}/#`, subscriptions)) {
             let profiles = await discover(serviceConn, `${hid}/${sid}`);
             let pids = [];
-            for (const pid of profiles.value) {
+            for (const pid of profiles.data) {
               if (
                 isIncluded(`${hid}/${sid}/${pid}/#`, subscriptions) &&
                 !isExcluded(`${hid}/${sid}/${pid}/#`, subscriptions)
@@ -214,6 +214,25 @@ module.exports = function (RED) {
     });
   }
 
+  async function filterObjectsByRIDValue(serviceConn, params) {
+    return new Promise((resolve, reject) => {
+      serviceConn.filterObjectsByRIDValue(
+        params.uri,
+        params.pids,
+        params.rid,
+        params.limit,
+        eval('(' + params.func + ')'),
+        (err, response) => {
+          if (err) {
+            reject(err);
+          } else {
+            resolve(response);
+          }
+        }
+      );
+    });
+  }
+
   function isIncluded(uri, subscriptions) {
     let include = false;
     for (const subscription of subscriptions) {

package/dist/nodes/mobius-discover.js

@@ -28,7 +28,7 @@
 'use strict';
 
 module.exports = function (RED) {
-  function MobiusDiscoverNode (n) {
+  function MobiusDiscoverNode(n) {
     RED.nodes.createNode(this, n);
     this.serviceConn = RED.nodes.getNode(n.connection);
     var node = this;
@@ -37,7 +37,7 @@ module.exports = function (RED) {
       node.status({
         fill: 'red',
         shape: 'ring',
-        text: 'Disconnected'
+        text: 'Disconnected',
       });
 
       node.on('input', function (msg) {
@@ -50,13 +50,13 @@ module.exports = function (RED) {
           node.status({
             fill: 'yellow',
             shape: 'dot',
-            text: 'Error: Input message topic must contain a valid discovery URI'
+            text: 'Error: Input message topic must contain a valid discovery URI',
           });
         } else {
           node.status({
             fill: 'green',
             shape: 'ring',
-            text: 'Busy'
+            text: 'Busy',
           });
 
           let parameters = {};
@@ -66,19 +66,19 @@ module.exports = function (RED) {
           } else {
             parameters['uri'] = path;
           }
-          node.serviceConn.discover(parameters, (err, response) => {
+          node.serviceConn.discover(parameters.uri, (err, response) => {
             if (err) {
               node.status({
                 fill: 'yellow',
                 shape: 'dot',
-                text: 'Error: ' + JSON.stringify(err.code)
+                text: 'Error: ' + JSON.stringify(err.code),
               });
               node.send({ topic: path, payload: { error: true, response: err } });
             } else {
               node.status({
                 fill: 'green',
                 shape: 'dot',
-                text: JSON.stringify(response.uri)
+                text: JSON.stringify(response.uri),
               });
               node.send({ topic: path, payload: { error: false, response: response } });
             }