node-red-contrib-mobius-flow-base 2.5.86-beta.11 → 2.5.86-beta.112

package/dist/nodes/mobius-connection.js

@@ -193,12 +193,142 @@ module.exports = function (RED) {
       });
     };
 
+    /**
+     * Select status text and colour of node status based on last active time
+     * @param {number} lastActiveTime - The node's last active time
+     * @returns Object containing status text and status colour
+     */
+    node.buildLastActiveTimeStatus = function (lastActiveTime) {
+      let response = {
+        text: 'Unknown',
+        colour: 'green',
+      };
+      const timeSinceLastActive = Date.now() - lastActiveTime;
+      if (timeSinceLastActive < 15 * 60000) {
+        response.text = 'Active less than 15 minutes ago';
+      }
+      if (timeSinceLastActive >= 15 * 60000 && timeSinceLastActive < 3 * 60 * 60000) {
+        response.text = 'Active less than 3 hours ago';
+      }
+      if (timeSinceLastActive >= 3 * 60 * 60000 && timeSinceLastActive < 12 * 60 * 60000) {
+        response.text = 'Active less than 12 hours ago';
+      }
+      if (timeSinceLastActive >= 12 * 60 * 60000 && timeSinceLastActive < 24 * 60 * 60000) {
+        response.text = 'Active less than 24 hours ago';
+      }
+      if (timeSinceLastActive > 24 * 60 * 60000 && lastActiveTime > 0) {
+        response.colour = 'grey';
+        response.text = 'Active more than 24 hours ago';
+      }
+      if (lastActiveTime === 0) {
+        response.colour = 'grey';
+        response.text = 'Never Active';
+      }
+      return {
+        fill: response.colour,
+        shape: 'dot',
+        text: response.text,
+      };
+    };
+
+    /**
+     * Update a given node's node status based on last active time
+     * @param  {Object} mobiusNode - The node whos status is to be updated
+     */
+    node.updateNodeStatus = function (mobiusNode) {
+      node.users[mobiusNode.id] = mobiusNode;
+      if (!node.users[mobiusNode.id].inError) {
+        switch (node.users[mobiusNode.id].statusType) {
+          case 'timeSinceLastActive':
+            node.users[mobiusNode.id].status(
+              node.buildLastActiveTimeStatus(node.users[mobiusNode.id].lastActiveTime)
+            );
+            break;
+          case 'lastUri':
+            const uri = node.users[mobiusNode.id].latestUri;
+            if (uri !== '' && uri !== undefined) {
+              node.users[mobiusNode.id].status({
+                fill: 'green',
+                shape: 'dot',
+                text: uri,
+              });
+            }
+            break;
+          case 'lastValue':
+            const value = node.users[mobiusNode.id].latestValue;
+            if (value !== '' && value !== undefined) {
+              node.users[mobiusNode.id].status({
+                fill: 'green',
+                shape: 'dot',
+                text: value,
+              });
+            }
+            break;
+        }
+      } else {
+        node.users[mobiusNode.id].status({
+          fill: 'yellow',
+          shape: 'dot',
+          text: node.users[mobiusNode.id].latestErrMessage,
+        });
+      }
+    };
+
+    // Information update functions to be used by node status
+    // Calling any of these will update the node status
+    node.update = {
+      /**
+       * Update a given node's node last active time
+       * @param  {Object} mobiusNode - The node whos last active time is to be updated
+       */
+      lastActiveTime: (mobiusNode) => {
+        node.users[mobiusNode.id] = mobiusNode;
+        node.users[mobiusNode.id].lastActiveTime = Date.now();
+        node.users[mobiusNode.id].inError = false;
+        node.updateNodeStatus(mobiusNode);
+      },
+      /**
+       * Update a given node's node latest URI record
+       * @param  {Object} mobiusNode - The node whos last URI record is to be updated
+       * @param {string} uri - The latest uri to be sent by the node
+       */
+      latestUri: (mobiusNode, uri) => {
+        node.users[mobiusNode.id] = mobiusNode;
+        node.users[mobiusNode.id].latestUri = uri;
+        node.users[mobiusNode.id].inError = false;
+        node.updateNodeStatus(mobiusNode);
+      },
+      /**
+       * Update a given node's node latest sent value record
+       * @param  {Object} mobiusNode - The node whos last value record is to be updated
+       * @param {number} value - The latest value to be sent by the node
+       */
+      latestValue: (mobiusNode, value) => {
+        node.users[mobiusNode.id] = mobiusNode;
+        node.users[mobiusNode.id].latestValue = value;
+        node.users[mobiusNode.id].inError = false;
+        node.updateNodeStatus(mobiusNode);
+      },
+      /**
+       * Update a given node's node latest error message record
+       * @param  {Object} mobiusNode - The node whos last error message record is to be updated
+       * @param {number} value - The node's latest error message
+       */
+      errMessage: (mobiusNode, message) => {
+        node.users[mobiusNode.id] = mobiusNode;
+        node.users[mobiusNode.id].latestErrMessage = message;
+        node.users[mobiusNode.id].inError = true;
+        node.updateNodeStatus(mobiusNode);
+      },
+    };
+
     /**
      * Register a new Mobius node with this config node
      * @param  {Object} mobiusNode - The new node to register
      */
     node.register = function (mobiusNode) {
       node.users[mobiusNode.id] = mobiusNode;
+      node.users[mobiusNode.id].inError = false;
       if (node.connected) {
         node.users[mobiusNode.id].status({
           fill: 'green',
@@ -206,6 +336,12 @@ module.exports = function (RED) {
           text: 'Connected',
         });
       }
+      node.users[mobiusNode.id].lastActiveTime = 0;
+      node.users[mobiusNode.id].statusCheckLoop = setInterval(() => {
+        if (node.connected) {
+          node.updateNodeStatus(mobiusNode);
+        }
+      }, 60000);
     };
 
     /**
@@ -214,6 +350,7 @@ module.exports = function (RED) {
      * @param  {Function} done       - A callback to be run by the node after it has been deregistered
      */
     node.deregister = function (mobiusNode, done) {
+      clearInterval(node.users[mobiusNode.id].statusCheckLoop);
       delete node.users[mobiusNode.id];
       if (node.service) {
         try {
@@ -520,30 +657,6 @@ module.exports = function (RED) {
     node.updateObjectInServiceConfig = function (hid, sid, pid, ins, config, callback) {
       node.service.srvcAPI.updateObjectInServiceConfig(hid, sid, pid, ins, config, callback);
     };
-
-    node.getNodeConfig = function (hid) {
-      return new Promise((resolve, reject) => {
-        node.service.srvcAPI.getNodeConfig(hid, (err, response) => {
-          if (!err) {
-            resolve(response);
-          } else {
-            reject(err);
-          }
-        });
-      });
-    };
-
-    node.getServiceConfigProm = function (hid, sid) {
-      return new Promise((resolve, reject) => {
-        node.service.srvcAPI.getServiceConfig(hid, sid, (err, response) => {
-          if (!err) {
-            resolve(response);
-          } else {
-            reject(err);
-          }
-        });
-      });
-    };
   }
 
   RED.nodes.registerType('mobius connection', MobiusConnectionNode);
@@ -604,42 +717,4 @@ 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) {
-    let conn = RED.nodes.getNode(req.query.mobius);
-    let uri = req.query.uri;
-    if (conn === null || !conn.service.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.');
-    } else {
-      uiDeviceDiscovery
-        .discover(conn, uri)
-        .then((response) => {
-          res.json(response);
-        })
-        .catch((err) => {
-          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) {
-    let conn = RED.nodes.getNode(req.query.mobius);
-    let hid = req.query.hid;
-    if (conn === null || !conn.service.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.');
-    } else {
-      uiDeviceDiscovery
-        .getServiceList(conn, hid)
-        .then((response) => {
-          res.json(response);
-        })
-        .catch((err) => {
-          RED.log.warn(`Get services failed - ${err}`);
-        });
-    }
-  });
 };

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

@@ -53,6 +53,13 @@ POSSIBILITY OF SUCH DAMAGE.
     <label for="node-input-detailedOutput" style="width: 70%;"> Use detailed outputs</label>
   </div>
   <hr>
+  <div class="form-row">
+    <label for="node-input-statusType" style="width: 135px;"><p><font color=##55aa88><i class="fa fa-square"></i></font> Status Display</p></label>
+    <select type="text" id="node-input-statusType" style="display: inline-block; width: 287px; vertical-align: center;">
+      <option value="timeSinceLastActive">Show time since last active</option>
+      <option value="lastUri">Show last URI</option>
+    </select>
+  </div>
   <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">
@@ -64,6 +71,7 @@ POSSIBILITY OF SUCH DAMAGE.
     category: 'mobius',
     defaults: {
       name: {value:""},
+      statusType: {value:"timeSinceLastActive"},
       detailedOutput: {value:false},
       format: {value: "name", required: true},
       include: {value: "changed", required: true},

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

@@ -29,29 +29,29 @@
 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.format = n.format;
     this.include = n.include;
     this.serviceConn = RED.nodes.getNode(n.connection);
+    this.statusType = n.statusType;
     var node = this;
 
     if (node.serviceConn) {
       node.status({
         fill: 'red',
         shape: 'ring',
-        text: 'Disconnected'
+        text: 'Disconnected',
       });
-
       node.serviceConn.subscribeToObjectCOV(node.object, this.id, (response) => {
-        node.status({
-          fill: 'green',
-          shape: 'dot',
-          text: JSON.stringify(response.uri)
-        });
-        let allResources = _.keyBy(response.value.resources, node.format === 'name' ? 'name' : 'rid');
+        node.serviceConn.update.latestUri(node, response.uri);
+        node.serviceConn.update.lastActiveTime(node);
+        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 +61,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,17 +54,12 @@ 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;
@@ -84,7 +79,7 @@ module.exports = {
     });
   },
 
-  async discoverServicesBySPID(RED, connection, hid, spid) {
+  async discoverServicesBySPID (RED, connection, hid, spid) {
     if (!hid || hid === '') {
       hid = connection.service.srvcAPI.status.hubId;
     }
@@ -104,101 +99,5 @@ 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,
-          });
-        }
-
-        // Fetch information from each service config
-        for (let i = 0; i < services.length; i++) {
-          const fullServiceConfig = await connection.getServiceConfigProm(hid, services[i].sid);
-          console.log(fullServiceConfig);
-          services[i].mobiusSettings = fullServiceConfig.value.serviceConfig.settings;
-          services[i].customSettings = fullServiceConfig.value.serviceConfig.custom;
-        }
-
-        console.log('Following service node configs');
-        console.log(services);
-
-        // 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,
-            });
-          }
-        }
-
-        console.log('Following discover');
-        console.log(services);
-
-        // Fetch status object from all services
-        for (let i = 0; i < services.length; i++) {
-          const statusObjectResponse = await this.discover(
-            connection,
-            `${hid}/${services[i].sid}/0001/0001`
-          );
-          const statusObject = statusObjectResponse.value;
-          services[i].status = statusObject.resources[1].pv;
-          services[i].statusText = `${statusObject.resources[2].pv}`;
-        }
-
-        console.log('Complete');
-        console.log(services);
-
-        resolve(services);
-      } catch (err) {
-        reject(err);
-      }
-    });
-  },
+  }
 };

package/package.json

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