Update examples.

Author: janiversen

README.rst

@@ -203,6 +203,15 @@ Otherwise you can pull the trunk source and install from there::
     cd pymodbus
     pip install -r requirements.txt
 
+Before cloning the repo, you need to install python3 (preferable 3.10)
+and make a virtual environment::
+
+   python3 -m venv /path/to/new/virtual/environment
+
+To activeate the virtual environment please do::
+
+   source .venv/bin/activate
+
 
 To get latest release (for now v2.5.3 with Python 2.7 support)::
 
@@ -216,8 +225,10 @@ To get a specific version:
 
     git checkout tags/vX.Y.Z -b vX.Y.Z
 
-Then::
+Then:
+
    pip install -r requirements.txt
+
    pip install -e .
 
 This installs pymodbus in your virtual environment with pointers directly to the pymodbus directory, so any change you make is immediately available as if installed.
@@ -262,23 +273,26 @@ Development Instructions
 The current code base is compatible python >= 3.8.
 Here are some of the common commands to perform a range of activities
 
-::
    pip install -r requirements.txt   install all requirements
+
    pip install -e .                  source directory is "release", useful for testing
 
    tox -e py38 (or py39, py310, pypy38) Run pytest on source code
 
    tox -e pylint                     Run pylint on source code
+
    tox -e codespell                  Run codespell on source code
+
    tox -e bandit                     Run bandit on source code
+
    tox -e flake8                     Run flake8 on source code
+
    tox -e black                      Run black on source code
 
 ------------------------------------------------------------
 Generate documentation
 ------------------------------------------------------------
 
-::
    cd doc
    make clean
    make html

doc/source/example/payload_client.rst renamed to doc/source/example/client_payload.rst

@@ -1,4 +1,4 @@
 ==================================================
 Modbus Payload Example
 ==================================================
-.. literalinclude:: ../../../examples/common/payload_client.py
+.. literalinclude:: ../../../examples/client_payload.py

doc/source/example/modules.rst

@@ -13,18 +13,18 @@ Examples
    client_async
    client_async_basic_calls
    client_async_extended_calls
+   client_payload
    changing_framers
    custom_datablock
    custom_message
    dbstore_update_server
    modbus_logging
    modbus_forwarder
    modbus_serial_forwarder
-   payload_client
-   payload_server
    performance
    server_sync
    server_async
+   server_payload
    updating_server
 
    bcd_payload

doc/source/example/payload_server.rst renamed to doc/source/example/server_payload.rst

@@ -1,4 +1,4 @@
 ==================================================
 Modbus Payload Server Example
 ==================================================
-.. literalinclude:: ../../../examples/common/payload_server.py
+.. literalinclude:: ../../../examples/server_payload.py

examples/client_async.py

