Update datastore_simulator example with client (#1967)

Author: janiversen

doc/source/_static/examples.tgz

@@ -168,11 +168,11 @@ Source: :github:`examples/simulator.py`
     :noindex:
 
 
-Simulator datastore example
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Source: :github:`examples/datastore_simulator.py`
+Simulator datastore (shared storage) example
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Source: :github:`examples/datastore_simulator_share.py`
 
-.. automodule:: examples.datastore_simulator
+.. automodule:: examples.datastore_simulator_share
     :undoc-members:
     :noindex:
 

doc/source/_static/examples.zip

@@ -3,18 +3,25 @@
 
 An example of using simulator datastore with json interface.
 
+Detailed description of the device definition can be found at:
+
+    https://pymodbus.readthedocs.io/en/latest/source/library/simulator/config.html#device-entries
+
 usage::
 
-    server_simulator.py [-h]
+    datastore_simulator_share.py [-h]
                         [--log {critical,error,warning,info,debug}]
                         [--port PORT]
+                        [--test_client]
 
     -h, --help
         show this help message and exit
     -l, --log {critical,error,warning,info,debug}
         set log level
     -p, --port PORT
         set port to use
+    --test_client
+        starts a client to test the configuration
 
 The corresponding client can be started as:
     python3 client_sync.py
@@ -25,7 +32,7 @@
 import asyncio
 import logging
 
-from pymodbus import Framer, pymodbus_apply_logging_config
+from pymodbus import pymodbus_apply_logging_config
 from pymodbus.datastore import ModbusServerContext, ModbusSimulatorContext
 from pymodbus.device import ModbusDeviceIdentification
 from pymodbus.server import StartAsyncTcpServer
@@ -129,24 +136,22 @@ def get_commandline(cmdline=None):
     )
     parser.add_argument("--port", help="set port", type=str, default="5020")
     parser.add_argument("--host", help="set interface", type=str, default="localhost")
+    parser.add_argument("--test_client", help="start client to test", action="store_true")
     args = parser.parse_args(cmdline)
-
     return args
 
 
 def setup_simulator(setup=None, actions=None, cmdline=None):
     """Run server setup."""
+    if not setup:
+        setup=demo_config
+    if not actions:
+        actions=demo_actions
     args = get_commandline(cmdline=cmdline)
     pymodbus_apply_logging_config(args.log.upper())
     _logger.setLevel(args.log.upper())
-    args.framer = Framer.SOCKET
     args.port = int(args.port)
 
-    _logger.info("### Create datastore")
-    if not setup:
-        setup = demo_config
-    if not actions:
-        actions = demo_actions
     context = ModbusSimulatorContext(setup, actions)
     args.context = ModbusServerContext(slaves=context, single=True)
     args.identity = ModbusDeviceIdentification(
@@ -169,7 +174,6 @@ async def run_server_simulator(args):
     await StartAsyncTcpServer(
         context=args.context,
         address=(args.host, args.port),
-        framer=args.framer,
     )
 
 

doc/source/examples.rst

@@ -17,7 +17,7 @@
 from examples.client_calls import template_call
 from examples.client_custom_msg import main as main_custom_client
 from examples.client_payload import main as main_payload_calls
-from examples.datastore_simulator import main as main_datastore_simulator
+from examples.datastore_simulator_share import main as main_datastore_simulator_share
 from examples.message_generator import generate_messages
 from examples.message_parser import main as main_parse_messages
 from examples.server_async import setup_server
@@ -82,10 +82,10 @@ async def test_updating_server(self, use_port, use_host):
         task.cancel()
         await task
 
-    async def test_datastore_simulator(self, use_port, use_host):
+    async def test_datastore_simulator_share(self, use_port, use_host):
         """Test server simulator."""
         cmdargs = ["--port", str(use_port), "--host", use_host]
-        task = asyncio.create_task(main_datastore_simulator(cmdline=cmdargs))
+        task = asyncio.create_task(main_datastore_simulator_share(cmdline=cmdargs))
         task.set_name("run main_datastore_simulator")
         await asyncio.sleep(0.1)
         testclient = setup_async_client(cmdline=cmdargs)

examples/datastore_simulator.py renamed to examples/datastore_simulator_share.py

@@ -291,6 +291,14 @@ def test_simulator_invalid_config(self):
         exc_setup[Label.repeat][0][Label.repeat_to] = [48, 500]
         with pytest.raises(RuntimeError):
             ModbusSimulatorContext(exc_setup, None)
+        exc_setup = copy.deepcopy(self.default_config)
+        exc_setup[Label.type_uint16].append(0)
+        ModbusSimulatorContext(exc_setup, None)
+        exc_setup = copy.deepcopy(self.default_config)
+        exc_setup[Label.type_uint16].append(250)
+        with pytest.raises(RuntimeError):
+            ModbusSimulatorContext(exc_setup, None)
+
 
     def test_simulator_validate_illegal(self):
         """Test validation without exceptions."""