message classes.

Author: janiversen

.gitignore

@@ -1,4 +1,3 @@
-*.db
 *.pyc
 *.swp
 __pycache__/

doc/index.rst

@@ -14,6 +14,7 @@ Welcome to PyModbus's documentation!
    changelog.rst
    source/library/client.rst
    source/library/server.rst
+   source/library/nullmodem.rst
    source/library/simulator/simulator
    source/library/REPL
    source/library/datastore.rst

doc/source/library/nullmodem.rst

@@ -0,0 +1,20 @@
+NullModem
+=========
+
+Pymodbus offers a special NullModem transport to help end-to-end test without network.
+
+The NullModem is activated by setting host= (port= for serial) to NULLMODEM_HOST (import pymodbus.transport)
+
+The NullModem works with the normal transport types, and simply substitutes the physical connection:
+- *Serial* (RS-485) typically using a dongle
+- *TCP*
+- *TLS*
+- *UDP*
+
+The NullModem is currently integrated in
+- :mod:`Modbus<x>Client`
+- :mod:`AsyncModbus<x>Client`
+- :mod:`Modbus<x>Server`
+- :mod:`AsyncModbus<x>Server`
+
+Of course the NullModem requires that server and client(s) run in the same python instance.

pymodbus/client/base.py

@@ -13,7 +13,7 @@
 from pymodbus.logging import Log
 from pymodbus.pdu import ModbusRequest, ModbusResponse
 from pymodbus.transaction import DictTransactionManager
-from pymodbus.transport.transport import CommParams, ModbusProtocol
+from pymodbus.transport import CommParams, ModbusProtocol
 from pymodbus.utilities import ModbusTransactionState
 
 

pymodbus/client/serial.py

@@ -10,7 +10,7 @@
 from pymodbus.framer import ModbusFramer
 from pymodbus.framer.rtu_framer import ModbusRtuFramer
 from pymodbus.logging import Log
-from pymodbus.transport.transport import CommType
+from pymodbus.transport import CommType
 from pymodbus.utilities import ModbusTransactionState
 
 

pymodbus/client/tcp.py

@@ -10,7 +10,7 @@
 from pymodbus.framer import ModbusFramer
 from pymodbus.framer.socket_framer import ModbusSocketFramer
 from pymodbus.logging import Log
-from pymodbus.transport.transport import CommType
+from pymodbus.transport import CommType
 from pymodbus.utilities import ModbusTransactionState
 
 

pymodbus/client/tls.py

@@ -7,7 +7,7 @@
 from pymodbus.framer import ModbusFramer
 from pymodbus.framer.tls_framer import ModbusTlsFramer
 from pymodbus.logging import Log
-from pymodbus.transport.transport import CommParams, CommType
+from pymodbus.transport import CommParams, CommType
 
 
 class AsyncModbusTlsClient(AsyncModbusTcpClient):

pymodbus/client/udp.py

@@ -8,7 +8,7 @@
 from pymodbus.framer import ModbusFramer
 from pymodbus.framer.socket_framer import ModbusSocketFramer
 from pymodbus.logging import Log
-from pymodbus.transport.transport import CommType
+from pymodbus.transport import CommType
 
 
 DGRAM_TYPE = socket.SOCK_DGRAM

pymodbus/server/async_io.py

@@ -19,7 +19,7 @@
     ModbusSocketFramer,
     ModbusTlsFramer,
 )
-from pymodbus.transport.transport import CommParams, CommType, ModbusProtocol
+from pymodbus.transport import CommParams, CommType, ModbusProtocol
 
 
 with suppress(ImportError):
@@ -296,6 +296,7 @@ def __init__(
                 reconnect_delay=0.0,
                 reconnect_delay_max=0.0,
                 timeout_connect=0.0,
+                new_connection_class=lambda: ModbusServerRequestHandler(self),
             ),
         )
         params.source_address = address
@@ -322,10 +323,6 @@ def __init__(
         # defer the initialization of the server
         self.handle_local_echo = False
 
-    def handle_new_connection(self):
-        """Handle incoming connect."""
-        return ModbusServerRequestHandler(self)
-
     async def serve_forever(self):
         """Start endless loop."""
         if self.transport:
@@ -408,6 +405,7 @@ def __init__(  # pylint: disable=too-many-arguments
             sslctx=CommParams.generate_ssl(
                 True, certfile, keyfile, password, sslctx=sslctx
             ),
+            new_connection_class=lambda: ModbusServerRequestHandler(self),
         )
         super().__init__(
             context,
@@ -468,6 +466,7 @@ def __init__(
                 reconnect_delay=0.0,
                 reconnect_delay_max=0.0,
                 timeout_connect=0.0,
+                new_connection_class=lambda: ModbusServerRequestHandler(self),
             ),
             True,
         )
@@ -490,10 +489,6 @@ def __init__(
         self.request_tracer = None
         self.handle_local_echo = False
 
-    def handle_new_connection(self):
-        """Handle incoming connect."""
-        return ModbusServerRequestHandler(self)
-
     async def serve_forever(self):
         """Start endless loop."""
         if self.transport:
@@ -570,6 +565,7 @@ def __init__(
                 parity=kwargs.get("parity", "N"),
                 baudrate=kwargs.get("baudrate", 19200),
                 stopbits=kwargs.get("stopbits", 1),
+                new_connection_class=lambda: ModbusServerRequestHandler(self),
             ),
             True,
         )
@@ -595,10 +591,6 @@ def __init__(
     async def start(self):
         """Start connecting."""
 
-    def handle_new_connection(self):
-        """Handle incoming connect."""
-        return ModbusServerRequestHandler(self)
-
     async def shutdown(self):
         """Terminate server."""
         self.transport_close()

pymodbus/transport/__init__.py

@@ -1 +1,20 @@
 """Transport."""
+
+__all__ = [
+    "CommType",
+    "CommParams",
+    "ModbusProtocol",
+    "NullModem",
+    "NULLMODEM_HOST",
+    "ModbusMessage",
+    "CommFrameType",
+]
+
+from pymodbus.transport.message import CommFrameType, ModbusMessage
+from pymodbus.transport.transport import (
+    NULLMODEM_HOST,
+    CommParams,
+    CommType,
+    ModbusProtocol,
+    NullModem,
+)