linux/Documentation/input/devices/pxrc.rst
Marcus Folkesson 8d58ce1b1e input: docs: pxrc: remove reference to phoenix-sim
The reference undeniably points to something unrelated nowadays.
Remove it.

Signed-off-by: Marcus Folkesson <marcus.folkesson@gmail.com>
Suggested-by: Mark Olsson <mark@markolsson.se>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20230824-pxrc-doc-v1-1-038b75a2ef05@gmail.com
2023-08-28 12:43:32 -06:00

57 lines
1.5 KiB
ReStructuredText

=======================================================
pxrc - PhoenixRC Flight Controller Adapter
=======================================================
:Author: Marcus Folkesson <marcus.folkesson@gmail.com>
This driver let you use your own RC controller plugged into the
adapter that comes with PhoenixRC or other compatible adapters.
The adapter supports 7 analog channels and 1 digital input switch.
Notes
=====
Many RC controllers is able to configure which stick goes to which channel.
This is also configurable in most simulators, so a matching is not necessary.
The driver is generating the following input event for analog channels:
+---------+----------------+
| Channel | Event |
+=========+================+
| 1 | ABS_X |
+---------+----------------+
| 2 | ABS_Y |
+---------+----------------+
| 3 | ABS_RX |
+---------+----------------+
| 4 | ABS_RY |
+---------+----------------+
| 5 | ABS_RUDDER |
+---------+----------------+
| 6 | ABS_THROTTLE |
+---------+----------------+
| 7 | ABS_MISC |
+---------+----------------+
The digital input switch is generated as an `BTN_A` event.
Manual Testing
==============
To test this driver's functionality you may use `input-event` which is part of
the `input layer utilities` suite [1]_.
For example::
> modprobe pxrc
> input-events <devnr>
To print all input events from input `devnr`.
References
==========
.. [1] https://www.kraxel.org/cgit/input/