node-red-opcua-otmr 2.0.3 → 3.0.0

package/README.md

@@ -1,19 +1,49 @@
-Node-RED OPCUA-OTMR Node
--------------------
+# Node-RED OPCUA-OTMR Node
 
-The node-red-opcua-otmr node makes it easy to connect with OPC UA servers, allowing you to fetch data from specific Node IDs. 
+The `@omidteimoori/node-red-opcua` Node-RED node allows seamless communication with OPC UA servers. It enables you to read, write, and subscribe to values from specific Node IDs — ideal for industrial automation and IoT applications.
 
-Customise the Endpoint URLs, Ports, and Node IDs to  integrate with industrial automation and IoT projects.
+## Features
 
+- Connect to any OPC UA server via customizable endpoint URL and port  
+- Read data from specific Node IDs  
+- Write data to OPC UA tags  
+- Subscribe to live changes  
+- Suitable for use in SCADA, MES, and Industry 4.0 projects  
 
+## Installation
 
-Install:
-----------------
+Run the following command in your Node-RED user directory (typically `~/.node-red`):
 
+```bash
+npm install @omidteimoori/node-red-opcua
+```
 
-Execute the following command in your Node-RED directory (usually located at `~/.node-red`):
+Then restart Node-RED. The node will appear in the **function** category as `opcua-otmr`.
 
-`npm i node-red-opcua-otmr`
+## Usage
 
-Find the `opcua-otmr` node under your function package.
+1. Drag the `opcua-otmr` node into your Node-RED workspace  
+2. Configure:
+   - Endpoint (e.g., `opc.tcp://192.168.0.10:4840`)
+   - Node ID (e.g., `ns=2;s=Temperature`)  
+   - Operation: Read, Write, or Subscribe  
+3. Deploy the flow and monitor/debug results
 
+## Example Use Cases
+
+- Real-time temperature monitoring from a PLC  
+- Writing setpoints to industrial devices  
+- Live dashboards for machine data  
+
+## Author
+
+Developed by [Omid Teimoori](https://omidteimoori.com)  
+[GitHub: omidteimoori](https://github.com/omidteimoori)
+
+## GitHub Repository
+
+[GitHub: node-red-opcua-otmr](https://github.com/omidteimoori/node-red-opcua-otmr/)
+
+## NPM Package
+
+[https://www.npmjs.com/package/node-red-opcua-otmr](https://www.npmjs.com/package/node-red-opcua-otmr)

package/opcua-otmr.html

@@ -7,6 +7,7 @@
             endpoint: { value: "", required: true },
             port: { value: 4840, validate: RED.validators.number(), required: true },
             nodeIds: { value: "", required: true },
+            operation: { value: "read", required: true },
             dataType: { value: "" }
         },
         inputs: 1,
@@ -17,16 +18,15 @@
         },
         oneditprepare: function() {
             $('#node-input-name').val(this.name);
+            $('#node-input-operation').val(this.operation);
             $('#node-input-endpoint').val(this.endpoint);
             $('#node-input-port').val(this.port);
             $('#node-input-nodeIds').val(this.nodeIds);
             $('#node-input-dataType').val(this.dataType);
-
-            $('#node-help').html("<p>This node communicates with an OPC UA server and reads values from various Node IDs.</p>");
-
         },
         oneditsave: function() {
             this.name = $('#node-input-name').val();
+            this.operation = $('#node-input-operation').val();
             this.endpoint = $('#node-input-endpoint').val();
             this.port = $('#node-input-port').val();
             this.nodeIds = $('#node-input-nodeIds').val();
@@ -34,7 +34,7 @@
 
             if (!this.endpoint || !this.port || !this.nodeIds) {
                 RED.notify("Endpoint URL, Port, and Node IDs are required fields.", "error");
-                return false; // Prevents the node from being saved
+                return false;
             }
         }
     });
@@ -42,35 +42,31 @@
 
 <script type="text/html" data-template-name="opcua-otmr">
     <div class="form-row">
-        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <label for="node-input-name">Name</label>
         <input type="text" id="node-input-name" placeholder="Name">
     </div>
     <div class="form-row">
-        <label for="node-input-endpoint"><i class="fa fa-wifi"></i> Endpoint</label>
+        <label for="node-input-operation">Operation</label>
+        <select id="node-input-operation">
+            <option value="read">Read</option>
+            <option value="write">Write</option>
+        </select>
+    </div>
+    <div class="form-row">
+        <label for="node-input-endpoint">Endpoint</label>
         <input type="text" id="node-input-endpoint" placeholder="opc.tcp://hostname">
     </div>
     <div class="form-row">
