forked from stb-tester/stb-tester
-
Notifications
You must be signed in to change notification settings - Fork 0
/
irnetbox.py
288 lines (227 loc) · 9.14 KB
/
irnetbox.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
# -*- coding: utf-8 -*-
"""Python module to control the RedRat irNetBox-III infrared emitter.
Author: David Rothlisberger <david@rothlis.net>
Copyright 2012 YouView TV Ltd.
License: LGPL v2.1 or (at your option) any later version (see
https://github.com/drothlis/stb-tester/blob/master/LICENSE for details).
The irNetBox-III is a network-controlled infrared emitter:
http://www.redrat.co.uk/products/irnetbox.html
This module only supports version III of the irNetBox hardware.
"§" section numbers in the function docstrings are from "The irNetBox
Network Control Protocol":
http://www.redrat.co.uk/products/IRNetBox_Comms-V3.0.pdf
Thanks to Chris Dodge at RedRat for friendly and prompt answers to all my
questions.
Classes:
IRNetBox -- An instance of IRNetBox holds a TCP connection to the device.
Note that the device only accepts one TCP connection at a time, so keep this
as short-lived as possible. For example:
with irnetbox.IRNetBox("192.168.0.10") as ir:
ir.power_on()
ir.irsend_raw(port=1, power=100, data=binascii.unhexlify("000174F..."))
RemoteControlConfig -- Holds infrared signal data from a config file produced
by RedRat's "IR Signal Database Utility". Example usage (where "POWER" is a
signal defined in the config file):
rcu = irnetbox.RemoteControlConfig("my-rcu.irnetbox.config")
ir.irsend_raw(port=1, power=100, data=rcu["POWER"])
"""
import binascii
import random
import re
import socket
import struct
import sys
import time
class IRNetBox:
def __init__(self, hostname):
port = 10001 # §5
for i in range(6):
try:
self._socket = socket.socket()
self._socket.connect((hostname, port))
break
except socket.error as e:
if e.errno == errno.ECONNREFUSED and i < 5:
delay = 0.1 * 2**i
sys.stderr.write(
"Connection to irNetBox '%s:%d' refused; "
"retrying in %.2fs.\n" %
(hostname, port, delay))
time.sleep(delay)
else:
raise
self._responses = _read_responses(self._socket)
def __enter__(self):
return self
def __exit__(self, type, value, traceback):
self._socket.close()
def power_on(self):
"""Power on the irNetBox device (§5.2.3).
§5.2.3 calls this "power to the CPLD device"; the irNetBox-III doesn't
have a CPLD, but according to Chris Dodge @ RedRat, this is now "power
on the whole irNetBox".
"""
self._send(MessageTypes.POWER_ON)
def power_off(self):
"""Put the irNetBox in low-power standby mode (§5.2.3).
In low power mode the LEDs on the front will be doing the Cylon
pattern.
"""
self._send(MessageTypes.POWER_OFF)
def indicators_on(self):
"""Enable LED indicators on the front panel (§5.2.4)."""
self._send(
MessageTypes.CPLD_INSTRUCTION,
struct.pack("B", 0x17))
def indicators_off(self):
"""Disable LED indicators on the front panel (§5.2.4)."""
self._send(
MessageTypes.CPLD_INSTRUCTION,
struct.pack("B", 0x18))
def irsend_raw(self, port, power, data):
"""Output the IR data on the given port at the set power (§6.1.1).
* `port` is a number between 1 and 16.
* `power` is a number between 1 and 100.
* `data` is a byte array as exported by the RedRat Signal DB Utility.
"""
ports = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
ports[port-1] = power
sequence_number = random.randint(0, 2**16 - 1)
delay = 0 # use the default delay of 100ms
self._send(
MessageTypes.OUTPUT_IR_ASYNC,
struct.pack(
">HH16s%ds" % len(data),
sequence_number,
delay,
struct.pack("16B", *ports),
data))
def _send(self, message_type, message_data=""):
self._socket.sendall(_message(message_type, message_data))
response_type, response_data = self._responses.next()
if response_type == MessageTypes.ERROR:
raise Exception("IRNetBox returned ERROR")
class RemoteControlConfig:
def __init__(self, filename):
self._data = _parse_config(open(filename))
def __getitem__(self, key):
return self._data[key]
class MessageTypes:
"""§5.2"""
ERROR = 0x01
POWER_ON = 0x05
POWER_OFF = 0x06
CPLD_INSTRUCTION = 0x07
OUTPUT_IR_ASYNC = 0x30
IR_ASYNC_COMPLETE = 0x31
MESSAGE_NAMES = {
MessageTypes.ERROR: "ERROR",
MessageTypes.POWER_ON: "POWER_ON",
MessageTypes.POWER_OFF: "POWER_OFF",
MessageTypes.CPLD_INSTRUCTION: "CPLD_INSTRUCTION",
MessageTypes.OUTPUT_IR_ASYNC: "OUTPUT_IR_ASYNC",
MessageTypes.IR_ASYNC_COMPLETE: "IR_ASYNC_COMPLETE",
}
def _message(message_type, message_data):
# §5.1. Message Structure: Host to irNetBox
#
# '#' byte The '#' character indicates to the control
# microprocessor the start of a message.
# Message length ushort The length of the data section of this message.
# Message type byte One of the values listed below.
# Data byte[] Any data associated with this type of message.
#
# A ushort value is a 16-bit unsigned integer in big-endian format.
#
return struct.pack(
">cHB%ds" % len(message_data),
"#",
len(message_data),
message_type,
message_data)
def _read_responses(stream):
"""Generator that splits stream into (type, data) tuples."""
# §5.1. Message Structure: irNetBox to Host
#
# Message length ushort The length of the data section of this message.
# Message type byte Contains either:
# a) The same value as the original message from
# the host, or
# b) A value (0x01) indicating "Error".
# Data byte[] Any data associated with this type of message.
#
buf = ""
while True:
s = stream.recv(4096)
if len(s) == 0:
break
buf += s
while len(buf) >= 3:
data_len, = struct.unpack(">H", buf[0:2])
if len(buf) < 3 + data_len:
break
response_type, response_data = struct.unpack(
">B%ds" % data_len,
buf[2 : 3+data_len])
if response_type != MessageTypes.IR_ASYNC_COMPLETE:
yield response_type, response_data
buf = buf[3+data_len :]
def _parse_config(file):
"""Read irNetBox configuration file.
Which is produced by RedRat's (Windows-only) "IR Signal Database Utility".
This doesn't support config files with "double signals" (where 2 different
signals were recorded from alternate presses of the same button on the
remote control unit).
"""
d = {}
for line in file:
fields = re.split("[\t ]+", line.rstrip(), maxsplit=3)
if len(fields) == 4:
name, type_, max_num_lengths, data = fields
if type_ == "MOD_SIG":
d[name] = binascii.unhexlify(data)
return d
# Tests
#===========================================================================
def test_that_read_responses_doesnt_hang_on_incomplete_data():
import StringIO
data = "abcdefghij"
m = struct.pack(
">HB%ds" % len(data),
len(data),
0x01,
data)
assert _read_responses(_FileToSocket(StringIO.StringIO(m))).next() == \
(0x01, data)
try:
_read_responses(_FileToSocket(StringIO.StringIO(m[:5]))).next()
except StopIteration:
pass
else:
assert False # expected StopIteration exception
def test_that_parse_config_understands_redrat_format():
import StringIO
f = StringIO.StringIO(re.sub("^ +", "", flags=re.MULTILINE, string=
"""Device TestRCU
Note: The data is of the form <signal name> MOD_SIG <max_num_lengths> <byte_array_in_ascii_hex>.
DOWN MOD_SIG 16 000174F5FF60000000060000004802450222F704540D12116A464F0000000000000000000000000000000000000000000102020202020202020202020202020202020202020202020202030202020202020202020202030202020202020203020202030203020202030203020302020203027F0004027F
UP MOD_SIG 16 000174FAFF60000000050000004803457422F7045A0D13116A00000000000000000000000000000000000000000000000102020202020202020202020202020202020202020202020202030202020202020203020202020202020202020203020202020203020302030203020302020203027F0004027F
"""))
config = _parse_config(f)
assert config["DOWN"].startswith("\x00\x01\x74\xF5")
assert config["UP"].startswith("\x00\x01\x74\xFA")
class _FileToSocket:
"""Makes something File-like behave like a Socket for testing purposes.
>>> import StringIO
>>> s = _FileToSocket(StringIO.StringIO('Hello'))
>>> s.recv(3)
'Hel'
>>> s.recv(3)
'lo'
>>> s.recv(3)
''
"""
def __init__(self, f):
self.file = f
def recv(self, bufsize, flags=0):
return self.file.read(bufsize)