From bea0c340ef373a5db73a0214f0d3d6b27ab6005d Mon Sep 17 00:00:00 2001
From: Your Name <you@example.com>
Date: Fri, 28 Apr 2023 12:04:30 +0200
Subject: [PATCH] Add readme for gamepad unit

---
 source/RobotAPI/drivers/GamepadUnit/README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 source/RobotAPI/drivers/GamepadUnit/README.md

diff --git a/source/RobotAPI/drivers/GamepadUnit/README.md b/source/RobotAPI/drivers/GamepadUnit/README.md
new file mode 100644
index 000000000..f987b05e9
--- /dev/null
+++ b/source/RobotAPI/drivers/GamepadUnit/README.md
@@ -0,0 +1,17 @@
+# GamepadUnit
+
+This component is used to control the robot with a gamepad.
+
+You have to set two device names:
+ - `GamepadDeviceName`
+   - Used to read the input from the device.
+    You can find the proper name by checking various names from `/dev/input/js*` with the command line util `jstest`.
+ - `GamepadForceFeedbackName`
+   - Used to give force feedback on the controller.
+    You can find the proper name by checking various names from `/dev/input/event*` with the command line util `fftest` or `evtest`.
+
+Alternatively you can find the proper name through `/dev/input/by-id`.
+
+E.g. for a Logitech F710 gamepad the proper names are: \
+`GamepadDeviceName=/dev/input/by-id/usb-Logitech_Wireless_Gamepad_F710_582F9A6B-joystick` \
+`GamepadForceFeedbackName=/dev/input/by-id/usb-Logitech_Wireless_Gamepad_F710_582F9A6B-event-joystick`
-- 
GitLab