-
Notifications
You must be signed in to change notification settings - Fork 0
/
StormBreakerSerial.py
316 lines (273 loc) · 10.8 KB
/
StormBreakerSerial.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
"""StormBreaker Serial Communications Protocol and Framework
This script packages received and parsed ArtNet data into data packages that
are ready to be sent to connected microcontrollers.
This script requires at least one active Serial port connected to a USB port.
This file should be imported as a module and contains the following classes:
* StormBreaker
and the following functions outside of classes:
* receive_ident
* receive_serials
* flush_buffer
"""
import sys
import serial
import time
from struct import pack, unpack
from enum import IntEnum
import array as arr
import main as top
# initializes USB serial ports for communication with the Teensy
# serBody = serial.Serial('/dev/ttyUSB0', baudrate=115200, bytesize=8, parity='N', stopbits=1, timeout=5)
if top.TeensyConnection.numTeensy == 1:
try:
if top.options.testing == True:
print("serBody initialization")
serBody = serial.Serial('/dev/ttyUSB0', baudrate=115200, bytesize=8, parity='N', stopbits=1, timeout=5)
except:
try:
serBody = serial.Serial('/dev/ttyUSB1', baudrate=115200, bytesize=8, parity='N', stopbits=1, timeout=5)
print("serial exception, trying USB1")
except:
if top.options.testing == True:
print("DOUBLE serial exception")
try:
serHead = serBody
except:
if top.options.testing == True:
print("both serial ports disconnected")
while True:
if top.options.testing == True:
print("SYS ERROR")
time.sleep(2)
elif top.TeensyConnection.numTeensy == 2:
try:
if top.options.testing == True:
print("serBody initialization")
serBody = serial.Serial('/dev/ttyUSB0', baudrate=115200, bytesize=8, parity='N', stopbits=1, timeout=5)
except:
if top.options.testing == True:
print("ONE TEENSY NOT CONNECTED - check numTeensys")
try:
if top.options.testing == True:
print("serHead initialization")
serHead = serial.Serial('/dev/ttyUSB1', baudrate=115200, bytesize=8, parity='N', stopbits=1, timeout=5)
except:
if top.options.testing == True:
print("SECOND TEENSY NOT CONNECTED - check numTeensys")
else:
if top.options.testing == True:
print("NO TEENSYS CONNECTED - CHECK NUMTEENSYS")
class StormBreaker:
"""StormBreaker Protocol"""
class MsgType(IntEnum):
"""Header enumeration for different messages"""
StormError = -2
StormWarning = -1
StormOK = 0
StormBody = 1
StormHead = 2
StormIdent = 99
class MsgLength(IntEnum):
"""Length of the StormBreaker payload"""
ident = 0
body = 5
head = 14
class Ident(IntEnum):
"""System identification message"""
body = 0xAF
head = 0x50
both_for_testing = 0xB7
# def unpack_storm()
class Headers():
"""Packs the StormBreaker header with relevent information"""
def body():
return pack('>BB', StormBreaker.MsgType.StormBody, StormBreaker.MsgLength.body)
def head():
return pack('>BB', StormBreaker.MsgType.StormHead, StormBreaker.MsgLength.head)
def ident():
return pack('>BB', StormBreaker.MsgType.StormIdent, StormBreaker.MsgLength.ident)
def pack_header(message_type):
"""Packages two bytes in the format of a StormBreaker Header
Parameters
----------
message_type : int
Create a StormBreaker header of this msg type
Returns
-------
bytes object
2 byte packaged header, ready to send
"""
header = {
StormBreaker.MsgType.StormBody: StormBreaker.Headers.body,
StormBreaker.MsgType.StormHead: StormBreaker.Headers.head,
StormBreaker.MsgType.StormIdent: StormBreaker.Headers.ident
}
retrieve_header = header.get(message_type, lambda: "INVALID MESSAGE")
return retrieve_header()
def identify():
"""Identifies connected Teensys as body or head units"""
global serBody, serHead
ident_message = StormBreaker.Headers.pack_header(StormBreaker.MsgType.StormIdent)
serBody.write(ident_message)
time.sleep(0.1)
check1 = receive_ident(True)
# Send ident to head
serHead.write(ident_message)
time.sleep(0.1)
check2 = receive_ident(False)
if top.options.testing == True:
print("check1 = ")
print(check1)
print("check2 = ")
print(check2)
if check1 == False and check2 == False:
serBuff = serBody
serBody = serHead
serHead = serBuff
if check1 == None or check2 == None:
if top.options.testing == True:
print("Identity check failed")
def send(data, body, head):
"""Sends the StormBreaker package to destination microcontrollers"""
if head == True:
if top.options.debugging == True:
print("Sending head frame")
if top.options.LX1 == True: # according to LX1 DMX spec:
strobe_shutter = data[0]
iris = data[20]
zoom = (data[21] << 8) | data[22]
focus = (data[23] << 8) | data[24]
tilt = (data[27] << 8) | data[28]
tilt_control = data[30]
pan_tilt_speed = data[31]
power_special_functions = data[32]
led_ring_red = data[33]
led_ring_green = data[34]
led_ring_blue = data[35]
else:
# change these variables to change packet data for system testing
strobe_shutter = data[23]
iris = data[125]
zoom = 42
focus = 69
tilt = (data[3] << 8) | data[4]
tilt_control = 0
pan_tilt_speed = 200
power_special_functions = 0
led_ring_red = 128
led_ring_green = 128
led_ring_blue = 128
serHead.write(StormBreaker.Headers.pack_header(StormBreaker.MsgType.StormHead))
serHead.write(pack('>B', strobe_shutter))
serHead.write(pack('>B', iris))
serHead.write(pack('>B', zoom >> 8))
serHead.write(pack('>B', zoom & 0xFF))
serHead.write(pack('>B', focus >> 8))
serHead.write(pack('>B', focus & 0xFF))
serHead.write(pack('>B', tilt >> 8))
serHead.write(pack('>B', tilt & 0xFF))
serHead.write(pack('>B', tilt_control))
serHead.write(pack('>B', pan_tilt_speed))
serHead.write(pack('>B', power_special_functions))
serHead.write(pack('>B', led_ring_red))
serHead.write(pack('>B', led_ring_green))
serHead.write(pack('>B', led_ring_blue))
if top.options.debugging == True:
print("Head Data: ")
print(strobe_shutter)
print(iris)
print(zoom)
print(focus)
print(tilt)
print(tilt_control)
print(pan_tilt_speed)
print(power_special_functions)
print(led_ring_red)
print(led_ring_green)
print(led_ring_blue)
if body == True:
if top.options.debugging == True:
print("Sending body frame")
if top.options.LX1 == True: # According to LX1 DMX specs
pan = (data[25] << 8) | data[26]
pan_control = data[29]
pan_tilt_speed = data[31]
power_special_functions = data[32]
else:
# change these variables to change packet data for system testing
pan = (data[3] << 8) | data[4] # 0 - 65535
pan_control = 1 # 0 - 255
pan_tilt_speed = 200 # 0 - 255
power_special_functions = 0 # 0 - 255
serBody.write(StormBreaker.Headers.pack_header(StormBreaker.MsgType.StormBody))
serBody.write(pack('>B', pan >> 8))
serBody.write(pack('>B', pan & 0xFF))
serBody.write(pack('>B', pan_control))
serBody.write(pack('>B', pan_tilt_speed))
serBody.write(pack('>B', power_special_functions))
if top.options.debugging == True:
print("Body Data: ")
print(pan)
print(pan_control)
print(pan_tilt_speed)
print(power_special_functions)
def receive(body, head):
"""Receives StormBreaker messages from connected microcontrollers"""
if head == True:
while serHead.in_waiting > 0:
while serHead.in_waiting > 0:
line = serHead.readline().strip()
if top.options.testing == True:
print(line)
time.sleep(0.01)
if body == True:
while serBody.in_waiting > 0:
while serBody.in_waiting > 0:
line = serBody.readline().strip
if top.options.testing == True:
print(line)
time.sleep(0.01)
def receive_ident(body):
if body == True:
while serBody.in_waiting == 0:
time.sleep(0.01)
line = serBody.readline().strip()
if top.options.testing == True:
print(line)
if line == pack('>B', StormBreaker.Ident.body):
return True
elif line == pack('>B', StormBreaker.Ident.head):
return False
else:
return None
else:
while serHead.in_waiting == 0:
time.sleep(0.01)
line = serHead.readline().strip()
if top.options.testing == True:
print(line)
if line == pack('>B', StormBreaker.Ident.head):
return True
elif line == pack('>B', StormBreaker.Ident.body):
return False
else:
return None
def receive_serials():
while serBody.in_waiting > 0:
while serBody.in_waiting > 0:
line = serBody.readline()
if top.options.testing == True:
print(line)
time.sleep(0.01)
while serHead.in_waiting > 0:
while serHead.in_waiting > 0:
line = serHead.readline()
if top.options.testing == True:
print(line)
time.sleep(0.01)
def flush_buffer():
serBody.reset_input_buffer()
serHead.reset_input_buffer()
serBody.reset_output_buffer()
serHead.reset_output_buffer()
time.sleep(0.1)