node-red-contrib-modbus-modpackqt 1.1.6 → 1.1.8

package/README.md

@@ -45,11 +45,28 @@ npm install node-red-contrib-modbus-modpackqt
 
 ## Prerequisites
 
-1. **Download and start the ModPackQT Gateway app:**
+1. **Sign up at [modpackqt.com](https://modpackqt.com)**
+   A free account works for all master nodes. Slave nodes require a **paid plan**.
+
+2. **Download and start the ModPackQT Gateway app**
    Download it from [modpackqt.com/download](https://modpackqt.com/download) and run it.
    By default it listens on **port 8502** (`localhost:8502`).
 
-2. For slave nodes, create and start at least one slave in the ModPackQT app first.
+3. **Create an API key**
+   In the ModPackQT web app go to **Settings → API Keys → New Key**. Paste it into the `modpackqt-config` node.
+
+4. **For slave nodes** — create and start at least one slave in the ModPackQT app first (Slave Simulator → New Slave). Note the **Slave ID** shown — you'll need it in Node-RED.
+
+> **Plan limits**
+>
+> | Feature | Free | Paid |
+> |---|---|---|
+> | Master Read (`modpackqt-master-read`) | ✓ | ✓ |
+> | Master Write (`modpackqt-master-write`) | ✓ | ✓ |
+> | Slave Write (`modpackqt-slave-write`) | ✗ | ✓ |
+> | Slave Read (`modpackqt-slave-read`) | ✗ | ✓ |
+>
+> [View plans & upgrade →](https://modpackqt.com/#pricing)
 
 ---
 
@@ -60,8 +77,8 @@ npm install node-red-contrib-modbus-modpackqt
 | `modpackqt-config` | Config | Shared gateway connection (host, port, API key) |
 | `modpackqt-master-read` | Modbus Master | Read Modbus TCP registers — FC1/FC2/FC3/FC4 |
 | `modpackqt-master-write` | Modbus Master | Write Modbus TCP registers — FC5/FC6/FC15/FC16 |
-| `modpackqt-slave-read` | Modbus Slave | Read registers from a ModPackQT simulated slave |
-| `modpackqt-slave-write` | Modbus Slave | Write registers into a ModPackQT simulated slave |
+| `modpackqt-slave-read` | Modbus Slave *(paid)* | Read registers from a ModPackQT slave |
+| `modpackqt-slave-write` | Modbus Slave *(paid)* | Push values into a ModPackQT slave (build a live Modbus device from Node-RED) |
 
 ---
 
@@ -114,21 +131,45 @@ The `modpackqt-master-write` node writes registers to **any Modbus TCP slave dev
 
 ---
 
-## Node-RED Modbus Slave — Read & Write Simulated Registers
+## Building a Modbus Slave from Node-RED *(Paid plan)*
 
-The `modpackqt-slave-read` and `modpackqt-slave-write` nodes interact with ModPackQT's **built-in slave simulator** — a virtual PLC register map you control.
+Use `modpackqt-slave-write` to make Node-RED the **data source** for a live Modbus slave device. Any external Modbus master (PLC, SCADA, HMI) that connects to the ModPackQT slave port will read whatever values you last pushed from Node-RED.
+
+**Typical flow:**
+```
+[MQTT / Sensor / Timer] → [Function: scale to integer] → [modpackqt-slave-write addr=0] → [External Modbus master reads]
+```
 
-**Register types:** Holding Registers, Coils, Input Registers, Discrete Inputs
+**Use cases:**
+- Publish MQTT sensor data as Modbus TCP registers
+- Simulate a PLC register map for HMI/SCADA testing
+- Bridge OPC-UA, REST, or database data to Modbus
+
+**Slave write input — all of these work:**
+```js
+msg.payload = 234;               // single integer
+msg.payload = [234, 1013, 65];   // array — writes 3 registers starting at address 0
+msg.payload = "[234, 1013, 65]"; // JSON string also works (inject string type)
+```
+
+**Override at runtime:**
+```js
+msg.slaveId      = "42";    // select a different slave per message
+msg.address      = 10;      // start at register 10 instead of the configured address
+msg.registerType = "coil";  // override register type
+```
 
 **Slave read output:**
 ```json
 {
   "payload": {
-    "values": [0, 42, 100],
+    "values": [234, 1013, 65],
     "registerType": "holding",
-    "address": 0
+    "address": 0,
+    "quantity": 3,
+    "slaveId": "42"
   },
-  "topic": "slave/{slaveId}/holding/0"
+  "topic": "slave/42/holding/0"
 }
 ```
 
@@ -136,7 +177,7 @@ The `modpackqt-slave-read` and `modpackqt-slave-write` nodes interact with ModPa
 
 ## Example Flows
 
-### Poll Holding Registers Every 5 Seconds (Node-RED Modbus Master)
+### Poll Holding Registers Every 5 Seconds (Modbus Master)
 
 ```
 [Inject (repeat 5s)] → [modpackqt-master-read FC3 target=192.168.1.10:502 unitId=1 addr=0 qty=10] → [Debug]
@@ -148,13 +189,14 @@ The `modpackqt-slave-read` and `modpackqt-slave-write` nodes interact with ModPa
 [Inject (payload=1234)] → [modpackqt-master-write FC6 target=192.168.1.10:502 unitId=1 addr=100] → [Debug]
 ```
 
-### Inject Test Values into a Modbus Slave Simulator
+### Build a Slave — Publish Sensor Data as Modbus (Paid plan)
 
 ```
-[Inject ([10,20,30])] → [modpackqt-slave-write Holding addr=0]
-[modpackqt-slave-read Holding addr=0 qty=3] → [Debug]
+[MQTT in] → [Function: msg.payload = parseInt(msg.payload * 10)] → [modpackqt-slave-write Holding addr=0] → [Debug]
 ```
 
+Any Modbus master on the network now reads live sensor values from the slave.
+
 ### Import the Demo Flow
 
 1. Open Node-RED → **Menu → Import**
@@ -191,9 +233,11 @@ Add one `modpackqt-config` node per gateway instance. All other nodes reference
 
 | Issue | Solution |
 |---|---|
-| `connect ECONNREFUSED localhost:8502` | Make sure the ModPackQT Gateway app is running. Check host/port in the config node. |
-| `404 Slave not found` | Check the Slave ID — find it in the ModPackQT app under your slave's settings. |
-| `Slave not running` (slave-write) | Start the slave in the ModPackQT app before writing. |
+| `connect ECONNREFUSED localhost:8502` | The ModPackQT Gateway app is not running. Start it first. |
+| `401 Unauthorized` | Missing or invalid API key — check `modpackqt-config`. |
+| `403 Forbidden` on slave nodes | Your plan does not include the Slave Simulator. [Upgrade your plan →](https://modpackqt.com/#pricing) |
+| `slave not found — check Slave ID` | The Slave ID is wrong or that slave was deleted. Check in ModPackQT → Slave Simulator. |
+| `gateway not running` on slave nodes | The Gateway app is stopped. Open ModPackQT and click Start Gateway. |
 | `Cannot find module 'axios'` | Run `npm install` in `~/.node-red`. |
 | Nodes not appearing after install | Restart Node-RED completely after `npm install`. |
 | Node-RED version error | Requires Node-RED ≥ 2.0.0 and Node.js ≥ 14. |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-modbus-modpackqt",
-  "version": "1.1.6",
+  "version": "1.1.8",
   "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.",
   "keywords": [
     "node-red",
@@ -29,10 +29,10 @@
   "node-red": {
     "version": ">=2.0.0",
     "nodes": {
-      "modpackqt-config":      "nodes/modpackqt-config.js",
-      "modpackqt-master-read":  "nodes/modpackqt-master-read.js",
+      "modpackqt-config": "nodes/modpackqt-config.js",
+      "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-read": "nodes/modpackqt-slave-read.js",
       "modpackqt-slave-write": "nodes/modpackqt-slave-write.js"
     }
   },