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

package/dist/nodes/mobius-connection.js

@@ -27,8 +27,12 @@
 'use strict';
 
 var _ = require('lodash');
-var tcpAPI = require('@ia/mobius-tcpip-service-api');
-var uiDeviceDiscovery = require('./node-red-ui-discover-devices');
+var uiFuncs = require('../node-red-ui-funcs');
+
+const webSocket = require('../engine-websocket');
+const apiCalls = require('../engine-api-calls');
+const webSocketCalls = require('../engine-websocket');
+const { getApiClient, setLoggedIn, closeApiClient } = require('../engine-api-client');
 
 module.exports = function (RED) {
   /**
@@ -62,18 +66,25 @@ module.exports = function (RED) {
     RED.nodes.createNode(this, n);
     this.host = n.host;
     this.port = n.port;
-    this.psk = n.psk;
-    this.service = new tcpAPI.TCPIPServiceAPI(n.host, n.port, n.psk);
-    this.service.srvcAPI.removeAllListeners('cov');
-    this.service.srvcAPI.removeAllListeners('obcov');
-    this.service.srvcAPI.removeAllListeners('bcmd');
-    this.service.srvcAPI.on('cov', (response) => {
+    this.username = n.username;
+    this.password = n.password;
+    this.secure = n.secure;
+    this.apiClient = getApiClient(
+      this.secure ? 'https' : 'http',
+      this.host,
+      this.port,
+      this.username,
+      this.password
+    );
+    // webSocket.connectToWebSocket();
+    webSocket.clearAllCallbacks();
+    webSocket.registerCallback('resource-cov', (response) => {
       this.handleCOVEvents(response);
     });
-    this.service.srvcAPI.on('obcov', (response) => {
+    webSocket.registerCallback('object-cov', (response) => {
       this.handleObjectCOVEvents(response);
     });
-    this.service.srvcAPI.on('bcmd', (response) => {
+    webSocket.registerCallback('broadcast-command', (response) => {
       this.handleBCMDEvents(response);
     });
     var node = this;
@@ -85,11 +96,27 @@ module.exports = function (RED) {
     node.bcmdSubscriptions = new Map();
     node.connected = false;
     node.unsubscribeTimeout = 0;
+    node.hubId = null;
 
     // Connected to the mobius TCPIP spoke
     // Update the status indicators
-    node.service.on('connected', () => {
+    webSocket.on('connected', () => {
       this.log(`Connected to ${n.host} : ${n.port}`);
+      apiCalls.getHubId(this.apiClient, (err, hubId) => {
+        if (err) {
+          node.error('Mobius error getting hub ID' + JSON.stringify(err));
+        } else {
+          node.hubId = hubId;
+          apiCalls.discover(this.apiClient, node.hubId, (err, response) => {
+            if (err) {
+              node.error('Mobius error discovering service list' + JSON.stringify(err));
+            } else {
+              node.serviceList = response.data;
+              node.hasStarted = true;
+            }
+          });
+        }
+      });
       node.connected = true;
       _.forEach(node.users, (user, id) => {
         if (node.users.hasOwnProperty(id)) {
@@ -102,30 +129,21 @@ module.exports = function (RED) {
       });
       // Subscribe to all COVs
       this.resourceSubscriptions.forEach((subs, key) => {
-        node.service.srvcAPI.subscribeToCOV(key);
+        webSocketCalls.subscribeToResourceCOV(key);
       });
       // Subscribe to all object COVs
       node.objectSubscriptions.forEach((subs, key) => {
-        node.service.srvcAPI.subscribeToObjectCOV(key);
+        webSocketCalls.subscribeToObjectCOV(key);
       });
       // Subscribe to all BCMDs
       node.bcmdSubscriptions.forEach((subs, key) => {
-        node.service.srvcAPI.subscribeToBCMD(key);
-      });
-      // Discover all service IDs
-      node.service.srvcAPI.discover(node.service.srvcAPI.status.hubId, (err, response) => {
-        if (err) {
-          node.error('Mobius error discovering service list' + JSON.stringify(err));
-        } else {
-          node.serviceList = response.value;
-          node.hasStarted = true;
-        }
+        webSocketCalls.subscribeToBCMD(key);
       });
     });
 
     // Disconnected from the mobius TCPIP spoke
     // Update the status indicators
-    node.service.on('disconnected', () => {
+    webSocket.on('disconnected', () => {
       this.log(`Disconnected from ${n.host} : ${n.port}`);
       node.connected = false;
       for (var id in node.users) {
@@ -214,54 +232,69 @@ 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) {
+      node.users[mobiusNode.id].status({
+        fill: 'red',
+        shape: 'ring',
+        text: 'Disconnected',
+      });
       delete node.users[mobiusNode.id];
-      if (node.service) {
-        try {
-          node.resourceSubscriptions.forEach((subs, key) => {
-            subs.forEach((sub, index) => {
-              if (mobiusNode.id === sub.node) {
-                subs.splice(index, 1);
-              }
-            });
-            if (subs.length === 0) {
-              node.service.srvcAPI.unsubscribeToCOV(key);
-              node.resourceSubscriptions.delete(key);
+      try {
+        node.resourceSubscriptions.forEach((subs, key) => {
+          subs.forEach((sub, index) => {
+            if (mobiusNode.id === sub.node) {
+              subs.splice(index, 1);
             }
           });
-          node.objectSubscriptions.forEach((subs, key) => {
-            subs.forEach((sub, index) => {
-              if (mobiusNode.id === sub.node) {
-                subs.splice(index, 1);
-              }
-            });
-            if (subs.length === 0) {
-              node.service.srvcAPI.unsubscribeToObjectCOV(key);
-              node.objectSubscriptions.delete(key);
+          if (subs.length === 0) {
+            webSocketCalls.unsubscribeToResourceCOV(key);
+            node.resourceSubscriptions.delete(key);
+          }
+        });
+        node.objectSubscriptions.forEach((subs, key) => {
+          subs.forEach((sub, index) => {
+            if (mobiusNode.id === sub.node) {
+              subs.splice(index, 1);
             }
           });
-          node.bcmdSubscriptions.forEach((subs, key) => {
-            subs.forEach((sub, index) => {
-              if (mobiusNode.id === sub.node) {
-                subs.splice(index, 1);
-              }
-            });
-            if (subs.length === 0) {
-              node.service.srvcAPI.unsubscribeToBCMD(key);
-              node.bcmdSubscriptions.delete(key);
+          if (subs.length === 0) {
+            webSocketCalls.unsubscribeToObjectCOV(key);
+            node.objectSubscriptions.delete(key);
+          }
+        });
+        node.bcmdSubscriptions.forEach((subs, key) => {
+          subs.forEach((sub, index) => {
+            if (mobiusNode.id === sub.node) {
+              subs.splice(index, 1);
             }
           });
-        } catch (err) {
-          console.log(`Failed to unsubscribe from event: ${err.message}`);
-        }
-        return done();
+          if (subs.length === 0) {
+            webSocketCalls.unsubscribeToBCMD(key);
+            node.bcmdSubscriptions.delete(key);
+          }
+        });
+      } catch (err) {
+        console.log(`Failed to unsubscribe from event: ${err.message}`);
       }
-      done();
+      return done();
     };
 
     /**
      * Register the close connection handler
      */
     node.on('close', (done) => {
+      webSocket.killWebSocket();
+      closeApiClient();
+      setLoggedIn(false);
+      this.log(`Connection to MOBiUS closed.`);
+      for (var id in node.users) {
+        if (node.users.hasOwnProperty(id)) {
+          node.users[id].status({
+            fill: 'red',
+            shape: 'ring',
+            text: 'Disconnected',
+          });
+        }
+      }
       if (node.connected) {
         // Wait for all nodes to unsubscribe before terminating the connection
         node.unsubscribeTimeout = 0;
@@ -273,16 +306,11 @@ module.exports = function (RED) {
             node.unsubscribeTimeout > 50
           ) {
             clearInterval(waitForCleanup);
-            node.service.end();
-            node.service.once('disconnected', () => {
-              node.connected = false;
-              done();
-            });
+            done();
           }
           node.unsubscribeTimeout++;
         }, 100);
       } else {
-        node.service.end();
         done();
       }
     });
