Merge branch 'dev'

janiversen · janiversen · commit abe2c5e4eb6f · 2025-08-05T11:51:57.000Z
diff --git a/API_changes.rst b/API_changes.rst
@@ -2,8 +2,22 @@ API changes
 ===========
 Versions (X.Y.Z) where Z > 0 e.g. 3.0.1 do NOT have API changes!
 
+API changes 3.11.0
+------------------
+- Revert wrong byte handling in v3.10.0
+  bit handling order is LSB-> MSB for each byte
+  REMARK: word are ordered depending on big/little endian
+  readCoils and other bit functions now return bit in logical order (NOT byte order)
+
+  Example:
+  Hex bytes: 0x00 0x01
+  delivers False * 8 True False * 7
+
+  Hex bytes: 0x01 0x03
+  delivers True False * 7 True True False * 6
+
 API changes 3.10.0
------------------
+------------------
 - ModbusSlaveContext replaced by ModbusDeviceContext
 - payload removed (replaced by "convert_to/from_registers")
 - slave=, slaves= replaced by device_id=, device_ids=
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -10,6 +10,7 @@ Pymodbus version 3 family
 -------------------------
 Thanks to
 
+- aaru-astranis
 - ahcm-dev
 - AKJ7
 - Alex
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -7,8 +7,13 @@ helps make pymodbus a better product.
 
 :ref:`Authors`: contains a complete list of volunteers have contributed to each major version.
 
