node-red-contrib-mobius-flow-base 2.5.86-beta.1 → 2.5.86-beta.101

package/dist/nodes/mobius-clear-resource.html

@@ -0,0 +1,178 @@
+<!--
+Copyright (C) 2016, IAConnects Technology Limited
+All Rights Reserved
+
+ALL INFORMATION CONTAINED HEREIN IS, AND REMAINS
+THE PROPERTY OF IACONNECTS TECHNOLOGY LIMITED AND ITS SUPPLIERS,
+IF ANY. THE INTELLECTUAL AND TECHNICAL CONCEPTS CONTAINED
+HEREIN ARE PROPRIETARY TO IACONNECTS TECHNOLOGY LIMITED
+AND ITS SUPPLIERS AND ARE PROTECTED BY TRADE SECRET OR COPYRIGHT LAW.
+DISSEMINATION OF THIS INFORMATION OR REPRODUCTION OF THIS MATERIAL
+IS STRICTLY FORBIDDEN UNLESS PRIOR WRITTEN PERMISSION IS OBTAINED
+FROM IACONNECTS TECHNOLOGY LIMITED.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS
+BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+-->
+
+<script type="text/x-red" data-template-name="mobius clear resource">
+  <div class="form-row">
+    <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-resource"><i class="fa fa-tasks"></i> URI</label>
+    <input type="text" id="node-input-resource" placeholder="Resource URI (hid/sid/pid/ins/rid)">
+  </div>
+  <div class="form-row">
+    <label for="node-input-priority"><i class="fa fa-exclamation-triangle"></i> Priority</label>
+    <input type="text" id="node-input-priority" placeholder="Priotity to clear">
+  </div>
+  <div class="form-row">
+    <label>&nbsp;</label>
+    <input type="checkbox" id="node-input-detailedOutput" style="display: inline-block; width: auto; vertical-align: top;">
+    <label for="node-input-detailedOutput" style="width: 70%;"> Use detailed outputs</label>
+  </div>
+<hr>
+  <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">
+  </div>
+</script>
+
+<script type="text/javascript">
+  RED.nodes.registerType('mobius clear resource',{
+    category: 'mobius',
+    defaults: {
+      name: {value:""},
+      detailedOutput: {value:false},
+      resource: {value:"", validate:function(v) {
+        if(v === '') { return true; }
+        let parts = v.split('/');
+        for(let lp = 0; lp < parts.length; lp++) {
+          if(parts[lp] === null || parts[lp] === '') { return false;}
+        }
+        if(parts.length === 5) { return true; }
+        if(parts.length < 5 && parts[parts.length - 1] === '#') { return true; }
+        return false;
+      }},
+      priority: {value:15, type: 'Number', validate:function(v) { return (v > 0 && v < 16) }},
+      connection: {type:"mobius connection", required:true}
+    },
+    color:"#8abff5",
+    inputs:1,
+    outputs:2,
+    outputLabels: function (index) {
+      if(index === 0) return ("Resource's PV");
+      if(index === 1) return ("Resource's PV and name");
+      if(index === 2) return ("MOBiUS resource");
+      if(index === 3) return ("Full MOBiUS response");
+    },
+    icon: "mobius.png",
+    align: "right",
+    paletteLabel: 'clr resource',
+    label: function() {
+      if(this.name) {
+        return this.name;
+      } else {
+        return this.resource ? `Clr - ${this.resource}` : "clear resource";
+      }
+    },
+    labelStyle: function() {
+      return this.name ? "node_label_italic":"";
+    },
+    oneditsave: function() {
+      if($("#node-input-detailedOutput").prop('checked')) {
+        this.outputs = 4;
+      } else {
+        this.outputs = 2;
+      }
+    }
+  });
+</script>
+
+<script type="text/x-red" data-help-name="mobius clear resource">
+  <p>Clear a MOBiUS resource priority.</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>URI <span class="property-type">string</span></dt>
+    <dd>The MOBiUS URI of the resource.</dd>
+    <dt>Priority <span class="property-type">number</span></dt>
+    <dd>The priority to clear.</dd>
+    <dt>Use detailed outputs <span class="property-type">boolean</span></dt>
+    <dd>If checked the full resource is sent on output 3 and the full MOBiUS response is sent on output 4.</dd>
+  </dl>
+
+  <h3>Inputs</h3>
+  <ol class="node-ports">
+    <li>Input message to trigger clearing a resource priority
+      <dl class="message-properties">
+        <dt class="optional">topic <span class="property-type">string</span></dt>
+        <dd>An optional property that overwrites the URI set in the node configuration page.
+          If the topic is not a valid URI it is ignored and the value set in the node configuration page is used.</dd>
+        <dt class="optional">priority <span class="property-type">number</span></dt>
+        <dd><An optional property that overwrites the priority set in the node configuration page.</dd>
+      </dl>
+    </li>
+  </ol>
+
+  <h3>Outputs</h3>
+  <ol class="node-ports">
+    <li>Output 1 (Present value)
+      <dl class="message-properties">
+        <dt>topic <span class="property-type">string</span></dt>
+        <dd>The full URI of the resource.</dd>
+        <dt>payload <span class="property-type">object</span></dt>
+        <dd>The resource's pv.</dd>
+      </dl>
+    </li>
+    <li>Output 2 (Present value and name of resource)
+      <dl class="message-properties">
+        <dt>topic <span class="property-type">string</span></dt>
+        <dd>The full URI of the resource.</dd>
+        <dt>payload.pv <span class="property-type">object</span></dt>
+        <dd>The resource's pv.</dd>
+        <dt>payload.name <span class="property-type">object</span></dt>
+        <dd>The resource's name.</dd>
+      </dl>
+    </li>
+    <li>Output 3 (The MOBiUS resource - optional)
+      <dl class="message-properties">
+        <dt>topic <span class="property-type">string</span></dt>
+        <dd>The full URI of the resource.</dd>
+        <dt>payload <span class="property-type">object</span></dt>
+        <dd>The resource.</dd>
+      </dl>
+    </li>
+    <li>Output 4 (Full MOBiUS response - optional)
+      <dl class="message-properties">
+        <dt>topic <span class="property-type">string</span></dt>
+        <dd>The full URI of the resource.</dd>
+        <dt>error <span class="property-type">boolean</span></dt>
+        <dd>True if an error occured, else false.</dd>
+        <dt>response <span class="property-type">object</span></dt>
+        <dd>The full MOBiUS response message.</dd>
+      </dl>
+    </li>
+  </ol>
+
+  <h3>Details</h3>
+  <p>Outputs 3 and 4 are only sent if <b>Use detailed outputs</b> is checked on the configuration page.</p>
+  <p>Outputs 1, 2 and 3 are only sent if no error occurs. The <b>error</b> property in output 4
+    can be used to determine if an error has occurred.</p>
+
+  <br>
+  <p align="center" style="color:#000080">iaconnects © 2017</p>
+</script>