-        <label for="node-input-port"><i class="fa fa-hashtag"></i> Port</label>
+        <label for="node-input-port">Port</label>
         <input type="text" id="node-input-port" placeholder="4840">
     </div>
     <div class="form-row">
-        <label for="node-input-nodeIds"><i class="fa fa-list"></i> Node IDs</label>
+        <label for="node-input-nodeIds">Node IDs</label>
         <input type="text" id="node-input-nodeIds" placeholder="NodeID 1, NodeID 2, ...">
     </div>
-    <!--
-    <div class="form-row">
-        <label for="node-input-dataType"><i class="fa fa-database"></i> Data Type</label>
-        <input type="text" id="node-input-dataType" placeholder="Data type 1, Data type 2, ...">
-    </div>
-    -->
-
-    <script type="text/html" data-help-name="opcua-otmr">
-        <p>This node communicates with an OPC UA server and reads values from various Node IDs. Data type of each NodeID will be captured automatically</p>
-    </script>
-    
-
 </script>
 
 <script type="text/html" data-help-name="opcua-otmr">
-    <p>This node communicates with an OPC UA server and reads values from specified Node IDs.</p>
-</script>
+    <p>This node communicates with an OPC UA server. You can choose to read or write values from specified Node IDs.</p>
+    <p>For write mode, send a simple value in <code>msg.payload</code> (e.g., <code>42</code> or <code>"ON"</code>), and the node will use the configured Node ID and Data Type.</p>
+</script>

package/opcua-otmr.js

