-
Notifications
You must be signed in to change notification settings - Fork 129
/
sc_dongle.py
396 lines (322 loc) · 10.8 KB
/
sc_dongle.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
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
#!/usr/bin/env python2
"""
SC Controller - Steam Controller Wireless Receiver (aka Dongle) Driver
Called and used when Dongle is detected on USB bus.
Handles one or multiple controllers connected to dongle.
"""
from scc.lib import IntEnum
from scc.drivers.usb import USBDevice, register_hotplug_device
from scc.constants import SCButtons, STICKTILT
from scc.controller import Controller
from scc.config import Config
from collections import namedtuple
from math import pi as PI, sin, cos
import struct, logging
VENDOR_ID = 0x28de
PRODUCT_ID = 0x1142
FIRST_ENDPOINT = 2
FIRST_CONTROLIDX = 1
INPUT_FORMAT = [
('b', 'type'),
('x', 'ukn_01'),
('B', 'status'),
('x', 'ukn_02'),
('H', 'seq'),
('x', 'ukn_03'),
('I', 'buttons'),
('B', 'ltrig'),
('B', 'rtrig'),
('x', 'ukn_04'),
('x', 'ukn_05'),
('x', 'ukn_06'),
('h', 'lpad_x'),
('h', 'lpad_y'),
('h', 'rpad_x'),
('h', 'rpad_y'),
('10x', 'ukn_06'),
('h', 'gpitch'),
('h', 'groll'),
('h', 'gyaw'),
('h', 'q1'),
('h', 'q2'),
('h', 'q3'),
('h', 'q4'),
('16x', 'ukn_07')]
FORMATS, NAMES = zip(*INPUT_FORMAT)
TUP_FORMAT = '<' + ''.join(FORMATS)
ControllerInput = namedtuple('ControllerInput', ' '.join([ x for x in NAMES if not x.startswith('ukn_') ]))
SCI_NULL = ControllerInput._make(struct.unpack('<' + ''.join(FORMATS), b'\x00' * 64))
STICKPRESS = 0b1000000000000000000000000000000
log = logging.getLogger("SCDongle")
def init(daemon, config):
""" Registers hotplug callback for controller dongle """
def cb(device, handle):
return Dongle(device, handle, daemon)
register_hotplug_device(cb, VENDOR_ID, PRODUCT_ID)
return True
class Dongle(USBDevice):
MAX_ENDPOINTS = 4
_available_serials = set() # used only is ignore_serials option is enabled
def __init__(self, device, handle, daemon):
self.daemon = daemon
USBDevice.__init__(self, device, handle)
self.claim_by(klass=3, subclass=0, protocol=0)
self._controllers = {}
self._no_serial = []
for i in xrange(0, Dongle.MAX_ENDPOINTS):
# Steam dongle apparently can do only 4 controllers at once
self.set_input_interrupt(FIRST_ENDPOINT + i, 64, self._on_input)
def close(self):
# Called when dongle is removed
for c in self._controllers.values():
self.daemon.remove_controller(c)
self._controllers = {}
USBDevice.close(self)
def _add_controller(self, endpoint):
"""
Called when new controller is detected either by HOTPLUG message or
by recieving first input event.
"""
ccidx = FIRST_CONTROLIDX + endpoint - FIRST_ENDPOINT
c = SCController(self, ccidx, endpoint)
c.configure()
c.read_serial()
self._controllers[endpoint] = c
def _on_input(self, endpoint, data):
tup = ControllerInput._make(struct.unpack(TUP_FORMAT, data))
if tup.status == SCStatus.HOTPLUG:
# Most of INPUT_FORMAT doesn't apply here
if ord(data[4]) == 2:
# Controller connected
if endpoint not in self._controllers:
self._add_controller(endpoint)
else:
# Controller disconnected
if endpoint in self._controllers:
self.daemon.remove_controller(self._controllers[endpoint])
self._controllers[endpoint].disconnected()
del self._controllers[endpoint]
elif tup.status == SCStatus.INPUT:
if endpoint not in self._controllers:
self._add_controller(endpoint)
elif len(self._no_serial):
for x in self._no_serial:
x.read_serial()
self._no_serial = []
else:
self._controllers[endpoint].input(tup)
class SCStatus(IntEnum):
IDLE = 0x04
INPUT = 0x01
HOTPLUG = 0x03
class SCPacketType(IntEnum):
OFF = 0x9f
AUDIO = 0xb6
CLEAR_MAPPINGS = 0x81
CONFIGURE = 0x87
LED = 0x87
CALIBRATE_JOYSTICK = 0xbf
CALIBRATE_TRACKPAD = 0xa7
SET_AUDIO_INDICES = 0xc1
LIZARD_MODE = 0x8e
FEEDBACK = 0x8f
RESET = 0x95
GET_SERIAL = 0xAE
class SCPacketLength(IntEnum):
LED = 0x03
OFF = 0x04
FEEDBACK = 0x07
CONFIGURE = 0x15
CONFIGURE_BT = 0x0f
GET_SERIAL = 0x15
class SCConfigType(IntEnum):
LED = 0x2d
CONFIGURE = 0x32
CONFIGURE_BT = 0x18
class SCController(Controller):
def __init__(self, driver, ccidx, endpoint):
Controller.__init__(self)
self._driver = driver
self._endpoint = endpoint
self._idle_timeout = 600
self._enable_gyros = False
self._input_rotation_l = 0
self._input_rotation_r = 0
self._led_level = 10
# TODO: Is serial really used anywhere?
self._serial = "0000000000"
self._id = self._generate_id() if driver else "-"
self._old_state = SCI_NULL
self._ccidx = ccidx
def get_type(self):
return "sc"
def __repr__(self):
return "<SCWireless %s>" % (self.get_id(),)
def input(self, idata):
old_state, self._old_state = self._old_state, idata
if self.mapper:
#if idata.buttons & SCButtons.LPAD:
# # STICKPRESS button may signalize pressing stick instead
# if (idata.buttons & STICKPRESS) and not (idata.buttons & STICKTILT):
# idata = ControllerInput.replace(buttons=idata.buttons & ~SCButtons.LPAD)
if self._input_rotation_l:
lx, ly = idata.lpad_x, idata.lpad_y
if idata.buttons & SCButtons.LPADTOUCH:
s, c = sin(self._input_rotation_l), cos(self._input_rotation_l)
lx = int(idata.lpad_x * c - idata.lpad_y * s)
ly = int(idata.lpad_x * s + idata.lpad_y * c)
s, c = sin(self._input_rotation_r), cos(self._input_rotation_r)
rx = int(idata.rpad_x * c - idata.rpad_y * s)
ry = int(idata.rpad_x * s + idata.rpad_y * c)
# TODO: This is awfull :(
idata = ControllerInput(
idata.type, idata.status, idata.seq, idata.buttons,
idata.ltrig, idata.rtrig,
lx, ly, rx, ry,
idata.gpitch, idata.groll, idata.gyaw,
idata.q1, idata.q2, idata.q3, idata.q4
)
self.mapper.input(self, old_state, idata)
def _generate_id(self):
"""
ID is generated as 'scX' where where 'X' starts as 0 and increases
as more controllers are connected.
This is used only when reading serial numbers from device is disabled.
sc_by_cable generates ids in scBUS:PORT format.
"""
magic_number = 1
tp = self.get_type()
id = None
while id is None or id in self._driver.daemon.get_active_ids():
id = "%s%s" % (tp, magic_number,)
magic_number += 1
return id
def read_serial(self):
""" Requests and reads serial number from controller """
if Config()["ignore_serials"]:
# Special exception for cases when controller drops instead of
# sending serial number. See issue #103
self.generate_serial()
self.on_serial_got()
return
def cb(rawserial):
size, serial = struct.unpack(">xBx12s49x", rawserial)
if size > 1:
serial = serial.strip(" \x00")
self._serial = serial
self.on_serial_got()
else:
self._driver._no_serial.append(self)
self._driver.make_request(
self._ccidx, cb,
struct.pack('>BBB61x',
SCPacketType.GET_SERIAL, SCPacketLength.GET_SERIAL, 0x01))
def generate_serial(self):
""" Called only if ignore_serials is enabled """
if len(self._driver._available_serials) > 0:
self._serial = self._driver._available_serials.pop()
else:
self._serial = self.get_id()
log.debug("Not requesting serial number for SC %s", self._serial)
def on_serial_got(self):
try:
log.debug("Got wireless SC with serial %s", self._serial)
except UnicodeDecodeError:
log.debug("Failed to decode wireless SC serial")
self._serial = self._driver._available_serials.pop()
self._id = str(self._serial)
self._driver.daemon.add_controller(self)
def apply_config(self, config):
self.configure(idle_timeout=int(config['idle_timeout']),
led_level=float(config['led_level']))
self._input_rotation_l = float(config['input_rotation_l']) * PI / -180.0
self._input_rotation_r = float(config['input_rotation_r']) * PI / -180.0
def disconnected(self):
# If ignore_serials config option is enabled, fake serial used by this
# controller is stored away and reused when next controller is connected
if Config()["ignore_serials"]:
self._driver._available_serials.add(self._serial)
FORMAT1 = b'>BBBBB13sB2s43x'
# Has to be overriden in sc_by_cable
FORMAT2 = b'>BBBB59x'
def configure(self, idle_timeout=None, enable_gyros=None, led_level=None):
"""
Sets and, if possible, sends configuration to controller.
Only value that is provided is changed.
'idle_timeout' is in seconds.
'led_level' is precent (0-100)
"""
# ------
"""
packet format:
- uint8_t type - SCPacketType.CONFIGURE
- uint8_t size - SCPacketLength.CONFIGURE or SCPacketLength.LED
- uint8_t config_type - SCConfigType.CONFIGURE or SCConfigType.LED
- 61B data
Format for data when configuring controller:
- uint16 timeout
- 13B unknown1 - (0x18, 0x00, 0x00, 0x31, 0x02, 0x00, 0x08, 0x07, 0x00, 0x07, 0x07, 0x00, 0x30)
- uint8 enable gyro sensor - 0x14 enables, 0x00 disables
- 2B unknown2 - (0x00, 0x2e)
- 43B unused
Format for data when configuring led:
- uint8 led
- 60B unused
"""
if idle_timeout is not None : self._idle_timeout = idle_timeout
if enable_gyros is not None : self._enable_gyros = enable_gyros
if led_level is not None: self._led_level = led_level
unknown1 = b'\x18\x00\x00\x31\x02\x00\x08\x07\x00\x07\x07\x00\x30'
unknown2 = b'\x00\x2e'
timeout1 = self._idle_timeout & 0x00FF
timeout2 = (self._idle_timeout & 0xFF00) >> 8
# Timeout & Gyros
self._driver.overwrite_control(self._ccidx, struct.pack(self.FORMAT1,
SCPacketType.CONFIGURE,
SCPacketLength.CONFIGURE,
SCConfigType.CONFIGURE,
timeout1, timeout2,
unknown1,
0x14 if self._enable_gyros else 0,
unknown2))
# LED
self._driver.overwrite_control(self._ccidx, struct.pack(self.FORMAT2,
SCPacketType.CONFIGURE,
SCPacketLength.LED,
SCConfigType.LED,
self._led_level
))
def set_led_level(self, level):
level = min(100, int(level)) & 0xFF
if self._led_level != level:
self._led_level = level
self._driver.overwrite_control(self._ccidx, struct.pack('>BBBB59x',
SCPacketType.CONFIGURE,
0x03,
SCConfigType.LED,
self._led_level
))
def set_gyro_enabled(self, enabled):
self.configure(enable_gyros = enabled)
def turnoff(self):
log.debug("Turning off the controller...")
# Mercilessly stolen from scraw library
self._driver.send_control(self._ccidx, struct.pack('<BBBBBB',
SCPacketType.OFF, 0x04, 0x6f, 0x66, 0x66, 0x21))
def get_gyro_enabled(self):
""" Returns True if gyroscope input is currently enabled """
return self._enable_gyros
def feedback(self, data):
self._feedback(*data.data)
def _feedback(self, position, amplitude=128, period=0, count=1):
"""
Add haptic feedback to be send on next usb tick
@param int position haptic to use 1 for left 0 for right
@param int amplitude signal amplitude from 0 to 65535
@param int period signal period from 0 to 65535
@param int count number of period to play
"""
if amplitude >= 0:
self._driver.send_control(self._ccidx, struct.pack('<BBBHHH',
SCPacketType.FEEDBACK, 0x07, position,
amplitude, period, count))