package/dist/nodes/mobius-clear-resource.js

@@ -0,0 +1,109 @@
+/**
+ Copyright (C) 2016, IAConnects Technology Limited
+ All Rights Reserved
+
+ ALL INFORMATION CONTAINED HEREIN IS, AND REMAINS
+ THE PROPERTY OF IACONNECTS TECHNOLOGY LIMITED AND ITS SUPPLIERS,
+ IF ANY. THE INTELLECTUAL AND TECHNICAL CONCEPTS CONTAINED
+ HEREIN ARE PROPRIETARY TO IACONNECTS TECHNOLOGY LIMITED
+ AND ITS SUPPLIERS AND ARE PROTECTED BY TRADE SECRET OR COPYRIGHT LAW.
+ DISSEMINATION OF THIS INFORMATION OR REPRODUCTION OF THIS MATERIAL
+ IS STRICTLY FORBIDDEN UNLESS PRIOR WRITTEN PERMISSION IS OBTAINED
+ FROM IACONNECTS TECHNOLOGY LIMITED.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS
+ BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ POSSIBILITY OF SUCH DAMAGE.
+ **/
+
+/* jshint elision: true */
+'use strict';
+
+module.exports = function (RED) {
+  function MobiusClearResourceNode (n) {
+    RED.nodes.createNode(this, n);
+    this.detailedOutput = n.detailedOutput;
+    this.resource = n.resource;
+    this.priority = n.priority;
+    this.serviceConn = RED.nodes.getNode(n.connection);
+    var node = this;
+
+    if (node.serviceConn) {
+      node.status({
+        fill: 'red',
+        shape: 'ring',
+        text: 'Disconnected'
+      });
+
+      node.on('input', function (msg) {
+        let uri = node.resource;
+        let pri = parseInt(node.priority);
+        if (msg.hasOwnProperty('topic') && require('./validateURI')(msg.topic, 5)) {
+          uri = msg.topic;
+        }
+        if (msg.hasOwnProperty('priority')) {
+          pri = msg.priority;
+        }
+
+        if (uri) {
+          node.status({
+            fill: 'green',
+            shape: 'ring',
+            text: 'Busy'
+          });
+
+          node.serviceConn.clearResourcePriority(uri, pri, (err, response) => {
+            if (err) {
+              node.status({
+                fill: 'yellow',
+                shape: 'dot',
+                text: 'Error: ' + JSON.stringify(err.code)
+              });
+              node.error('Mobius error clearing resource priority ' + JSON.stringify(err));
+              if (node.detailedOutput === true) {
+                node.send([null, null, null, {topic: uri, payload: { error: true, response: err }}]);
+              }
+            } else {
+              node.status({
+                fill: 'green',
+                shape: 'dot',
+                text: JSON.stringify(response.value.pv)
+              });
+              if (node.detailedOutput === true) {
+                node.send([
+                  { topic: uri, payload: response.value.pv },
+                  { topic: uri, payload: { pv: response.value.pv, name: response.value.name } },
+                  { topic: uri, payload: response.value },
+                  { topic: uri, payload: { error: false, response: response } }
+                ]);
+              } else {
+                node.send([
+                  { topic: uri, payload: response.value.pv },
+                  { topic: uri, payload: { pv: response.value.pv, name: response.value.name } }
+                ]);
+              }
+            }
+          });
+        }
+      });
+
+      node.serviceConn.register(node);
+
+      node.on('close', function (done) {
+        node.serviceConn.deregister(node, done);
+      });
+    } else {
+      node.error(RED._('Mobius service not defined'));
+    }
+  }
+
+  RED.nodes.registerType('mobius clear resource', MobiusClearResourceNode);
+};

