Fix REPL server documentation, support multiple unit id's, handle response manipulators in serial servers

Author: dhoomakethu

CHANGELOG.rst

@@ -8,6 +8,7 @@ version 2.5.0
 * Fix sync client and processing of incomplete frames with rtu framers
 * Support synchronous diagnostic client (TCP)
 * Server updates (REPL and async)
+* Handle Memory leak in sync servers due to socketserver memory leak
 
 version 2.5.0rc3
 ----------------------------------------------------------

pymodbus/repl/server/cli.py

@@ -45,10 +45,24 @@
     "help": None,
     "clear": None
 }
-USAGE = "manipulate response_type=|normal|error|delayed| " \
-        "error_code=<int> delay_by=<in seconds>"
+USAGE = "manipulator response_type=|normal|error|delayed|empty|stray \n" \
+        "\tAdditional parameters\n" \
+        "\t\terror_code=<int> \n\t\tdelay_by=<in seconds> \n\t\t" \
+        "clear_after=<clear after n messages int>" \
+        "\n\t\tdata_len=<length of stray data (int)>\n" \
+        "\n\tExample usage: \n\t" \
+        "1. Send error response 3 for 4 requests\n\t" \
+        "   <ansiblue>manipulator response_type=error error_code=3 clear_after=4</ansiblue>\n\t" \
+        "2. Delay outgoing response by 5 seconds indefinitely\n\t" \
+        "   <ansiblue>manipulator response_type=delayed delay_by=5</ansiblue>\n\t" \
+        "3. Send empty response\n\t" \
+        "   <ansiblue>manipulator response_type=empty</ansiblue>\n\t" \
+        "4. Send stray response of lenght 12 and revert to normal after 2 responses\n\t" \
+        "   <ansiblue>manipulator response_type=stray data_len=11 clear_after=2</ansiblue>\n\t" \
+        "5. To disable response manipulation\n\t" \
+        "   <ansiblue>manipulator response_type=normal</ansiblue>"
 COMMAND_HELPS = {
-   "manipulator": "Manipulate response from server.\nUsage: '{}'".format(USAGE),
+   "manipulator": "Manipulate response from server.\nUsage: {}".format(USAGE),
     "clear": "Clears screen"
 
 }

pymodbus/repl/server/main.py

@@ -5,13 +5,18 @@
 import asyncio
 import json
 import click
-from pymodbus.utilities import IS_PYTHON3
+from pymodbus.compat import IS_PYTHON3, PYTHON_VERSION
 from pymodbus.framer.socket_framer import ModbusSocketFramer
 from pymodbus.server.reactive.main import (
     ReactiveServer, DEFAULT_FRAMER, DEFUALT_HANDLERS)
 from pymodbus.server.reactive.default_config import DEFUALT_CONFIG
 from pymodbus.repl.server.cli import run_repl
 
+if IS_PYTHON3 and PYTHON_VERSION > (3, 7):
+    CANCELLED_ERROR = asyncio.exceptions.CancelledError
+else:
+    CANCELLED_ERROR = asyncio.CancelledError
+
 
 @click.group("ReactiveModbusServer")
 @click.option("--host", default="localhost", help="Host address")
@@ -38,7 +43,7 @@ def server(ctx, host, web_port, broadcast_support, repl, verbose):
         pymodbus_logger.setLevel(logging.ERROR)
         logger.setLevel(logging.ERROR)
 
-    ctx.obj = {"repl": repl, "host": host, "port": web_port,
+    ctx.obj = {"repl": repl, "host": host, "web_port": web_port,
                "broadcast": broadcast_support}
 
 
@@ -52,11 +57,17 @@ def server(ctx, host, web_port, broadcast_support, repl, verbose):
                                 case_sensitive=False),
               help="Modbus framer to use")
 @click.option("--modbus-port", default="5020", help="Modbus port")
-@click.option("--modbus-unit-id", default=1, help="Modbus unit id")
+@click.option("--modbus-unit-id", default=[1], multiple=True, help="Modbus unit id")
 @click.option("--modbus-config", type=click.Path(exists=True),
               help="Path to additional modbus server config")
