Keyboard.txt 2.16 KB
Newer Older
1
2
3
4
5
6
7
/** \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 Keyboard Device Demo
8
9
10
11
12
13
14
15
16
17
18
19
20
21
 *
 *  \section SSec_Compat Demo Compatibility:
 *
 *  The following table indicates what microcontrollers are compatible with this demo.
 *
 *  - AT90USB1287
 *  - AT90USB1286
 *  - AT90USB647
 *  - AT90USB646
 *  - ATMEGA32U6
 *  - ATMEGA32U4
 *  - ATMEGA16U4
 *  - AT90USB162
 *  - AT90USB82
22
23
24
25
 *
 *  \section SSec_Info USB Information:
 *
 *  The following table gives a rundown of the USB utilization of this demo.
26
27
28
29
30
31
32
33
34
35
36
37
 *
 *  <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>
38
 *    <td>Keyboard Subclass</td>
39
40
41
42
43
44
45
46
47
48
 *   </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>
49
50
 *
 *  \section SSec_Description Project Description:
51
 *
52
53
54
55
56
 *  Keyboard demonstration application. This gives a simple reference application
 *  for implementing a USB Keyboard using the basic USB HID drivers in all modern
 *  OSes (i.e. no special drivers required). It is boot protocol compatible, and thus
 *  works under compatible BIOS as if it was a native keyboard (e.g. PS/2).
 *  
57
 *  On start-up the system will automatically enumerate and function
58
59
60
 *  as a keyboard when the USB connection to a host is present. To use
 *  the keyboard example, manipulate the joystick to send the letters
 *  a, b, c, d and e. See the USB HID documentation for more information
61
 *  on sending keyboard event and key presses.
62
63
64
65
66
67
68
 *
 *  \section SSec_Options Project Options
 *  
 *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
 *
 *  <table>
 *   <tr>
69
70
71
 *    <td>
 *     None
 *    </td>
72
73
 *   </tr>
 *  </table>
74
 */