node-red-contrib-modbus-modpackqt 1.1.85 → 2.0.0

package/nodes/modpackqt-traffic.html

@@ -0,0 +1,118 @@
+<script type="text/javascript">
+  RED.nodes.registerType('modpackqt-traffic', {
+    category: 'ModPackQT',
+    color: '#22c55e',
+    defaults: {
+      name:            { value: '' },
+      server:          { value: '', type: 'modpackqt-config', required: true },
+      filterDirection: { value: 'any' },
+      filterKind:      { value: 'any' },
+      filterFc:        { value: 'any' },
+      filterTarget:    { value: '' },
+      format:          { value: 'object' },
+      alsoLog:         { value: false }
+    },
+    inputs: 0,
+    outputs: 1,
+    icon: 'font-awesome/fa-eye',
+    label: function () {
+      const parts = [];
+      if (this.filterKind      !== 'any') parts.push(this.filterKind);
+      if (this.filterDirection !== 'any') parts.push(this.filterDirection);
+      if (this.filterFc        !== 'any') parts.push('FC' + this.filterFc);
+      if (this.filterTarget) parts.push(this.filterTarget);
+      return this.name || ('traffic' + (parts.length ? ' · ' + parts.join(' ') : ''));
+    },
+    paletteLabel: 'modbus traffic'
+  });
+</script>
+
+<script type="text/html" data-template-name="modpackqt-traffic">
+  <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>
+  <div class="form-row"><label for="node-input-server"><i class="fa fa-cog"></i> Runtime</label>
+    <input type="text" id="node-input-server"></div>
+
+  <h4 style="margin-top:14px">Filters (optional)</h4>
+  <div class="form-row"><label for="node-input-filterKind"><i class="fa fa-server"></i> Kind</label>
+    <select id="node-input-filterKind">
+      <option value="any">Any</option>
+      <option value="master">Master only</option>
+      <option value="slave">Slave only</option>
+    </select>
+  </div>
+  <div class="form-row"><label for="node-input-filterDirection"><i class="fa fa-exchange"></i> Direction</label>
+    <select id="node-input-filterDirection">
+      <option value="any">Any</option>
+      <option value="read">Read only</option>
+      <option value="write">Write only</option>
+    </select>
+  </div>
+  <div class="form-row"><label for="node-input-filterFc"><i class="fa fa-list"></i> Function Code</label>
+    <select id="node-input-filterFc">
+      <option value="any">Any</option>
+      <option value="1">FC1 — Read Coils</option>
+      <option value="2">FC2 — Read Discrete Inputs</option>
+      <option value="3">FC3 — Read Holding</option>
+      <option value="4">FC4 — Read Input</option>
+      <option value="5">FC5 — Write Coil</option>
+      <option value="6">FC6 — Write Register</option>
+      <option value="15">FC15 — Write Coils</option>
+      <option value="16">FC16 — Write Registers</option>
+    </select>
+  </div>
+  <div class="form-row"><label for="node-input-filterTarget"><i class="fa fa-filter"></i> Target contains</label>
+    <input type="text" id="node-input-filterTarget" placeholder="e.g. 192.168.1.10  or  rtu:/dev/ttyUSB0"></div>
+
+  <h4 style="margin-top:14px">Output</h4>
+  <div class="form-row"><label for="node-input-format"><i class="fa fa-code"></i> Payload</label>
+    <select id="node-input-format">
+      <option value="object">Full event object</option>
+      <option value="summary">One-line summary string</option>
+    </select>
+  </div>
+  <div class="form-row"><label for="node-input-alsoLog" style="width:auto">
+    <input type="checkbox" id="node-input-alsoLog" style="width:auto;vertical-align:middle">
+    Also write to Node-RED log
+  </label></div>
+
+  <div class="form-tips">
+    <b>Passive monitor.</b> No input wire — just listens to all Modbus ops on the runtime
+    and emits one message each. Free.
+  </div>
+</script>
+
+<script type="text/html" data-help-name="modpackqt-traffic">
+  <p>
+    Passive Modbus traffic monitor. Subscribes to all Modbus operations performed by any
+    master or slave node sharing the same runtime config and emits one message per op.
+  </p>
+
+  <h3>Output payload (object format)</h3>
+  <pre>{
+  ts: "2026-05-09T14:23:01.234Z",
+  direction: "read" | "write",
+  kind: "master" | "slave",
+  target: "192.168.1.10:502" | "local:1502" | "rtu:/dev/ttyUSB0",
+  unitId: 1,
+  fc: 3,                  // null for slave events
+  registerType: "holding",// only set for slave events
+  address: 100,
+  quantity: 2,
+  values: [16828, 0],     // raw register values
+  durationMs: 12,
+  ok: true,
+  error: null             // populated on failure
+}</pre>
+
+  <h3>Use cases</h3>
+  <ul>
+    <li><b>Debug:</b> wire to a Debug node — see exactly what every Modbus op did.</li>
+    <li><b>Alerting:</b> filter <code>ok=false</code> → email/Slack on errors.</li>
+    <li><b>Charting:</b> count ops/sec, response-time histograms, per-target latency.</li>
+    <li><b>Audit trail:</b> store every op in a database for compliance.</li>
+  </ul>
+
+  <h3>Pricing</h3>
+  <p><b>Free</b> — visibility costs nothing. Traffic events themselves don't count toward your daily op limit.</p>
+</script>

package/nodes/modpackqt-traffic.js

