@t0a5tbr0t/node-red-contrib-opcua 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+
+## [0.1.0]
+- Fork of the original node-red-contrib-opcua
+- set `maxNotificationsPerPublish` to 0 (unlimited) in opcua-basics.js

package/LICENSE

@@ -0,0 +1,20 @@
+
+Copyright 2015 Valmet Automation Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+
+Developer List:
+
+since 2015 - Mika Karaila - mika.karaila@valmet.com - Valmet Automation Inc.
+since 2016 - Klaus Landsdorf - klaus.landsdorf@bianco-royal.de - Bianco Royal

package/Readme.md

@@ -0,0 +1,239 @@
+[![NPM download](https://img.shields.io/npm/dm/node-red-contrib-opcua.svg)](http://www.npm-stats.com/~packages/node-red-contrib-opcua)
+[![NPM version](https://badge.fury.io/js/node-red-contrib-opcua.png)](http://badge.fury.io/js/node-red-contrib-opcua)
+
+![Node-RED OPC UA](http://b.repl.ca/v1/Node--RED-OPC_UA-blue.png)
+
+node-red-contrib-opcua
+========================
+
+![opcuanodeLogo64](images/opcuanodeLogo64.png)
+
+A [Node-RED][1] nodes to communicate or serve via [OPC UA](https://www.npmjs.com/package/node-opcua).
+
+based on [node-opcua](http://node-opcua.github.io/)
+
+![nodeopcua64](images/nodeopcua64.png)
+
+Install
+-------
+
+Run command on Node-RED installation directory.
+
+	npm install node-red-contrib-opcua
+
+or run command for global installation.
+
+	npm install -g node-red-contrib-opcua
+
+Usage
+-----
+
+Use OpcUa-Item to define variables.
+Use OpcUa-Client to read / write / subscribe / browse OPC UA server.
+
+See some flows under folder ![examples].
+Updated server sub-flow example OPCUA-TEST-NODES.json look commands: addFolder, addVariable, addMethod, setFolder.
+Added new opcua-rights node to set folder/variable access level and role & permissions.
+
+Here you got some ready to use examples.
+You can use the Import in Node-RED in the right upper corner menu.
+
+![node-red-opcua-flow](images/Example.png)
+
+Examples are available for Schneider IGSS and Prosys Simulation Server as Node-RED flow.
+Search for OPC UA on: http://flows.nodered.org/
+
+![node-red-opcua-flow-Prosys](images/PROSYS-OPC-UA-EXAMPLE2.png)
+
+![New method node example](images/PROSYS-OPCUA-METHOD-EXAMPLE.png)
+
+![Events example](images/PROSYS-OPCUA-EVENTS-EXAMPLE.png)
+
+Message parameters
+------------------
+
+Input message
+----
+
+| __**Property**__   | __**Function/Value**__    | __**Notes**__             |
+|--------------------|---------------------------|---------------------------|
+|  payload 	         | set interval for subscription or monitorItem
+|  interval	         | Subscription interval     |
+|  queueSize	     | Subscription queue size   |
+|  deadbandType      | "a" abs. or "p" percent   | Action monitor
+|  deadbandValue     | integer for deadband      | Action monitor
+|  topic		     | NodeId and DataType in format ns=3;s=Counter;datatype=Int32
+|  action            | subscribe                 | nodeId / variable
+|                    | unsubscribe               | nodeId / variable
+|                    | deletesubscription        | subscription
+|                    | browse                    | nodeId / folder
+|                    | info                      | nodeId
+|                    | read                      | nodeId
+|                    | write                     | nodeId & value
+|                    | monitor                   | deadbandtype abs/pro
+|                    | events                    | nodeId
+|                    | readmultiple              | [nodeId + datatype]
+|                    | writemultiple             | [nodeId + datatype + value]
+
+readmultiple to readmultiple items
+writemultiple to write multiple items
+clearitems to empty multiple items (readmultiple / writemultiple)
+
+NOTE: With datatype=xxxArray msg.payload.range = "2:4" can used as indexRange to read/write partial array
+
+Output message
+----
+
+| __**Property**__   | __**Function/Value**__    | __**Notes**__             |
+|--------------------|---------------------------|---------------------------|
+|  payload           | dataValue.value.value     |                           |
+|  statusCode	     | OPC UA StatusCode         |                           |
+|  sourceTimestamp	 | Source timestamp          |                           |
+|  serverTimestamp   | Server´s timestamp        |                           |
+
+Release history (only couple of older releases):
+
+
+**v0.2.223**
+<p>
+Fixed: Namespace index used with variables (set value).<br/>
+Enhancements: Initial value can be set to server variable, server returns nodeId as variable created. Added support for StringArray.
+</p>
+
+**v0.2.117**
+<p>
+Enhancement: Added users to server. Users.json contains username, password and role for each user.<br/>
+</p>
+
+**v0.2.116**
+<p>
+Enhancement: server allow anonymous, added verbose to show trusted/rejected folders.<br/>
+</p>
+
+
+**v0.2.115**
+<p>
+Enhancement: server node security settings; mode and policy<br/>
+</p>
+
+**v0.2.114**
+<p>
+Fix: added to client certificate manager<br/>
+</p>
+
+**v0.2.113**
+<p>
+Enhancement: server commands: registerNamespace and getNamespaceIndex, user can addVariables with registered namespaces like ns=5.<br/>
+Enhancement: msg.topic = readmultiple AND msg.payload = ALL then msg.payload = values<br/>
+</p>
+
+**v0.2.112**
+<p>
+Added DateTime to server.<br/>
+</p>
+
+**v0.2.111**
+<p>
+Fixed DateTime conversion (write).<br/>
+</p>
+
+**v0.2.110**
+<p>
+Added 2D and 3D array support. Examples:<br/>
+ns=1;s=Float2D;datatype=FloatArray[5,5]<br/>
+ns=1;s=Float3D;datatype=FloatArray[5,5,5]<br/>
+NOTE: Write range uses msg.range<br/>
+New feature msg.payload.range can be used to read part of Array<br/>
+New feature msg.range can be used to write part of Array<br/>
+Updated example OPCUA-TEST-NODES.json<br/>
+
+</p>
+
+**v0.2.109**
+<p>
+Added array range examples (examples/OPCUA-TEST-NODES.json).<br/>
+Send only if payload contains something.<br/>
+Added msg.payload.range usage<br/>
+New feature msg.payload.range can be used to read/write part of Array<br/>
+Fix: FQDN -> hostname in makeAplicationUri<br/>
+EventId and statustext as clear string<br/>
+EventId as hex string<br/>
+</p>
+
+**v0.2.108 and older**
+<p>
+Fixed support for server Array variables<br/>
+Browse will create topic and datatype thus output can be connected. Next node can progress output msg.<br/>
+Refactored browse action fast and simple<br/>
+Merged event payload fix. Merge pull request #265 from list3f/master<br/>
+Put OPC UA event data in msg.payload<br/>
+</p>
+# Advanced examples
+- needed from users (add links to examples folder)
+
+
+
+# Authors
+
+* since 2015 [Mika Karaila][2]
+* since 2016 [Klaus Landsdorf][3]
+
+Testing
+------
+
+    karma start opcua.conf.js --log-level debug --single-run
+
+TBD List
+-----
+
+| __**Nodes**__      | __**Function**__          | __**Done**__              |
+|--------------------|---------------------------|---------------------------|
+|  All               |                           |                           |
+|                    | Project structure         | :white_check_mark:        |
+|                    | Async calls               | :waxing_crescent_moon:    |
+|                    | UnitTesting               | :new_moon:                |
+|                    | Documentation             | :first_quarter_moon:    |
+|  Item              |                           | :white_check_mark:        |
+|  Browser           |                           |                           |
+|                    | Browse                    | :white_check_mark:        |
+|                    | Simple UI interface       | :first_quarter_moon:      |
+|  Client            |                           |                           |
+|                    | Read                      | :white_check_mark:        |
+|                    | Read Multiple             | :white_check_mark:        |
+|                    | Write                     | :white_check_mark:        |
+|                    | Write Multiple            | :white_check_mark:        |
+|                    | Subscribe                 | :white_check_mark:        |
+|                    | Unsubscribe               | :white_check_mark:        |
+|                    | DeleteSubscription        | :white_check_mark:        |
+|                    | Info                      | :white_check_mark:        |
+|                    | Browse                    | :white_check_mark:        |
+|                    | AE                        | :new_moon:                |
+|                    | reconnect on error        | :waxing_crescent_moon:    |
+|  Server            |                           |                           |
+|      Commands      |                           |                           |
+|                    | Restart                   | :white_check_mark:        |
+|                    | Add Folder                | :white_check_mark:        |
+|                    | Set Folder                | :white_check_mark:        |
+|                    | Add Variable              | :white_check_mark:        |
+|                    | Add Object                | :new_moon:                |
+|                    | Add Method                | :new_moon:                |
+|                    | Add Equipment             | :first_quarter_moon:      |
+|                    | Add PhysicalAssets        | :first_quarter_moon:      |
+|                    |                           |                           |
+|                    | Delete by NodeId          | :white_check_mark:        |
+|      Examples      |                           |                           |
+|                    | Methods                   |                           |
+|                    | Structures                |                           |
+|                    | Variables                 |                           |
+|                    | Objects                   |                           |
+|                    | AE                        |                           |
+|                    |                           |                           |
+|  Alarm and Events  |                           |                           |
+|                    | Subscribe                 | :white_check_mark:        |
+|                    |                           |                           |
+
+[EMOJI CHEAT SHEET](http://www.emoji-cheat-sheet.com/)
+
+[1]:http://nodered.org
+[2]:https://github.com/mikakaraila
+[3]:https://github.com/biancode

package/opcua/101-opcuaitem.html

@@ -0,0 +1,106 @@
+<!--
+
+Copyright 2015 Valmet Automation Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-->
+
+<script type="text/javascript">
+    RED.nodes.registerType('OpcUa-Item',{
+        category: 'opcua',
+        color:"#3FADB5",
+        defaults: {
+            item: {value: "", required: true},
+            datatype: {value: "", required: true},
+            value: {value: null},
+            name: {value: ""}
+        },
+        inputs:1,
+        outputs:1,
+        align: "right",
+        icon: "opcuanodeLogo.png",
+        label: function() {
+            return this.name || "OPC UA Item";
+        },
+        labelStyle: function() {
+            return this.name?"node_label_italic":"";
+        }
+    });
+</script>
+
+
+
+<script type="text/x-red" data-template-name="OpcUa-Item">
+    <div class="form-row">
+        <label for="node-input-item"><i class="icon-tasks"></i> Item</label>
+        <input type="text" id="node-input-item" placeholder="ns=2;s=MySwitch or ns=2;i=1234 or br=/objects/3:Simulation/3:Counter">
+    </div>
+    <div class="form-row">
+        <label for="node-input-datatype"><i class="icon-tasks"></i> Type</label>
+        <select type="text" id="node-input-datatype">
+            <option value="Int8">Int8</option>
+            <option value="Int16">Int16</option>
+            <option value="Int32">Int32</option>
+            <option value="Int64">Int64</option>
+            <option value="UInt8">UInt8</option>
+            <option value="UInt16">UInt16</option>
+            <option value="UInt32">UInt32</option>
+            <option value="UInt64">UInt64</option>
+            <option value="Byte">Byte</option>
+            <option value="SByte">SByte</option>
+            <option value="Float">Float</option>
+            <option value="Double">Double</option>
+            <option value="Boolean">Boolean</option>
+            <option value="String">String</option>
+            <option value="LocalizedText">LocalizedText</option>
+			<option value="DateTime">DateTime</option>
+            <option value="Int8 Array">Int8 Array</option>
+            <option value="Int16 Array">Int16 Array</option>
+            <option value="Int32 Array">Int32 Array</option>
+            <option value="UInt8 Array">UInt8 Array</option>
+            <option value="UInt16 Array">UInt16 Array</option>
+            <option value="UInt32 Array">UInt32 Array</option>
+            <option value="Byte Array">Byte Array</option>
+            <option value="SByte Array">SByte Array</option>
+            <option value="String Array">String Array</option>
+            <option value="Float Array">Float Array</option>
+            <option value="Double Array">Double Array</option>
+            <option value="Boolean Array">Boolean Array</option>
+            <option value="Extension Object">ExtensionObject</option>
+            <option value="Extension Object Array">ExtensionObject Array</option>
+        </select>
+    </div>
+    <div class="form-row">
+        <label for="node-input-value"><i class="icon-tag"></i> Value</label>
+        <input type="text" id="node-input-value" placeholder="">
+    </div>
+    <div class="form-row">
+        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="">
+    </div>
+</script>
+
+
+
+<script type="text/x-red" data-help-name="OpcUa-Item">
+    <p>Defines OPC UA item, type and value.</p>
+    <p>Item contains valid OPC UA address like ns=2;i=4 OR ns=3;s=MyVariable</p>
+    <p>There are not all Types possible for now, but you can select some.</p>
+    <p>Value is needed only if item will be written to OPC UA server.</p>
+    <p>If value isn't filled, OpcUa-Item sends input <strong>msg.payload</strong>.</p>
+    <p>Array values are delimited by , and must be given in following syntax:</p>
+    <p>5,4,3,2,1</p>
+    <p><strong>NOTE:</strong> Item value can be used as initial value when msg.payload is empty.</p>
+    <p>      Otherwise msg.payload is used to set value.</p>
+</script>

package/opcua/101-opcuaitem.js

@@ -0,0 +1,82 @@
+/**
+
+ Copyright 2015 Valmet Automation Inc.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ **/
+
+module.exports = function (RED) {
+    "use strict";
+    var opcua = require('node-opcua');
+    var opcuaBasics = require('./opcua-basics');
+    const {parse, stringify} = require('flatted');
+
+    function OpcUaItemNode(n) {
+
+        RED.nodes.createNode(this, n);
+
+        this.item = n.item; // OPC UA address: ns=2;i=4 OR ns=3;s=MyVariable
+        this.datatype = n.datatype.replace(/\s/g, ""); // String; need to remove white space from node datatype to be consistent with inputs, i.e. ExtensionObject
+        this.value = n.value; // 66.6
+        this.name = n.name; // browseName shall be put here
+
+        var node = this;
+
+        function verbose_warn(logMessage) {
+            //if (RED.settings.verbose) {
+                node.warn((node.name) ? node.name + ': ' + logMessage : 'OpcUaClientNode: ' + logMessage);
+            //}
+        }
+
+        function verbose_log(logMessage) {
+            //if (RED.settings.verbose) {
+                // node.log(logMessage);
+                node.debug(logMessage);
+            //}
+        }
+
+        node.on("input", function (msg) {
+
+            msg.topic = node.item;
+            msg.datatype = node.datatype;
+            msg.browseName = node.name;
+            
+            // Node contains static value, inject with empty string as payload
+            if (node.value && msg.payload.length === 0) {
+                verbose_log('First set value by node value:' + node.value);
+                if (node.datatype) {
+                    msg.payload = opcuaBasics.build_new_value_by_datatype(node.datatype, node.value);
+                }
+                if (msg.datatype) {
+                    msg.payload = opcuaBasics.build_new_value_by_datatype(msg.datatype, node.value);
+                }
+                verbose_warn("NODE value, setting value to " + stringify(msg));
+            }
+            // Input msg is dynamic and will overwrite node.value
+            if (msg.payload && msg.payload.length > 0) {
+                // verbose_warn("Second set value by Input " + msg.payload);
+                if (node.datatype) {
+                   msg.payload = opcuaBasics.build_new_value_by_datatype(node.datatype, msg.payload);
+                }
+                if (msg.datatype) {
+                    msg.payload = opcuaBasics.build_new_value_by_datatype(msg.datatype, msg.payload);
+                }
+                // verbose_warn("Payload value, setting value to " + stringify(msg));
+            }
+            node.send(msg);
+        });
+    }
+
+    RED.nodes.registerType("OpcUa-Item", OpcUaItemNode);
+};