-
Notifications
You must be signed in to change notification settings - Fork 1
/
modbus_packets.py
379 lines (342 loc) · 13 KB
/
modbus_packets.py
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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""EZT570i Modbus packets
By John Stile At Meyer Sound Laboratories Inc.
this is distributed under a MIT license, see LICENSE
"""
import binascii # for human readable access to bit packed data
import ctypes # to access binary packed data in calibration file
def write_profile_factory(register_count):
"""Use factory to return properly sized structure
which depends on the register_count parameter"""
class WriteProfileSend(ctypes.BigEndianStructure):
"""For Profile Download only, to transmit profile data one step at a time.
SEE "Profile Parameters" section for a list of all registers.
The EZT-570i will respond to each message received, but not executed.
Write Register Send Packet:
nn | nn | nn nn | nn nn | nn | nn nn ... nn nn | nn nn
0x01 0x10 | | 0x00 0x0F 0x1E | | | | | |
address ___| | | | | | | | | | | | |
command ________| | | | | | | | | | | |
reg high byte _______| | | | | | | | | | |
reg low byte __________| | | | | | | | | |
quantity to write high byte _| | | | | | | | |
quantity to write low byte ______| | | | | | | |
quantity of data bytes ________________| | | | | | |
data 1 high byte ____________________________| | | | | |
data 1 low byte ________________________________| | | | |
... | | | |
... | | | |
data 15 high byte _____________________________________| | | |
data 15 low byte _________________________________________| | |
crc low byte___________________________________________________| |
crc high byte ____________________________________________________|
"""
_pack_ = 1 # Do not align on word boundary, interferes with debug logs
_fields_ = [
("address", ctypes.c_uint8), # Address
("command", ctypes.c_uint8), # Command
("reg", ctypes.c_uint16), # Register
("quantity", ctypes.c_uint16), # Quantity of registers (15)
("dsize", ctypes.c_uint8), # Data size in bytes (30)
("data", ctypes.c_int16 * register_count), # Dynamic
("crc", ctypes.c_uint16), # 16bit crc
]
def __init__(self, data_count):
super(WriteProfileSend, self).__init__()
self.data_count = data_count
def __repr__(self):
return (
(
"\n"
"address:{}\n"
"command:{}\n"
"reg:{}\n"
"quantity:{}\n"
"dsize:{}\n"
"data:{}\n"
"crc:{}"
).format(
self.address,
self.command,
self.reg,
self.quantity,
self.dsize,
self.data,
self.crc
)
)
def __str__(self):
"""human readable data"""
data_hex_string = binascii.hexlify(self.data)
return (
(
'\n'
'\tAddress: {:02X}\n'
'\tCommand: {:02X}\n'
'\tRegister:{:04X}\n'
'\tQuantity:{:04X}\n'
'\tDSize: {:02X}\n'
'\tData: {}\n'
'\tCRC: {:04X}'
).format(
self.address,
self.command,
self.reg,
self.quantity,
self.dsize,
data_hex_string,
self.crc
)
)
return WriteProfileSend(register_count)
class WriteProfileResponse(ctypes.Structure):
"""For Profile Download only, response packet from valid write:
nn | nn | nn nn | nn nn | nn nn
0x01 0x10 | | 0x00 0x0F | |
address ___| | | | | | | |
command ________| | | | | | |
reg high byte _______| | | | | |
reg low byte __________| | | | |
quantity to write high byte _| | | |
quantity to write low byte ______| | |
crc low byte ___________________________| |
crc high byte _____________________________|
"""
_pack_ = 1 # Do not align on word boundary, interferes with debug logs
_fields_ = [
("address", ctypes.c_uint8), # Address
("command", ctypes.c_uint8), # Command
("reg", ctypes.c_uint16), # Register
("qty", ctypes.c_uint16), # Number written
("crc", ctypes.c_uint16), # 16bit
]
def __repr__(self):
return (
(
"\n"
"address:{}\n"
"command:{}\n"
"reg:{}\n"
"qty:{}\n"
"crc:{}"
).format(
self.address,
self.command,
self.reg,
self.qty,
self.crc
)
)
def __str__(self):
"""human readable data"""
return (
(
'\n'
'\tAddress: {:02X}\n'
'\tCommand: {:02X}\n'
'\tRegister:{:04X}\n'
'\tQty: {:04X}\n'
'\tCRC: {:04X}'
).format(
self.address,
self.command,
self.reg,
self.qty,
self.crc
)
)
class WriteRegister(ctypes.BigEndianStructure):
"""Write value to single register, for setting control values.
To set multiple values, repeat the command for each data location.
Since Send and Response packets are the same format,
use this class for both
Write Register Send Packet:
nn | nn | nn nn | nn nn | nn nn
0x01 0x06 | | | | | |
address ___| | | | | | | |
command ________| | | | | | |
reg high byte _______| | | | | |
reg low byte __________| | | | |
data high byte ______________| | | |
data low byte __________________| | |
crc low byte_________________________| |
crc high byte __________________________|
Example 1: Write register 60 (temperature set point) of address 01 to 20 degrees.
Sent: 01 06 00 3C 00 C8 48 50
NOTE: might want to test with light, as it won't effect running test.
--> r/w 21 (0x0015), Chamber Light Control, 0 = Light Off, 1=Light On
Sent: 01 06 00 15 00 01 <crc>
"""
_pack_ = 1 # Do not align on word boundary, interferes with debug logs
_fields_ = [
("address", ctypes.c_uint8), # Address
("command", ctypes.c_uint8), # Command
("reg", ctypes.c_uint16), # Register
("value", ctypes.c_uint16), # Set Value
("crc", ctypes.c_uint16), # 16bit crc
]
def __repr__(self):
return (
(
"\n"
"address:{}\n"
"command:{}\n"
"reg:{}\n"
"value:{}\n"
"crc:{}"
).format(
self.address,
self.command,
self.reg,
self.value,
self.crc
)
)
def __str__(self):
"""human readable data"""
return (
(
'\n'
'\tAddress: {:02X}\n'
'\tCommand: {:02X}\n'
'\tRegister:{:04X}\n'
'\tValue: {:04X}\n'
'\tCRC: {:04X}\n'
).format(
self.address,
self.command,
self.reg,
self.value,
self.crc
)
)
class ReadRegistersSend(ctypes.BigEndianStructure):
"""Read Register Send packet:
nn | nn | nn nn nn nn | nn nn
0x01 0x03 | | | | | |
address ___| | | | | | | |
command ________| | | | | | |
start reg high byte _| | | | | |
start reg low byte ____| | | | |
quantity to read high byte | | | |
quantity to read low byte ____| | |
crc low byte ______________________| |
crc high byte ________________________|
Example 1: Read register 61 (chamber temperature) of controller at address 1.
Sent: 01 03 00 3D 00 01 15 C6
"""
_pack_ = 1 # Do not align on word boundary, interferes with debug logs
_fields_ = [
("address", ctypes.c_uint8), # Address
("command", ctypes.c_uint8), # Command
("reg", ctypes.c_uint16), # Register
("quantity", ctypes.c_uint16), # Quantity of Registers to read
("crc", ctypes.c_uint16), # 16bit crc
]
def __repr__(self):
return (
(
"\n"
"address:{}\n"
"command:{}\n"
"reg:{}\n"
"quantity:{}\n"
"crc:{}"
).format(
self.address,
self.command,
self.reg,
self.quantity,
self.crc
)
)
def __str__(self):
"""human readable data"""
return (
(
'\n'
'\tAddress: {:02X}\n'
'\tCommand: {:02X}\n'
'\tRegister:{:04X}\n'
'\tQuantity:{:04X}\n'
'\tCRC: {:04X}'
).format(
self.address,
self.command,
self.reg,
self.quantity,
self.crc
)
)
def read_response_factory(quantity):
"""Use factory to return properly sized structure
which depends on the byte_count parameter"""
class ReadRegisterReceive(ctypes.BigEndianStructure):
"""Read Register Receive Packet:
nn | nn | nn | nn nn .. .. | nn nn
0x01 0x03 | | | | | | |
address ___| | | | | | | | |
command ________| | | | | | | |
number of of bytes __| | | | | | |
value reg high byte ______| | | | | |
value reg low byte _________| | | | |
... next value reg high ________| | | |
... next value reg low ____________| | |
crc low byte ___________________________| |
crc high byte _____________________________|
Example 1: Read register 61 (chamber temperature) of controller at address 1.
Received: 01 03 02 00 EC B9 C9
"""
_pack_ = 1 # Do not align on word boundary, interferes with debug logs
_fields_ = [
("address", ctypes.c_uint8), # Address
("command", ctypes.c_uint8), # Command
("number", ctypes.c_uint8), # Number of values
("data", ctypes.c_int16 * quantity), # Dynamic
("crc", ctypes.c_uint16), # 16bit crc
]
def __init__(self, quantity):
super(ReadRegisterReceive, self).__init__()
self.quantity = quantity
def __repr__(self):
return (
(
"\n"
"address:{}\n"
"command:{}\n"
"number:{}\n"
"data:{}\n"
"crc:{}"
).format(
self.address,
self.command,
self.number,
self.data,
self.crc
)
)
def __str__(self):
"""human readable data"""
#TODO: NEED BETTER WAY TO HANDLE DYNAMIC NATURE OF THIS
#data_hex_string = ''.join('{}'.format(b) for b in self.data)
#data_celcius = int(data_hex_string)/10.0
#data_hex_string = ''.join('{}'.format(b) for b in self.data)
data_hex_string = binascii.hexlify(self.data)
return (
(
'\n'
'\tAddress:{:02X}\n'
'\tCommand:{:02X}\n'
'\tNumber: {:02X}\n'
'\tData: {}\n'
'\tCRC: {:04X}'
).format(
self.address,
self.command,
self.number,
data_hex_string,
self.crc
)
)
return ReadRegisterReceive(quantity)