summaryrefslogtreecommitdiff
path: root/digital/avr/modules/usb/lufa/Demos/Joystick/Joystick.txt
blob: 6229aa042d3451fceccfc07b89628bc9f4dd0688 (plain)
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
/** \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>
 */