@tier0/opcua-client 0.1.0

package/nodes/connection.html

@@ -0,0 +1,44 @@
+<style>
+  .opcua-advanced { margin: 8px 0 12px; }
+  .opcua-advanced summary { cursor: pointer; font-weight: 600; padding: 6px 0; }
+  .opcua-standard-note { margin: 0 0 10px 105px; color: var(--red-ui-form-text-color, #666); font-size: 0.9em; }
+</style>
+<script type="text/html" data-template-name="tier0-opcua-connection">
+  <div class="form-row"><label for="node-config-input-endpoint">Endpoint</label><input type="text" id="node-config-input-endpoint" placeholder="opc.tcp://127.0.0.1:4840"></div>
+  <div class="form-row"><label for="node-config-input-securityMode">Security</label><select id="node-config-input-securityMode"><option value="None">None</option><option value="Sign">Sign</option><option value="SignAndEncrypt">SignAndEncrypt</option></select></div>
+  <div class="opcua-standard-note">Standard defaults include automatic reconnect, connectivity checks, and a bounded NodeId cache.</div>
+  <details class="opcua-advanced">
+    <summary>Security and advanced connection settings</summary>
+    <div class="form-row"><label for="node-config-input-securityPolicy">Policy</label><select id="node-config-input-securityPolicy"><option value="None">None</option><option value="Basic256Sha256">Basic256Sha256</option><option value="Aes128Sha256RsaOaep">Aes128Sha256RsaOaep</option><option value="Aes256Sha256RsaPss">Aes256Sha256RsaPss</option></select></div>
+    <div class="form-row"><label for="node-config-input-user">User</label><input type="text" id="node-config-input-user"></div>
+    <div class="form-row"><label for="node-config-input-password">Password</label><input type="password" id="node-config-input-password"></div>
+    <div class="form-row"><label for="node-config-input-certificate">Certificate</label><input type="text" id="node-config-input-certificate"></div>
+    <div class="form-row"><label for="node-config-input-privateKey">Private key</label><input type="text" id="node-config-input-privateKey"></div>
+    <div class="form-row"><label for="node-config-input-requestedSessionTimeout">Session timeout</label><input type="number" id="node-config-input-requestedSessionTimeout"></div>
+    <div class="form-row"><label for="node-config-input-requestTimeout">Request timeout</label><input type="number" id="node-config-input-requestTimeout"></div>
+    <div class="form-row"><label for="node-config-input-connectivityCheckInterval">Connectivity check</label><input type="number" id="node-config-input-connectivityCheckInterval"></div>
+    <div class="form-row"><label for="node-config-input-reconnectInterval">Reconnect interval</label><input type="number" id="node-config-input-reconnectInterval"></div>
+    <div class="form-row"><label for="node-config-input-maxReconnectInterval">Max reconnect</label><input type="number" id="node-config-input-maxReconnectInterval"></div>
+    <div class="form-row"><label for="node-config-input-nodeIdCacheSize">NodeId cache</label><input type="number" id="node-config-input-nodeIdCacheSize"></div>
+  </details>
+  <div class="form-row"><label for="node-config-input-name">Name</label><input type="text" id="node-config-input-name"></div>
+</script>
+<script type="text/javascript">
+  RED.nodes.registerType('tier0-opcua-connection', {
+    category: 'config',
+    defaults: {
+      endpoint: { value: '', required: true },
+      securityMode: { value: 'None' }, securityPolicy: { value: 'None' },
+      user: { value: '' }, certificate: { value: '' }, privateKey: { value: '' },
+      requestedSessionTimeout: { value: 60000, validate: RED.validators.number() },
+      requestTimeout: { value: 10000, validate: RED.validators.number() },
+      connectivityCheckInterval: { value: 5000, validate: RED.validators.number() },
+      reconnectInterval: { value: 5000, validate: RED.validators.number() },
+      maxReconnectInterval: { value: 30000, validate: RED.validators.number() },
+      nodeIdCacheSize: { value: 100000, validate: RED.validators.number() },
+      name: { value: '' }
+    },
+    credentials: { password: { type: 'password' } },
+    label: function () { return this.name || this.endpoint || 'tier0-opcua-connection'; }
+  });
+</script>

package/nodes/connection.js

@@ -0,0 +1,49 @@
+'use strict';
+
+const { OpcUaClient } = require('../lib/client');
+
+module.exports = function registerConnectionNode(RED) {
+  function OpcUaConnectionNode(config) {
+    RED.nodes.createNode(this, config);
+    const node = this;
+
+    node.client = new OpcUaClient({
+      endpoint: config.endpoint,
+      securityMode: config.securityMode || 'None',
+      securityPolicy: config.securityPolicy || 'None',
+      user: config.user || '',
+      password: node.credentials?.password || '',
+      certificate: config.certificate || '',
+      privateKey: config.privateKey || '',
+      requestedSessionTimeout: Number(config.requestedSessionTimeout) || 60000,
+      requestTimeout: Number(config.requestTimeout) || 10000,
+      connectivityCheckInterval: Number.isFinite(Number(config.connectivityCheckInterval))
+        ? Math.max(0, Math.floor(Number(config.connectivityCheckInterval)))
+        : 5000,
+      reconnectInterval: Number(config.reconnectInterval) || 5000,
+      maxReconnectInterval: Number(config.maxReconnectInterval) || 30000,
+      nodeIdCacheSize: Number.isFinite(Number(config.nodeIdCacheSize))
+        ? Math.max(0, Math.floor(Number(config.nodeIdCacheSize)))
+        : 100000,
+    });
+
+    node.client.on('fault', (error) => node.warn(`OPC UA connection fault: ${error.message}`));
+    node.client.on('state', (state) => {
+      if (state.state === 'failed') node.warn(`OPC UA connection failed: ${state.statusCode}`);
+    });
+    node.on('close', async (done) => {
+      try {
+        await node.client.disconnect();
+      } catch (error) {
+        node.warn(`OPC UA disconnect failed: ${error.message}`);
+      }
+      done();
+    });
+  }
+
+  RED.nodes.registerType('tier0-opcua-connection', OpcUaConnectionNode, {
+    credentials: {
+      password: { type: 'password' },
+    },
+  });
+};

package/nodes/read.html

@@ -0,0 +1,187 @@
+<style>
+  .opcua-advanced { margin: 8px 0 12px; }
+  .opcua-advanced summary { cursor: pointer; font-weight: 600; padding: 6px 0; }
+  .opcua-point-editor { box-sizing: border-box; display: inline-block; vertical-align: top; width: calc(100% - 110px); }
+  .opcua-point-toolbar { display: flex; gap: 6px; margin-bottom: 8px; }
+  .opcua-point-add { display: flex; gap: 6px; margin-bottom: 8px; }
+  .opcua-point-add input { flex: 1; min-width: 0; }
+  .opcua-point-list { border: 1px solid var(--red-ui-form-input-border-color, #ccc); border-radius: 2px; box-sizing: border-box; height: 180px; list-style: none; margin: 0 !important; overflow: auto; padding: 0 !important; width: 100%; }
+  .opcua-point-list li { align-items: center; border-bottom: 1px solid var(--red-ui-secondary-border-color, #eee); display: flex; gap: 8px; min-height: 34px; padding: 4px 8px; }
+  .opcua-point-list li:last-child { border-bottom: 0; }
+  .opcua-point-list .opcua-point-text { flex: 1; min-width: 0; overflow: hidden; text-overflow: ellipsis; white-space: nowrap; }
+  .opcua-point-list .opcua-point-empty { color: var(--red-ui-form-placeholder-color, #888); justify-content: center; }
+  .opcua-point-list .opcua-point-remove { border: 0; color: var(--red-ui-text-color, #555); flex: 0 0 auto; }
+  .opcua-point-status { color: var(--red-ui-form-text-color, #666); font-size: 0.9em; margin-top: 5px; }
+</style>
+<script type="text/html" data-template-name="tier0-opcua-read">
+  <div class="form-row"><label for="node-input-connection">Connection</label><input type="text" id="node-input-connection"></div>
+  <input type="hidden" id="node-input-nodeId">
+  <input type="hidden" id="node-input-pointList">
+  <input type="hidden" id="node-input-pointListFileName">
+  <input type="file" id="node-input-pointFile" accept=".json,.csv,application/json,text/csv" style="display:none">
+  <div class="form-row">
+    <label>Points</label>
+    <div class="opcua-point-editor">
+      <div class="opcua-point-toolbar">
+        <button type="button" class="red-ui-button" id="node-input-importPointList"><i class="fa fa-upload"></i> Import</button>
+        <button type="button" class="red-ui-button" id="node-input-clearPointList"><i class="fa fa-trash"></i> Clear all</button>
+      </div>
+      <div class="opcua-point-add">
+        <input type="text" id="node-input-newPointNodeId" placeholder="NodeId, for example ns=2;s=Machine.Speed">
+        <button type="button" class="red-ui-button" id="node-input-addPoint"><i class="fa fa-plus"></i> Add</button>
+      </div>
+      <ol class="opcua-point-list" id="node-input-pointListItems"></ol>
+      <div class="opcua-point-status" id="node-input-pointListStatus">0 points</div>
+    </div>
+  </div>
+  <details class="opcua-advanced">
+    <summary>Advanced settings</summary>
+    <div class="form-row"><label for="node-input-batchSize">Batch size</label><input type="number" id="node-input-batchSize"></div>
+    <div class="form-row"><label for="node-input-outputMode">Output</label><select id="node-input-outputMode"><option value="batch">Batch</option><option value="split">One message per point</option></select></div>
+  </details>
+  <div class="form-row"><label for="node-input-name">Name</label><input type="text" id="node-input-name"></div>
+</script>
+<script type="text/html" data-help-name="tier0-opcua-read">
+  <p>Add NodeIds to the point list or import JSON/CSV. Imported points are parsed and shown in the same list.</p>
+  <p>CSV requires a <code>nodeId</code> header. A JSON/CSV point list may also arrive dynamically in <code>msg.payload</code>.</p>
+</script>
+<script type="text/javascript">
+  RED.nodes.registerType('tier0-opcua-read', {
+    category: 'OPC UA', color: '#c7e9f1', inputs: 1, outputs: 1, icon: 'bridge.png',
+    defaults: {
+      connection: { value: '', type: 'tier0-opcua-connection', required: true },
+      nodeId: { value: '' }, pointList: { value: '' }, pointListFileName: { value: '' },
+      batchSize: { value: 500, validate: RED.validators.number() },
+      outputMode: { value: 'batch' }, name: { value: '' }
+    },
+    oneditprepare: function () {
+      const points = new Map();
+
+      const csvLine = (line) => {
+        const fields = [];
+        let value = '';
+        let quoted = false;
+        for (let index = 0; index < line.length; index += 1) {
+          const character = line[index];
+          if (character === '"') {
+            if (quoted && line[index + 1] === '"') { value += '"'; index += 1; }
+            else quoted = !quoted;
+          } else if (character === ',' && !quoted) {
+            fields.push(value.trim()); value = '';
+          } else value += character;
+        }
+        fields.push(value.trim());
+        return fields;
+      };
+
+      const parse = (content) => {
+        const text = String(content || '').replace(/^\uFEFF/, '').trim();
+        if (!text) return [];
+        if (text.startsWith('[') || text.startsWith('{')) {
+          const parsed = JSON.parse(text);
+          return Array.isArray(parsed) ? parsed : (Array.isArray(parsed.items) ? parsed.items : [parsed]);
+        }
+        const lines = text.split(/\r?\n/).filter((line) => line.trim() && !line.trimStart().startsWith('#'));
+        if (!lines.length) return [];
+        const headers = csvLine(lines.shift());
+        if (!headers.includes('nodeId')) throw new Error('CSV header must contain nodeId');
+        return lines.map((line) => {
+          const values = csvLine(line);
+          return Object.fromEntries(headers.map((header, index) => [header, values[index] || '']));
+        });
+      };
+
+      const normalize = (item) => {
+        const source = typeof item === 'string' ? { nodeId: item } : { ...(item || {}) };
+        source.nodeId = String(source.nodeId || source.topic || '').trim();
+        if (!source.nodeId) throw new Error('Point is missing nodeId');
+        return source;
+      };
+
+      const persist = () => {
+        const items = [...points.values()];
+        $('#node-input-pointList').val(items.length ? JSON.stringify(items) : '');
+        if (items.length) $('#node-input-nodeId').val('');
+        $('#node-input-pointListStatus').text(`${items.length} point${items.length === 1 ? '' : 's'}`);
+      };
+
+      const render = () => {
+        const list = document.getElementById('node-input-pointListItems');
+        list.textContent = '';
+        if (!points.size) {
+          const empty = document.createElement('li');
+          empty.className = 'opcua-point-empty';
+          empty.textContent = 'No points. Add a NodeId or import a file.';
+          list.appendChild(empty);
+        } else {
+          const fragment = document.createDocumentFragment();
+          points.forEach((point, nodeId) => {
+            const row = document.createElement('li');
+            const text = document.createElement('span');
+            text.className = 'opcua-point-text';
+            text.textContent = point.alias ? `${point.alias} — ${nodeId}` : nodeId;
+            text.title = text.textContent;
+            const remove = document.createElement('button');
+            remove.type = 'button';
+            remove.className = 'red-ui-button opcua-point-remove';
+            remove.title = `Remove ${nodeId}`;
+            remove.innerHTML = '<i class="fa fa-times"></i>';
+            remove.addEventListener('click', () => { points.delete(nodeId); render(); });
+            row.append(text, remove);
+            fragment.appendChild(row);
+          });
+          list.appendChild(fragment);
+        }
+        persist();
+      };
+
+      const merge = (items) => {
+        items.forEach((item) => { const point = normalize(item); points.set(point.nodeId, point); });
+        render();
+      };
+
+      try {
+        const stored = $('#node-input-pointList').val();
+        if (stored) merge(parse(stored));
+        else if ($('#node-input-nodeId').val()) merge([{ nodeId: $('#node-input-nodeId').val() }]);
+        else render();
+      } catch (error) {
+        RED.notify(`Cannot load point list: ${error.message}`, 'error');
+        render();
+      }
+
+      $('#node-input-addPoint').on('click', () => {
+        try {
+          merge([{ nodeId: $('#node-input-newPointNodeId').val() }]);
+          $('#node-input-newPointNodeId').val('').focus();
+        } catch (error) { RED.notify(error.message, 'error'); }
+      });
+      $('#node-input-newPointNodeId').on('keydown', function (event) {
+        if (event.key === 'Enter') { event.preventDefault(); $('#node-input-addPoint').click(); }
+      });
+      $('#node-input-importPointList').on('click', () => $('#node-input-pointFile').click());
+      $('#node-input-pointFile').on('change', function () {
+        const file = this.files && this.files[0];
+        if (!file) return;
+        const reader = new FileReader();
+        reader.onload = () => {
+          try {
+            const imported = parse(reader.result);
+            merge(imported);
+            $('#node-input-pointListFileName').val(file.name);
+            RED.notify(`${imported.length} point(s) imported`, 'success');
+          } catch (error) { RED.notify(`Import failed: ${error.message}`, 'error'); }
+          $('#node-input-pointFile').val('');
+        };
+        reader.readAsText(file);
+      });
+      $('#node-input-clearPointList').on('click', () => {
+        points.clear();
+        $('#node-input-nodeId').val('');
+        $('#node-input-pointListFileName').val('');
+        render();
+      });
+    },
+    label: function () { return this.name || 'tier0-opcua-read'; }
+  });
+</script>

package/nodes/read.js

@@ -0,0 +1,66 @@
+'use strict';
+
+const { looksLikePointList, messagePoints } = require('../lib/points');
+
+module.exports = function registerReadNode(RED) {
+  function OpcUaReadNode(config) {
+    RED.nodes.createNode(this, config);
+    const node = this;
+    node.connection = RED.nodes.getNode(config.connection);
+
+    node.on('input', async (msg, send, done) => {
+      if (!node.connection) return done(new Error('OPC UA connection not configured'));
+
+      try {
+        const points = messagePoints(msg, config.nodeId, {}, {
+          configuredPayload: config.pointList,
+          format: 'auto',
+        });
+        node.status({ fill: 'blue', shape: 'dot', text: `reading ${points.length}` });
+        const values = await node.connection.client.readMany(
+          points,
+          Number(config.batchSize) || 500
+        );
+        const descriptors = new Map(points.map((point) => [point.nodeId, point]));
+        const results = values.map((value) => ({
+          ...descriptors.get(value.nodeId),
+          ...value,
+        }));
+
+        if ((config.outputMode || 'batch') === 'split') {
+          results.forEach((result) => send({
+            ...msg,
+            topic: result.nodeId,
+            payload: result.value,
+            opcua: result,
+          }));
+        } else if (points.length === 1 && !looksLikePointList(msg.payload) &&
+                   !Array.isArray(msg.items) && !config.pointList) {
+          const result = results[0];
+          msg.topic = result.nodeId;
+          msg.payload = result.value;
+          msg.opcua = result;
+          send(msg);
+        } else {
+          msg.payload = results;
+          msg.opcua = {
+            ...(msg.opcua || {}),
+            operation: 'read',
+            total: results.length,
+            good: results.filter((item) => item.statusCode === 'Good').length,
+            clientDiagnostics: node.connection.client.getDiagnostics(),
+          };
+          send(msg);
+        }
+
+        node.status({ fill: 'green', shape: 'dot', text: `${results.length} read` });
+        done();
+      } catch (error) {
+        node.status({ fill: 'red', shape: 'ring', text: error.message });
+        done(error);
+      }
+    });
+  }
+
+  RED.nodes.registerType('tier0-opcua-read', OpcUaReadNode);
+};

package/nodes/subscribe.html

@@ -0,0 +1,44 @@
+<style>
+  .opcua-advanced { margin: 8px 0 12px; }
+  .opcua-advanced summary { cursor: pointer; font-weight: 600; padding: 6px 0; }
+  .opcua-standard-note { margin: 0 0 10px 105px; color: var(--red-ui-form-text-color, #666); font-size: 0.9em; }
+</style>
+<script type="text/html" data-template-name="tier0-opcua-subscribe">
+  <div class="form-row"><label for="node-input-connection">Connection</label><input type="text" id="node-input-connection"></div>
+  <div class="form-row"><label for="node-input-nodeId">NodeId</label><input type="text" id="node-input-nodeId" placeholder="Optional when input supplies points"></div>
+  <div class="form-row"><label for="node-input-samplingInterval">Sampling (ms)</label><input type="number" id="node-input-samplingInterval"></div>
+  <div class="opcua-standard-note">Standard mode batches changes and automatically rebuilds the subscription after reconnect.</div>
+  <details class="opcua-advanced">
+    <summary>Advanced subscription and queue settings</summary>
+    <div class="form-row"><label for="node-input-publishingInterval">Publishing interval</label><input type="number" id="node-input-publishingInterval"></div>
+    <div class="form-row"><label for="node-input-queueSize">Server queue size</label><input type="number" id="node-input-queueSize"></div>
+    <div class="form-row"><label for="node-input-discardOldest">Discard oldest</label><input type="checkbox" id="node-input-discardOldest" style="width:auto"></div>
+    <div class="form-row"><label for="node-input-deadbandType">Deadband</label><select id="node-input-deadbandType"><option value="none">None</option><option value="absolute">Absolute</option><option value="percent">Percent</option></select></div>
+    <div class="form-row"><label for="node-input-deadbandValue">Deadband value</label><input type="number" id="node-input-deadbandValue"></div>
+    <div class="form-row"><label for="node-input-batchSize">Create batch size</label><input type="number" id="node-input-batchSize"></div>
+    <div class="form-row"><label for="node-input-outputMode">Change output</label><select id="node-input-outputMode"><option value="batch">Native batch</option><option value="single">One message per change</option></select></div>
+    <div class="form-row"><label for="node-input-callbackBatchSize">Native batch size</label><input type="number" id="node-input-callbackBatchSize"></div>
+    <div class="form-row"><label for="node-input-callbackQueueSize">Native queue capacity</label><input type="number" id="node-input-callbackQueueSize"></div>
+    <div class="form-row"><label for="node-input-queueMode">Queue mode</label><select id="node-input-queueMode"><option value="all">All changes</option><option value="latest">Latest value per point</option></select></div>
+    <div class="form-row"><label for="node-input-overflowPolicy">Overflow policy</label><select id="node-input-overflowPolicy"><option value="drop-oldest">Drop oldest</option><option value="drop-newest">Drop newest</option></select></div>
+  </details>
+  <div class="form-row"><label for="node-input-name">Name</label><input type="text" id="node-input-name"></div>
+</script>
+<script type="text/html" data-help-name="tier0-opcua-subscribe"><p>Creates one OPC UA subscription with many monitored items. Input may be an array, JSON, CSV, or Browse output. Commands are <code>replace</code>, <code>add</code>, <code>remove</code>, and <code>clear</code> in <code>msg.opcua.command</code>.</p><p>Standard mode preserves all changes in bounded native batches and reports queue diagnostics in <code>msg.opcua.queue</code>.</p></script>
+<script type="text/javascript">
+  RED.nodes.registerType('tier0-opcua-subscribe', {
+    category: 'OPC UA', color: '#c7e9f1', inputs: 1, outputs: 1, icon: 'bridge.png',
+    defaults: {
+      connection: { value: '', type: 'tier0-opcua-connection', required: true }, nodeId: { value: '' },
+      publishingInterval: { value: 1000, validate: RED.validators.number() }, samplingInterval: { value: 1000, validate: RED.validators.number() },
+      queueSize: { value: 10, validate: RED.validators.number() }, discardOldest: { value: true },
+      deadbandType: { value: 'none' }, deadbandValue: { value: 0, validate: RED.validators.number() },
+      batchSize: { value: 500, validate: RED.validators.number() }, outputMode: { value: 'batch' },
+      callbackBatchSize: { value: 500, validate: RED.validators.number() }, callbackQueueSize: { value: 10000, validate: RED.validators.number() },
+      queueMode: { value: 'all' }, overflowPolicy: { value: 'drop-oldest' },
+      lifetimeCount: { value: 120 }, maxKeepAliveCount: { value: 10 }, maxNotificationsPerPublish: { value: 0 },
+      reconnectInterval: { value: 5000 }, name: { value: '' }
+    },
+    label: function () { return this.name || 'tier0-opcua-subscribe'; }
+  });
+</script>