@@ -0,0 +1,68 @@
+/**
+ * ModPackQT Traffic — passive Modbus traffic monitor.
+ *
+ * Subscribes to the config node's traffic event bus and emits one message
+ * per Modbus operation (master read/write or slave read/write).
+ *
+ * Free for everyone — debug visibility costs nothing.
+ */
+module.exports = function (RED) {
+  function ModPackQTTrafficNode(config) {
+    RED.nodes.createNode(this, config);
+    const node = this;
+    const server = RED.nodes.getNode(config.server);
+
+    node.filterDirection = config.filterDirection || 'any'; // any | read | write
+    node.filterKind      = config.filterKind      || 'any'; // any | master | slave
+    node.filterFc        = config.filterFc        || 'any'; // any | 1 | 2 | 3 | 4 | 5 | 6 | 15 | 16
+    node.filterTarget    = (config.filterTarget   || '').trim(); // substring match
+    node.format          = config.format          || 'object';   // object | summary
+    node.alsoLog         = config.alsoLog === true || config.alsoLog === 'true';
+
+    let count = 0;
+
+    if (!server) {
+      node.status({ fill: 'red', shape: 'ring', text: 'no config' });
+      return;
+    }
+
+    function summarize(evt) {
+      const tag = evt.kind === 'slave'
+        ? `slave ${evt.direction} ${evt.registerType}@${evt.address}×${evt.quantity}`
+        : `${evt.direction} FC${evt.fc} ${evt.target} u${evt.unitId} @${evt.address}×${evt.quantity}`;
+      const status = evt.ok ? `${evt.durationMs}ms` : `ERR ${evt.error || ''}`;
+      return `${tag} · ${status}`;
+    }
+
+    function onTraffic(evt) {
+      // Filters
+      if (node.filterDirection !== 'any' && evt.direction !== node.filterDirection) return;
+      if (node.filterKind      !== 'any' && evt.kind      !== node.filterKind)      return;
+      if (node.filterFc        !== 'any' && String(evt.fc) !== String(node.filterFc)) return;
+      if (node.filterTarget && !(evt.target || '').includes(node.filterTarget))     return;
+
+      count += 1;
+      const summary = summarize(evt);
+      node.status({
+        fill: evt.ok ? 'green' : 'red', shape: 'dot',
+        text: `modpackqt · ${count} ops · ${summary.slice(0, 50)}`
+      });
+
+      if (node.alsoLog) node.log(summary);
+
+      const msg = (node.format === 'summary')
+        ? { payload: summary, traffic: evt }
+        : { payload: evt };
+      msg.topic = `modpackqt/traffic/${evt.kind}/${evt.direction}`;
+      node.send(msg);
+    }
+
+    server.traffic.on('op', onTraffic);
+    node.status({ fill: 'grey', shape: 'ring', text: 'modpackqt · waiting…' });
+
+    node.on('close', function () {
+      try { server.traffic.removeListener('op', onTraffic); } catch (_) {}
+    });
+  }
+  RED.nodes.registerType('modpackqt-traffic', ModPackQTTrafficNode);
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "node-red-contrib-modbus-modpackqt",
-  "version": "1.1.85",
-  "description": "Node-RED nodes for ModPackQT — read/write Modbus TCP registers (master & slave) via the ModPackQT Gateway app. Supports FC1/FC2/FC3/FC4 reads and FC5/FC6/FC15/FC16 writes.",
+  "version": "2.0.0",
+  "description": "Node-RED Modbus nodes — embedded Modbus TCP/RTU master + slave server, no extra apps required. By ModPackQT. FC1/FC2/FC3/FC4 reads, FC5/FC6/FC15/FC16 writes, a built-in slave register store, and a free passive traffic monitor for debugging.",
   "keywords": [
     "node-red",
     "modbus",
@@ -10,22 +10,39 @@
     "modbus-rtu",
     "modbus-master",
     "modbus-slave",
+    "modbus-server",
     "industrial",
     "automation",
     "holding-register",
     "coil",
     "iiot",
+    "scada",
     "plc"
   ],
   "license": "MIT",
   "author": "ModPackQT",
-  "homepage": "https://modpackqt.com",
+  "homepage": "https://modpackqt.com/nodered",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/modpackqt/node-red-contrib-modbus-modpackqt.git"
+  },
   "bugs": {
-    "url": "https://modpackqt.com/contact"
+    "url": "https://github.com/modpackqt/node-red-contrib-modbus-modpackqt/issues",
+    "email": "support@modpackqt.com"
   },
   "engines": {
     "node": ">=14"
   },
+  "files": [
+    "nodes/",
+    "examples/",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md",
+    "DISCLAIMER.md",
+    "SECURITY.md",
+    "CONTRIBUTING.md"
+  ],
   "node-red": {
     "version": ">=2.0.0",
     "nodes": {
@@ -33,10 +50,11 @@
       "modpackqt-master-read": "nodes/modpackqt-master-read.js",
       "modpackqt-master-write": "nodes/modpackqt-master-write.js",
       "modpackqt-slave-read": "nodes/modpackqt-slave-read.js",
-      "modpackqt-slave-write": "nodes/modpackqt-slave-write.js"
+      "modpackqt-slave-write": "nodes/modpackqt-slave-write.js",
+      "modpackqt-traffic": "nodes/modpackqt-traffic.js"
     }
   },
   "dependencies": {
-    "axios": "^1.6.0"
+    "modbus-serial": "^8.0.0"
   }
 }