Merge branch 'dev'

Author: janiversen

.github/workflows/ci.yml

@@ -5,12 +5,12 @@ on:
       - dev
       - master
       - wait_next_API
-      - dev_*
     tags:
       - v*
   pull_request:
     branches:
       - dev
+      - wait_next_api
     types: [opened, synchronize, reopened, ready_for_review]
   schedule:
     # Sunday at 02:10 UTC.

.github/workflows/clean_workflow_runs.yml

@@ -22,7 +22,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Clear cache
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7
         with:
           script: |
             console.log("About to clear")

AUTHORS.rst

@@ -16,6 +16,7 @@ Thanks to
 - Alexander Lanin
 - Alexandre CUER
 - Alois Hockenschlohe
+- Andy Walker
 - Arjan
 - André Srinivasan
 - andrew-harness
@@ -27,6 +28,7 @@ Thanks to
 - Chandler Riehm
 - Chris Hung
 - Christian Krause
+- Daniel Rauber
 - dhoomakethu
 - doelki
 - DominicDataP
@@ -64,6 +66,8 @@ Thanks to
 - Logan Gunthorpe
 - Marko Luther
 - Matthias Straka
+- Matthias Urlichs
+- Michel F
 - Mickaël Schoentgen
 - Pavel Kostromitinov
 - peufeu2
@@ -77,6 +81,7 @@ Thanks to
 - Totally a booplicate
 - WouterTuinstra
 - wriswith
+- Yash Jani
 - Yohrog
 - yyokusa
 

CHANGELOG.rst

@@ -7,6 +7,44 @@ helps make pymodbus a better product.
 
 :ref:`Authors`: contains a complete list of volunteers have contributed to each major version.
 
