node-red-contrib-mobius-flow-base 2.5.86-beta.4 → 2.5.86-beta.40

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

@@ -30,11 +30,11 @@
 const _ = require('lodash');
 
 module.exports = function (RED) {
-  function MobiusGetObjectNode (n) {
+  function MobiusGetObjectNode(n) {
     RED.nodes.createNode(this, n);
     this.detailedOutput = n.detailedOutput;
     this.format = n.format;
-    this.mobject = n.mobject;
+    this.instance = n.instance;
     this.serviceConn = RED.nodes.getNode(n.connection);
     var node = this;
 
@@ -42,11 +42,11 @@ module.exports = function (RED) {
       node.status({
         fill: 'red',
         shape: 'ring',
-        text: 'Disconnected'
+        text: 'Disconnected',
       });
 
       node.on('input', function (msg) {
-        let uri = node.mobject;
+        let uri = node.instance;
         if (msg.hasOwnProperty('topic') && require('./validateURI')(msg.topic, 4)) {
           uri = msg.topic;
         }
@@ -54,32 +54,35 @@ module.exports = function (RED) {
         node.status({
           fill: 'green',
           shape: 'ring',
-          text: 'Busy'
+          text: 'Busy',
         });
         node.serviceConn.readObject(uri, (err, response) => {
           if (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));
             if (node.detailedOutput === true) {
-              node.send([null, null, {topic: uri, payload: { error: true, response: err }}]);
+              node.send([null, null, { topic: uri, payload: { error: true, response: err } }]);
             }
           } else {
             node.status({
               fill: 'green',
               shape: 'dot',
-              text: JSON.stringify(response.uri)
+              text: JSON.stringify(response.uri),
             });
 
-            let allResources = _.keyBy(response.value.resources, node.format === 'name' ? 'name' : 'rid');
+            let allResources = _.keyBy(
+              response.value.resources,
+              node.format === 'name' ? 'name' : 'rid'
+            );
             if (node.detailedOutput === true) {
               node.send([
                 { topic: uri, payload: allResources },
                 { topic: uri, payload: response.value },
-                { topic: uri, payload: { error: false, response: response } }
+                { topic: uri, payload: { error: false, response: response } },
               ]);
             } else {
               node.send({ topic: uri, payload: allResources });

package/dist/nodes/mobius-object-cov.html

@@ -29,9 +29,35 @@ POSSIBILITY OF SUCH DAMAGE.
     <label for="node-input-connection"><i class="fa fa-globe"></i> MOBiUS</label>
     <input type="text" id="node-input-connection">
   </div>
-  <div class="form-row">
-    <label for="node-input-object"><i class="fa fa-tasks"></i> URI</label>
-    <input type="text" id="node-input-object" placeholder="Object URI (hid/sid/pid/ins)">
+  <div id="instance-message-row" class="form-row hidden" style="color:#ff0000" align="center">
+    <p>To select a configured object from a drop-down list, <br/>
+    please create a MOBiUS connection, deploy the flow, and <br />
+    ensure that the node-red-connector service is running. <br />
+    Click the Confirm Deploy button if asked.</p>
+  </div>
+  <div id="instance-row">
+    <div class="form-row">
+      <label for="node-input-instance"><i class="fa fa-tasks"></i> URI</label>
+      <input type="text" id="node-input-instance" style="width:61%;" placeholder="HID/SID/PID/INS (optional name)">
+      <a id="node-lookup-instance" class="searchbutton" style="vertical-align: middle"><i id="node-lookup-instance-icon" class="fa fa-search"></i></a>
+    </div>
+  </div>
+  <div id="instance-search-row">
+    <div class="form-row">
+      <label for="instance-search-sid"><i class="fa fa-tasks"></i> URI</label>
+      <input type="text" id="instance-search-hid" style="width:15%;" placeholder="HID">
+      <input type="text" id="instance-search-sid" style="width:10%;" placeholder="SID">
+      <input type="text" id="instance-search-pid" style="width:10%;" placeholder="PID">
+      <input type="text" id="instance-search-ins" style="width:10%;" placeholder="INS">
+      <a id="node-search-return" class="searchbutton" style="vertical-align: middle"><i id="node-search-return-icon" class="fa fa-arrow-left"></i></a>
+      <a id="node-search-accept" class="searchbutton" style="vertical-align: middle"><i id="node-search-accept-icon" class="fa fa-check"></i></a>
+    </div>
+  </div>
+  <div id="wildcard-alert-row" class="form-row hidden" style="color:#555555" align="center">
+    <p>Please note: The selection of wildcard '+'
+      means a search for a specific instance or resource
+      cannot be performed. As such, enter the 
+      INS manually.</p>
   </div>
   <div class="form-row">
     <label for="node-input-include"><i class="fa fa-bars"></i> Include</label>
@@ -67,7 +93,7 @@ POSSIBILITY OF SUCH DAMAGE.
       detailedOutput: {value:false},
       format: {value: "name", required: true},
       include: {value: "changed", required: true},
-      object: {value:"", validate:function(v) {
+      instance: {value:"", validate:function(v) {
         if(v === '') { return true; }
         let parts = v.split('/');
         for(let lp = 0; lp < parts.length; lp++) {
@@ -94,12 +120,251 @@ POSSIBILITY OF SUCH DAMAGE.
       if(this.name) {
         return this.name;
       } else {
-        return this.object ? `ObjCOV - ${this.object}` : "object cov";
+        return this.instance ? `ObjCOV - ${this.instance}` : "object cov";
       }
     },
     labelStyle: function() {
       return this.name ? "node_label_italic":"";
     },
+    oneditprepare: function () {
+
+      var node = this;
+      let mobiusSrvc = $("#node-input-connection").val();
+
+      $("#instance-search-row").hide();
+
+      function doesMobiusServiceExist() {
+        let srvc = $("#node-input-mobius").val();
+        if (srvc === '_ADD_') {
+          $("#node-lookup-instance").hide();
+          $("#instance-message-row").show();
+        } else {
+          $("#instance-message-row").hide();
+          $("#node-lookup-instance").show();
+        }
+      }
+      doesMobiusServiceExist();
+
+      $("#node-search-return").addClass('disabled');
+
+      // *** MOBSEARCH *** //
+
+      //Inital setup
+      $("#instance-search-row").hide();
+      $("#wildcard-alert-row").hide();
+      $("#node-search-return").addClass('disabled');
+      $.getJSON(`mgethid?mobius=${mobiusSrvc}`, function (response) {
+        $("#instance-search-hid").val(response);
+      })
+      let readyToAccept = false;
+      let searchObject = {
+        hid: $("#instance-search-hid").val(),
+        sid: $("#instance-search-sid").val(),
+        pid: $("#instance-search-pid").val(),
+        ins: $("#instance-search-ins").val(),
+        objects: []
+      }
+
+      //Function to search for INSs
+      function insSearch (objects, pid) {
+        let inss = ['#'];
+        for (let i = 0; i < objects.length; i++) {
+          if (objects[i].pid === pid) {
+            const name = objects[i].resources[1].pv;
+            if (name === '') {
+              inss.push(objects[i].ins);
+            } else {
+              inss.push(`${objects[i].ins} - ${name}`);
+            }
+          }
+        }
+        $("#instance-search-ins").autocomplete({
+          source: inss,
+          minLength: 0,
+          close: function (event, ui) {
+            acceptCheck();
+            $("#instance-search-ins").autocomplete('destroy');
+            if ($("#instance-search-ins").val().length > 4) {
+              $("#instance-search-ins").val($("#instance-search-ins").val().substring(0, 4))
+            }
+            searchObject.ins = $("#instance-search-ins").val();
+          }
+        }).autocomplete('search', '');
+      }
+
+      //Function to search for PIDs
+      function pidsSearch(objects) {
+        searchObject.objects = objects;
+        let pids = ['#', '+'];
+        for (let i = 0; i < objects.length; i++) {
+          pids.push(`${objects[i].pid} - ${objects[i].profileName}`);
+        }
+        pids = [...new Set(pids)];
+        $("#instance-search-pid").autocomplete({
+          source: pids,
+          minLength: 0,
+          close: function (event, ui) {
+            acceptCheck();
+            $("#instance-search-pid").autocomplete('destroy');
+            if ($("#instance-search-pid").val().length > 4) {
+              $("#instance-search-pid").val($("#instance-search-pid").val().substring(0, 4))
+            }
+            searchObject.pid = $("#instance-search-pid").val();
+          }
+        }).autocomplete('search', '');
+      }
+
+      //Function to search for SIDs, and then fetch child objects based on selection
+      function serviceSearch(response) {
+        let services = ['#', '+'];
+        for (let i = 0; i < response.length; i++) {
+          if (response[i].sid !== '009') {
+            services.push(`${response[i].sid} - ${response[i].name}`);
+          }
+        }
+        $("#instance-search-sid").autocomplete({
+          source: services,
+          minLength: 0,
+          close: function (event, ui) {
+            acceptCheck();
+            $("#instance-search-sid").autocomplete('destroy');
+            if ($("#instance-search-sid").val().length > 3) {
+              $("#instance-search-sid").val($("#instance-search-sid").val().substring(0, 3))
+            }
+            searchObject.sid = $("#instance-search-sid").val();
+            if (searchObject.sid === '+') {
+              for (let i = 2; i < services.length; i++) {
+                $.getJSON(`mgetobjects?mobius=${mobiusSrvc}&hid=${searchObject.hid}&sid=${services[i].substring(0, 3)}`, (objects) => {
+                  searchObject.objects = searchObject.objects.concat(objects);
+                })
+              }
+            } else {
+              $.getJSON(`mgetobjects?mobius=${mobiusSrvc}&hid=${searchObject.hid}&sid=${searchObject.sid}`, (objects) => {
+                searchObject.objects = objects;
+              })
+            }
+          }
+        }).autocomplete('search', '');
+      }
+
+      //Start a new search
+      function startSearch() {
+        $("#wildcard-alert-row").hide();
+        $("#instance-search-sid").val('');
+        $("#instance-search-pid").val('');
+        $("#instance-search-ins").val('');
+        searchObject.hid = $("#instance-search-hid").val()
+        searchObject.sid = '';
+        searchObject.pid = '';
+        searchObject.ins = '';
+        if (/((^([0-9A-F]){6}$)|^$)/.test(searchObject.hid)) {
+          $.getJSON(`mgetservices?mobius=${mobiusSrvc}&hid=${searchObject.hid}`, serviceSearch)
+            .fail((err) => {
+              console.log('Some kind of html failure message on service discovery');
+            });
+        }
+      }
+
+      //Finish a search
+      function finishSearch() {
+        $("#wildcard-alert-row").hide();
+        let uri = `${searchObject.hid}/${searchObject.sid}/${searchObject.pid}/${searchObject.ins}`
+        if (uri.includes('#')) {
+          uri = uri.substring(0,uri.indexOf('#') + 1)
+        }
+        $("#node-input-instance").val(uri);
+        $("#node-search-accept").css('color', '#CCCCCC');
+        readyToAccept = false;
+        $("#node-search-return").addClass('disabled');
+        $("#node-search-accept").addClass('disabled');
+        $("#node-lookup-instance").removeClass('disabled');
+        $("#instance-search-row").hide();
+        $("#instance-row").show();
+      }
+
+      //Function to update if accept button is grade out and functions based on conditions of fields
+      function acceptCheck() {
+        if (($("#instance-search-hid").val() !== '' && $("#instance-search-sid").val() !== '' && $("#instance-search-pid").val() !== '' && $("#instance-search-ins").val() !== '') ||
+        $("#instance-search-sid").val() === '#' || $("#instance-search-pid").val() === '#' || $("#instance-search-ins").val() === '#') {
+          $("#node-search-accept").css('color', '#555555');
+          readyToAccept = true;
+        } else {
+          $("#node-search-accept").css('color', '#CCCCCC');
+          readyToAccept = false;
+        }
+        if ($("#instance-search-sid").val() !== '+' && $("#instance-search-pid").val() !== '+') {
+          $("#wildcard-alert-row").hide();
+        } else {
+          $("#wildcard-alert-row").show();
+        }
+      }
+
+      // Respond to clicks
+      $("#node-lookup-instance").click(function () {  //When search button is clicked
+        $("#instance-search-sid").val('');
+        $("#instance-search-pid").val('');
+        $("#instance-search-ins").val('');
+        $("#node-lookup-instance").addClass('disabled');
+        $("#node-search-return").removeClass('disabled');
+        $("#node-search-accept").removeClass('disabled');
+        $("#instance-row").hide();
+        $("#instance-search-row").show();
+      });
+      $("#instance-search-sid").click(function () {     //SID field clicked
+        $("#instance-search-pid").val('')
+        $("#instance-search-ins").val('')
+        searchObject.pid = '';
+        searchObject.ins = '';
+        searchObject.objects = [];
+        startSearch();
+      })
+      $("#instance-search-pid").click(function () {    //PID field clicked
+        $("#instance-search-ins").val('')
+        searchObject.ins = '';
+        if (searchObject.sid !== '') {
+          pidsSearch(searchObject.objects);
+        }
+      })
+      $("#instance-search-ins").click(function () {   //INS field clicked
+        if (searchObject.pid !== '' && searchObject.pid !== '+' && searchObject.sid !== '+') {
+          insSearch(searchObject.objects, searchObject.pid);
+        }
+      })
+      $("#node-search-return").click(function () {    //Return/Back button clicked
+        $("#node-search-return").addClass('disabled');
+        $("#node-search-accept").addClass('disabled');
+        $("#node-lookup-instance").removeClass('disabled');
+        $("#instance-search-row").hide();
+        $("#instance-row").show();
+      });
+      $("#node-search-accept").click(function () {    //Accept button clicked
+        if (readyToAccept) {
+          finishSearch();
+        }
+      });
+
+      // Respond to search field changes
+      $("#instance-search-hid").change(function () {
+        acceptCheck();
+        $("#instance-search-sid").val('');
+        $("#instance-search-pid").val('');
+        $("#instance-search-ins").val('');
+      });
+      $("#instance-search-sid").change(function () {
+        searchObject.sid = $("#instance-search-sid").val()
+        acceptCheck();
+      });
+      $("#instance-search-pid").change(function () {
+        searchObject.pid = $("#instance-search-pid").val()
+        acceptCheck();
+      });
+      $("#instance-search-ins").change(function () {
+        searchObject.ins = $("#instance-search-ins").val()
+        acceptCheck();
+      });
+
+      // *** MOBSEARCH *** //
+    },
     oneditsave: function() {
       if($("#node-input-detailedOutput").prop('checked')) {
         this.outputs = 3;

package/dist/nodes/mobius-object-cov.js

@@ -29,10 +29,10 @@
 var _ = require('lodash');
 
 module.exports = function (RED) {
-  function MobiusObjectCovNode (n) {
+  function MobiusObjectCovNode(n) {
     RED.nodes.createNode(this, n);
     this.detailedOutput = n.detailedOutput;
-    this.object = n.object;
+    this.instance = n.instance;
     this.format = n.format;
     this.include = n.include;
     this.serviceConn = RED.nodes.getNode(n.connection);
@@ -42,16 +42,19 @@ module.exports = function (RED) {
       node.status({
         fill: 'red',
         shape: 'ring',
-        text: 'Disconnected'
+        text: 'Disconnected',
       });
 
-      node.serviceConn.subscribeToObjectCOV(node.object, this.id, (response) => {
+      node.serviceConn.subscribeToObjectCOV(node.instance, this.id, (response) => {
         node.status({
           fill: 'green',
           shape: 'dot',
-          text: JSON.stringify(response.uri)
+          text: JSON.stringify(response.uri),
         });
-        let allResources = _.keyBy(response.value.resources, node.format === 'name' ? 'name' : 'rid');
+        let allResources = _.keyBy(
+          response.value.resources,
+          node.format === 'name' ? 'name' : 'rid'
+        );
         if (node.include === 'changed') {
           allResources = _.pickBy(allResources, (res) => {
             return response.changed.includes(res.rid);
@@ -61,7 +64,7 @@ module.exports = function (RED) {
           node.send([
             { topic: response.uri, payload: allResources },
             { topic: response.uri, payload: response.value },
-            { topic: response.uri, payload: { response: response } }
+            { topic: response.uri, payload: { response: response } },
           ]);
         } else {
           node.send({ topic: response.uri, payload: allResources });

package/dist/nodes/node-red-ui-discover-devices.js

@@ -29,7 +29,7 @@
 const _ = require('lodash');
 
 module.exports = {
-  async discover (connection, uri) {
+  async discover(connection, uri) {
     return new Promise((resolve, reject) => {
       connection.discover(uri, (err, response) => {
         if (err) {
@@ -41,7 +41,7 @@ module.exports = {
     });
   },
 
-  async discoverDevicesByPID (RED, connection, hid, spids, pid) {
+  async discoverDevicesByPID(RED, connection, hid, spids, pid) {
     let devices = [];
     if (!hid || hid === '') {
       hid = connection.service.srvcAPI.status.hubId;
@@ -54,12 +54,17 @@ module.exports = {
       throw new Error(`Discover devices failed (${hid}) - ${err.message}`);
     }
     for (let srvcLoop = 0; srvcLoop < services.value.length; srvcLoop++) {
-      if (services.value[srvcLoop].status === 'online' && (spids.length === 0 || spids.includes(services.value[srvcLoop].spid))) {
+      if (
+        services.value[srvcLoop].status === 'online' &&
+        (spids.length === 0 || spids.includes(services.value[srvcLoop].spid))
+      ) {
         let insURI = `${hid}/${services.value[srvcLoop].id.split('/')[1]}/${pid}`;
         try {
           let instances = await this.discover(connection, insURI);
           for (let insLoop = 0; insLoop < instances.value.length; insLoop++) {
-            let deviceURI = `${hid}/${services.value[srvcLoop].id.split('/')[1]}/${pid}/${instances.value[insLoop]}`;
+            let deviceURI = `${hid}/${services.value[srvcLoop].id.split('/')[1]}/${pid}/${
+              instances.value[insLoop]
+            }`;
             let device = await this.discover(connection, deviceURI);
             let resourcesByName = _.keyBy(device.value[0].resources, 'name');
             let deviceName = resourcesByName['name'].pv;
@@ -79,7 +84,7 @@ module.exports = {
     });
   },
 
-  async discoverServicesBySPID (RED, connection, hid, spid) {
+  async discoverServicesBySPID(RED, connection, hid, spid) {
     if (!hid || hid === '') {
       hid = connection.service.srvcAPI.status.hubId;
     }
@@ -99,5 +104,130 @@ module.exports = {
     return new Promise((resolve) => {
       resolve(srvcs);
     });
-  }
+  },
+
+  getServiceList(connection, hid) {
+    // getNodeConfig -> id, spid, uri, name, enabled, runAtStart
+    // For every: getServiceConfig -> mobiusSettings, customSettings
+    // discover -> registered, last connected, status + any remaining if new service
+    // For every: discover object -/0001/0001 -> status, statusText
+    return new Promise(async (resolve, reject) => {
+      try {
+        // Fetch information from node config
+        const nodeConfig = await connection.getNodeConfig(hid);
+        const servicesFromConfig = nodeConfig.value.services;
+        let services = [];
+        for (let i = 0; i < servicesFromConfig.length; i++) {
+          services.push({
+            id: servicesFromConfig[i].id,
+            spid: servicesFromConfig[i].id.split('/')[0],
+            sid: servicesFromConfig[i].id.split('/')[1],
+            uri: `${nodeConfig.uri}/${servicesFromConfig[i].id.split('/')[1]}`,
+            name: servicesFromConfig[i].name,
+            enabled: servicesFromConfig[i].enabled,
+            runAtStart: servicesFromConfig[i].runAtStart,
+            registered: null,
+            lastConnected: null,
+            status: null,
+            statusText: null,
+            mobiusSettings: null,
+            customSettings: null,
+            pids: [],
+          });
+        }
+
+        // Fetch information from each service config
+        for (let i = 0; i < services.length; i++) {
+          const fullServiceConfig = await connection.getServiceConfigProm(hid, services[i].sid);
+          if (fullServiceConfig.value.serviceConfig !== undefined) {
+            services[i].mobiusSettings = fullServiceConfig.value.serviceConfig.settings;
+            services[i].customSettings = fullServiceConfig.value.serviceConfig.custom;
+          } else {
+            services[i].mobiusSettings = fullServiceConfig.value.settings;
+            services[i].customSettings = fullServiceConfig.value.custom;
+          }
+        }
+
+        // Fetch information from discovered services
+        const discoveryResponse = await this.discover(connection, hid);
+        const servicesFromDiscovery = discoveryResponse.value;
+        for (let i = 0; i < servicesFromDiscovery.length; i++) {
+          let serviceFound = false;
+          for (let j = 0; j < services.length; j++) {
+            if (servicesFromDiscovery[i].id === services[j].id) {
+              serviceFound = true;
+              services[j].registered = servicesFromDiscovery[i].registered;
+              services[j].lastConnected = servicesFromDiscovery[i].lastconnected;
+              j = services.length;
+            }
+          }
+          if (!serviceFound) {
+            services.push({
+              id: servicesFromDiscovery[i].id,
+              spid: servicesFromDiscovery[i].id.split('/')[0],
+              sid: servicesFromDiscovery[i].id.split('/')[1],
+              uri: `${nodeConfig.uri}/${servicesFromDiscovery[i].id.split('/')[1]}`,
+              name: null,
+              enabled: null,
+              runAtStart: null,
+              registered: servicesFromDiscovery[i].registered,
+              lastConnected: servicesFromDiscovery[i].lastconnected,
+              status: null,
+              statusText: null,
+              mobiusSettings: null,
+              customSettings: null,
+              pids: [],
+            });
+          }
+        }
+
+        // Fetch pids and status object from all services
+        for (let i = 0; i < services.length; i++) {
+          if (services[i].sid !== '009') {
+            const serviceResponse = await this.discover(connection, `${hid}/${services[i].sid}`);
+            services[i].pids = [...new Set(serviceResponse.value)];
+            const statusObjectResponse = await this.discover(
+              connection,
+              `${hid}/${services[i].sid}/0001/0001`
+            );
+            const statusObject = statusObjectResponse.value[0];
+            services[i].status = statusObject.resources[1].pv;
+            services[i].statusText = `${statusObject.resources[2].pv}`;
+          } else {
+            services[i].pids = [];
+            services[i].status = 'Unknown';
+            services[i].statusText = 'Unknown';
+          }
+        }
+
+        resolve(services);
+      } catch (err) {
+        reject(JSON.stringify(err));
+      }
+    });
+  },
+
+  getObjectList(connection, hid, sid) {
+    return new Promise(async (resolve, reject) => {
+      try {
+        let objectList = [];
+        const serviceResponse = await this.discover(connection, `${hid}/${sid}`);
+        const pids = [...new Set(serviceResponse.value)];
+        for (let i = 0; i < pids.length; i++) {
+          const inssResponse = await this.discover(connection, `${hid}/${sid}/${pids[i]}`);
+          const inss = inssResponse.value;
+          for (let j = 0; j < inss.length; j++) {
+            const objResponse = await this.discover(
+              connection,
+              `${hid}/${sid}/${pids[i]}/${inss[j]}`
+            );
+            objectList.push(objResponse.value[0]);
+          }
+        }
+        resolve(objectList);
+      } catch (err) {
+        reject(JSON.stringify(err));
+      }
+    });
+  },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-mobius-flow-base",
-  "version": "2.5.86-beta.4",
+  "version": "2.5.86-beta.40",
   "description": "Node-RED base nodes for Mobius Flow",
   "main": "index.js",
   "types": "dist/index.d.ts",