@teamcymbeline/node-red-contrib-mcprotocol 0.0.0-stage → 1.4.1

package/nodes/connection.html

@@ -0,0 +1,155 @@
+<!-- 
+MIT License
+
+Copyright (c) 2019, 2020 Steve-Mcl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. 
+-->
+
+<style>
+  .mc-protocol-form > .form-row > label:first-of-type {
+    width: 130px !important;
+  }
+  .mc-protocol-form > .form-row > input {
+    width: calc(70% - 30px) !important;
+  }
+</style>
+
+<script type="text/html" data-template-name="MC Protocol Connection">
+  <div class="mc-protocol-form">
+    <div class="form-row">
+      <label for="node-input-name"><i class="icon-tag"></i> <span data-i18n="mcprotocol-read.label.name">Name</span></label>
+      <input type="text" id="node-config-input-name" placeholder="Name">
+    </div>  
+    <div class="form-row">
+        <label for="node-input-host"><i class="icon-tag"></i> <span data-i18n="mcprotocol-read.label.host">Host</span></label>
+        <input type="text" id="node-config-input-host" placeholder="192.168.x.x">
+    </div>
+    <div class="form-row">
+      <label for="node-input-port"><i class="icon-tag"></i> <span data-i18n="mcprotocol-read.label.port">Port</span></label>
+      <input type="text" id="node-config-input-port" placeholder="9600">
+    </div>
+    <div class="form-row">
+      <label for="node-config-input-frame"><i class="icon-tag"></i> <span data-i18n="mcprotocol-read.label.frame">frame</span></label>
+      <select id="node-config-input-frame">
+        <option value="1E">1E</option>
+        <option value="3E">3E</option>
+        <option value="4E">4E</option>
+      </select>
+    </div>
+    <div class="form-row">
+      <label for="node-config-input-protocol"><i class="icon-tag"></i> <span data-i18n="mcprotocol-read.label.protocol">protocol</span></label>
+      <select id="node-config-input-protocol">
+        <option value="TCP">TCP</option>
+        <option value="UDP">UDP</option>
+      </select>
+    </div>
+    <div class="form-row">
+      <label for="node-config-input-plcType"><i class="icon-tag"></i> <span data-i18n="mcprotocol-read.label.plcType">PLC Type</span></label>
+      <select id="node-config-input-plcType">
+        <option value="A">A</option>
+        <option value="QnA">QnA</option>
+        <option value="Q">Q</option>
+        <option value="L">L</option>
+        <option value="R">R</option>
+      </select>
+    </div>
+
+    <div class="form-row">
+      <label for="node-config-input-ascii"> </label>
+      <label for="node-config-input-ascii" style="width:70%">
+          <input type="checkbox" id="node-config-input-ascii" style="display:inline-block; width:22px; vertical-align:baseline;"><span data-i18n="mcprotocol-read.label.ascii">ascii mode</span>
+      </label>
+    </div>
+
+    <div class="form-row">
+      <label for="node-input-network"><i class="icon-tag"></i> <span data-i18n="mcprotocol-read.label.network">Network No</span></label>
+      <input type="text" id="node-config-input-network" placeholder="Default 0 (for 3E / 4E only)">
+    </div>
+
+    <div class="form-row">
+      <label for="node-input-PCStation"><i class="icon-tag"></i> <span data-i18n="mcprotocol-read.label.PCStation">PC No</span></label>
+      <input type="text" id="node-config-input-PCStation" placeholder="0xff">
+    </div>
+
+    <div class="form-row">
+      <label for="node-input-PLCModuleNo"><i class="icon-tag"></i> <span data-i18n="mcprotocol-read.label.PLCModuleNo">Dest Module No</span></label>
+      <input type="text" id="node-config-input-PLCModuleNo" placeholder="Default 0x3ff (for 3E / 4E only)">
+    </div>
+
+    <div class="form-row">
+      <label for="node-input-PLCStation"><i class="icon-tag"></i> <span data-i18n="mcprotocol-read.label.PLCStation">Dest Module Stn No</span></label>
+      <input type="text" id="node-config-input-PLCStation" placeholder="0x0 for connected station (host station).">
+    </div> 
+
+    <div class="form-row">
+      <label for="node-config-input-octalInputOutput"> </label>
+      <label for="node-config-input-octalInputOutput" style="width:70% !important">
+          <input type="checkbox" id="node-config-input-octalInputOutput" style="display:inline-block; width:22px; vertical-align:baseline;"><span data-i18n="mcprotocol-read.label.octalInputOutput">Octal Input/Output</span>
+      </label>
+    </div>
+
+    <div class="form-row">
+      <label for="node-input-timeout"><i class="fa fa-clock-o"></i> <span data-i18n="mcprotocol-read.label.timeout">Timeout MS</span></label>
+      <input type="text" id="node-config-input-timeout" placeholder="1000 ms is recommended timeout">
+    </div> 
+  </div>
+</script>
+
+
+<script type="text/javascript">
+  RED.nodes.registerType('MC Protocol Connection', {
+    category: 'config',
+    color: '#3FADB5',
+    icon: "connection.png",
+    defaults: {
+      name: { value: "" },
+      host: { value: "192.168.0.1", required: true },
+      port: { value: 5001, required: true, validate: RED.validators.number() },
+      protocol: { value: "TCP"},
+      frame: { value: "3E"},
+      plcType: { value: "Q"},
+      ascii: { value: false},
+      PLCStation : { value: 0},
+      PCStation : { value: undefined},
+      PLCModuleNo : { value: undefined},
+      network : { value: undefined},
+      octalInputOutput : { value: false},
+      timeout : { value: 1000},
+
+    },
+    label: function () {
+      return this.name || this.host + ":" + this.port || "MC Protocol Connection";
+    }
+  });
+</script>
+
+
+<script type="text/html" data-help-name="MC Protocol Connection">
+  <p>Configuration for a connection to a Mitsubishi PLC.</p>
+  <p>This configuration will create a single connection to the PLC which can
+     then be reused by <code>MC Read</code> and <code>MC Read</code> nodes.</p>
+  <p></p>
+  <h4>NOTES</h4>
+  <ul>
+    <li>ASCII mode is currently not supported for frames 3E and 4E</li>
+    <li>For A series PLC, only 1E frames are supported</li>
+  </ul>
+
+</script>

