1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
"""Bit Message Test Fixture.
This fixture tests the functionality of all the
bit based request/response messages:
* Read/Write Discretes
* Read Coils
"""
import pytest
from pymodbus.exceptions import ModbusException
from pymodbus.pdu.file_message import (
FileRecord,
ReadFifoQueueRequest,
ReadFifoQueueResponse,
ReadFileRecordRequest,
ReadFileRecordResponse,
WriteFileRecordRequest,
WriteFileRecordResponse,
)
TEST_MESSAGE = b"\x00\n\x00\x08\x00\x01\x00\x02\x00\x03\x00\x04"
class TestBitMessage:
"""Modbus bit message tests."""
def test_read_fifo_queue_request_encode(self):
"""Test basic bit message encoding/decoding."""
handle = ReadFifoQueueRequest(0x1234)
result = handle.encode()
assert result == b"\x12\x34"
def test_read_fifo_queue_request_decode(self):
"""Test basic bit message encoding/decoding."""
handle = ReadFifoQueueRequest(0x0000)
handle.decode(b"\x12\x34")
assert handle.address == 0x1234
async def test_read_fifo_queue_request(self, mock_context):
"""Test basic bit message encoding/decoding."""
context = mock_context()
handle = ReadFifoQueueRequest(0x1234)
result = await handle.update_datastore(context)
assert isinstance(result, ReadFifoQueueResponse)
def test_read_fifo_queue_response_encode(self):
"""Test that the read fifo queue response can encode."""
message = TEST_MESSAGE
handle = ReadFifoQueueResponse([1, 2, 3, 4])
result = handle.encode()
assert result == message
def test_read_fifo_queue_response_decode(self):
"""Test that the read fifo queue response can decode."""
message = TEST_MESSAGE
handle = ReadFifoQueueResponse([1, 2, 3, 4])
handle.decode(message)
assert handle.values == [1, 2, 3, 4]
def test_frame_size(self):
"""Test that the read fifo queue response can decode."""
message = TEST_MESSAGE
result = ReadFifoQueueResponse.calculateRtuFrameSize(message)
assert result == 14
# -----------------------------------------------------------------------#
# File Record
# -----------------------------------------------------------------------#
def test_file_record_length(self):
"""Test file record length generation."""
record = FileRecord(
file_number=0x01, record_number=0x02, record_data=b"\x00\x01\x02\x04"
)
assert record.record_length == 0x02
def test_file_record_errors(self):
"""Test file record length generation."""
with pytest.raises(ModbusException):
FileRecord(record_length=12, record_data=b"\x00\x01\x02\x04")
with pytest.raises(ModbusException):
FileRecord(record_length=11)
def test_read_file_record_request_encode(self):
"""Test basic bit message encoding/decoding."""
records = [FileRecord(file_number=0x01, record_number=0x02)]
handle = ReadFileRecordRequest(records=records)
result = handle.encode()
assert result == b"\x07\x06\x00\x01\x00\x02\x00\x00"
def test_read_file_record_request_decode(self):
"""Test basic bit message encoding/decoding."""
# record = FileRecord(file_number=0x04, record_number=0x01, record_length=0x02)
request = b"\x0e\x06\x00\x04\x00\x01\x00\x02\x06\x00\x03\x00\x09\x00\x02"
handle = ReadFileRecordRequest()
handle.decode(request)
# assert handle.records[0] == record
def test_read_file_record_request_frame_size(self):
"""Test basic bit message encoding/decoding."""
request = (
b"\x00\x00\x0e\x06\x00\x04\x00\x01\x00\x02\x06\x00\x03\x00\x09\x00\x02"
)
handle = ReadFileRecordRequest()
size = handle.calculateRtuFrameSize(request)
assert size == 0x0E + 5
async def test_read_file_record_request_update_datastore(self):
"""Test basic bit message encoding/decoding."""
handle = ReadFileRecordRequest()
result = await handle.update_datastore(None)
assert isinstance(result, ReadFileRecordResponse)
# -----------------------------------------------------------------------#
# Read File Record Response
# -----------------------------------------------------------------------#
def test_read_file_record_response_encode(self):
"""Test basic bit message encoding/decoding."""
records = [FileRecord(record_data=b"\x00\x01\x02\x03\x04\x05")]
handle = ReadFileRecordResponse(records)
result = handle.encode()
assert result == b"\x08\x07\x06\x00\x01\x02\x03\x04\x05"
def test_read_file_record_response_decode(self):
"""Test basic bit message encoding/decoding."""
# record1 = FileRecord(
# file_number=0x00, record_number=0x00, record_data=b"\x0d\xfe\x00\x20"
# )
# record2 = FileRecord(
# file_number=0x00, record_number=0x00, record_data=b"\x33\xcd\x00\x40"
# )
response = b"\x0c\x05\x06\x0d\xfe\x00\x20\x05\x06\x33\xcd\x00\x40"
handle = ReadFileRecordResponse()
handle.decode(response)
# assert handle.records[0] == record1
# ssert handle.records[1] == record2
def test_read_file_record_response_frame_size(self):
"""Test basic bit message encoding/decoding."""
request = b"\x00\x00\x0c\x05\x06\x0d\xfe\x00\x20\x05\x05\x06\x33\xcd\x00\x40"
handle = ReadFileRecordResponse()
size = handle.calculateRtuFrameSize(request)
assert size == 0x0C + 5
# -----------------------------------------------------------------------#
# Write File Record Request
# -----------------------------------------------------------------------#
def test_write_file_record_request_encode(self):
"""Test basic bit message encoding/decoding."""
records = [
FileRecord(
file_number=0x01, record_number=0x02, record_data=b"\x00\x01\x02\x03"
)
]
handle = WriteFileRecordRequest(records)
result = handle.encode()
assert result == b"\x0b\x06\x00\x01\x00\x02\x00\x02\x00\x01\x02\x03"
def test_write_file_record_request_decode(self):
"""Test basic bit message encoding/decoding."""
# record = FileRecord(
# file_number=0x04,
# record_number=0x07,
# record_data=b"\x06\xaf\x04\xbe\x10\x0d",
# )
request = b"\x0d\x06\x00\x04\x00\x07\x00\x03\x06\xaf\x04\xbe\x10\x0d"
handle = WriteFileRecordRequest()
handle.decode(request)
# assert handle.records[0] == record
def test_write_file_record_request_frame_size(self):
"""Test write file record request rtu frame size calculation."""
request = b"\x00\x00\x0d\x06\x00\x04\x00\x07\x00\x03\x06\xaf\x04\xbe\x10\x0d"
handle = WriteFileRecordRequest()
size = handle.calculateRtuFrameSize(request)
assert size == 0x0D + 5
async def test_write_file_record_request_update_datastore(self):
"""Test basic bit message encoding/decoding."""
handle = WriteFileRecordRequest()
result = await handle.update_datastore(None)
assert isinstance(result, WriteFileRecordResponse)
# -----------------------------------------------------------------------#
# Write File Record Response
# -----------------------------------------------------------------------#
def test_write_file_record_response_encode(self):
"""Test basic bit message encoding/decoding."""
records = [
FileRecord(
file_number=0x01, record_number=0x02, record_data=b"\x00\x01\x02\x03"
)
]
handle = WriteFileRecordResponse(records)
result = handle.encode()
assert result == b"\x0b\x06\x00\x01\x00\x02\x00\x02\x00\x01\x02\x03"
def test_write_file_record_response_decode(self):
"""Test basic bit message encoding/decoding."""
# record = FileRecord(
# file_number=0x04,
# record_number=0x07,
# record_data=b"\x06\xaf\x04\xbe\x10\x0d",
# )
request = b"\x0d\x06\x00\x04\x00\x07\x00\x03\x06\xaf\x04\xbe\x10\x0d"
handle = WriteFileRecordResponse()
handle.decode(request)
# assert handle.records[0] == record
def test_write_file_record_response_frame_size(self):
"""Test write file record response rtu frame size calculation."""
request = b"\x00\x00\x0d\x06\x00\x04\x00\x07\x00\x03\x06\xaf\x04\xbe\x10\x0d"
handle = WriteFileRecordResponse()
size = handle.calculateRtuFrameSize(request)
assert size == 0x0D + 5
|
