node-red-contrib-mobius-flow-base 2.5.85 → 2.5.86-beta.100

package/README.md

@@ -1,10 +1,16 @@
 # node-red-contrib-mobius-flow-base
+![Version](https://img.shields.io/badge/Version-v1.0.12-blue.svg)  
 
-Copyright 2016 [iaconnects](http://www.iaconnects.co.uk).
+Copyright 2016 [Interior Automation](http://www.interior-automation.co.uk) under the BSD-3-Clause license.
 
-[Node-RED](http://nodered.org) nodes to interact with MOBiUSFlow.
+[Node-RED](http://nodered.org) nodes to interact with Interior Automation's MOBiUS Flow.
 
-This module currently requires access to the iaconnects private NPM repository.
+## Install
+Run the following command in the root directory of your Node-RED install:
+
+```npm install node-red-contrib-mobius-flow-base```
+
+This module currently requires access to Interior Automation's private NPM repository. This will be made public in the future once MOBiUS Flow is ready for public release.
 
 ## Nodes
 
@@ -27,4 +33,4 @@ Clears the specified priority of resource.
 Subscribe to change of value events for an object
 
 ### Resource COV Node
-Subscribe to change of value events for a resource
+Subscribe to change of value events for a resource

package/dist/nodes/mobius-connection.js

@@ -193,6 +193,91 @@ 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;
+      let newStatus = {
+        fill: 'green',
+        shape: 'dot',
+        text: 'Connected',
+      };
+      switch (node.users[mobiusNode.id].statusType) {
+        case 'timeSinceLastActive':
+          newStatus = node.buildLastActiveTimeStatus(node.users[mobiusNode.id].lastActiveTime);
+        case 'lastUri':
+          const uri = node.users[mobiusNode.id].latestUri;
+          if (uri !== '') {
+            newStatus = {
+              fill: 'green',
+              shape: 'dot',
+              text: uri,
+            };
+          }
+      }
+      node.users[mobiusNode.id].status(newStatus);
+    };
+
+    /**
+     * Update a given node's node latest URI record
+     * @param  {Object} mobiusNode - The node whos last URI record is to be updated
+     */
+    node.updateLatestUri = function (mobiusNode, uri) {
+      node.users[mobiusNode.id] = mobiusNode;
+      node.users[mobiusNode.id].latestUri = uri;
+      node.updateNodeStatus(mobiusNode);
+    };
+
+    /**
+     * Update a given node's node last active time
+     * @param  {Object} mobiusNode - The node whos last active time is to be updated
+     */
+    node.updateLastActiveTime = function (mobiusNode) {
+      node.users[mobiusNode.id] = mobiusNode;
+      node.users[mobiusNode.id].lastActiveTime = Date.now();
+      node.updateNodeStatus(mobiusNode);
+    };
+
     /**
      * Register a new Mobius node with this config node
      * @param  {Object} mobiusNode - The new node to register
@@ -206,6 +291,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 +305,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 {

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" ><i class="fa fa-bars"></i> Status </label>
+    <select type="text" id="node-input-statusType" style="display: inline-block; width: auto; 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,30 @@
 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.latestUri = '';
+    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.updateLatestUri(node, response.uri);
+        node.serviceConn.updateLastActiveTime(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 +62,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/package.json

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