forked from gvalkov/python-evdev
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdevice.py
More file actions
329 lines (238 loc) · 10.3 KB
/
device.py
File metadata and controls
329 lines (238 loc) · 10.3 KB
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
# encoding: utf-8
import os
from select import select
from collections import namedtuple
from evdev import _input, _uinput, ecodes, util
from evdev.events import InputEvent, FFEffect, FFConstantEffect
_AbsInfo = namedtuple('AbsInfo', ['value', 'min', 'max', 'fuzz', 'flat', 'resolution'])
_KbdInfo = namedtuple('KbdInfo', ['repeat', 'delay'])
_DeviceInfo = namedtuple('DeviceInfo', ['bustype', 'vendor', 'product', 'version'])
class AbsInfo(_AbsInfo):
'''
A ``namedtuple`` for storing absolut axis information -
corresponds to the ``input_absinfo`` c struct:
- value
Latest reported value for the axis.
- min
Specifies minimum value for the axis.
- max
Specifies maximum value for the axis.
- fuzz
Specifies fuzz value that is used to filter noise from the
event stream.
- flat
Values that are within this value will be discarded by joydev
interface and reported as 0 instead.
- resolution
Specifies resolution for the values reported for the axis.
Resolution for main axes (``ABS_X, ABS_Y, ABS_Z``) is reported
in units per millimeter (units/mm), resolution for rotational
axes (``ABS_RX, ABS_RY, ABS_RZ``) is reported in units per
radian.
.. note: The input core does not clamp reported values to the
``[minimum, maximum]`` limits, such task is left to userspace.
'''
pass
def __str__(self):
return 'val {}, min {}, max {}, fuzz {}, flat {}, res {}'.format(*self)
class KbdInfo(_KbdInfo):
'''
Keyboard repeat rate:
- repeat:
Keyboard repeat rate in characters per second.
- delay:
Amount of time that a key must be depressed before it will start
to repeat (in milliseconds).
'''
def __str__(self):
return 'repeat {}, delay {}'.format(*self)
class DeviceInfo(_DeviceInfo):
def __str__(self):
msg = 'bus: {:04x}, product {:04x}, vendor {:04x}, version {:04x}'
return msg.format(*self)
class InputDevice(object):
'''
A linux input device from which input events can be read.
'''
__slots__ = ('fn', 'fd', 'info', 'name', 'phys', '_rawcapabilities',
'version')
def __init__(self, dev):
'''
:param dev: path to input device
'''
#: Path to input device
self.fn = dev
#: A non-blocking file descriptor to the device file
self.fd = os.open(dev, os.O_RDWR | os.O_NONBLOCK)
# Returns (bustype, vendor, product, version, name, phys, capabilities)
info_res = _input.ioctl_devinfo(self.fd)
#: A :class:`DeviceInfo <evdev.device.DeviceInfo>` instance
self.info = DeviceInfo(*info_res[:4])
#: The name of the event device
self.name = info_res[4]
#: The physical topology of the device
self.phys = info_res[5]
#: The evdev protocol version
self.version = _input.ioctl_EVIOCGVERSION(self.fd)
#: The raw dictionary of device capabilities - see `:func:capabilities()`
self._rawcapabilities = _input.ioctl_capabilities(self.fd)
def _capabilities(self, absinfo=True):
res = {}
for etype, ecodes in self._rawcapabilities.items():
for code in ecodes:
l = res.setdefault(etype, [])
if isinstance(code, tuple):
if absinfo:
a = code[1] # (0, 0, 0, 255, 0, 0)
i = AbsInfo(*a)
l.append((code[0], i))
else:
l.append(code[0])
else:
l.append(code)
return res
def capabilities(self, verbose=False, absinfo=True):
'''
Returns the event types that this device supports as a mapping of
supported event types to lists of handled event codes. Example::
{ 1: [272, 273, 274],
2: [0, 1, 6, 8] }
If ``verbose`` is ``True``, event codes and types will be resolved
to their names. Example::
{ ('EV_KEY', 1) : [('BTN_MOUSE', 272), ('BTN_RIGHT', 273), ('BTN_MIDDLE', 273)],
('EV_REL', 2) : [('REL_X', 0), ('REL_Y', 0), ('REL_HWHEEL', 6), ('REL_WHEEL', 8)] }
Unknown codes or types will be resolved to ``'?'``.
If ``absinfo`` is ``True``, the list of capabilities will also
include absolute axis information (``absmin``, ``absmax``,
``absfuzz``, ``absflat``) in the following form::
{ 3 : [ (0, AbsInfo(min=0, max=255, fuzz=0, flat=0)),
(1, AbsInfo(min=0, max=255, fuzz=0, flat=0)) ]}
Combined with ``verbose`` the above becomes::
{ ('EV_ABS', 3) : [ (('ABS_X', 0), AbsInfo(min=0, max=255, fuzz=0, flat=0)),
(('ABS_Y', 1), AbsInfo(min=0, max=255, fuzz=0, flat=0)) ]}
'''
if verbose:
return dict(util.resolve_ecodes(self._capabilities(absinfo)))
else:
return self._capabilities(absinfo)
def leds(self, verbose=False):
'''
Returns currently set LED keys. Example::
[0, 1, 8, 9]
If ``verbose`` is ``True``, event codes will be resolved to
their names. Unknown codes will be resolved to ``'?'``. Example::
[('LED_NUML', 0), ('LED_CAPSL', 1), ('LED_MISC', 8), ('LED_MAIL', 9)]
'''
leds = _input.get_sw_led_snd(self.fd, ecodes.EV_LED)
if verbose:
return [(ecodes.LED[l] if l in ecodes.LED else '?', l) for l in leds]
return leds
def set_led(self, led_num, value):
'''
Sets the state of the selected LED. Example::
device.set_led(ecodes.LED_NUML, 1)
'''
_uinput.write(self.fd, ecodes.EV_LED, led_num, value)
def __eq__(self, o):
'''Two devices are considered equal if their :data:`info` attributes are equal.'''
return self.info == o.info
def __str__(self):
msg = 'device {}, name "{}", phys "{}"'
return msg.format(self.fn, self.name, self.phys)
def __repr__(self):
msg = (self.__class__.__name__, self.fn)
return '{}({!r})'.format(*msg)
def close(self):
os.close(self.fd)
self.fd = -1
def fileno(self):
'''
Returns the file descriptor to the event device. This makes
passing ``InputDevice`` instances directly to
:func:`select.select()` and :class:`asyncore.file_dispatcher`
possible. '''
return self.fd
def read_one(self):
'''
Read and return a single input event as a
:class:`InputEvent <evdev.events.InputEvent>` instance.
Return `None` if there are no pending input events.
'''
# event -> (sec, usec, type, code, val)
event = _input.device_read(self.fd)
if event:
return InputEvent(*event)
def read_loop(self):
'''Enter a polling loop that yields input events.'''
while True:
r,w,x = select([self.fd], [], [])
for event in self.read():
yield event
def read(self):
'''
Read multiple input events from device. This function returns a
generator object that yields :class:`InputEvent
<evdev.events.InputEvent>` instances.
'''
# events -> [(sec, usec, type, code, val), ...]
events = _input.device_read_many(self.fd)
for i in events:
yield InputEvent(*i)
def grab(self):
'''Grab input device using `EVIOCGRAB` - other applications
will be unable to receive until the device is released. Only
one process can hold a `EVIOCGRAB` on a device.
.. warning:: Grabbing an already grabbed device will raise an
IOError('Device or resource busy') exception.'''
_input.ioctl_EVIOCGRAB(self.fd, 1)
def ungrab(self):
'''Release device if it has been already grabbed (uses
`EVIOCGRAB`).
.. warning:: Releasing an already released device will raise an
IOError('Invalid argument') exception.'''
_input.ioctl_EVIOCGRAB(self.fd, 0)
def n_effects(self):
'''Query device for number of simultaneous Force Feedback effects'''
return _input.ioctl_EVIOCGEFFECTS(self.fd)
def set_FF_AUTOCENTER(self,force):
'''set AUTOCENTER force to make wheel return to 0'''
force = int(force) & 0xFFFF
return _input.set_FF_AUTOCENTER(self.fd, force)
def clear_FF_AUTOCENTER(self):
'''clear AUTOCENTER force'''
return _input.set_FF_AUTOCENTER(self.fd, 0)
def set_FF_GAIN(self,force):
'''set GAIN of force effects'''
gain = int(force) & 0xFFFF
return _input.set_FF_GAIN(self.fd, gain)
def upload_FF_EFFECT(self,fx):
'''save (or update) a FFEffect forcefeedback effect'''
# pull out the parameters of the FfEffect
#FFEffect(fxtype=ecodes.FF_CONSTANT,direction=0xC000,replay_length=0xF,replay_delay=0xF,fxid=-1)
if not fx or type(fx) is not FFEffect:
raise Exception("Invalid fx")
good = False
if type(fx.effect) is FFConstantEffect:
effect = fx.effect
envelope = effect.envelope
return _input.ioctl_EVIOCSFF_CONSTANT(self.fd, fx.type,fx.id, fx.direction,effect.level,
fx.replay.length, fx.replay.delay, fx.trigger.button, fx.trigger.interval,
envelope.attack_level, envelope.attack_length, envelope.fade_level, envelope.fade_length,
)
else:
raise Exception("Only FFConstantEffect supported!")
return -1
def play_FF(self, fxid, ntimes=1):
''' play a previously uploaded forcefeedback effect'''
return _input.play_FF_EFFECT(self.fd, fxid,ntimes)
def stop_FF(self, fxid):
''' stop a previously uploaded forcefeedback effect'''
return _input.play_FF_EFFECT(self.fd, fxid,0)
@property
def repeat(self):
'''Get or set the keyboard repeat rate (in characters per
minute) and delay (in milliseconds).'''
return KbdInfo(*_input.ioctl_EVIOCGREP(self.fd))
@repeat.setter
def repeat(self, value):
return _input.ioctl_EVIOCSREP(self.fd, *value)