Merge branch 'dev'

Author: janiversen

.github/workflows/ci.yml

@@ -36,11 +36,11 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python: ['3.9', '3.10', '3.11', '3.12']
+        python: ['3.9', '3.10', '3.11', '3.12', "3.13"]
         include:
           - python: '3.9'
             run_lint: true
-          - python: '3.12'
+          - python: '3.13'
             run_doc: true
             run_lint: true
           - os: macos-latest
@@ -113,13 +113,13 @@ jobs:
           ruff check .
 
       - name: pytest
-        if: ${{ (matrix.os != 'ubuntu-latest') || (matrix.python != '3.12') }}
+        if: ${{ (matrix.os != 'ubuntu-latest') || (matrix.python != '3.13') }}
         run: |
           env
           pytest
 
       - name: pytest coverage
-        if: ${{ (matrix.os == 'ubuntu-latest') && (matrix.python == '3.12')  }}
+        if: ${{ (matrix.os == 'ubuntu-latest') && (matrix.python == '3.13')  }}
         run: |
           env
           pytest --cov

AUTHORS.rst

@@ -10,6 +10,7 @@ Pymodbus version 3 family
 -------------------------
 Thanks to
 
+- ahcm-dev
 - AKJ7
 - Alex
 - Alex Ruddick
@@ -58,13 +59,12 @@ Thanks to
 - julian
 - Justin Standring
 - Kenny Johansson
-- Martyy
-- Matthias Straka
+- Kürşat Aktaş
 - laund
 - Logan Gunthorpe
 - Marko Luther
-- Logan Gunthorpe
-- Marko Luther
+- Martyy
+- Máté Szabó
 - Matthias Straka
 - Matthias Urlichs
 - Michel F

CHANGELOG.rst

@@ -7,6 +7,40 @@ helps make pymodbus a better product.
 
 :ref:`Authors`: contains a complete list of volunteers have contributed to each major version.
 
