node-red-modbus-dynamic-server 0.1.0

package/src/modbus-dynamic-server.html

@@ -0,0 +1,90 @@
+<script type="text/html" data-template-name="modbus-dynamic-server">
+    <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> Server</label>
+        <input type="text" id="node-input-server">
+    </div>
+</script>
+
+<script type="text/html" data-help-name="modbus-dynamic-server">
+    <p>Receives incoming Modbus TCP requests from a <code>modbus-dynamic-server-config</code> node
+    and emits them as messages for downstream processing. Each message must eventually be answered
+    by a <code>modbus-dynamic-server-response</code> or <code>modbus-registers-respond</code> node.</p>
+
+    <h3>Outputs</h3>
+    <ol class="node-ports">
+        <li>Request message
+            <dl class="message-properties">
+                <dt>payload <span class="property-type">object</span></dt>
+                <dd>The full jsmodbus request object, including <code>body</code>, <code>unitId</code>,
+                and <code>id</code> (transaction ID).</dd>
+
+                <dt>modbus.requestId <span class="property-type">string</span></dt>
+                <dd>UUID that uniquely identifies this pending request. Must be passed unchanged to
+                the response node.</dd>
+
+                <dt>_modbus <span class="property-type">object</span></dt>
+                <dd>Internal request-response context used by downstream response nodes.
+                Includes <code>requestId</code> and <code>configNodeId</code>. This object must be
+                preserved in flow messages.</dd>
+
+                <dt>modbus.eventName <span class="property-type">string</span></dt>
+                <dd>Modbus function-code event name, e.g. <code>readHoldingRegisters</code>,
+                <code>writeSingleCoil</code>. See Details for the full list.</dd>
+
+                <dt>modbus.address <span class="property-type">number</span></dt>
+                <dd>Starting register or coil address from the request.</dd>
+
+                <dt>modbus.quantity <span class="property-type">number</span></dt>
+                <dd>Number of registers or coils requested.</dd>
+
+                <dt>topic <span class="property-type">string</span></dt>
+                <dd>Always <code>modbus/request</code>.</dd>
+            </dl>
+        </li>
+    </ol>
+
+    <h3>Details</h3>
+    <p>Supported <code>eventName</code> values:</p>
+    <ul>
+        <li><code>readCoils</code> (FC1)</li>
+        <li><code>readDiscreteInputs</code> (FC2)</li>
+        <li><code>readHoldingRegisters</code> (FC3)</li>
+        <li><code>readInputRegisters</code> (FC4)</li>
+        <li><code>writeSingleCoil</code> (FC5)</li>
+        <li><code>writeSingleRegister</code> (FC6)</li>
+        <li><code>writeMultipleCoils</code> (FC15)</li>
+        <li><code>writeMultipleRegisters</code> (FC16)</li>
+    </ul>
+    <p>Every emitted message must be answered within the timeout configured on the server config
+    node, otherwise the client will receive a Gateway Path Unavailable exception automatically.</p>
+    <p>When editing messages in function nodes, preserve the internal context:</p>
+    <pre><code>// CORRECT
+msg.payload = newValue;
+return msg;
+
+// INCORRECT: request context is lost
+msg = { payload: newValue };
+return msg;</code></pre>
+</script>
+
+<script type="text/javascript">
+  RED.nodes.registerType('modbus-dynamic-server', {
+    category: 'modbus',
+    color: '#E9967A',
+    defaults: {
+      name: { value: '' },
+      server: { value: '', type: 'modbus-dynamic-server-config', required: true }
+    },
+    inputs: 0,
+    outputs: 1,
+    icon: 'bridge.svg',
+    label: function () {
+      return this.name || 'Modbus Dynamic Server Request'
+    }
+  })
+</script>

package/src/modbus-dynamic-server.js

