Update more v2.5.3 examples. (#1446)

Author: janiversen

doc/source/examples.rst

@@ -10,52 +10,60 @@ These examples are considered essential usage examples, and are guaranteed to wo
 because they are tested automatilly with each dev branch commit using CI.
 
 
-Asynchronous client Example
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Asynchronous client
+^^^^^^^^^^^^^^^^^^^
 .. literalinclude:: ../../examples/client_async.py
 
-Asynchronous client basic calls example
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Asynchronous client basic calls
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 .. literalinclude:: ../../examples/client_calls.py
 
-Asynchronous server example
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Asynchronous server
+^^^^^^^^^^^^^^^^^^^
 .. literalinclude:: ../../examples/server_async.py
 
-Build bcd Payload example
-^^^^^^^^^^^^^^^^^^^^^^^^^
+Build bcd Payload
+^^^^^^^^^^^^^^^^^
 .. literalinclude:: ../../examples/build_bcd_payload.py
 
-Message generator example
-^^^^^^^^^^^^^^^^^^^^^^^^^
+Callback Server example
+^^^^^^^^^^^^^^^^^^^^^^^
+.. literalinclude:: ../../examples/server_callback.py
+
+Custom Message client
+^^^^^^^^^^^^^^^^^^^^^
+.. literalinclude:: ../../examples/client_custom_msg.py
+
+Message generator
+^^^^^^^^^^^^^^^^^
 .. literalinclude:: ../../examples/message_generator.py
 
-Message Parser example
-^^^^^^^^^^^^^^^^^^^^^^
+Message Parser
+^^^^^^^^^^^^^^
 .. literalinclude:: ../../examples/message_parser.py
 
-Modbus forwarder Example
-^^^^^^^^^^^^^^^^^^^^^^^^
+Modbus forwarder
+^^^^^^^^^^^^^^^^
 .. literalinclude:: ../../examples/modbus_forwarder.py
 
-Modbus payload client Example
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Modbus payload client
+^^^^^^^^^^^^^^^^^^^^^
 .. literalinclude:: ../../examples/client_payload.py
 
-Modbus payload Server example
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Modbus payload Server
+^^^^^^^^^^^^^^^^^^^^^
 .. literalinclude:: ../../examples/server_payload.py
 
-Synchronous client Example
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+Synchronous client
+^^^^^^^^^^^^^^^^^^
 .. literalinclude:: ../../examples/client_sync.py
 
-Synchronous server example
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+Synchronous server
+^^^^^^^^^^^^^^^^^^
 .. literalinclude:: ../../examples/server_sync.py
 
-Updating server example
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+Updating server
+^^^^^^^^^^^^^^^
 .. literalinclude:: ../../examples/server_updating.py
 
 
@@ -65,47 +73,14 @@ Examples contributions
 These examples are supplied by users of pymodbus.
 The pymodbus team thanks for sharing the examples.
 
-Redis datastore example
-^^^^^^^^^^^^^^^^^^^^^^^^
+Redis datastore
+^^^^^^^^^^^^^^^
 .. literalinclude:: ../../examples/contrib/redis_datastore.py
 
-Serial Forwarder example
-^^^^^^^^^^^^^^^^^^^^^^^^
+Serial Forwarder
+^^^^^^^^^^^^^^^^
 .. literalinclude:: ../../examples/contrib/serial_forwarder.py
 
-Sqlalchemy datastore example
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. literalinclude:: ../../examples/contrib/sql_datastore.py
-
-
-Examples version 2.5.3
-----------------------
-
-These examples have not been upgraded to v3.0.0 but are still relevant.
-
-Help is wanted to upgrade the examples.
-
-
-Callback Server example
-^^^^^^^^^^^^^^^^^^^^^^^
-.. literalinclude:: ../../examples/v2.5.3/callback_server.py
-
-Custom Message example
-^^^^^^^^^^^^^^^^^^^^^^
-.. literalinclude:: ../../examples/v2.5.3/custom_message.py
-
-Deviceinfo showcase client example
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. literalinclude:: ../../examples/v2.5.3/deviceinfo_showcase_client.py
-
-Deviceinfo showcase server example
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. literalinclude:: ../../examples/v2.5.3/deviceinfo_showcase_server.py
-
-Modbus Saver example
+Sqlalchemy datastore
 ^^^^^^^^^^^^^^^^^^^^
-.. literalinclude:: ../../examples/v2.5.3/modbus_saver.py
-
-performance module
-^^^^^^^^^^^^^^^^^^
-.. literalinclude:: ../../examples/v2.5.3/performance.py
+.. literalinclude:: ../../examples/contrib/sql_datastore.py

examples/v2.5.3/custom_message.py renamed to examples/client_custom_msg.py

@@ -124,9 +124,25 @@ def __init__(self, address, **kwargs):
 # --------------------------------------------------------------------------- #
 
 
-if __name__ == "__main__":
+def run_custom_client():
+    """Run versions of read coil."""
     with ModbusClient(host="localhost", port=5020) as client:
+        # Standard call
+        request = ReadCoilsRequest(32, 1, slave=1)
+        result = client.execute(request)
+        print(result)
+
+        # inherited request
+        request = Read16CoilsRequest(32, slave=1)
+        result = client.execute(request)
+        print(result)
+
+        # new modbus function code.
         client.register(CustomModbusResponse)
-        request = CustomModbusRequest(1, slave=1)
+        request = CustomModbusRequest(32, slave=1)
         result = client.execute(request)
-        print(result.values)
+        print(result)
+
+
+if __name__ == "__main__":
+    run_custom_client()

examples/server_callback.py

@@ -0,0 +1,67 @@
+#!/usr/bin/env python3
+"""Pymodbus Server With Callbacks.
+
+This is an example of adding callbacks to a running modbus server
+when a value is written to it.
+"""
+import asyncio
+import logging
+
+from examples.server_async import run_async_server, setup_server
+from pymodbus.datastore import (
+    ModbusSequentialDataBlock,
+    ModbusServerContext,
+    ModbusSlaveContext,
+)
+
+
+_logger = logging.getLogger()
+_logger.setLevel(logging.DEBUG)
+
+
+class CallbackDataBlock(ModbusSequentialDataBlock):
+    """A datablock that stores the new value in memory,
+
+    and passes the operation to a message queue for further processing.
+    """
+
+    def __init__(self, queue, addr, values):
+        """Initialize."""
+        self.queue = queue
+        super().__init__(addr, values)
+
+    def setValues(self, address, value):
+        """Set the requested values of the datastore."""
+        super().setValues(address, value)
+        txt = f"Callback from setValues with address {address}, value {value}"
+        _logger.debug(txt)
+
+    def getValues(self, address, count=1):
+        """Return the requested values from the datastore."""
+        result = super().getValues(address, count=count)
+        txt = f"Callback from getValues with address {address}, count {count}, data {result}"
+        _logger.debug(txt)
+        return result
+
+    def validate(self, address, count=1):
+        """Check to see if the request is in range."""
+        result = super().validate(address, count=count)
+        txt = f"Callback from validate with address {address}, count {count}, data {result}"
+        _logger.debug(txt)
+        return result
+
+
+async def run_callback_server(cmdline=None):
+    """Define datastore callback for server and do setup."""
+    queue = asyncio.Queue()
+    block = CallbackDataBlock(queue, 0x00, [17] * 100)
+    store = ModbusSlaveContext(di=block, co=block, hr=block, ir=block)
+    context = ModbusServerContext(slaves=store, single=True)
+    run_args = setup_server(
+        description="Run callback server.", cmdline=cmdline, context=context
+    )
+    await run_async_server(run_args)
+
+
+if __name__ == "__main__":
+    asyncio.run(run_callback_server())