+@click.option("-r", "--randomize", default=0, help="Randomize every `r` reads."
+                                                   " 0=never, 1=always, "
+                                                   "2=every-second-read, "
+                                                   "and so on. "
+                                                   "Applicable IR and DI.")
 @click.pass_context
-def run(ctx, modbus_server, modbus_framer, modbus_port, modbus_unit_id, modbus_config):
+def run(ctx, modbus_server, modbus_framer, modbus_port, modbus_unit_id,
+        modbus_config, randomize):
     """
     Run Reactive Modbus server exposing REST endpoint
     for response manipulation.
@@ -82,6 +93,7 @@ def run(ctx, modbus_server, modbus_framer, modbus_port, modbus_unit_id, modbus_c
     handler = DEFUALT_HANDLERS.get(handler.strip())
 
     modbus_config["handler"] = handler
+    modbus_config["randomize"] = randomize
     app = ReactiveServer.factory(modbus_server, framer,
                                  modbus_port=modbus_port,
                                  unit=modbus_unit_id,
@@ -96,7 +108,7 @@ def run(ctx, modbus_server, modbus_framer, modbus_port, modbus_unit_id, modbus_c
         else:
             app.run()
 
-    except asyncio.exceptions.CancelledError:
+    except CANCELLED_ERROR:
         print("Done!!!!!")
 
 

pymodbus/server/async_io.py

@@ -56,8 +56,7 @@ def _log_exception(self):
                 "been canceled" % self.client_address[:2])
         elif isinstance(self, ModbusSingleRequestHandler):
             _logger.error(
-                "Handler for serial port [%s] has been "
-                "cancelled" % self.transport.serial.port)
+                "Handler for serial port has been cancelled")
         else:
             sock_name = self.protocol._sock.getsockname()
             _logger.error("Handler for UDP socket [%s] has "

pymodbus/server/reactive/main.py

@@ -71,7 +71,8 @@
     "ModbusDisconnectedRequestHandler": ModbusDisconnectedRequestHandler
 }
 DEFAULT_MODBUS_MAP = {"start_offset": 0,
-                      "count": 10, "value": 0, "sparse": False}
+                      "count": 100,
+                      "value": 0, "sparse": False}
 DEFAULT_DATA_BLOCK = {
     "co": DEFAULT_MODBUS_MAP,
     "di": DEFAULT_MODBUS_MAP,
@@ -318,7 +319,9 @@ def create_context(cls, data_block=None, unit=1,
 
         slave_context = ModbusSlaveContext(**block, zero_mode=True)
         if not single:
-            slaves = {unit: slave_context}
+            slaves = {}
+            for i in unit:
+                slaves[i] = slave_context
         else:
             slaves = slave_context
         server_context = ModbusServerContext(slaves, single=single)

pymodbus/server/sync.py

@@ -581,7 +581,10 @@ def serve_forever(self):
             if not self.handler:
                 self._build_handler()
             while self.is_running:
-                self.handler.response_manipulator()
+                if hasattr(self.handler, "response_manipulator"):
+                    self.handler.response_manipulator()
+                else:
+                    self.handler.handle()
         else:
             _logger.error("Error opening serial port , "
                           "Unable to start server!!")

pymodbus/transaction.py

@@ -217,7 +217,6 @@ def execute(self, request):
                                 "/Unable to decode response")
                             response = ModbusIOException(last_exception,
                                                          request.function_code)
-                        self.client.close()
                     if hasattr(self.client, "state"):
                         _logger.debug("Changing transaction state from "
                                       "'PROCESSING REPLY' to "
@@ -228,7 +227,6 @@ def execute(self, request):
                 return response
             except ModbusIOException as ex:
                 # Handle decode errors in processIncomingPacket method
-                self.client.close()
                 _logger.exception(ex)
                 self.client.close()
                 self.client.state = ModbusTransactionState.TRANSACTION_COMPLETE