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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
#!/usr/bin/env python
'''
Bit Message Test Fixture
--------------------------------
This fixture tests the functionality of all the
bit based request/response messages:
* Read/Write Discretes
* Read Coils
'''
import unittest
from pymodbus.file_message import *
from pymodbus.exceptions import *
from pymodbus.pdu import ModbusExceptions
from .modbus_mocks import MockContext
#---------------------------------------------------------------------------#
# Fixture
#---------------------------------------------------------------------------#
class ModbusBitMessageTests(unittest.TestCase):
#-----------------------------------------------------------------------#
# Setup/TearDown
#-----------------------------------------------------------------------#
def setUp(self):
'''
Initializes the test environment and builds request/result
encoding pairs
'''
pass
def tearDown(self):
''' Cleans up the test environment '''
pass
#-----------------------------------------------------------------------#
# Read Fifo Queue
#-----------------------------------------------------------------------#
def testReadFifoQueueRequestEncode(self):
''' Test basic bit message encoding/decoding '''
handle = ReadFifoQueueRequest(0x1234)
result = handle.encode()
self.assertEqual(result, b'\x12\x34')
def testReadFifoQueueRequestDecode(self):
''' Test basic bit message encoding/decoding '''
handle = ReadFifoQueueRequest(0x0000)
handle.decode(b'\x12\x34')
self.assertEqual(handle.address, 0x1234)
def testReadFifoQueueRequest(self):
''' Test basic bit message encoding/decoding '''
context = MockContext()
handle = ReadFifoQueueRequest(0x1234)
result = handle.execute(context)
self.assertTrue(isinstance(result, ReadFifoQueueResponse))
handle.address = -1
result = handle.execute(context)
self.assertEqual(ModbusExceptions.IllegalValue,
result.exception_code)
handle.values = [0x00]*33
result = handle.execute(context)
self.assertEqual(ModbusExceptions.IllegalValue,
result.exception_code)
def testReadFifoQueueRequestError(self):
''' Test basic bit message encoding/decoding '''
context = MockContext()
handle = ReadFifoQueueRequest(0x1234)
handle.values = [0x00]*32
result = handle.execute(context)
self.assertEqual(result.function_code, 0x98)
def testReadFifoQueueResponseEncode(self):
''' Test that the read fifo queue response can encode '''
message = b'\x00\n\x00\x08\x00\x01\x00\x02\x00\x03\x00\x04'
handle = ReadFifoQueueResponse([1,2,3,4])
result = handle.encode()
self.assertEqual(result, message)
def testReadFifoQueueResponseDecode(self):
''' Test that the read fifo queue response can decode '''
message = b'\x00\n\x00\x08\x00\x01\x00\x02\x00\x03\x00\x04'
handle = ReadFifoQueueResponse([1,2,3,4])
handle.decode(message)
self.assertEqual(handle.values, [1,2,3,4])
def testRtuFrameSize(self):
''' Test that the read fifo queue response can decode '''
message = b'\x00\n\x00\x08\x00\x01\x00\x02\x00\x03\x00\x04'
result = ReadFifoQueueResponse.calculateRtuFrameSize(message)
self.assertEqual(result, 14)
#-----------------------------------------------------------------------#
# File Record
#-----------------------------------------------------------------------#
def testFileRecordLength(self):
''' Test file record length generation '''
record = FileRecord(file_number=0x01, record_number=0x02,
record_data=b'\x00\x01\x02\x04')
self.assertEqual(record.record_length, 0x02)
self.assertEqual(record.response_length, 0x05)
def testFileRecordComapre(self):
''' Test file record comparison operations '''
record1 = FileRecord(file_number=0x01, record_number=0x02, record_data=b'\x00\x01\x02\x04')
record2 = FileRecord(file_number=0x01, record_number=0x02, record_data=b'\x00\x0a\x0e\x04')
record3 = FileRecord(file_number=0x02, record_number=0x03, record_data=b'\x00\x01\x02\x04')
record4 = FileRecord(file_number=0x01, record_number=0x02, record_data=b'\x00\x01\x02\x04')
self.assertTrue(record1 == record4)
self.assertTrue(record1 != record2)
self.assertNotEqual(record1, record2)
self.assertNotEqual(record1, record3)
self.assertNotEqual(record2, record3)
self.assertEqual(record1, record4)
self.assertEqual(str(record1), "FileRecord(file=1, record=2, length=2)")
self.assertEqual(str(record2), "FileRecord(file=1, record=2, length=2)")
self.assertEqual(str(record3), "FileRecord(file=2, record=3, length=2)")
#-----------------------------------------------------------------------#
# Read File Record Request
#-----------------------------------------------------------------------#
def testReadFileRecordRequestEncode(self):
''' Test basic bit message encoding/decoding '''
records = [FileRecord(file_number=0x01, record_number=0x02)]
handle = ReadFileRecordRequest(records)
result = handle.encode()
self.assertEqual(result, b'\x07\x06\x00\x01\x00\x02\x00\x00')
def testReadFileRecordRequestDecode(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)
self.assertEqual(handle.records[0], record)
def testReadFileRecordRequestRtuFrameSize(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)
self.assertEqual(size, 0x0e + 5)
def testReadFileRecordRequestExecute(self):
''' Test basic bit message encoding/decoding '''
handle = ReadFileRecordRequest()
result = handle.execute(None)
self.assertTrue(isinstance(result, ReadFileRecordResponse))
#-----------------------------------------------------------------------#
# Read File Record Response
#-----------------------------------------------------------------------#
def testReadFileRecordResponseEncode(self):
''' Test basic bit message encoding/decoding '''
records = [FileRecord(record_data=b'\x00\x01\x02\x03')]
handle = ReadFileRecordResponse(records)
result = handle.encode()
self.assertEqual(result, b'\x06\x06\x02\x00\x01\x02\x03')
def testReadFileRecordResponseDecode(self):
''' Test basic bit message encoding/decoding '''
record = FileRecord(file_number=0x00, record_number=0x00,
record_data=b'\x0d\xfe\x00\x20')
request = b'\x0c\x05\x06\x0d\xfe\x00\x20\x05\x05\x06\x33\xcd\x00\x40'
handle = ReadFileRecordResponse()
handle.decode(request)
self.assertEqual(handle.records[0], record)
def testReadFileRecordResponseRtuFrameSize(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)
self.assertEqual(size, 0x0c + 5)
#-----------------------------------------------------------------------#
# Write File Record Request
#-----------------------------------------------------------------------#
def testWriteFileRecordRequestEncode(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()
self.assertEqual(result, b'\x0b\x06\x00\x01\x00\x02\x00\x02\x00\x01\x02\x03')
def testWriteFileRecordRequestDecode(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)
self.assertEqual(handle.records[0], record)
def testWriteFileRecordRequestRtuFrameSize(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)
self.assertEqual(size, 0x0d + 5)
def testWriteFileRecordRequestExecute(self):
''' Test basic bit message encoding/decoding '''
handle = WriteFileRecordRequest()
result = handle.execute(None)
self.assertTrue(isinstance(result, WriteFileRecordResponse))
#-----------------------------------------------------------------------#
# Write File Record Response
#-----------------------------------------------------------------------#
def testWriteFileRecordResponseEncode(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()
self.assertEqual(result, b'\x0b\x06\x00\x01\x00\x02\x00\x02\x00\x01\x02\x03')
def testWriteFileRecordResponseDecode(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)
self.assertEqual(handle.records[0], record)
def testWriteFileRecordResponseRtuFrameSize(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)
self.assertEqual(size, 0x0d + 5)
#---------------------------------------------------------------------------#
# Main
#---------------------------------------------------------------------------#
if __name__ == "__main__":
unittest.main()
|
