Serial docs (#508)

* Improved Serial documentation. * Adding Enron function documentation. * Formatting of MD file * not ignoring node_modules when linting? * removing older LTS --------- Co-authored-by: 1038642892 <[email protected]>
yaacov · Aug 21, 2023 · 5caff30 · 5caff30
1 parent f62b36d
commit 5caff30
Show file tree

Hide file tree

Showing 4 changed files with 180 additions and 4 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -12,7 +12,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x, 18.x]
+        node-version: [14.x, 18.x]
 
     steps:
       - uses: actions/checkout@v2

diff --git a/README.md b/README.md
@@ -61,14 +61,15 @@ This module has not been tested on every single version of NodeJS. For best resu
 |-------|----------|
 | FC1 "Read Coil Status" | `readCoils(coil, len)` |
 | FC2 "Read Input Status" | `readDiscreteInputs(addr, arg)` |
-| FC3 "Read Holding Registers" | `readHoldingRegisters(addr, len) ` |
+| FC3 "Read Holding Registers" | `readHoldingRegisters(addr, len)`, `readRegistersEnron(addr, len)`* |
 | FC4 "Read Input Registers" | `readInputRegisters(addr, len) ` |
 | FC5 "Force Single Coil" | `writeCoil(coil, binary) //NOT setCoil` |
 | FC6 "Preset Single Register" | `writeRegister(addr, value)` |
 | FC15 "Force Multiple Coil" | `writeCoils(addr, valueAry)` |
-| FC16 "Preset Multiple Registers" | `writeRegisters(addr, valueAry)` |
+| FC16 "Preset Multiple Registers" | `writeRegisters(addr, valueAry)`, `writeRegistersEnron(addr, valueAry)`* |
 | FC43/14 "Read Device Identification" (supported ports: TCP, RTU) | `readDeviceIdentification(id, obj)` |
 
+\* See examples/server_enron.js for enron configuration example.
 ###### Client Serial:
 
 * modbus-RTU (SerialPort): Over serial line [require node serialport].
@@ -228,7 +229,7 @@ setInterval(function() {
 }, 1000);
 ```
 ----
-###### ModbusTCP Server
+###### Modbus TCP Server
 ``` javascript
 // create an empty modbus client
 const ModbusRTU = require("modbus-serial");
@@ -284,6 +285,91 @@ serverTCP.on("socketError", function(err){
 });
 ```
 ----
+###### Modbus Serial Server
+``` javascript
+const ModbusRTU = require("..");
+
+const holdingRegisters = {};
+const coils = {};
+const inputRegisters = {};
+const discreteInputs = {};
+
+const vector = {
+    getInputRegister: function(addr) {
+        return inputRegisters[addr];
+    },
+    getMultipleInputRegisters: function(startAddr, length) {
+        const values = [];
+        for (let i = 0; i < length; i++) {
+            values[i] = inputRegisters[startAddr + i];
+        }
+        return values;
+    },
+    getDiscreteInput: function(addr) {
+        return discreteInputs[addr];
+    },
+    getHoldingRegister: function(addr) {
+        return holdingRegisters[addr];
+    },
+    setRegister: function(addr, value) {
+        holdingRegisters[addr] = value;
+        return;
+    },
+    getMultipleHoldingRegisters: function(startAddr, length) {
+        const values = [];
+        for (let i = 0; i < length; i++) {
+            values[i] = holdingRegisters[startAddr + i];
+        }
+        return values;
+    },
+    getCoil: function(addr) {
+        return coils[addr];
+    },
+    setCoil: function(addr, value) {
+        coils[addr] = value;
+        return coils[addr];
+    },
+    readDeviceIdentification: function() {
+        return {
+            0x00: "MyVendorName",
+            0x01: "MyProductCode",
+            0x02: "MyMajorMinorRevision",
+            0x05: "MyModelName",
+            0x97: "MyExtendedObject1",
+            0xab: "MyExtendedObject2"
+        };
+    }
+};
+
+// set the server to answer for modbus requests
+const serverSerial = new ModbusRTU.ServerSerial(
+    vector,
+    {
+        port: "/tmp/ttyp0",
+        debug: true,
+        unitID: 1
+        // enron: true,
+        // enronTables: {
+        //     booleanRange: [1001, 1999],
+        //     shortRange: [3001, 3999],
+        //     longRange: [5001, 5999],
+        //     floatRange: [7001, 7999]
+        // }
+    },
+    {
+        baudRate: 9600,
+        dataBits: 8,
+        stopBits: 1,
+        parity: "even"
+    }
+);
+
+serverSerial.on("error", function(err) {
+    // Handle socket error if needed, can be ignored
+    console.error(err);
+});
+```
+----
 ###### Read and Write Modbus ASCII
 ``` javascript
 // create an empty modbus client