package/nodes/connection.js

@@ -0,0 +1,59 @@
+/*
+MIT License
+
+Copyright (c) 2019, 2020 Steve-Mcl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. 
+*/
+
+function isNumeric(n) {
+  return !isNaN(parseFloat(n)) && isFinite(n);
+}
+
+function safeInt(int, def) {
+  try {
+    if(typeof int == "number") return parseInt(int);
+    if(isNumeric(int)) return parseInt(int);
+  } catch (e) { }
+  return def
+}
+
+module.exports = function(RED) {
+  function mcConnection(config) {
+    RED.nodes.createNode(this, config);
+
+    this.name = config.name;
+    this.host = config.host;
+    this.port = config.port;
+    this.options = {};
+    this.options.protocol = config.protocol ? config.protocol : "TCP";
+    this.options.plcType = config.plcType ? config.plcType : "Q";
+    this.options.frame = config.frame ? config.frame : "3E";
+    this.options.ascii = config.ascii ? config.ascii : false;
+    this.options.PLCStation = safeInt(config.PLCStation, 0);
+    this.options.PCStation = safeInt(config.PCStation, 0xff);
+    this.options.PLCModuleNo = safeInt(config.PLCModuleNo, 0x3ff);
+    this.options.network = safeInt(config.network, 0);
+    this.options.timeout = safeInt(config.timeout, 1000);
+    this.options.octalInputOutput = config.octalInputOutput
+      ? config.octalInputOutput
+      : false;
+  }
+  RED.nodes.registerType("MC Protocol Connection", mcConnection);
+};

package/nodes/read.html

