summaryrefslogtreecommitdiff
path: root/digital/avr/modules/usb/lufa/Demos/Joystick/Joystick.txt
diff options
context:
space:
mode:
Diffstat (limited to 'digital/avr/modules/usb/lufa/Demos/Joystick/Joystick.txt')
-rw-r--r--digital/avr/modules/usb/lufa/Demos/Joystick/Joystick.txt44
1 files changed, 44 insertions, 0 deletions
diff --git a/digital/avr/modules/usb/lufa/Demos/Joystick/Joystick.txt b/digital/avr/modules/usb/lufa/Demos/Joystick/Joystick.txt
new file mode 100644
index 00000000..6229aa04
--- /dev/null
+++ b/digital/avr/modules/usb/lufa/Demos/Joystick/Joystick.txt
@@ -0,0 +1,44 @@
+/** \file
+ *
+ * This file contains special DoxyGen information for the generation of the main page and other special
+ * documentation pages. It is not a project source file.
+ */
+
+/** \mainpage Joystick Device Demo
+ *
+ * Joystick demonstration application. This gives a simple reference
+ * application for implementing a USB Keyboard device, for USB Joysticks
+ * using the standard Keyboard HID profile.
+ *
+ * This device will show up as a generic joystick device, with two buttons.
+ * Pressing the joystick inwards is the first button, and the HWB button
+ * is the second.
+ *
+ * Moving the joystick on the selected board moves the joystick location on
+ * the host computer.
+ *
+ * Currently only single interface joysticks are supported.
+ *
+ * <table>
+ * <tr>
+ * <td><b>USB Mode:</b></td>
+ * <td>Device</td>
+ * </tr>
+ * <tr>
+ * <td><b>USB Class:</b></td>
+ * <td>Human Interface Device (HID)</td>
+ * </tr>
+ * <tr>
+ * <td><b>USB Subclass:</b></td>
+ * <td>N/A</td>
+ * </tr>
+ * <tr>
+ * <td><b>Relevant Standards:</b></td>
+ * <td>USBIF HID Specification, USBIF HID Usage Tables</td>
+ * </tr>
+ * <tr>
+ * <td><b>Usable Speeds:</b></td>
+ * <td>Low Speed Mode, Full Speed Mode</td>
+ * </tr>
+ * </table>
+ */ \ No newline at end of file