+Version 3.11.0
+--------------
+ * Correct bit handling (each byte is LSB->MSB). (#2707)
+ * read_input_registers docstring change count to regs (#2704)
+
 Version 3.10.0
--------------
+--------------
 * Raise runtimeerror if listen() fails. (#2697)
 * Correct values parameter in setValues. (#2696)
 * Correct return from getValues. (#2695)
diff --git a/README.rst b/README.rst
@@ -29,7 +29,7 @@ Upgrade examples:
 
 It is always recommended to read the CHANGELOG as well as the API_changes files.
 
-Current release is `3.10.0 <https://github.com/pymodbus-dev/pymodbus/releases/tag/v3.10.0>`_.
+Current release is `3.11.0 <https://github.com/pymodbus-dev/pymodbus/releases/tag/v3.11.0>`_.
 
 Bleeding edge (not released) is `dev <https://github.com/pymodbus-dev/pymodbus/tree/dev>`_.
 
diff --git a/doc/source/_static/examples.tgz b/doc/source/_static/examples.tgz
diff --git a/doc/source/_static/examples.zip b/doc/source/_static/examples.zip
diff --git a/doc/source/roadmap.rst b/doc/source/roadmap.rst
@@ -13,7 +13,7 @@ The maintainers are very open to these pull request, and ONLY work to secure tha
 
 The following bullet points are what the maintainers focus on:
 
-- 3.10.x, with:
+- 3.12.x, with:
     - Currently not planned
 - 4.0.0, with:
     - ModbusControlBlock pr slave
diff --git a/doc/source/upgrade_40.rst b/doc/source/upgrade_40.rst
@@ -4,7 +4,6 @@ Pymodbus 4.0 upgrade procedure
 Pymodbus 4.0 contains a number of incompatibilities with Pymodbus 3.x, however
 most of these are simple edits.
 
-
 Python 3.9
 ----------
 Python 3.9 is reaching end of life and from october 2025 no longer receives security updates.
diff --git a/pymodbus/__init__.py b/pymodbus/__init__.py
@@ -20,5 +20,5 @@
 from pymodbus.pdu.device import ModbusDeviceIdentification
 
 
-__version__ = "3.10.0"
+__version__ = "3.11.0"
 __version_full__ = f"[pymodbus, version {__version__}]"
diff --git a/pymodbus/client/mixin.py b/pymodbus/client/mixin.py
@@ -121,7 +121,7 @@ def read_input_registers(self,
         """Read input registers (code 0x04).
 
         :param address: Start address to read from
-        :param count: (optional) Number of coils to read
+        :param count: (optional) Number of registers to read
         :param device_id: (optional) Modbus device ID
         :param no_response_expected: (optional) The client will not expect a response to the request
         :raises ModbusException:
diff --git a/pymodbus/pdu/pdu.py b/pymodbus/pdu/pdu.py
@@ -166,14 +166,15 @@ def pack_bitstring(bits: list[bool], align_byte=True) -> bytes:
     bits_extra = 8 if align_byte else 16
     if (extra := len(bits) % bits_extra):
         t_bits += [False] * (bits_extra - extra)
-    for bit in reversed(t_bits):
-        packed <<= 1
-        if bit:
-            packed += 1
-        i += 1
-        if i == 8:
-            ret += struct.pack(">B", packed)
-            i = packed = 0
+    for byte_inx in range(0, len(t_bits), 8):
+        for bit in reversed(t_bits[byte_inx:byte_inx+8]):
+            packed <<= 1
+            if bit:
+                packed += 1
+            i += 1
+            if i == 8:
+                ret += struct.pack(">B", packed)
+                i = packed = 0
     return ret
 
 
@@ -185,13 +186,11 @@ def unpack_bitstring(data: bytes) -> list[bool]:
         bytes 0x05 0x81
         result = unpack_bitstring(bytes)
 
-        [True, False, False, False] +
-        [False, False, False, True] +
-        [True, False, True, False] +
-        [False, False, False, False]
+        [True, False, True, False] + [False, False, False, False]
+        [True, False, False, False] + [False, False, False, True]
     """
     res = []
-    for byte_index in range(len(data) -1, -1, -1):
+    for _, t_byte in enumerate(data):
         for bit in (1, 2, 4, 8, 16, 32, 64, 128):
-            res.append(bool(data[byte_index] & bit))
+            res.append(bool(t_byte & bit))
     return res
diff --git a/test/client/test_client.py b/test/client/test_client.py
@@ -170,55 +170,55 @@ def fake_execute(_self, _no_response_expected, request):
             (
                 ModbusClientMixin.DATATYPE.BITS,
                 [True],
-                [1],  # 0x00 0x01
+                [256],  # 0x01 0x00
                 None,
             ),
             (
                 ModbusClientMixin.DATATYPE.BITS,
                 [True] + [False] * 15,
-                [1],  # 0x00 0x01
+                [256],  # 0x01 0x00
                 None,
             ),
             (
                 ModbusClientMixin.DATATYPE.BITS,
                 [False] * 8 + [True] + [False] * 7,
-                [256],  # 0x01 0x00
+                [1],  # 0x00 0x01
                 None,
             ),
             (
                 ModbusClientMixin.DATATYPE.BITS,
                 [False] * 15 + [True],
-                [32768],  # 0x80 0x00
+                [128],  # 0x00 0x80
                 None,
             ),
             (
                 ModbusClientMixin.DATATYPE.BITS,
                 [True] + [False] * 14 + [True],
-                [32769],  # 0x80 0x01
+                [384],  # 0x01 0x80
                 None,
             ),
             (
                 ModbusClientMixin.DATATYPE.BITS,
                 [False] * 8 + [True, False, True] + [False] * 5,
-                [1280],  # 0x05 0x00
+                [5],  # 0x00 0x05
                 None,
             ),
             (
                 ModbusClientMixin.DATATYPE.BITS,
                 [True] + [False] * 7 + [True, False, True] + [False] * 5,
-                [1281],  # 0x05 0x01
+                [261],  # 0x01 0x05
                 None,
             ),
             (
                 ModbusClientMixin.DATATYPE.BITS,
                 [True] + [False] * 6 + [True, True, False, True] + [False] * 5,
-                [1409], # 0x05 0x81
+                [33029], # 0x81 0x05
                 None,
             ),
             (
                 ModbusClientMixin.DATATYPE.BITS,
                 [False] * 8 + [True] + [False] * 7 + [True] + [False] * 6 + [True, True, False, True] + [False] * 5,
-                [1409, 256],  # 92340480 = 0x05 0x81 0x01 0x00
+                [1, 33029],  # 92340480 = 0x00 0x01 0x81 0x05
                 None,
             ),
         ],
diff --git a/test/pdu/test_pdu.py b/test/pdu/test_pdu.py
@@ -255,21 +255,21 @@ async def test_pdu_default_datastore(self, mock_context):
     @pytest.mark.parametrize(
         ("bytestream", "bitlist"),
         [
-            (b"\x00\x01", [True] + [False] * 15),
-            (b"\x01\x00", [False] * 8 + [True] + [False] * 7),
-            (b"\x80\x00", [False] * 15 + [True]),
-            (b"\x80\x01", [True] + [False] * 14 + [True]),
-            (b"\x05\x00", [False] * 8 + [True, False, True] + [False] * 5),
-            (b"\x05\x01", [True] + [False] * 7 + [True, False, True] + [False] * 5),
-            (b"\x05\x81", [True] + [False] * 6 + [True, True, False, True] + [False] * 5),
-            (b"\x05\x81\x01\x00", [False] * 8 + [True] + [False] * 7 + [True] + [False] * 6 + [True, True, False, True] + [False] * 5),
+            (b"\x01\x00", [True] + [False] * 15),
+            (b"\x00\x80", [False] * 15 + [True]),
+            (b"\x00\x01", [False] * 8 + [True] + [False] * 7),
+            (b"\x01\x80", [True] + [False] * 14 + [True]),
+            (b"\x00\x05", [False] * 8 + [True, False, True] + [False] * 5),
+            (b"\x01\x05", [True] + [False] * 7 + [True, False, True] + [False] * 5),
+            (b"\x81\x05", [True] + [False] * 6 + [True, True, False, True] + [False] * 5),
+            (b"\x00\x01\x81\x05", [False] * 8 + [True] + [False] * 7 + [True] + [False] * 6 + [True, True, False, True] + [False] * 5),
 
-            (b"\x00\x01", [True]),
-            (b"\x01\x00", [False] * 8 + [True]),
-            (b"\x05\x00", [False] * 8 + [True, False, True]),
-            (b"\x05\x01", [True] + [False] * 7 + [True, False, True]),
-            (b"\x05\x81", [True] + [False] * 6 + [True, True, False, True]),
-            (b"\x05\x81\x01\x00", [False] * 8 + [True] + [False] * 7 + [True] + [False] * 6 + [True, True, False, True]),
+            (b"\x01\x00", [True]),
+            (b"\x00\x01", [False] * 8 + [True]),
+            (b"\x00\x05", [False] * 8 + [True, False, True]),
+            (b"\x01\x05", [True] + [False] * 7 + [True, False, True]),
+            (b"\x81\x05", [True] + [False] * 6 + [True, True, False, True]),
+            (b"\x00\x01\x81\x05", [False] * 8 + [True] + [False] * 7 + [True] + [False] * 6 + [True, True, False, True]),
         ],
     )
     def test_bit_packing(self, bytestream, bitlist):
@@ -280,9 +280,9 @@ def test_bit_packing(self, bytestream, bitlist):
         ("bytestream", "bitlist"),
         [
             (b"\x01", [True]),
-            (b"\x01\x00", [False] * 8 + [True]),
+            (b"\x00\x01", [False] * 8 + [True]),
             (b"\x05", [True, False, True]),
-            (b"\x05\x01", [True] + [False] * 7 + [True, False, True]),
+            (b"\x01\x05", [True] + [False] * 7 + [True, False, True]),
         ],
     )
     def test_bit_packing8(self, bytestream, bitlist):
@@ -293,14 +293,17 @@ def test_bit_packing8(self, bytestream, bitlist):
         ("bytestream", "bitlist"),
         [
             (b"\x01", [True] + [False] * 7),
-            (b"\x00\x01", [True] + [False] * 15),
-            (b"\x01\x00", [False] * 8 + [True] + [False] * 7),
-            (b"\x80\x00", [False] * 15 + [True]),
-            (b"\x80\x01", [True] + [False] * 14 + [True]),
-            (b"\x05\x00", [False] * 8 + [True, False, True] + [False] * 5),
-            (b"\x05\x01", [True] + [False] * 7 + [True, False, True] + [False] * 5),
-            (b"\x05\x81", [True] + [False] * 6 + [True, True, False, True] + [False] * 5),
-            (b"\x05\x81\x01\x00", [False] * 8 + [True] + [False] * 7 + [True] + [False] * 6 + [True, True, False, True] + [False] * 5),
+            (b"\x01\x00", [True] + [False] * 15),
+            (b"\x00\x01", [False] * 8 + [True] + [False] * 7),
+            (b"\x00\x80", [False] * 15 + [True]),
+            (b"\x01\x80", [True] + [False] * 14 + [True]),
+            (b"\x00\x05", [False] * 8 + [True, False, True] + [False] * 5),
+            (b"\x01\x05", [True] + [False] * 7 + [True, False, True] + [False] * 5),
+            (b"\x81\x05", [True] + [False] * 6 + [True, True, False, True] + [False] * 5),
+            (b"\x05\x81\x01\x00", [True, False, True] + [False] * 5 +
+                                  [True] + [False] * 6 + [True] +
+                                  [True] + [False] * 7 +
+                                  [False] * 8),
         ],
     )
     def test_bit_unpacking(self, bytestream, bitlist):