@@ -0,0 +1,45 @@
+module.exports = function (RED) {
+  function ModbusFlexServerNode (config) {
+    RED.nodes.createNode(this, config)
+    const node = this
+
+    node.server = RED.nodes.getNode(config.server)
+
+    if (!node.server) {
+      node.status({ fill: 'red', shape: 'ring', text: 'no server' })
+      return
+    }
+
+    node.status({ fill: 'grey', shape: 'ring', text: 'stub' })
+
+    node.server.emitter.on('request', function (data) {
+      const msg = {
+        topic: 'modbus/request',
+        _modbus: {
+          requestId: data.requestId,
+          configNodeId: node.server.id,
+          eventName: data.eventName,
+          address: data.request.address,
+          quantity: data.request.quantity,
+          connection: data.connection || null
+        },
+        modbus: {
+          requestId: data.requestId,
+          eventName: data.eventName,
+          address: data.request.address,
+          quantity: data.request.quantity,
+          connection: data.connection || null
+        },
+        payload: data.request
+      }
+
+      node.send(msg)
+    })
+
+    node.on('close', function () {
+      // cleanup later
+    })
+  }
+
+  RED.nodes.registerType('modbus-dynamic-server', ModbusFlexServerNode)
+}

package/src/modbus-fc-filter.html