@@ -296,7 +324,7 @@ module.exports = function (RED) {
      *                                the response message event
      */
     node.discover = function (uri, callback) {
-      node.service.srvcAPI.discover(uri, callback);
+      apiCalls.discover(this.apiClient, uri, callback);
     };
 
     /**
@@ -307,7 +335,7 @@ module.exports = function (RED) {
      * @param  {Function} callback  - Callback when complete
      */
     node.writeResourceValue = function (uri, value, priority, callback) {
-      node.service.srvcAPI.writeResourceValue(uri, value, priority, callback);
+      apiCalls.writeResource(this.apiClient, uri, value, priority, callback);
     };
 
     /**
@@ -320,7 +348,7 @@ module.exports = function (RED) {
      *                                the response message event
      */
     node.multiWriteResourceValue = function (uri, updates, callback) {
-      node.service.srvcAPI.multiWriteResourceValue(uri, updates, callback);
+      apiCalls.writeMultiResource(this.apiClient, uri, updates, callback);
     };
 
     /**
@@ -330,7 +358,7 @@ module.exports = function (RED) {
      * @param  {Function} callback  - Callback when complete
      */
     node.clearResourcePriority = function (uri, priority, callback) {
-      node.service.srvcAPI.clearResourcePriority(uri, priority, callback);
+      apiCalls.clearResource(this.apiClient, uri, priority, callback);
     };
 
     /**
@@ -339,7 +367,7 @@ module.exports = function (RED) {
      * @param  {Function} callback  - Callback when complete
      */
     node.readResource = function (uri, callback) {
-      node.service.srvcAPI.readResource(uri, callback);
+      apiCalls.readResource(this.apiClient, uri, callback);
     };
 
     /**
@@ -348,7 +376,7 @@ module.exports = function (RED) {
      * @param  {Function} callback  - Callback when complete
      */
     node.readObject = function (uri, callback) {
-      node.service.srvcAPI.readObject(uri, callback);
+      apiCalls.readObject(this.apiClient, uri, callback);
     };
 
     /**
@@ -361,9 +389,18 @@ module.exports = function (RED) {
      * @param  {Function} callback  - function(err, [object]) {}
      */
     node.filterObjectsByRIDValue = function (uri, pids, rid, limit, func, callback) {
-      node.service.srvcAPI.filterObjectsByRIDValue(uri, pids, rid, limit, func, callback);
+      apiCalls.filterObjectsByRIDValue(this.apiClient, uri, pids, rid, limit, func, callback);
     };
 
+    /**
+     * Change the password of the admin user
+     * @param {*} password - The new password
+     * @param {*} callback - Callback when complete, function(err, [object]) {}
+     */
+    node.changeAdminPassword = function(password, callback) {
+      apiCalls.changeAdminPassword(this.apiClient, password, callback);
+    }
+
     /**
      * Subscribe to a resource COV
      * @param  {string} uri         - The full URI of the resource
@@ -376,7 +413,7 @@ module.exports = function (RED) {
         cb: callback,
       };
       if (!node.resourceSubscriptions.has(uri)) {
-        node.service.srvcAPI.subscribeToCOV(uri);
+        webSocketCalls.subscribeToResourceCOV(uri);
         node.resourceSubscriptions.set(uri, [sub]);
       } else {
         //        _.pullAllBy(node.resourceSubscriptions.get(uri), [{node: ref}], node);
@@ -397,7 +434,7 @@ module.exports = function (RED) {
         );
       }
       if (node.resourceSubscriptions.get(uri).length === 0) {
-        node.service.srvcAPI.unsubscribeToCOV(uri);
+        webSocketCalls.unsubscribeToResourceCOV(uri);
         node.resourceSubscriptions.delete(uri);
       }
     };
@@ -414,7 +451,7 @@ module.exports = function (RED) {
         cb: callback,
       };
       if (!node.objectSubscriptions.has(uri)) {
-        node.service.srvcAPI.subscribeToObjectCOV(uri);
+        webSocketCalls.subscribeToObjectCOV(uri);
         node.objectSubscriptions.set(uri, [sub]);
       } else {
         //        _.pullAllBy(node.objectSubscriptions.get(uri), [{node: ref}], node);
@@ -435,7 +472,7 @@ module.exports = function (RED) {
         );
       }
       if (node.objectSubscriptions.get(uri).length === 0) {
-        node.service.srvcAPI.unsubscribeToObjectCOV(uri);
+        webSocketCalls.unsubscribeToObjectCOV(uri);
         node.objectSubscriptions.delete(uri);
       }
     };
@@ -452,7 +489,7 @@ module.exports = function (RED) {
         cb: callback,
       };
       if (!node.bcmdSubscriptions.has(uri)) {
-        node.service.srvcAPI.subscribeToBCMD(uri);
+        webSocketCalls.subscribeToBCMD(uri);
         node.bcmdSubscriptions.set(uri, [sub]);
       } else {
         node.bcmdSubscriptions.get(uri).push(sub);
@@ -472,7 +509,7 @@ module.exports = function (RED) {
         );
       }
       if (node.bcmdSubscriptions.get(uri).length === 0) {
-        node.service.srvcAPI.unsubscribeToBCMD(uri);
+        webSocketCalls.unsubscribeToBCMD(uri);
         node.bcmdSubscriptions.delete(uri);
       }
     };
@@ -483,7 +520,7 @@ module.exports = function (RED) {
      * @param  {Object} commandData - An object containing the command data
      */
     node.sendBroadcastCommand = function (cid, commandData) {
-      node.service.srvcAPI.sendBroadcastCommand(cid, commandData);
+      apiCalls.sendBroadcastCommand(this.apiClient, cid, commandData);
     };
 
     /**
@@ -495,7 +532,7 @@ module.exports = function (RED) {
      * @param  {Function} callback  - Callback when complete
      */
     node.sendDirectCommand = function (uri, cid, commandData, timeout, callback) {
-      node.service.srvcAPI.sendDirectCommand(uri, cid, commandData, timeout, callback);
+      apiCalls.sendDirectCommand(uri, cid, commandData, timeout, callback);
     };
 
     /**
@@ -505,7 +542,7 @@ module.exports = function (RED) {
      * @param {Function} callback   - Callback when complete
      */
     node.getServiceConfig = function (hid, sid, callback) {
-      node.service.srvcAPI.getServiceConfig(hid, sid, callback);
+      apiCalls.getServiceConfig(this.apiClient, `${hid}/${sid}`, callback);
     };
 
     /**
@@ -518,8 +555,17 @@ module.exports = function (RED) {
      * @param {Function} callback   - Callback when complete
      */
     node.updateObjectInServiceConfig = function (hid, sid, pid, ins, config, callback) {
-      node.service.srvcAPI.updateObjectInServiceConfig(hid, sid, pid, ins, config, callback);
+      apiCalls.updateObject(this.apiClient, `${hid}/${sid}/${pid}/${ins}`, config, callback);
     };
+
+    /**
+     * Get hub configuration
+     * @param {string} uri - The URI of the hub (hid)
+     * @param {Function} callback - Callback when complete
+     */
+    node.getNodeConfig = function (uri, callback) {
+      apiCalls.getNodeConfig(this.apiClient, uri, callback);
+    }
   }
 
   RED.nodes.registerType('mobius connection', MobiusConnectionNode);