diff --git a/examples/server_serial.js b/examples/server_serial.js
@@ -0,0 +1,81 @@
+const ModbusRTU = require("..");
+
+const holdingRegisters = {};
+const coils = {};
+const inputRegisters = {};
+const discreteInputs = {};
+
+const vector = {
+    getInputRegister: function(addr) {
+        return inputRegisters[addr];
+    },
+    getMultipleInputRegisters: function(startAddr, length) {
+        const values = [];
+        for (let i = 0; i < length; i++) {
+            values[i] = inputRegisters[startAddr + i];
+        }
+        return values;
+    },
+    getDiscreteInput: function(addr) {
+        return discreteInputs[addr];
+    },
+    getHoldingRegister: function(addr) {
+        return holdingRegisters[addr];
+    },
+    setRegister: function(addr, value) {
+        holdingRegisters[addr] = value;
+        return;
+    },
+    getMultipleHoldingRegisters: function(startAddr, length) {
+        const values = [];
+        for (let i = 0; i < length; i++) {
+            values[i] = holdingRegisters[startAddr + i];
+        }
+        return values;
+    },
+    getCoil: function(addr) {
+        return coils[addr];
+    },
+    setCoil: function(addr, value) {
+        coils[addr] = value;
+        return coils[addr];
+    },
+    readDeviceIdentification: function() {
+        return {
+            0x00: "MyVendorName",
+            0x01: "MyProductCode",
+            0x02: "MyMajorMinorRevision",
+            0x05: "MyModelName",
+            0x97: "MyExtendedObject1",
+            0xab: "MyExtendedObject2"
+        };
+    }
+};
+
+// set the server to answer for modbus requests
+const serverSerial = new ModbusRTU.ServerSerial(
+    vector,
+    {
+        port: "/tmp/ttyp0",
+        debug: true,
+        unitID: 1
+        // enron: true,
+        // enronTables: {
+        //     booleanRange: [1001, 1999],
+        //     shortRange: [3001, 3999],
+        //     longRange: [5001, 5999],
+        //     floatRange: [7001, 7999]
+        // }
+    },
+    {
+        baudRate: 9600,
+        dataBits: 8,
+        stopBits: 1,
+        parity: "even"
+    }
+);
+
+serverSerial.on("error", function(err) {
+    // Handle socket error if needed, can be ignored
+    console.error(err);
+});
diff --git a/test/servers/serverserial.test.js b/test/servers/serverserial.test.js
@@ -68,6 +68,9 @@ describe("Modbus Serial Server (no serverID)", function() {
             port: "/dev/server",
             portResponse: clientSerial,
             debug: true
+        },
+        {
+            baudRate: 9600
         });
     });
 
@@ -258,6 +261,9 @@ describe("Modbus Serial Server (serverID = requestID)", function() {
             portResponse: clientSerial,
             debug: true,
             unitID: 4
+        },
+        {
+            baudRate: 9600
         });
     });
 
@@ -318,6 +324,9 @@ describe("Modbus Serial Server (serverID != requestID)", function() {
             portResponse: clientSerial,
             debug: true,
             unitID: 4
+        },
+        {
+            baudRate: 9600
         });
     });