@@ -0,0 +1,179 @@
+<!-- 
+MIT License
+
+Copyright (c) 2019, 2020 Steve-Mcl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. 
+-->
+
+<script type="text/javascript">
+  function setupTypedInput(varName, types, def) {
+    let varSel = '#node-input-' + varName;
+    let typeSel = varSel + 'Type';
+    let varVal = this[varName];
+    let typeVal = this[varName + 'Type'];
+
+    if (typeVal == null || typeVal === 'none') {
+      typeVal = def;
+    } else if (typeVal === 'string') {
+      typeVal = "str";
+    } else if (typeVal === 'number') {
+      typeVal = "num";
+    }
+    $(typeSel).val(typeVal);
+    $(varSel).typedInput({
+      default: def,
+      typeField: $(typeSel),
+      types: types
+    });
+    $(varSel).typedInput('type', typeVal);
+  }
+
+  RED.nodes.registerType('MC Read', {
+    category: 'MITSUBISHI',
+    color: '#0090d4',
+    defaults: {
+      name: { value: "" },
+      topic: { value: "" },
+      connection: { type: "MC Protocol Connection", required: true },
+      address: { value: "", validate: RED.validators.typedInput("addressType") },
+      addressType: { value: "str" },
+      outputFormat: { value: 0 },
+      errorHandling: { value: "throw" },
+      outputs: { value: 1 }
+    },
+    inputs: 1,
+    outputs: 1,
+    inputLabels: "Trigger request",
+    outputLabels: "Returned values",
+    align: "left",
+    icon: "read.png",
+    label: function () {
+      return this.name || 'MC Read';
+    },
+    oneditprepare: function () {
+      var sti = setupTypedInput.bind(this);
+      sti('address', ['msg', 'flow', 'global', 'str', 'env'], 'str');//addr
+    }, 
+    oneditsave: function () {
+      var errH = $("#node-input-errorHandling").val();
+      this.outputs = errH === "output2" ? 2 : 1;//1 output pins if throw or msg.error, 2 outputs if errors to go to seperate output pin
+    } 
+
+  });
+</script>
+
+<style>
+  .mc-protocol-form > .form-row > label {
+    width: 120px !important;
+  }
+</style>
+
+<script type="text/html" data-template-name="MC Read">
+  <div class="mc-protocol-form">
+    <div class="form-row">
+        <label for="node-input-name"><i class="icon-tag"></i> <span data-i18n="read.label.name"> Name</span></label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+    <div class="form-row">
+        <label for="node-input-connection"><i class="icon-globe"></i><span data-i18n="read.label.connection"> Connection</span></label>
+        <input type="text" id="node-input-connection">
+    </div>
+    <div class="form-row">
+        <label for="node-input-address"><i class="fa fa-envelope"></i><span data-i18n="ab-df1-read.label.address"> Address</span></label>
+        <input type="hidden" id="node-input-addressType">
+        <input style="width: 70%" type="text" id="node-input-address" placeholder="D0">
+    </div>
+    <div class="form-row">
+      <label for="node-input-outputFormat"><i class="fa fa-sign-out"></i><span data-i18n="ab-df1-read.label.outputFormat"> Output format</span></label>
+      <select style="width: 70%" id="node-input-outputFormat">
+          <option value="0">JSON Object</option>
+          <option value="1">Array</option>
+      </select>
+    </div>
+    <div class="form-row">
+      <label for="node-input-errorHandling"><i class="fa fa-exclamation"></i><span data-i18n="ab-df1-read.label.errors"> Errors</span></label>
+      <select style="width: 70%" id="node-input-errorHandling">
+        <option value="throw">Throw (default)</option>
+        <option value="msg">Output to msg.error</option>
+        <option value="output2">Send to seperate output</option>
+      </select>
+    </div>  
+  </div>
+</script>
+
+
+<script type="text/html" data-help-name="MC Read">
+  <p>Read data from an MITSUBISHI PLCs using MC Protocol</p>
+  <h3>Inputs</h3>
+  <dl class="message-properties">
+    <dt class="required">Connection<span class="property-type">DF1 Connection</span></dt>
+    <dd>The PLC connection</dd>
+    <dt class="required">Address<span class="property-type">number | string | payload</span></dt>
+    <dd>PLC Memory Address</dd>
+    <p><i>INFO: To open / close the MC Protocol connection, send boolean <code>true</code> in <code>msg.connect</code> , <code>msg.disconnect</code> or <code>msg.reinitialize</code>.  Alternatively, send string <code>connect</code>, <code>disconnect</code> or <code>reinitialize</code> in <code>msg.topic</code> to the any mc read / mc write node.</i></p>
+  </dl>
+  <h3>Outputs</h3>
+  <dl class="message-properties">
+    <dt>payload <span class="property-type">array | object</span></dt>
+    <dd>the values read from the PLC.</dd>
+    <i>To view additional details of the PLC read result, use a debug node to inspect the data</i>
+  </dl>
+  <h3>Details</h3>
+  <p>
+    If an error occurs the output of this node may still be triggered. 
+    In this case, the payload will be <code>null</code> but the <code>mcWriteDetails</code> will contain additional information about the problem.
+  </p>
+  <p>Address format [DS] DEV [DT] DN [.BIT] [,CNT] [:OPTS]...  
+      <ol>
+        <li>[1] DS	 - {string} Digit specifier (e.g. K4) [optional]</li>
+        <li>[2] DEV  - {string} Device (Y|X|D|F|W|B|R|etc)</li>
+        <li>[3] DT 	 - {string} Data type (REAL|FLOAT|STR|WORD|DWORD|DINT|UINT) [optional]</li>
+        <li>[4] DN 	 - {int} Device number</li>
+        <li>[5] BIT  - {int} Bit number [optional]</li>
+        <li>[6] CNT  - {int} Count of items [optional]</li>
+        <li>[7] OPTS - {JSON} Options for specifying network and station e.g. {N:2,S:3} would attempt to route the message to station 3 on network 2 [optional]</li>
+      </ol>
+      <i>Notes...<br>DS and DT should not be used together. <br>if CNT is omitted, then <code>1</code> is assumed. <br>DN may be DEC or HEX depending on the notation of the Device e.g. YA, X1E, WBA4, B3D   </i> 
+  </p>
+  <p>data returned will match the address specified e.g...
+    <table>
+      <tr>
+        <td>Address Example</td>
+        <td>Data Type</td>
+        <td>Notes</td>
+        </tr>
+      <tr>
+        <td>K4Y0</td>
+        <td>int</td>
+        <td>−32,768 to 32,767</td>
+        </tr>
+      <tr>
+        <td>DSTR0,10</td>
+        <td>string</td>
+        <td>Up to 10 chars long</td>
+        </tr>
+      <tr>
+        <td>DUINT0,10</td>
+        <td>UINT[10]</td>
+        <td>10 WD array containing values 0 to 65535</td>
+        </tr>
+    </table>
+  </p>
+</script>