Add test_examples. (#1032)

Author: janiversen

examples/client_async.py

@@ -43,9 +43,12 @@
 )
 
 
-def setup_async_client():
+def setup_client(args):
     """Run client setup."""
-    args = get_commandline()
+    if not args:
+        args = get_commandline()
+    if args.comm != "serial":
+        args.port = int(args.port)
     _logger.info("### Create client object")
 
     if args.comm == "tcp":
@@ -118,10 +121,10 @@ def setup_async_client():
     return client
 
 
-async def run_async_client(modbus_calls=None):
+async def run_client(modbus_calls=None, args=None):
     """Run sync client."""
     _logger.info("### Client ready")
-    client = setup_async_client()
+    client = setup_client(args)
     await client.aConnect()
     if modbus_calls:
         await modbus_calls(client.protocol)
@@ -186,12 +189,11 @@ def get_commandline():
         args.comm = "tcp"
     if not args.framer:
         args.framer = comm_defaults[args.comm][0]
-    if not args.port:
-        args.port = comm_defaults[args.comm][1]
+    args.port = args.port or comm_defaults[args.comm][1]
     args.framer = framers[args.framer]
     return args
 
 
 if __name__ == "__main__":
     # Connect/disconnect no calls.
-    asyncio.run(run_async_client())
+    asyncio.run(run_client())

examples/client_async_basic_calls.py

@@ -8,7 +8,7 @@
 """
 import asyncio
 
-from examples.client_async import _logger, run_async_client
+from examples.client_async import _logger, run_client
 
 UNIT = 0x01
 
@@ -119,4 +119,4 @@ async def demonstrate_calls(client):
 
 if __name__ == "__main__":
     # Connect/disconnect no calls.
-    asyncio.run(run_async_client(demonstrate_calls))
+    asyncio.run(run_client(demonstrate_calls))

examples/client_async_extended_calls.py

@@ -24,7 +24,7 @@
 """
 import asyncio
 
-from examples.client_async import _logger, run_async_client
+from examples.client_async import _logger, run_client
 
 from pymodbus.diag_message import (
     ChangeAsciiInputDelimiterRequest,
@@ -167,4 +167,4 @@ async def demonstrate_calls(client):
 
 if __name__ == "__main__":
     # Connect/disconnect no calls.
-    asyncio.run(run_async_client(demonstrate_calls))
+    asyncio.run(run_client(demonstrate_calls))

examples/client_sync.py

@@ -41,9 +41,12 @@
 )
 
 
-def setup_sync_client():
+def setup_client(args):
     """Run client setup."""
-    args = get_commandline()
+    if not args:
+        args = get_commandline()
+    if args.comm != "serial":
+        args.port = int(args.port)
     _logger.info("### Create client object")
     if args.comm == "tcp":
         client = ModbusTcpClient(
@@ -115,10 +118,10 @@ def setup_sync_client():
     return client
 
 
-def run_sync_client(modbus_calls=None):
+def run_client(modbus_calls=None, args=None):
     """Run sync client."""
     _logger.info("### Client ready")
-    client = setup_sync_client()
+    client = setup_client(args)
     client.connect()
     if modbus_calls:
         modbus_calls(client)
@@ -183,12 +186,11 @@ def get_commandline():
         args.comm = "tcp"
     if not args.framer:
         args.framer = comm_defaults[args.comm][0]
-    if not args.port:
-        args.port = comm_defaults[args.comm][1]
+    args.port = args.port or comm_defaults[args.comm][1]
     args.framer = framers[args.framer]
     return args
 
 
 if __name__ == "__main__":
     # Connect/disconnect no calls.
-    run_sync_client()
+    run_client()

examples/client_sync_basic_calls.py

@@ -6,7 +6,7 @@
 The corresponding server must be started before e.g. as:
     python3 server_sync.py
 """
-from examples.client_sync import _logger, run_sync_client
+from examples.client_sync import _logger, run_client
 
 UNIT = 0x01
 
@@ -116,4 +116,4 @@ def demonstrate_calls(client):
 
 
 if __name__ == "__main__":
-    run_sync_client(demonstrate_calls)
+    run_client(demonstrate_calls)

examples/client_sync_extended_calls.py

@@ -22,7 +22,7 @@
 The corresponding server must be started before e.g. as:
     python3 server_sync.py
 """
-from examples.client_sync import _logger, run_sync_client
+from examples.client_sync import _logger, run_client
 
 from pymodbus.diag_message import (
     ChangeAsciiInputDelimiterRequest,
@@ -164,4 +164,4 @@ def demonstrate_calls(client):
 
 
 if __name__ == "__main__":
-    run_sync_client(demonstrate_calls)
+    run_client(demonstrate_calls)

examples/server_async.py

@@ -57,9 +57,10 @@
 from pymodbus.version import version
 
 
-def setup_async_server():
+def setup_server(args):
     """Run server setup."""
-    args = get_commandline()
+    if not args:
+        args = get_commandline()
 
     # The datastores only respond to the addresses that are initialized
     # If you initialize a DataBlock to addresses of 0x00 to 0xFF, a request to
@@ -133,12 +134,14 @@ def setup_async_server():
             "MajorMinorRevision": version.short(),
         }
     )
+    if args.comm != "serial":
+        args.port = int(args.port)
     return args.comm, args.port, store, identity, args.framer
 
 
-async def run_server():
+async def run_server(args=None):
     """Run server."""