+Version 3.7.4
+-------------
+* Clean PDU init. (#2399)
+* Wrong close, when transaction do not match. (#2401)
+* Remove unmaintained (not working) example contributions. (#2400)
+* All pdu (incl. function code) tests to pdu directory. (#2397)
+* Add `no_response_expected` argument to requests (#2385)
+* Resubmit: Don't close/reopen tcp connection on single modbus message timeout (#2350)
+* 100% test coverage for PDU. (#2394)
+* Type DecodePDU. (#2392)
+* Update to use DecodePDU. (#2391)
+* Client/Server decoder renamed and moved to pdu. (#2390)
+* Move client/server decoder to pdu. (#2388)
+* Introducing PyModbus Guru on Gurubase.io (#2387)
+* Remove IllegalFunctionRequest. (#2384)
+* remove ModbusResponse. (#2383)
+* Add typing to pdu base classes. (#2380)
+* Updated roadmap.
+* remove databuffer from framer. (#2379)
+* Improve retries for sync client. (#2377)
+* Move process test to framer tests (#2376)
+* Framer do not check ids (#2375)
+* Remove callback from framer. (#2374)
+* Auto fill device ids for clients. (#2372)
+* Reenable multidrop tests. (#2370)
+* write_register/s accept bytes or int. (#2369)
+* roadmap corrections.
+* Added roadmap (not written in stone). (#2367)
+* Update README to show python 3.13.
+* Test on Python 3.13 (#2366)
+* Use @abstractmethod (#2365)
+* Corrected smaller documentation bugs. (#2364)
+* README as landing page in readthedocs. (#2363)
+
 Version 3.7.3
 -------------
 * 100% test coverage of framers (#2359)
@@ -44,7 +78,6 @@ Version 3.7.3
 * 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,9 +14,10 @@ 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.3..HEAD > commit.log
-        git log --pretty="%an" v3.7.3..HEAD | sort -uf > authors.log
+        git log --oneline v3.7.4..HEAD > commit.log
+        git log --pretty="%an" v3.7.4..HEAD | sort -uf > authors.log
         update AUTHORS.rst and CHANGELOG.rst
+        update roadmap.rst
         cd doc; ./build_html
    * rm -rf build/* dist/*
    * python3 -m build

README.rst

@@ -8,8 +8,11 @@ PyModbus - A Python Modbus Stack
 .. image:: https://pepy.tech/badge/pymodbus
    :target: https://pepy.tech/project/pymodbus
    :alt: Downloads
+.. image:: https://img.shields.io/badge/Gurubase-Ask%20PyModbus%20Guru-006BFF
+   :target: https://gurubase.io/g/pymodbus
+   :alt: PyModbus Guru
 
-Pymodbus is a full Modbus protocol implementation offering client/server with synchronous/asynchronous API a well as simulators.
+Pymodbus is a full Modbus protocol implementation offering client/server with synchronous/asynchronous API and simulators.
 
 Our releases is defined as X.Y.Z, and we have strict rules what to release when:
 
@@ -23,7 +26,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.3 <https://github.com/pymodbus-dev/pymodbus/releases/tag/v3.7.3>`_.
+Current release is `3.7.4 <https://github.com/pymodbus-dev/pymodbus/releases/tag/v3.7.4>`_.
 
 Bleeding edge (not released) is `dev <https://github.com/pymodbus-dev/pymodbus/tree/dev>`_.
 
@@ -57,7 +60,7 @@ Common features
 * very lightweight project
 * requires Python >= 3.9
 * thorough test suite, that test all corners of the library
-* automatically tested on Windows, Linux and MacOS combined with python 3.9 - 3.12
+* automatically tested on Windows, Linux and MacOS combined with python 3.9 - 3.13
 * strongly typed API (py.typed present)
 
 The modbus protocol specification: Modbus_Application_Protocol_V1_1b3.pdf can be found on

doc/index.rst

@@ -8,7 +8,6 @@ Please select a topic in the left hand column.
    :caption: Contents:
    :hidden:
 
-   source/readme
    source/api_changes
    source/client
    source/server
@@ -17,5 +16,7 @@ Please select a topic in the left hand column.
    source/examples
    source/authors
    source/changelog
-   source/api_changes
    source/internals
+   source/roadmap
+   
+.. include:: ../README.rst

doc/source/README.rst

@@ -166,6 +166,14 @@ 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.
 
+Retry logic for async clients
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If no response is received to a request (call), it is retried (parameter retries) times, if not successful
+an exception response is returned, BUT the connection is not touched.
+
+If 3 consequitve requests (calls) do not receive a response, the connection is terminated.
+
 Development notes
 ^^^^^^^^^^^^^^^^^
 
@@ -191,14 +199,12 @@ The logical devices represented by the device is addressed with the :mod:`slave=
 With **Serial**, the comm port is defined when creating the object.
 The physical devices are addressed with the :mod:`slave=` parameter.
 
-:mod:`slave=0` is used as broadcast in order to address all devices.
-However experience shows that modern devices do not allow broadcast, mostly because it is
-inheriently dangerous. With :mod:`slave=0` the application can get upto 254 responses on a single request,
-and this is not handled with the normal API calls!
+:mod:`slave=0` is defined as broadcast in the modbus standard, but pymodbus treats is a normal device.
 
-The simple request calls (mixin) do NOT support broadcast, if an application wants to use broadcast
-it must call :mod:`client.execute` and deal with the responses.
+If an application is expecting multiple responses to a broadcast request, it must call :mod:`client.execute` and deal with the responses.
 
+If no response is expected to a request, the :mod:`no_response_expected=True` argument can be used
+in the normal API calls, this will cause the call to return imidiatble with :mod:`None`
 
 
 Client response handling
@@ -227,6 +233,7 @@ And in case of read retrieve the data depending on type of request
 - :mod:`rr.bits` is set for coils / input_register requests
 - :mod:`rr.registers` is set for other requests
 
+Remark if using :mod:`no_response_expected=True` rr will always be None.
 
 Client interface classes
 ------------------------