Skip to content

Correct byte order in bits. #2631

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 9, 2025
Merged

Correct byte order in bits. #2631

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e93e707
Correct byte order in bits.
janiversen Apr 9, 2025
f71730e
pylint.
janiversen Apr 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 13 additions & 14 deletions pymodbus/pdu/pdu.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,14 +164,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


Expand All @@ -183,13 +184,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
16 changes: 8 additions & 8 deletions test/client/test_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,49 +139,49 @@ def fake_execute(_self, _no_response_expected, request):
(
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,
),
],
Expand Down
51 changes: 27 additions & 24 deletions test/pdu/test_pdu.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand All @@ -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):
Expand All @@ -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):
Expand Down