@@ -20,35 +20,27 @@
 The corresponding server must be started before e.g. as:
     python3 server_sync.py
 """
-import argparse
 import os
 import asyncio
 import logging
 
 # --------------------------------------------------------------------------- #
 # import the various client implementations
 # --------------------------------------------------------------------------- #
+from examples.helper import get_commandline
 from pymodbus.client import (
     AsyncModbusSerialClient,
     AsyncModbusTcpClient,
     AsyncModbusTlsClient,
     AsyncModbusUdpClient,
 )
-from pymodbus.transaction import (
-    ModbusAsciiFramer,
-    ModbusBinaryFramer,
-    ModbusRtuFramer,
-    ModbusSocketFramer,
-    ModbusTlsFramer,
-)
 
 
-def setup_async_client(args=None):
+_logger = logging.getLogger()
+
+
+def setup_async_client(args):
     """Run client setup."""
-    if not args:
-        args = get_commandline()
-    if args.comm != "serial" and args.port:
-        args.port = int(args.port)
     _logger.info("### Create client object")
     if args.comm == "tcp":
         client = AsyncModbusTcpClient(
@@ -134,69 +126,10 @@ async def run_async_client(client, modbus_calls=None):
     _logger.info("### End of Program")
 
 
-# --------------------------------------------------------------------------- #
-# Extra code, to allow commandline parameters instead of changing the code
-# --------------------------------------------------------------------------- #
-FORMAT = "%(asctime)-15s %(levelname)-8s %(module)-15s:%(lineno)-8s %(message)s"
-logging.basicConfig(format=FORMAT)
-_logger = logging.getLogger()
-
-
-def get_commandline():
-    """Read and validate command line arguments"""
-    parser = argparse.ArgumentParser(
-        description="Connect/disconnect a synchronous client."
-    )
-    parser.add_argument(
-        "--comm",
-        choices=["tcp", "udp", "serial", "tls"],
-        help='"serial", "tcp", "udp" or "tls"',
-        type=str,
-    )
-    parser.add_argument(
-        "--framer",
-        choices=["ascii", "binary", "rtu", "socket", "tls"],
-        help='"ascii", "binary", "rtu", "socket" or "tls"',
-        type=str,
-    )
-    parser.add_argument(
-        "--log",
-        choices=["critical", "error", "warning", "info", "debug"],
-        help='"critical", "error", "warning", "info" or "debug"',
-        type=str,
-    )
-    parser.add_argument(
-        "--port",
-        help="the port to use",
-        type=str,
-    )
-    args = parser.parse_args()
-
-    # set defaults
-    comm_defaults = {
-        "tcp": ["socket", 5020],
-        "udp": ["socket", 5020],
-        "serial": ["rtu", "/dev/ptyp0"],
-        "tls": ["tls", 5020],
-    }
-    framers = {
-        "ascii": ModbusAsciiFramer,
-        "binary": ModbusBinaryFramer,
-        "rtu": ModbusRtuFramer,
-        "socket": ModbusSocketFramer,
-        "tls": ModbusTlsFramer,
-    }
-    _logger.setLevel(args.log.upper() if args.log else logging.INFO)
-    if not args.comm:
-        args.comm = "tcp"
-    if not args.framer:
-        args.framer = comm_defaults[args.comm][0]
-    args.port = args.port or comm_defaults[args.comm][1]
-    args.framer = framers[args.framer]
-    return args
-
-
 if __name__ == "__main__":
-    # Connect/disconnect no calls.
-    testclient = setup_async_client()
+    cmd_args = get_commandline(
+        server=False,
+        description="Run asynchronous client.",
+    )
+    testclient = setup_async_client(cmd_args)
     asyncio.run(run_async_client(testclient), debug=True)

examples/client_async_basic_calls.py

@@ -9,9 +9,12 @@
 import asyncio
 import logging
 
+from examples.helper import get_commandline
 from examples.client_async import run_async_client, setup_async_client
 
 
+_logger = logging.getLogger()
+
 SLAVE = 0x01
 
 
@@ -118,14 +121,11 @@ async def run_async_basic_calls(client):
     await _handle_holding_registers(client)
     await _handle_input_registers(client)
 
-# --------------------------------------------------------------------------- #
-# Extra code, to allow commandline parameters instead of changing the code
-# --------------------------------------------------------------------------- #
-FORMAT = "%(asctime)-15s %(levelname)-8s %(module)-15s:%(lineno)-8s %(message)s"
-logging.basicConfig(format=FORMAT)
-_logger = logging.getLogger()
-
 
 if __name__ == "__main__":
-    testclient = setup_async_client()
+    cmd_args = get_commandline(
+        server=False,
+        description="Run basic calls in asynchronous client.",
+    )
+    testclient = setup_async_client(cmd_args)
     asyncio.run(run_async_client(testclient, modbus_calls=run_async_basic_calls))

examples/client_async_extended_calls.py

@@ -25,6 +25,7 @@
 import asyncio
 import logging
 
+from examples.helper import get_commandline
 from examples.client_async import run_async_client, setup_async_client
 
 from pymodbus.diag_message import (
@@ -53,6 +54,7 @@
     ReportSlaveIdRequest,
 )
 
+_logger = logging.getLogger()
 
 UNIT = 0x01
 
@@ -175,5 +177,9 @@ async def run_async_ext_calls(client):
 
 
 if __name__ == "__main__":
-    testclient = setup_async_client()
+    cmd_args = get_commandline(
+        server=False,
+        description="Run extended calls in asynchronous client.",
+    )
+    testclient = setup_async_client(cmd_args)
     asyncio.run(run_async_client(testclient, modbus_calls=run_async_ext_calls))

examples/common/payload_client.py renamed to examples/client_payload.py

@@ -1,3 +1,4 @@
+#!/usr/bin/env python3
 """Pymodbus Client Payload Example.
 
 This example shows how to build a client with a