-    server, port, store, identity, framer = setup_async_server()
+    server, port, store, identity, framer = setup_server(args)
 
     _logger.info("### start server")
     if server == "tcp":
@@ -287,8 +290,6 @@ def get_commandline():
     if not args.framer:
         args.framer = comm_defaults[args.comm][0]
     args.port = args.port or comm_defaults[args.comm][1]
-    if args.comm != "serial":
-        args.port = int(args.port)
     args.framer = framers[args.framer]
     return args
 

examples/server_sync.py

@@ -56,9 +56,10 @@
 from pymodbus.version import version
 
 
-def setup_sync_server():
+def setup_server(args):
     """Run server setup."""
-    args = get_commandline()
+    if not args:
+        args = get_commandline()
 
     # The datastores only respond to the addresses that are initialized
     # If you initialize a DataBlock to addresses of 0x00 to 0xFF, a request to
@@ -132,16 +133,18 @@ def setup_sync_server():
             "MajorMinorRevision": version.short(),
         }
     )
-    return args.comm, args.port, store, identity, args.framer
+    if args.comm != "serial":
+        args.port = int(args.port)
+    return args.comm, args.port, store, identity, args.framer, args.prepare
 
 
-def run_server():
+def run_server(args=None):
     """Run server."""
-    server, port, store, identity, framer = setup_sync_server()
+    server_id, port, store, identity, framer, prepare = setup_server(args)
 
     _logger.info("### start server")
-    if server == "tcp":
-        StartTcpServer(
+    if server_id == "tcp":
+        server = StartTcpServer(
             context=store,  # Data storage
             identity=identity,  # server identify
             # TBD host=
@@ -155,9 +158,10 @@ def run_server():
             # broadcast_enable=False,  # treat unit_id 0 as broadcast address,
             # TBD timeout=1,  # waiting time for request to complete
             # TBD strict=True,  # use strict timing, t1.5 for Modbus RTU
+            prepare=prepare  # Only prepare server do not activate, INTERNAL.
         )
-    elif server == "udp":
-        StartUdpServer(
+    elif server_id == "udp":
+        server = StartUdpServer(
             context=store,  # Data storage
             identity=identity,  # server identify
             address=("", port),  # listen address
@@ -170,10 +174,10 @@ def run_server():
             # TBD timeout=1,  # waiting time for request to complete
             # TBD strict=True,  # use strict timing, t1.5 for Modbus RTU
         )
-    elif server == "serial":
+    elif server_id == "serial":
         # socat -d -d PTY,link=/tmp/ptyp0,raw,echo=0,ispeed=9600 PTY,
         #             link=/tmp/ttyp0,raw,echo=0,ospeed=9600
-        StartSerialServer(
+        server = StartSerialServer(
             context=store,  # Data storage
             identity=identity,  # server identify
             timeout=0.005,  # waiting time for request to complete
@@ -190,8 +194,8 @@ def run_server():
             broadcast_enable=False,  # treat unit_id 0 as broadcast address,
             strict=True,  # use strict timing, t1.5 for Modbus RTU
         )
-    elif server == "tls":
-        StartTlsServer(
+    elif server_id == "tls":
+        server = StartTlsServer(
             context=store,  # Data storage
             host="localhost",  # define tcp address where to connect to.
             port=port,  # on which port
@@ -211,6 +215,7 @@ def run_server():
             # TBD timeout=1,  # waiting time for request to complete
             # TBD strict=True,  # use strict timing, t1.5 for Modbus RTU
         )
+    return server
 
 
 # --------------------------------------------------------------------------- #
@@ -284,11 +289,10 @@ def get_commandline():
     if not args.framer:
         args.framer = comm_defaults[args.comm][0]
     args.port = args.port or comm_defaults[args.comm][1]
-    if args.comm != "serial":
-        args.port = int(args.port)
     args.framer = framers[args.framer]
     return args
 
 
 if __name__ == "__main__":
-    run_server()
+    server = run_server()
+    server.shutdown()

pymodbus/client/base.py

@@ -97,12 +97,12 @@ def __init__(
         """Initialize a client instance."""
         self.params = self._params()
         self.params.framer = framer
-        self.params.timeout = timeout
-        self.params.retries = retries
-        self.params.retry_on_empty = retry_on_empty
-        self.params.close_comm_on_error = close_comm_on_error
-        self.params.strict = strict
-        self.params.broadcast_enable = broadcast_enable
+        self.params.timeout = int(timeout)
+        self.params.retries = int(retries)
+        self.params.retry_on_empty = bool(retry_on_empty)
+        self.params.close_comm_on_error = bool(close_comm_on_error)
+        self.params.strict = bool(strict)
+        self.params.broadcast_enable = bool(broadcast_enable)
         self.params.kwargs = kwargs
 
         # Common variables.

pymodbus/framer/rtu_framer.py

@@ -265,7 +265,7 @@ def sendPacket(self, message):
         :return:
         """
         start = time.time()
-        timeout = start + self.client.timeout
+        timeout = start + self.client.params.timeout
         while self.client.state != ModbusTransactionState.IDLE:
             if self.client.state == ModbusTransactionState.TRANSACTION_COMPLETE:
                 timestamp = round(time.time(), 6)
@@ -291,7 +291,7 @@ def sendPacket(self, message):
             elif self.client.state == ModbusTransactionState.RETRYING:
                 # Simple lets settle down!!!
                 # To check for higher baudrates
-                time.sleep(self.client.timeout)
+                time.sleep(self.client.params.timeout)
                 break
             elif time.time() > timeout:
                 _logger.debug(