@@ -1,10 +1,11 @@
-module.exports = function(RED) {
+module.exports = function (RED) {
     function OpcuaOtmrNode(config) {
         RED.nodes.createNode(this, config);
-        var node = this;
+        const node = this;
         node.endpoint = config.endpoint;
-        node.port = parseInt(config.port); // Parse port as an integer
-        node.nodeIds = config.nodeIds ? config.nodeIds.split(",").map(id => id.trim()) : []; // Split Node IDs by comma and trim whitespace, default to empty array
+        node.operation = config.operation || "read";
+        node.port = parseInt(config.port);
+        node.nodeIds = config.nodeIds ? config.nodeIds.split(",").map(id => id.trim()) : [];
         node.dataType = config.dataType;
 
         const opcua = require("node-opcua");
@@ -19,7 +20,7 @@ module.exports = function(RED) {
                 session = await client.createSession();
                 node.log("Session created");
             } catch (err) {
-                node.error("Failed to connect to OPC UA server: " + err.message);
+                node.error("Failed to connect to OPC UA server", err);
                 node.status({ fill: "red", shape: "ring", text: "connection failed" });
             }
         }
@@ -30,7 +31,7 @@ module.exports = function(RED) {
                     await session.close();
                     node.log("Session closed");
                 } catch (closeError) {
-                    node.error("Failed to close session: " + closeError.message);
+                    node.error("Failed to close session", closeError);
                 }
                 session = null;
             }
@@ -38,13 +39,22 @@ module.exports = function(RED) {
             node.log("Disconnected from OPC UA server");
         }
 
-        node.on('input', async function(msg) {
-            const nodeIds = node.nodeIds || msg.nodeIds || [];
-            const dataType = node.dataType || msg.dataType;
+        function inferDataType(value) {
+            const type = typeof value;
+            if (type === "number") return "Double";
+            if (type === "boolean") return "Boolean";
+            if (type === "string") return "String";
+            return null;
+        }
+
+        node.on('input', async function (msg) {
+            const nodeId = node.nodeIds[0];
+            const configuredType = node.dataType;
+            const payload = msg.payload;
 
-            if (!node.endpoint || isNaN(node.port) || node.port < 0 || node.port > 65535 || nodeIds.length === 0) {
-                node.error("Endpoint URL, port, and Node IDs must be provided.");
-                node.status({ fill: "red", shape: "ring", text: "missing required fields" });
+            if (!node.endpoint || isNaN(node.port) || node.port < 0 || node.port > 65535 || !nodeId) {
+                node.error("Endpoint URL, port, and a Node ID must be configured.");
+                node.status({ fill: "red", shape: "ring", text: "missing configuration" });
                 return;
             }
 
@@ -53,29 +63,74 @@ module.exports = function(RED) {
             }
 
             try {
-                const dataValues = await Promise.all(nodeIds.map(async (nodeId) => {
+                if (node.operation === "write") {
+                    const resolvedType = configuredType || inferDataType(payload);
+                    if (!resolvedType || !opcua.DataType.hasOwnProperty(resolvedType)) {
+                        node.error(`Unsupported or missing data type: ${resolvedType}`);
+                        node.status({ fill: "red", shape: "ring", text: "invalid data type" });
+                        return;
+                    }
+
+                    const variant = new opcua.Variant({
+                        dataType: opcua.DataType[resolvedType],
+                        value: payload
+                    });
+
+                    const itemToWrite = {
+                        nodeId: nodeId,
+                        attributeId: opcua.AttributeIds.Value,
+                        value: { value: variant }
+                    };
+
+                    const results = await session.write([itemToWrite]);
+                    const statusCode = results?.[0]?.statusCode;
+
+                    msg.payload = {
+                        nodeId: nodeId,
+                        value: payload,
+                    };
+
+                    if (statusCode && statusCode.name === "Good") {
+                        node.log(`Wrote ${payload} (${resolvedType}) to ${nodeId} [${statusCode.name}]`);
+                        node.status({ fill: "green", shape: "dot", text: "value written" });
+                    } else if (statusCode && statusCode.name.startsWith("Bad")) {
+                        const statusText = statusCode.toString();
+                        node.warn(`Write failed for ${nodeId}: ${statusText}`);
+                        node.status({ fill: "red", shape: "ring", text: statusText });
+                    } else {
+                        node.log(`Write completed with status: ${statusCode ? statusCode.toString() : "unknown"}`);
+                        node.status({ fill: "grey", shape: "dot", text: "unknown status" });
+                    }
+
+                    node.send(msg);
+
+                } else {
                     const dataValue = await session.readVariableValue(nodeId);
-                    return { nodeId, value: dataValue.value.value };
-                }));
-                node.log(`Read values from Node IDs: ${JSON.stringify(dataValues)}`);
-                msg.payload = dataValues;
-                node.send(msg);
-                node.status({ fill: "green", shape: "dot", text: "data read successfully" });
+                    msg.payload = {
+                        nodeId: nodeId,
+                        value: dataValue.value.value
+                    };
+                    node.send(msg);
+                    node.status({ fill: "green", shape: "dot", text: "value read" });
+                }
             } catch (err) {
-                node.error("Failed to read values from OPC UA server: " + err.message);
-                node.status({ fill: "red", shape: "ring", text: "read error" });
+                const errorDetails = (typeof err === "object")
+                    ? JSON.stringify(err, Object.getOwnPropertyNames(err))
+                    : String(err);
+                node.error("OPC UA operation failed: " + errorDetails);
+                node.status({ fill: "red", shape: "ring", text: "operation error" });
             }
         });
 
-        node.on('close', async function() {
+        node.on('close', async function () {
             await disconnectFromServer();
         });
 
-        process.on('SIGINT', async function() {
+        process.on('SIGINT', async function () {
             await disconnectFromServer();
             process.exit();
         });
     }
 
     RED.nodes.registerType("opcua-otmr", OpcuaOtmrNode);
-};
+};

package/package.json

@@ -1,22 +1,35 @@
 {
   "name": "node-red-opcua-otmr",
-  "version": "2.0.3",
+  "version": "3.0.0",
   "description": "OPCUA communication",
   "main": "opcua-otmr.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "keywords": [
-    "OPCUA",
-    "node-red"
+    "node-red",
+    "opcua",
+    "node-red-contrib",
+    "opc ua",
+    "iiot",
+    "industrial",
+    "automation"
   ],
-  "author": "Omid Teimoori",
+  "author": "Omid Teimoori <omid@teimoori.com> (https://omidteimoori.com)",
   "license": "ISC",
+  "homepage": "https://omidteimoori.com/projects",
   "node-red": {
     "nodes": {
       "opcua-otmr": "opcua-otmr.js"
     }
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/omidteimoori/node-red-opcua-otmr.git"
+  },
+  "bugs": {
+    "url": "https://github.com/omidteimoori/node-red-opcua-otmr/issues"
+  },
   "dependencies": {
     "node-opcua": "^2.126.0"
   }