GNU Linux-libre 6.9.1-gnu
[releases.git] / Documentation / input / devices / pxrc.rst
1 =======================================================
2 pxrc - PhoenixRC Flight Controller Adapter
3 =======================================================
4
5 :Author: Marcus Folkesson <marcus.folkesson@gmail.com>
6
7 This driver let you use your own RC controller plugged into the
8 adapter that comes with PhoenixRC or other compatible adapters.
9
10 The adapter supports 7 analog channels and 1 digital input switch.
11
12 Notes
13 =====
14
15 Many RC controllers is able to configure which stick goes to which channel.
16 This is also configurable in most simulators, so a matching is not necessary.
17
18 The driver is generating the following input event for analog channels:
19
20 +---------+----------------+
21 | Channel |      Event     |
22 +=========+================+
23 |     1   |  ABS_X         |
24 +---------+----------------+
25 |     2   |  ABS_Y         |
26 +---------+----------------+
27 |     3   |  ABS_RX        |
28 +---------+----------------+
29 |     4   |  ABS_RY        |
30 +---------+----------------+
31 |     5   |  ABS_RUDDER    |
32 +---------+----------------+
33 |     6   |  ABS_THROTTLE  |
34 +---------+----------------+
35 |     7   |  ABS_MISC      |
36 +---------+----------------+
37
38 The digital input switch is generated as an `BTN_A` event.
39
40 Manual Testing
41 ==============
42
43 To test this driver's functionality you may use `input-event` which is part of
44 the `input layer utilities` suite [1]_.
45
46 For example::
47
48     > modprobe pxrc
49     > input-events <devnr>
50
51 To print all input events from input `devnr`.
52
53 References
54 ==========
55
56 .. [1] https://www.kraxel.org/cgit/input/