package/dist/nodes/mobius-connection.html

@@ -0,0 +1,68 @@
+<!--
+Copyright (C) 2016, IAConnects Technology Limited
+All Rights Reserved
+
+ALL INFORMATION CONTAINED HEREIN IS, AND REMAINS
+THE PROPERTY OF IACONNECTS TECHNOLOGY LIMITED AND ITS SUPPLIERS,
+IF ANY. THE INTELLECTUAL AND TECHNICAL CONCEPTS CONTAINED
+HEREIN ARE PROPRIETARY TO IACONNECTS TECHNOLOGY LIMITED
+AND ITS SUPPLIERS AND ARE PROTECTED BY TRADE SECRET OR COPYRIGHT LAW.
+DISSEMINATION OF THIS INFORMATION OR REPRODUCTION OF THIS MATERIAL
+IS STRICTLY FORBIDDEN UNLESS PRIOR WRITTEN PERMISSION IS OBTAINED
+FROM IACONNECTS TECHNOLOGY LIMITED.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS
+BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+-->
+
+<script type="text/x-red" data-template-name="mobius connection">
+  <div class="form-row">
+    <label for="node-config-input-host"><i class="fa fa-globe"></i> Host</label>
+    <input class="input-append-left" type="text" id="node-config-input-host" placeholder="e.g. localhost" style="width: 40%;" >
+    <label for="node-config-input-port" style="margin-left: 10px; width: 35px; "> Port</label>
+    <input type="text" id="node-config-input-port" placeholder="1890" style="width:50px">
+  </div>
+  <div class="form-row">
+    <label for="node-config-input-psk"><i class="fa fa-key"></i> PSK</label>
+    <input type="text" id="node-config-input-psk" placeholder="Pre-shared key">
+  </div>
+</script>
+
+<script type="text/javascript">
+  RED.nodes.registerType('mobius connection', {
+    category: 'config',
+    defaults: {
+      host: {required: true, value: 'localhost'},
+      port: {required: true, value: 1890, validate: RED.validators.number()},
+      psk: {required: true}
+    },
+    label: function() {
+      return `${this.host}:${this.port}`;
+    }
+  });
+</script>
+
+<script type="text/x-red" data-help-name="mobius connection">
+  <p>Shared MOBiUS Flow Connection used by all of the MOBiUS Flow nodes to connect to a MOBiUS Flow hub.</p>
+
+  <h3>Configuration Page</h3>
+  <dl class="message-properties">
+    <dt>Host <span class="property-type">string</span></dt>
+    <dd>The IP Address of the MOBiUS TCP/IP spoke.</dd>
+    <dt>Port <span class="property-type">number</span></dt>
+    <dd>The TCP/IP port that the spoke is listening for connections on.</dd>
+    <dt>PSK <span class="property-type">string</span></dt>
+    <dd>The pre-shared key used to encode and decode all messages to and from the spoke.</dd>
+  </dl>
+  <br>
+  <p align="center" style="color:#000080">iaconnects © 2017</p>
+</script>