@@ -0,0 +1,205 @@
+<script type="text/html" data-template-name="modbus-fc-filter">
+  <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 style="vertical-align: top;"><i class="fa fa-check-square-o"></i> Allowed Standard FCs</label>
+    <div style="display: inline-block; width: calc(100% - 110px);">
+      <label for="node-input-allowFc1" style="display:block; width:auto; margin:2px 0;">
+        <input type="checkbox" id="node-input-allowFc1" style="width:auto; margin-right:6px;">1 - Read Coils
+      </label>
+      <label for="node-input-allowFc2" style="display:block; width:auto; margin:2px 0;">
+        <input type="checkbox" id="node-input-allowFc2" style="width:auto; margin-right:6px;">2 - Read Discrete Inputs
+      </label>
+      <label for="node-input-allowFc3" style="display:block; width:auto; margin:2px 0;">
+        <input type="checkbox" id="node-input-allowFc3" style="width:auto; margin-right:6px;">3 - Read Holding Registers
+      </label>
+      <label for="node-input-allowFc4" style="display:block; width:auto; margin:2px 0;">
+        <input type="checkbox" id="node-input-allowFc4" style="width:auto; margin-right:6px;">4 - Read Input Registers
+      </label>
+      <label for="node-input-allowFc5" style="display:block; width:auto; margin:2px 0;">
+        <input type="checkbox" id="node-input-allowFc5" style="width:auto; margin-right:6px;">5 - Write Single Coil
+      </label>
+      <label for="node-input-allowFc6" style="display:block; width:auto; margin:2px 0;">
+        <input type="checkbox" id="node-input-allowFc6" style="width:auto; margin-right:6px;">6 - Write Single Register
+      </label>
+      <label for="node-input-allowFc15" style="display:block; width:auto; margin:2px 0;">
+        <input type="checkbox" id="node-input-allowFc15" style="width:auto; margin-right:6px;">15 - Write Multiple Coils
+      </label>
+      <label for="node-input-allowFc16" style="display:block; width:auto; margin:2px 0;">
+        <input type="checkbox" id="node-input-allowFc16" style="width:auto; margin-right:6px;">16 - Write Multiple Registers
+      </label>
+    </div>
+  </div>
+
+  <div class="form-row">
+    <label style="vertical-align:top;"><i class="fa fa-plus-square"></i> Additional FCs</label>
+    <ol id="node-input-custom-fc-container" style="display:inline-block; width: calc(100% - 110px); margin:0;"></ol>
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-exceptionCode"><i class="fa fa-ban"></i> Exception on Reject</label>
+    <select id="node-input-exceptionCode" style="width: calc(100% - 110px);">
+      <option value="1">1 - Illegal Function</option>
+      <option value="2">2 - Illegal Data Address</option>
+      <option value="3">3 - Illegal Data Value</option>
+      <option value="4">4 - Server Device Failure</option>
+    </select>
+  </div>
+</script>
+
+<script type="text/html" data-help-name="modbus-fc-filter">
+  <p>Filters incoming Modbus requests by function code (<code>msg.payload.fc</code>).</p>
+
+  <p>If the function code is allowed, the message is forwarded unchanged.
+  If the function code is not allowed, the message is not emitted and a Modbus
+  exception response is sent for the pending request.</p>
+
+  <h3>Inputs</h3>
+  <dl class="message-properties">
+    <dt>payload.fc <span class="property-type">number</span></dt>
+    <dd>Required Modbus function code from the incoming request message.</dd>
+
+    <dt>_modbus.requestId <span class="property-type">string</span></dt>
+    <dd>Required internal request context used when blocked requests are terminated.</dd>
+
+    <dt>_modbus.configNodeId <span class="property-type">string</span></dt>
+    <dd>Required internal config-node identifier used to send the exception response.</dd>
+  </dl>
+
+  <h3>Outputs</h3>
+  <ol class="node-ports">
+    <li>Allowed request
+      <dl class="message-properties">
+        <dt>payload <span class="property-type">object</span></dt>
+        <dd>The original request message, forwarded unchanged when <code>payload.fc</code> is allowed.</dd>
+      </dl>
+    </li>
+  </ol>
+
+  <h3>Configuration</h3>
+  <dl class="message-properties">
+    <dt>Allowed Standard FCs <span class="property-type">checkboxes</span></dt>
+    <dd>Select from common Modbus function codes (1, 2, 3, 4, 5, 6, 15, 16).</dd>
+
+    <dt>Additional FCs <span class="property-type">list</span></dt>
+    <dd>Add custom/proprietary function codes (integer 1-255). Invalid entries are discarded.
+    Duplicates are ignored.</dd>
+
+    <dt>Exception on Reject <span class="property-type">select</span></dt>
+    <dd>Modbus exception code returned when a request is blocked. Default is
+    <b>1 - Illegal Function</b>.</dd>
+  </dl>
+
+  <h3>Details</h3>
+  <p>Matching is exact numeric equality only. No ranges and no multi-output routing are used.</p>
+  <p>This node is useful for read-only and restricted-function Modbus gateway flows.</p>
+  <p>Flows must preserve <code>msg._modbus</code>:</p>
+  <pre><code>// CORRECT
+msg.payload = newValue;
+return msg;
+
+// INCORRECT: request context is lost
+msg = { payload: newValue };
+return msg;</code></pre>
+</script>
+
+<script type="text/javascript">
+;(function () {
+  function normalizeCustomCodes (values) {
+    if (!Array.isArray(values)) return []
+
+    const dedupe = new Set()
+    const out = []
+    values.forEach(function (value) {
+      const n = Number(value)
+      if (!Number.isInteger(n) || n < 1 || n > 255) return
+      if (dedupe.has(n)) return
+      dedupe.add(n)
+      out.push(n)
+    })
+    return out
+  }
+
+  function customCodeValidator (values) {
+    if (!Array.isArray(values)) return false
+    return values.every(function (value) {
+      const n = Number(value)
+      return Number.isInteger(n) && n >= 1 && n <= 255
+    })
+  }
+
+  RED.nodes.registerType('modbus-fc-filter', {
+    category: 'modbus',
+    color: '#E9967A',
+    defaults: {
+      name: { value: '' },
+      allowFc1: { value: true },
+      allowFc2: { value: true },
+      allowFc3: { value: true },
+      allowFc4: { value: true },
+      allowFc5: { value: false },
+      allowFc6: { value: false },
+      allowFc15: { value: false },
+      allowFc16: { value: false },
+      customFunctionCodes: {
+        value: [],
+        validate: customCodeValidator
+      },
+      exceptionCode: { value: 1, required: true }
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: 'switch.svg',
+
+    label: function () {
+      return this.name || 'Modbus FC Filter'
+    },
+
+    oneditprepare: function () {
+      const container = $('#node-input-custom-fc-container')
+
+      container.css('min-height', '120px').editableList({
+        addButton: 'Add Function Code',
+        removable: true,
+        sortable: true,
+        addItem: function (row, index, data) {
+          const input = $('<input/>', {
+            type: 'number',
+            min: 1,
+            max: 255,
+            class: 'node-input-custom-fc',
+            placeholder: 'Function code (1-255)',
+            style: 'width:100%;'
+          })
+
+          if (data && data.value !== undefined && data.value !== null && data.value !== '') {
+            input.val(data.value)
+          }
+
+          row.css({ display: 'flex', alignItems: 'center' })
+          row.append(input)
+        }
+      })
+
+      const existing = normalizeCustomCodes(this.customFunctionCodes)
+      existing.forEach(function (fc) {
+        container.editableList('addItem', { value: fc })
+      })
+    },
+
+    oneditsave: function () {
+      const values = []
+      $('#node-input-custom-fc-container').editableList('items').each(function () {
+        const val = $(this).find('input.node-input-custom-fc').val()
+        if (val === '' || val === null || val === undefined) return
+        values.push(val)
+      })
+      this.customFunctionCodes = normalizeCustomCodes(values)
+    }
+  })
+})()
+</script>
+

package/src/modbus-fc-filter.js

@@ -0,0 +1,85 @@
+const { respondWithPayload } = require('./modbus-response-context')
+
+module.exports = function (RED) {
+  'use strict'
+
+  const STANDARD_FC_FLAGS = [
+    ['allowFc1', 1],
+    ['allowFc2', 2],
+    ['allowFc3', 3],
+    ['allowFc4', 4],
+    ['allowFc5', 5],
+    ['allowFc6', 6],
+    ['allowFc15', 15],
+    ['allowFc16', 16]
+  ]
+
+  function toValidFc (value) {
+    const n = Number(value)
+    if (!Number.isInteger(n) || n < 1 || n > 255) return null
+    return n
+  }
+
+  function normalizeBoolean (value) {
+    if (typeof value === 'boolean') return value
+    if (typeof value === 'string') {
+      const lowered = value.trim().toLowerCase()
+      if (lowered === 'false' || lowered === '0' || lowered === 'off' || lowered === 'no') return false
+    }
+    return Boolean(value)
+  }
+
+  function buildAllowedFcSet (config) {
+    const allowed = new Set()
+
+    STANDARD_FC_FLAGS.forEach(function ([flag, fc]) {
+      if (normalizeBoolean(config[flag])) allowed.add(fc)
+    })
+
+    if (Array.isArray(config.customFunctionCodes)) {
+      config.customFunctionCodes.forEach(function (value) {
+        const fc = toValidFc(value)
+        if (fc !== null) allowed.add(fc)
+      })
+    }
+
+    return allowed
+  }
+
+  function ModbusFcFilterNode (config) {
+    RED.nodes.createNode(this, config)
+    const node = this
+
+    node.exceptionCode = toValidFc(config.exceptionCode) || 1
+    node.allowedFcSet = buildAllowedFcSet(config)
+
+    if (node.allowedFcSet.size === 0) {
+      node.status({ fill: 'yellow', shape: 'ring', text: 'no function codes allowed' })
+    } else {
+      node.status({ fill: 'grey', shape: 'ring', text: 'ready' })
+    }
+
+    node.on('input', function (msg, send, done) {
+      const incomingFc = toValidFc(msg && msg.payload ? msg.payload.fc : undefined)
+
+      if (incomingFc !== null && node.allowedFcSet.has(incomingFc)) {
+        node.status({ fill: 'green', shape: 'dot', text: `allow fc ${incomingFc}` })
+        send(msg)
+        done()
+        return
+      }
+
+      const responseResult = respondWithPayload(RED, node, msg, { exception: node.exceptionCode })
+      if (!responseResult.context) {
+        node.status({ fill: 'red', shape: 'ring', text: 'missing context' })
+      }
+
+      const blockedLabel = incomingFc === null ? 'invalid' : incomingFc
+      node.status({ fill: 'yellow', shape: 'ring', text: `blocked fc ${blockedLabel} -> ex ${node.exceptionCode}` })
+      done()
+    })
+  }
+
+  RED.nodes.registerType('modbus-fc-filter', ModbusFcFilterNode)
+}
+

package/src/modbus-proxy-target.html

@@ -0,0 +1,175 @@
+<script type="text/html" data-template-name="modbus-proxy-target">
+	<div class="form-row">
+		<label for="node-config-input-name"><i class="fa fa-tag"></i> Name</label>
+		<input type="text" id="node-config-input-name" placeholder="Optional name">
+	</div>
+
+	<div class="form-row">
+		<label for="node-config-input-targetType"><i class="fa fa-exchange"></i> Target Type</label>
+		<select id="node-config-input-targetType" onchange="updateTargetTypeUI()">
+			<option value="tcp">TCP</option>
+			<option value="serial">Serial (RTU)</option>
+		</select>
+	</div>
+
+	<!-- TCP Settings -->
+	<div id="tcp-settings" class="form-row" style="display:block;">
+		<label for="node-config-input-tcpHost"><i class="fa fa-globe"></i> Target Host</label>
+		<input type="text" id="node-config-input-tcpHost" placeholder="localhost">
+	</div>
+
+	<div id="tcp-settings" class="form-row" style="display:block;">
+		<label for="node-config-input-tcpPort"><i class="fa fa-random"></i> Target Port</label>
+		<input type="number" id="node-config-input-tcpPort" min="1" max="65535" placeholder="502">
+	</div>
+
+	<!-- Serial Settings -->
+	<div id="serial-settings" class="form-row" style="display:none;">
+		<label for="node-config-input-serialPort"><i class="fa fa-usb"></i> Serial Port</label>
+		<input type="text" id="node-config-input-serialPort" placeholder="/dev/ttyUSB0">
+	</div>
+
+	<div id="serial-settings" class="form-row" style="display:none;">
+		<label for="node-config-input-serialBaud"><i class="fa fa-tachometer"></i> Baud Rate</label>
+		<select id="node-config-input-serialBaud">
+			<option value="300">300</option>
+			<option value="600">600</option>
+			<option value="1200">1200</option>
+			<option value="2400">2400</option>
+			<option value="4800">4800</option>
+			<option value="9600" selected>9600</option>
+			<option value="14400">14400</option>
+			<option value="19200">19200</option>
+			<option value="28800">28800</option>
+			<option value="38400">38400</option>
+			<option value="57600">57600</option>
+			<option value="115200">115200</option>
+		</select>
+	</div>
+
+	<div id="serial-settings" class="form-row" style="display:none;">
+		<label for="node-config-input-serialParity"><i class="fa fa-check"></i> Parity</label>
+		<select id="node-config-input-serialParity">
+			<option value="none" selected>None</option>
+			<option value="even">Even</option>
+			<option value="odd">Odd</option>
+		</select>
+	</div>
+
+	<div id="serial-settings" class="form-row" style="display:none;">
+		<label for="node-config-input-serialWordLength"><i class="fa fa-binary"></i> Word Length</label>
+		<select id="node-config-input-serialWordLength">
+			<option value="5">5</option>
+			<option value="6">6</option>
+			<option value="7">7</option>
+			<option value="8" selected>8</option>
+		</select>
+	</div>
+
+	<div id="serial-settings" class="form-row" style="display:none;">
+		<label for="node-config-input-serialStopBits"><i class="fa fa-stop"></i> Stop Bits</label>
+		<select id="node-config-input-serialStopBits">
+			<option value="1" selected>1</option>
+			<option value="2">2</option>
+		</select>
+	</div>
+
+	<!-- Common Settings -->
+	<div class="form-row">
+		<label for="node-config-input-timeout"><i class="fa fa-clock-o"></i> Timeout (ms)</label>
+		<input type="number" id="node-config-input-timeout" min="100" placeholder="5000">
+	</div>
+</script>
+
+<script type="text/javascript">
+  RED.nodes.registerType('modbus-proxy-target', {
+	category: 'config',
+	defaults: {
+	  name: { value: '' },
+	  targetType: { value: 'tcp', required: true },
+	  tcpHost: { value: 'localhost', required: true },
+	  tcpPort: { value: 502, required: true, validate: RED.validators.number() },
+	  serialPort: { value: '/dev/ttyUSB0', required: true },
+	  serialBaud: { value: 9600, required: true, validate: RED.validators.number() },
+	  serialParity: { value: 'none', required: true },
+	  serialWordLength: { value: 8, required: true, validate: RED.validators.number() },
+	  serialStopBits: { value: 1, required: true, validate: RED.validators.number() },
+	  timeout: { value: 5000, required: true, validate: RED.validators.number() }
+	},
+	label: function () {
+	  if (this.targetType === 'tcp') {
+		return this.name || (this.tcpHost + ':' + this.tcpPort)
+	  } else {
+		return this.name || ('Serial: ' + this.serialPort)
+	  }
+	},
+	oneditprepare: function () {
+	  updateTargetTypeUI()
+	}
+  })
+
+  function updateTargetTypeUI () {
+	const targetType = $('#node-config-input-targetType').val()
+	if (targetType === 'tcp') {
+	  $('[id="tcp-settings"]').show()
+	  $('[id="serial-settings"]').hide()
+	} else {
+	  $('[id="tcp-settings"]').hide()
+	  $('[id="serial-settings"]').show()
+	}
+  }
+</script>
+
+<script type="text/html" data-help-name="modbus-proxy-target">
+	<p>Configures a Modbus proxy target (TCP or serial) that can be used by
+	<code>modbus-dynamic-proxy</code> nodes to forward incoming Modbus requests.</p>
+
+	<h3>Configuration</h3>
+	<dl class="message-properties">
+		<dt>Name <span class="property-type">string</span></dt>
+		<dd>Optional label shown in the editor.</dd>
+
+		<dt>Target Type <span class="property-type">select</span></dt>
+		<dd>Choose between <b>TCP</b> (network socket) or <b>Serial (RTU)</b> (RS-485/RS-232).</dd>
+
+		<dt>Target Host <span class="property-type">string</span></dt>
+		<dd><b>TCP only:</b> IP address or hostname of the remote Modbus device.
+		Default: <code>localhost</code>.</dd>
+
+		<dt>Target Port <span class="property-type">number</span></dt>
+		<dd><b>TCP only:</b> TCP port of the remote Modbus device.
+		Default: <code>502</code>.</dd>
+
+		<dt>Serial Port <span class="property-type">string</span></dt>
+		<dd><b>Serial only:</b> Device path for the serial port, e.g. <code>/dev/ttyUSB0</code> (Linux/Mac)
+		or <code>COM3</code> (Windows). Default: <code>/dev/ttyUSB0</code>.</dd>
+
+		<dt>Baud Rate <span class="property-type">number</span></dt>
+		<dd><b>Serial only:</b> Serial communication speed. Common values: 9600, 19200, 38400, 115200.
+		Default: <code>9600</code>.</dd>
+
+		<dt>Parity <span class="property-type">select</span></dt>
+		<dd><b>Serial only:</b> Parity check mode: <b>None</b>, <b>Even</b>, or <b>Odd</b>.
+		Default: <b>None</b>.</dd>
+
+		<dt>Word Length <span class="property-type">number</span></dt>
+		<dd><b>Serial only:</b> Data bits per character. Typically <b>8</b>.
+		Default: <code>8</code>.</dd>
+
+		<dt>Stop Bits <span class="property-type">number</span></dt>
+		<dd><b>Serial only:</b> Number of stop bits (1 or 2). Default: <code>1</code>.</dd>
+
+		<dt>Timeout (ms) <span class="property-type">number</span></dt>
+		<dd>Maximum wait time for a response from the target device. If a response is not received
+		within this time, the proxy automatically replies with a Modbus exception code&nbsp;4
+		(Gateway Path Unavailable). Default: <code>5000</code>.</dd>
+	</dl>
+
+	<h3>Details</h3>
+	<p>One config node represents one connection target. Requests from multiple
+	<code>modbus-dynamic-proxy</code> nodes sharing the same target are queued internally
+	and processed in order to ensure reliable operation.</p>
+	<p>Serial support requires the <code>serialport</code> package; TCP connections use the built-in
+	<code>net</code> module.</p>
+</script>
+