Merge branch 'dev'

Author: janiversen

.github/workflows/ci.yml

@@ -32,7 +32,7 @@ jobs:
         include:
           - python: '3.10'
             run_lint: true
-          - python: '3.13'
+          - python: '3.14'
             run_doc: true
             run_lint: true
           - os: macos-latest
@@ -101,10 +101,10 @@ jobs:
     timeout-minutes: 10
     steps:
       - uses: actions/[email protected]
-      - uses: github/codeql-action/init@v3
+      - uses: github/codeql-action/init@v4
         with:
           languages: python
-      - uses: github/codeql-action/analyze@v3
+      - uses: github/codeql-action/analyze@v4
 
   ci_complete:
     name: ci_complete

.gitignore

@@ -16,8 +16,8 @@ __pycache__/
 prof/
 dist/pymodbus*
 build/html
+build/lib
 /pymodbus.egg-info/
 venv
 downloaded_files/
-pymodbus.log
 *.lock

API_changes.rst

@@ -2,6 +2,10 @@ API changes
 ===========
 Versions (X.Y.Z) where Z > 0 e.g. 3.0.1 do NOT have API changes!
 
+API changes 3.12.0
+------------------
+- when using no_response_expected=, the call returns None
+
 API changes 3.11.0
 ------------------
 - Revert wrong byte handling in v3.10.0

CHANGELOG.rst

@@ -7,6 +7,24 @@ helps make pymodbus a better product.
 
 :ref:`Authors`: contains a complete list of volunteers have contributed to each major version.
 
+Version 3.11.4
+--------------
+* Prepare 3.11.4 (#2815)
+* Update CodeQL to v4. (#2816)
+* Solve python3.14 problem (and mypy upgrade). (#2814)
+* More doc corrections. (#2813)
+* Correct wrong example in doc. (#2812)
+* update to pylint 4 (#2806)
+* ExceptionResponse for no_response_expected. (#2801)
+* Complete test for SimData / SimDevice. (#2798)
+* SimData and simDevice. (#2796)
+* Avoid windows CI problem with log testing. (#2797)
+* Update doc with 4.0 information. (#2795)
+* Make global DataType. (#2794)
+* Remove test pymodbus.log file. (#2793)
+* Update README. (#2788)
+* Activate ruff indent checking. (#2787)
+
 Version 3.11.3
 --------------
 * Coverage 100% (using no cover, when needed). (#2783)

MAKE_RELEASE.rst

@@ -15,13 +15,12 @@ Prepare/make release on dev.
    * Control / Update API_changes.rst
    * Update CHANGELOG.rst
       * Add commits from last release, but selectively !
-        git log --oneline v3.8.4..HEAD > commit.log
-        git log --pretty="%an" v3.8.4..HEAD | sort -uf > authors.log
+        git log --oneline v3.11.4..HEAD > commit.log
+        git log --pretty="%an" v3.11.4..HEAD | sort -uf > authors.log
         update AUTHORS.rst and CHANGELOG.rst
         cd doc; ./build_html
    * rm -rf build/* dist/*
    * python3 -m build
-   * pypi-alias pymodbus_ha_core
    * twine check dist/*
    * Commit, push and merge.
    * Wait for CI to complete
@@ -42,6 +41,7 @@ Prepare/make release on dev.
    * git checkout v3.7.0dev0
    * rm -rf build/* dist/*
    * python3 -m build
+   * pypi-alias pymodbus_ha_core
    * twine upload dist/*  (upload to pypi)
    * Double check Read me docs are updated
       * trigger build https://readthedocs.org/projects/pymodbus/builds/

README.rst

@@ -35,7 +35,7 @@ as well as the
 `API_changes <https://github.com/pymodbus-dev/pymodbus/blob/dev/API_changes.rst>`_
 files.
 
-Current release is `3.11.3 <https://github.com/pymodbus-dev/pymodbus/releases/tag/v3.11.3>`_.
+Current release is `3.11.4 <https://github.com/pymodbus-dev/pymodbus/releases/tag/v3.11.4>`_.
 
 Bleeding edge (not released) is `dev <https://github.com/pymodbus-dev/pymodbus/tree/dev>`_.
 
@@ -48,25 +48,6 @@ Source code on `github <https://github.com/pymodbus-dev/pymodbus>`_
 
 Full documentation for newest releases as well as the bleeding edge (dev) `readthedocs <https://pymodbus.readthedocs.io>`_
 
-pymodbus is maintained in 2 versions:
-- pymodbus, the official library
-- pymodbus_ha_core
-
-Pymodbus_ha_core
-----------------
-`Pymodbus_ha_core <https://pypi.org/project/pymodbus-ha-core/>`_ is
-an alias to pymodbus, available on pypi.org.
-
-Being an alias means it is 100% the same as pymodbus, without any extra
-code, just another name.
-
-This allows home-assistant to use a pymodbus version for the modbus integration,
-while custom_components use another version.
-
-We are offering to make other aliases for projects who need this, please
-open an issue in the pymodbus project, with an explanation of why it is
-needed.
-
 Pymodbus in a nutshell
 ----------------------
 Pymodbus consist of 5 parts:

doc/index.rst

@@ -20,6 +20,5 @@ Please select a topic in the left hand column.
    source/authors
    source/changelog
    source/internals
-   source/roadmap
 
 .. include:: ../README.rst

doc/source/_static/examples.tgz

@@ -130,7 +130,7 @@ Synchronous example
     client = ModbusTcpClient('MyDevice.lan')       # Create client object
     client.connect()                               # connect to device
     client.write_coil(1, True, device_id=1)        # set information in device
-    result = client.read_coils(2, 3, device_id=1)  # get information from device
+    result = client.read_coils(2, count=3, device_id=1)  # get information from device
     print(result.bits[0])                          # use information
     client.close()                                 # Disconnect device
 
@@ -150,7 +150,7 @@ Asynchronous example
     client = AsyncModbusTcpClient('MyDevice.lan')        # Create client object
     await client.connect()                               # connect to device, reconnect automatically
     await client.write_coil(1, True, device_id=1)        # set information in device
-    result = await client.read_coils(2, 3, device_id=1)  # get information from device
+    result = await client.read_coils(2, count=3, device_id=1)  # get information from device
     print(result.bits[0])                                # use information
     client.close()                                       # Disconnect device
 
@@ -160,9 +160,9 @@ anything.
 The line :mod:`await client.connect()` connects to the device (or comm port), if this cannot connect successfully within
 the timeout it throws an exception. If connected successfully reconnecting later is handled automatically
 
-The line :mod:`await client.write_coil(1, True, device_id=1)` is an example of a write request, set address 1 to True on device 1.
+The line :mod:`await client.write_coil(1, [True], device_id=1)` is an example of a write request, set address 1 to True on device 1.
 
-The line :mod:`result = await client.read_coils(2, 3, device_id=1)` is an example of a read request, get the value of address 2, 3 and 4 (count = 3) from device 1.
+The line :mod:`result = await client.read_coils(2, count=3, device_id=1)` is an example of a read request, get the value of address 2, 3 and 4 (count = 3) from device 1.
 
 The last line :mod:`client.close()` closes the connection and render the object inactive.
 
@@ -217,7 +217,7 @@ All simple request calls (mixin) return a unified result independent whether it
 The application should evaluate the result generically::
 
     try:
-        rr = await client.read_coils(1, 1, device_id=1)
+        rr = await client.read_coils(1, count=1, device_id=1)
     except ModbusException as exc:
         _logger.error(f"ERROR: exception in pymodbus {exc}")
         raise exc