+Version 3.7.3
+-------------
+* 100% test coverage of framers (#2359)
+* Framer, final touches. (#2360)
+* Readme file renamed (#2357)
+* Remove old framers (#2358)
+* frameProcessIncomingPacket removed (#2355)
+* Cleanup framers (reduce old_framers) (#2342)
+* Run CI on PR targeted at wait_next_api.
+* Sync client, allow unknown recv msg size. (#2353)
+* integrate old rtu framer in new framer (#2344)
+* Update README.rst (#2351)
+* Client.close should not allow reconnect= (#2347)
+* Remove async client.idle_time(). (#2349)
+* Client doc, add common methods (base). (#2348)
+* Reset receive buffer with send(). (#2343)
+* Remove unused protocol_id from pdu (#2340)
+* CI run on demand on non-protected branches. (#2339)
+* Server listener and client connections have is_server set. (#2338)
+* Reopen listener in server if disconnected. (#2337)
+* Regroup test. (#2335)
+* Improve docs around sync clients and reconnection (#2321)
+* transport 100% test coverage (again) (#2333)
+* Update actions to new node.js. (#2332)
+* Bump 3rd party (#2331)
+* Documentation on_connect_callback (#2324)
+* Fixes the unexpected implementation of the ModbusSerialClient.connected property (#2327)
+* Forward error responses instead of timing out. (#2329)
+* Add `stacklevel=2` to logging functions (#2330)
+* Fix encoding & decoding of ReadFileRecordResponse (#2319)
+* Improvements for example/contib/solar (#2318)
+* Update solar.py (#2316)
+* Remove double conversion in int (#2315)
+* Complete pull request #2310 (#2312)
+* fixed type hints for write_register and write_registers (#2309)
+* Remove _header from framers. (#2305)
+
+
 Version 3.7.2
 -------------
 * Correct README

MAKE_RELEASE.rst

@@ -14,8 +14,8 @@ Prepare/make release on dev.
    * Control / Update API_changes.rst
    * Update CHANGELOG.rst
       * Add commits from last release, but selectively !
-        git log --oneline v3.7.0..HEAD > commit.log
-        git log --pretty="%an" v3.7.0..HEAD | sort -uf > authors.log
+        git log --oneline v3.7.3..HEAD > commit.log
+        git log --pretty="%an" v3.7.3..HEAD | sort -uf > authors.log
         update AUTHORS.rst and CHANGELOG.rst
         cd doc; ./build_html
    * rm -rf build/* dist/*
@@ -58,4 +58,4 @@ Architecture documentation.
 ------------------------------------------------------------
 * install graphviz
 * pyreverse -k -o jpg pymodbus
-l
+l

README.rst

@@ -23,7 +23,7 @@ Upgrade examples:
 - 3.6.1 -> 3.7.0: Smaller changes to the pymodbus calls might be needed
 - 2.5.4 -> 3.0.0: Major changes in the application might be needed
 
-Current release is `3.7.2 <https://github.com/pymodbus-dev/pymodbus/releases/tag/v3.7.2>`_.
+Current release is `3.7.3 <https://github.com/pymodbus-dev/pymodbus/releases/tag/v3.7.3>`_.
 
 Bleeding edge (not released) is `dev <https://github.com/pymodbus-dev/pymodbus/tree/dev>`_.
 
@@ -84,7 +84,7 @@ Server Features
 * callback to intercept requests/responses
 * work on RS485 in parallel with other devices
 
-`Server documentation <https://pymodbus.readthedocs.io/en/latest/source/library/server.html>`_
+`Server documentation <https://pymodbus.readthedocs.io/en/latest/source/server.html>`_
 
 
 REPL Features

doc/source/readme.rst doc/source/README.rst

@@ -55,9 +55,9 @@ Pymodbus offers clients with transport different protocols and different framers
      - ASCII
      - RTU
      - RTU_OVER_TCP
-     - Socket
+     - SOCKET
      - TLS
-   * - Serial (RS-485)
+   * - SERIAL (RS-485)
      - Yes
      - Yes
      - No
@@ -118,19 +118,32 @@ that a device have received the packet.
 Client usage
 ------------
 Using pymodbus client to set/get information from a device (server)
-is done in a few simple steps, like the following synchronous example::
+is done in a few simple steps.
+
+Synchronous example
+^^^^^^^^^^^^^^^^^^^
+
+::
 
     from pymodbus.client import ModbusTcpClient
 
     client = ModbusTcpClient('MyDevice.lan')   # Create client object
-    client.connect()                           # connect to device, reconnect automatically
+    client.connect()                           # connect to device
     client.write_coil(1, True, slave=1)        # set information in device
     result = client.read_coils(2, 3, slave=1)  # get information from device
     print(result.bits[0])                      # use information
     client.close()                             # Disconnect device
 
+The line :mod:`client.connect()` connects to the device (or comm port). If this cannot connect successfully within
+the timeout it throws an exception. After this initial connection, further
+calls to the same client (here, :mod:`client.write_coil(...)` and
+:mod:`client.read_coils(...)` ) will check whether the client is still
+connected, and automatically reconnect if not.
 
-and a asynchronous example::
+Asynchronous example
+^^^^^^^^^^^^^^^^^^^^
+
+::
 
     from pymodbus.client import AsyncModbusTcpClient
 
@@ -141,7 +154,7 @@ and a asynchronous example::
     print(result.bits[0])                            # use information
     client.close()                                   # Disconnect device
 
-The line :mod:`client = AsyncModbusTcpClient('MyDevice.lan')` only creates the object it does not activate
+The line :mod:`client = AsyncModbusTcpClient('MyDevice.lan')` only creates the object; it does not activate
 anything.
 
 The line :mod:`await client.connect()` connects to the device (or comm port), if this cannot connect successfully within
@@ -153,6 +166,9 @@ The line :mod:`result = await client.read_coils(2, 3, slave=1)` is an example of
 
 The last line :mod:`client.close()` closes the connection and render the object inactive.
 
+Development notes
+^^^^^^^^^^^^^^^^^
+
 Large parts of the implementation are shared between the different classes,
 to ensure high stability and efficient maintenance.
 
@@ -232,6 +248,20 @@ There are a client class for each type of communication and for asynchronous/syn
      - :mod:`AsyncModbusUdpClient`
      - :mod:`ModbusUdpClient`
 
+Client common
+^^^^^^^^^^^^^
+Some methods are common to all client:
+
+.. autoclass:: pymodbus.client.base.ModbusBaseClient
+    :members:
+    :member-order: bysource
+    :show-inheritance:
+
+.. autoclass:: pymodbus.client.base.ModbusBaseSyncClient
+    :members:
+    :member-order: bysource
+    :show-inheritance:
+
 Client serial
 ^^^^^^^^^^^^^
 .. autoclass:: pymodbus.client.AsyncModbusSerialClient

doc/source/_static/examples.tgz

@@ -1,34 +1,34 @@
 Framer
 ======
 
-pymodbus\.framer\.ModbusAsciiFramer module
+pymodbus\.framer\.FramerAscii module
 ------------------------------------------
 
-.. automodule:: pymodbus.framer.ModbusAsciiFramer
+.. automodule:: pymodbus.framer.FramerAscii
     :members:
     :undoc-members:
     :show-inheritance:
 
-pymodbus\.framer\.ModbusRtuFramer module
+pymodbus\.framer\.FramerRTU module
 ----------------------------------------
 
-.. automodule:: pymodbus.framer.ModbusRtuFramer
+.. automodule:: pymodbus.framer.FramerRTU
     :members:
     :undoc-members:
     :show-inheritance:
 
-pymodbus\.framer\.ModbusSocketFramer module
+pymodbus\.framer\.FramerSocket module
 -------------------------------------------
 
-.. automodule:: pymodbus.framer.ModbusSocketFramer
+.. automodule:: pymodbus.framer.FramerSocket
     :members:
     :undoc-members:
     :show-inheritance:
 
-pymodbus\.framer\.ModbusTlsFramer module
+pymodbus\.framer\.FramerTLS module
 ----------------------------------------
 
-.. automodule:: pymodbus.framer.ModbusTlsFramer
+.. automodule:: pymodbus.framer.FramerTLS
     :members:
     :undoc-members:
     :show-inheritance:

doc/source/_static/examples.zip

@@ -63,10 +63,10 @@ The entry “comm” allows the following values:
 
 The entry “framer” allows the following values:
 
-- “ascii” to use :class:`pymodbus.framer.ModbusAsciiFramer`,
-- “rtu” to use :class:`pymodbus.framer.ModbusRtuFramer`,
-- “tls” to use :class:`pymodbus.framer.ModbusTlsFramer`,
-- “socket” to use :class:`pymodbus.framer.ModbusSocketFramer`.
+- “ascii” to use :class:`pymodbus.framer.FramerAscii`,
+- “rtu” to use :class:`pymodbus.framer.FramerRTU`,
+- “socket” to use :class:`pymodbus.framer.FramerSocket`.
+- “tls” to use :class:`pymodbus.framer.FramerTLS`,
 
 Optional entry "device_id" will limit server to only accept a single id. If
 not set, the server will accept all device id.

doc/source/client.rst

@@ -81,7 +81,7 @@ def setup_async_client(description=None, cmdline=None):
         client = modbusClient.AsyncModbusSerialClient(
             args.port,
             # Common optional parameters:
-            #    framer=ModbusRtuFramer,
+            #    framer=FramerType.RTU,
             timeout=args.timeout,
             #    retries=3,
             # Serial setup parameters

doc/source/library/framer.rst

@@ -36,9 +36,9 @@ class CustomModbusResponse(ModbusResponse):
     function_code = 55
     _rtu_byte_count_pos = 2
 
-    def __init__(self, values=None, slave=1, transaction=0, protocol=0, skip_encode=False):
+    def __init__(self, values=None, slave=1, transaction=0, skip_encode=False):
         """Initialize."""
-        ModbusResponse.__init__(self, slave, transaction, protocol, skip_encode)
+        ModbusResponse.__init__(self, slave, transaction, skip_encode)
         self.values = values or []
 
     def encode(self):
@@ -68,9 +68,9 @@ class CustomModbusRequest(ModbusRequest):
     function_code = 55
     _rtu_frame_size = 8
 
-    def __init__(self, address=None, slave=1, transaction=0, protocol=0, skip_encode=False):
+    def __init__(self, address=None, slave=1, transaction=0, skip_encode=False):
         """Initialize."""
-        ModbusRequest.__init__(self, slave, transaction, protocol, skip_encode)
+        ModbusRequest.__init__(self, slave, transaction, skip_encode)
         self.address = address
         self.count = 16
 
@@ -100,12 +100,12 @@ def execute(self, context):
 class Read16CoilsRequest(ReadCoilsRequest):
     """Read 16 coils in one request."""
 
-    def __init__(self, address, count=None, slave=1, transaction=0, protocol=0, skip_encode=False):
+    def __init__(self, address, count=None, slave=1, transaction=0, skip_encode=False):
         """Initialize a new instance.
 
         :param address: The address to start reading from
         """
-        ReadCoilsRequest.__init__(self, address, count=16, slave=slave, transaction=transaction, protocol=protocol, skip_encode=skip_encode)
+        ReadCoilsRequest.__init__(self, address, count=16, slave=slave, transaction=transaction, skip_encode=skip_encode)
 
 
 # --------------------------------------------------------------------------- #

doc/source/library/simulator/config.rst

@@ -85,7 +85,7 @@ def setup_sync_client(description=None, cmdline=None):
         client = modbusClient.ModbusSerialClient(
             port=args.port,  # serial port
             # Common optional parameters:
-            #    framer=ModbusRtuFramer,
+            #    framer=FramerType.RTU,
             timeout=args.timeout,
             #    retries=3,
             # Serial setup parameters