examples/client_sync.py

@@ -20,34 +20,26 @@
 The corresponding server must be started before e.g. as:
     python3 server_sync.py
 """
-import argparse
 import os
 import logging
 
 # --------------------------------------------------------------------------- #
 # import the various client implementations
 # --------------------------------------------------------------------------- #
+from examples.helper import get_commandline
 from pymodbus.client import (
     ModbusSerialClient,
     ModbusTcpClient,
     ModbusTlsClient,
     ModbusUdpClient,
 )
-from pymodbus.transaction import (
-    ModbusAsciiFramer,
-    ModbusBinaryFramer,
-    ModbusRtuFramer,
-    ModbusSocketFramer,
-    ModbusTlsFramer,
-)
 
 
-def setup_sync_client(args=None):
+_logger = logging.getLogger()
+
+
+def setup_sync_client(args):
     """Run client setup."""
-    if not args:
-        args = get_commandline()
-    if args.comm != "serial" and args.port:
-        args.port = int(args.port)
     _logger.info("### Create client object")
     if args.comm == "tcp":
         client = ModbusTcpClient(
@@ -132,69 +124,10 @@ def run_sync_client(client, modbus_calls=None):
     _logger.info("### End of Program")
 
 
-# --------------------------------------------------------------------------- #
-# Extra code, to allow commandline parameters instead of changing the code
-# --------------------------------------------------------------------------- #
-FORMAT = "%(asctime)-15s %(levelname)-8s %(module)-15s:%(lineno)-8s %(message)s"
-logging.basicConfig(format=FORMAT)
-_logger = logging.getLogger()
-
-
-def get_commandline():
-    """Read and validate command line arguments"""
-    parser = argparse.ArgumentParser(
-        description="Connect/disconnect a synchronous client."
-    )
-    parser.add_argument(
-        "--comm",
-        choices=["tcp", "udp", "serial", "tls"],
-        help='"serial", "tcp", "udp" or "tls"',
-        type=str,
-    )
-    parser.add_argument(
-        "--framer",
-        choices=["ascii", "binary", "rtu", "socket", "tls"],
-        help='"ascii", "binary", "rtu", "socket" or "tls"',
-        type=str,
-    )
-    parser.add_argument(
-        "--log",
-        choices=["critical", "error", "warning", "info", "debug"],
-        help='"critical", "error", "warning", "info" or "debug"',
-        type=str,
-    )
-    parser.add_argument(
-        "--port",
-        help="the port to use",
-        type=str,
-    )
-    args = parser.parse_args()
-
-    # set defaults
-    comm_defaults = {
-        "tcp": ["socket", 5020],
-        "udp": ["socket", 5020],
-        "serial": ["rtu", "/dev/ptyp0"],
-        "tls": ["tls", 5020],
-    }
-    framers = {
-        "ascii": ModbusAsciiFramer,
-        "binary": ModbusBinaryFramer,
-        "rtu": ModbusRtuFramer,
-        "socket": ModbusSocketFramer,
-        "tls": ModbusTlsFramer,
-    }
-    _logger.setLevel(args.log.upper() if args.log else logging.INFO)
-    if not args.comm:
-        args.comm = "tcp"
-    if not args.framer:
-        args.framer = comm_defaults[args.comm][0]
-    args.port = args.port or comm_defaults[args.comm][1]
-    args.framer = framers[args.framer]
-    return args
-
-
 if __name__ == "__main__":
-    # Connect/disconnect no calls.
-    testclient = setup_sync_client()
+    cmd_args = get_commandline(
+        server=False,
+        description="Run synchronous client.",
+    )
+    testclient = setup_sync_client(cmd_args)
     run_sync_client(testclient)