author | Tero Marttila <terom@paivola.fi> |
Thu, 29 Jan 2015 23:11:44 +0200 | |
changeset 107 | 05707929ff6f |
parent 90 | 13c2deb919d1 |
permissions | -rw-r--r-- |
74 | 1 |
import collections |
2 |
import logging; log = logging.getLogger('qmsk.dmx.control') |
|
3 |
import serial |
|
4 |
||
83
136e210fce82
qmsk.dmx: new Head-based model/view; output/updates not yet implemented
Tero Marttila <terom@paivola.fi>
parents:
74
diff
changeset
|
5 |
""" |
136e210fce82
qmsk.dmx: new Head-based model/view; output/updates not yet implemented
Tero Marttila <terom@paivola.fi>
parents:
74
diff
changeset
|
6 |
Low-level DMX channel output. |
136e210fce82
qmsk.dmx: new Head-based model/view; output/updates not yet implemented
Tero Marttila <terom@paivola.fi>
parents:
74
diff
changeset
|
7 |
""" |
136e210fce82
qmsk.dmx: new Head-based model/view; output/updates not yet implemented
Tero Marttila <terom@paivola.fi>
parents:
74
diff
changeset
|
8 |
|
74 | 9 |
class DMXError (Exception) : |
10 |
def __init__ (self, **kwargs) : |
|
11 |
self.kwargs = kwargs |
|
12 |
||
13 |
def __str__ (self) : |
|
14 |
return self.__doc__.strip().format(**self.kwargs) |
|
15 |
||
16 |
class DMXCommandError (DMXError) : |
|
17 |
""" |
|
18 |
Command {cmd!r} failed: {out!r} |
|
19 |
""" |
|
20 |
||
21 |
class DMXUnknownCommandError (DMXError) : |
|
22 |
""" |
|
23 |
Unknown command: {cmd!r} |
|
24 |
""" |
|
25 |
||
26 |
class DMX (object) : |
|
27 |
""" |
|
28 |
Arudino-based DMX controller using src/hello-dmx.c over the serial port. |
|
29 |
""" |
|
30 |
||
31 |
SERIAL = '/dev/arduino' |
|
32 |
SERIAL_BAUD = 9600 |
|
33 |
||
34 |
@classmethod |
|
90
13c2deb919d1
qmsk.dmx.control: python3; remove broken serial timeout, quickfix startup dual-sync
Tero Marttila <terom@paivola.fi>
parents:
87
diff
changeset
|
35 |
def open (cls, path, baud=SERIAL_BAUD) : |
13c2deb919d1
qmsk.dmx.control: python3; remove broken serial timeout, quickfix startup dual-sync
Tero Marttila <terom@paivola.fi>
parents:
87
diff
changeset
|
36 |
return cls(serial.Serial(path, baud)) |
74 | 37 |
|
38 |
def __init__ (self, io) : |
|
39 |
self.io = io |
|
90
13c2deb919d1
qmsk.dmx.control: python3; remove broken serial timeout, quickfix startup dual-sync
Tero Marttila <terom@paivola.fi>
parents:
87
diff
changeset
|
40 |
|
13c2deb919d1
qmsk.dmx.control: python3; remove broken serial timeout, quickfix startup dual-sync
Tero Marttila <terom@paivola.fi>
parents:
87
diff
changeset
|
41 |
# XXX: sync initial line |
13c2deb919d1
qmsk.dmx.control: python3; remove broken serial timeout, quickfix startup dual-sync
Tero Marttila <terom@paivola.fi>
parents:
87
diff
changeset
|
42 |
self.sync() |
13c2deb919d1
qmsk.dmx.control: python3; remove broken serial timeout, quickfix startup dual-sync
Tero Marttila <terom@paivola.fi>
parents:
87
diff
changeset
|
43 |
self.sync() |
74 | 44 |
|
90
13c2deb919d1
qmsk.dmx.control: python3; remove broken serial timeout, quickfix startup dual-sync
Tero Marttila <terom@paivola.fi>
parents:
87
diff
changeset
|
45 |
def sync (self) : |
13c2deb919d1
qmsk.dmx.control: python3; remove broken serial timeout, quickfix startup dual-sync
Tero Marttila <terom@paivola.fi>
parents:
87
diff
changeset
|
46 |
""" |
13c2deb919d1
qmsk.dmx.control: python3; remove broken serial timeout, quickfix startup dual-sync
Tero Marttila <terom@paivola.fi>
parents:
87
diff
changeset
|
47 |
XXX: startup sync |
13c2deb919d1
qmsk.dmx.control: python3; remove broken serial timeout, quickfix startup dual-sync
Tero Marttila <terom@paivola.fi>
parents:
87
diff
changeset
|
48 |
""" |
13c2deb919d1
qmsk.dmx.control: python3; remove broken serial timeout, quickfix startup dual-sync
Tero Marttila <terom@paivola.fi>
parents:
87
diff
changeset
|
49 |
|
13c2deb919d1
qmsk.dmx.control: python3; remove broken serial timeout, quickfix startup dual-sync
Tero Marttila <terom@paivola.fi>
parents:
87
diff
changeset
|
50 |
self.io.write(b'\r') |
74 | 51 |
self.io.flush() |
52 |
self.io.read(1) |
|
53 |
||
54 |
def _arg (self, arg) : |
|
87
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
55 |
""" |
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
56 |
Format given value as a protocol argument. |
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
57 |
""" |
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
58 |
|
74 | 59 |
if isinstance(arg, str) : |
60 |
value, = arg |
|
61 |
value = ord(value) |
|
62 |
elif isinstance(arg, int) : |
|
63 |
value = arg |
|
64 |
else : |
|
65 |
raise ValueError(arg) |
|
66 |
||
67 |
if 0 <= value <= 255 : |
|
90
13c2deb919d1
qmsk.dmx.control: python3; remove broken serial timeout, quickfix startup dual-sync
Tero Marttila <terom@paivola.fi>
parents:
87
diff
changeset
|
68 |
return str(value).encode('ascii') |
74 | 69 |
else : |
70 |
raise ValueError(value) |
|
71 |
||
87
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
72 |
def __iter__ (self) : |
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
73 |
""" |
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
74 |
Read command responses back. |
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
75 |
""" |
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
76 |
|
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
77 |
while True: |
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
78 |
yield self.io.readline() |
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
79 |
|
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
80 |
def __call__ (self, cmd, *args, **opts) : |
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
81 |
""" |
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
82 |
|
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
83 |
<chr> [<int> [...]] |
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
84 |
""" |
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
85 |
|
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
86 |
# XXX: |
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
87 |
poll = opts.pop('poll', True) |
90
13c2deb919d1
qmsk.dmx.control: python3; remove broken serial timeout, quickfix startup dual-sync
Tero Marttila <terom@paivola.fi>
parents:
87
diff
changeset
|
88 |
|
13c2deb919d1
qmsk.dmx.control: python3; remove broken serial timeout, quickfix startup dual-sync
Tero Marttila <terom@paivola.fi>
parents:
87
diff
changeset
|
89 |
out = cmd + b' ' + b' '.join(self._arg(arg) for arg in args) |
74 | 90 |
|
91 |
log.info("%s", out) |
|
92 |
||
93 |
self.io.write(out) |
|
90
13c2deb919d1
qmsk.dmx.control: python3; remove broken serial timeout, quickfix startup dual-sync
Tero Marttila <terom@paivola.fi>
parents:
87
diff
changeset
|
94 |
self.io.write(b'\r') |
74 | 95 |
self.io.flush() |
96 |
||
87
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
97 |
if poll: |
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
98 |
for ret in self: |
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
99 |
break |
74 | 100 |
|
90
13c2deb919d1
qmsk.dmx.control: python3; remove broken serial timeout, quickfix startup dual-sync
Tero Marttila <terom@paivola.fi>
parents:
87
diff
changeset
|
101 |
if b'!' in ret : |
87
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
102 |
raise DMXCommandError(cmd=out, out=ret) |
74 | 103 |
|
90
13c2deb919d1
qmsk.dmx.control: python3; remove broken serial timeout, quickfix startup dual-sync
Tero Marttila <terom@paivola.fi>
parents:
87
diff
changeset
|
104 |
elif b'?' in ret : |
87
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
105 |
raise DMXUnknownCommandError(cmd=cmd) |
74 | 106 |
|
87
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
107 |
def clear (self, **opts) : |
74 | 108 |
""" |
109 |
Set dmx = [ ] |
|
110 |
||
111 |
i.e. start transmitting zero-length DMX packets. |
|
112 |
For most lights, this seems to be equivalent to losing the DMX signal, and they retain their old state. |
|
113 |
""" |
|
114 |
||
90
13c2deb919d1
qmsk.dmx.control: python3; remove broken serial timeout, quickfix startup dual-sync
Tero Marttila <terom@paivola.fi>
parents:
87
diff
changeset
|
115 |
self(b'c', **opts) |
74 | 116 |
|
87
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
117 |
def zero (self, **opts) : |
74 | 118 |
""" |
119 |
Set dmx = [0, ...] |
|
120 |
||
121 |
Uses the maximum DMX packet length available. |
|
122 |
""" |
|
123 |
||
90
13c2deb919d1
qmsk.dmx.control: python3; remove broken serial timeout, quickfix startup dual-sync
Tero Marttila <terom@paivola.fi>
parents:
87
diff
changeset
|
124 |
self(b'z', **opts) |
74 | 125 |
|
87
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
126 |
def out (self, *values, **opts) : |
74 | 127 |
""" |
128 |
Set dmx = (value, ...) |
|
129 |
""" |
|
130 |
||
90
13c2deb919d1
qmsk.dmx.control: python3; remove broken serial timeout, quickfix startup dual-sync
Tero Marttila <terom@paivola.fi>
parents:
87
diff
changeset
|
131 |
self(b'o', *values, **opts) |
74 | 132 |
|
87
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
133 |
def set (self, start, *values, **opts) : |
74 | 134 |
""" |
135 |
Set dmx[start:] = value |
|
136 |
""" |
|
137 |
||
90
13c2deb919d1
qmsk.dmx.control: python3; remove broken serial timeout, quickfix startup dual-sync
Tero Marttila <terom@paivola.fi>
parents:
87
diff
changeset
|
138 |
self(b's', start, *values, **opts) |
74 | 139 |
|
87
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
140 |
def fill (self, start, end, *values, **opts) : |
74 | 141 |
""" |
142 |
Set dmx[start:end] to repetitions of (value, ...) |
|
143 |
""" |
|
144 |
||
90
13c2deb919d1
qmsk.dmx.control: python3; remove broken serial timeout, quickfix startup dual-sync
Tero Marttila <terom@paivola.fi>
parents:
87
diff
changeset
|
145 |
self(b'f', start, end, *values, **opts) |
74 | 146 |
|
87
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
147 |
def range (self, start, stop, step, value, **opts) : |
74 | 148 |
""" |
149 |
Set dmx[start:end:step] = value |
|
150 |
""" |
|
151 |
||
90
13c2deb919d1
qmsk.dmx.control: python3; remove broken serial timeout, quickfix startup dual-sync
Tero Marttila <terom@paivola.fi>
parents:
87
diff
changeset
|
152 |
self(b'r', start, stop, step, value, **opts) |
74 | 153 |
|
154 |
def __setitem__ (self, index, value) : |
|
87
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
155 |
""" |
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
156 |
Magic indexing. |
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
157 |
""" |
2179a4e28aba
qmsk.dmx.control: switch to readline() based __iter__, with __call__(poll=True) and **opts
Tero Marttila <terom@paivola.fi>
parents:
83
diff
changeset
|
158 |
|
74 | 159 |
if isinstance(value, collections.Sequence) : |
160 |
values = tuple(value) |
|
161 |
else : |
|
162 |
values = (value, ) |
|
163 |
||
164 |
if isinstance(index, slice) : |
|
165 |
if index.start and index.stop and index.step : |
|
166 |
# XXX: single |
|
167 |
self.range(index.start, index.stop, index.step, value) |
|
168 |
||
169 |
elif index.start and index.stop : |
|
170 |
self.fill(index.start, index.stop, *values) |
|
171 |
||
172 |
elif index.start : |
|
173 |
self.set(index.start, *values) |
|
174 |
||
175 |
else : |
|
176 |
raise IndexError("invalid slice: %s" % (index, )) |
|
177 |
||
178 |
else : |
|
179 |
# simple set |
|
180 |
self.set(index, *values) |
|
181 |