@@ -541,11 +587,11 @@ module.exports = function (RED) {
       }
 
       let pid = req.query.pid;
-      if (conn === null || !conn.service.connected) {
+      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.');
       } else {
-        uiDeviceDiscovery
+        uiFuncs
           .discoverDevicesByPID(RED, conn, hid, spids, pid)
           .then((devices) => {
             res.json(devices);
@@ -565,11 +611,11 @@ module.exports = function (RED) {
       let conn = RED.nodes.getNode(req.query.mobius);
       let hid = req.query.hid;
       let spid = req.query.spid;
-      if (conn === null || !conn.service.connected) {
+      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.');
       } else {
-        uiDeviceDiscovery
+        uiFuncs
           .discoverServicesBySPID(RED, conn, hid, spid)
           .then((services) => {
             res.json(services);
@@ -580,4 +626,89 @@ 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.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 {
+        uiFuncs
+          .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.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 {
+        uiFuncs
+          .getServiceList(conn, hid)
+          .then((response) => {
+            res.json(response);
+          })
+          .catch((err) => {
+            RED.log.warn(`Get services failed - ${err}`);
+          });
+      }
+    });
+  
+    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.');
+      } else {
+        uiFuncs
+          .getObjectList(conn, hid, sid)
+          .then((response) => {
+            res.json(response);
+          })
+          .catch((err) => {
+            RED.log.warn(`Get objects failed - ${err}`);
+          });
+      }
+    });
+  
+    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.');
+        throw new Error('Get hid failed - could not to connect to MOBiUS hub.');
+      } else {
+        res.json(conn.hubId);
+      }
+    });
+
+    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);
+    });
+
 };