]> git.gir.st - tmk_keyboard.git/blob - protocol/lufa/LUFA-git/Demos/Device/ClassDriver/Keyboard/Keyboard.txt
Squashed 'tmk_core/' changes from caca2c0..dc0e46e
[tmk_keyboard.git] / protocol / lufa / LUFA-git / Demos / Device / ClassDriver / Keyboard / Keyboard.txt
1 /** \file
2 *
3 * This file contains special DoxyGen information for the generation of the main page and other special
4 * documentation pages. It is not a project source file.
5 */
6
7 /** \mainpage Keyboard Device Demo
8 *
9 * \section Sec_Compat Demo Compatibility:
10 *
11 * The following list indicates what microcontrollers are compatible with this demo.
12 *
13 * \li Series 7 USB AVRs (AT90USBxxx7)
14 * \li Series 6 USB AVRs (AT90USBxxx6)
15 * \li Series 4 USB AVRs (ATMEGAxxU4)
16 * \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
17 * \li Series AU XMEGA AVRs (ATXMEGAxxxAxU)
18 * \li Series B XMEGA AVRs (ATXMEGAxxxBxU)
19 * \li Series C XMEGA AVRs (ATXMEGAxxxCxU)
20 *
21 * \section Sec_Info USB Information:
22 *
23 * The following table gives a rundown of the USB utilization of this demo.
24 *
25 * <table>
26 * <tr>
27 * <td><b>USB Mode:</b></td>
28 * <td>Device</td>
29 * </tr>
30 * <tr>
31 * <td><b>USB Class:</b></td>
32 * <td>Human Interface Device (HID)</td>
33 * </tr>
34 * <tr>
35 * <td><b>USB Subclass:</b></td>
36 * <td>Keyboard Subclass</td>
37 * </tr>
38 * <tr>
39 * <td><b>Relevant Standards:</b></td>
40 * <td>USBIF HID Specification \n
41 * USBIF HID Usage Tables</td>
42 * </tr>
43 * <tr>
44 * <td><b>Supported USB Speeds:</b></td>
45 * <td>Low Speed Mode \n
46 * Full Speed Mode</td>
47 * </tr>
48 * </table>
49 *
50 * \section Sec_Description Project Description:
51 *
52 * Keyboard demonstration application. This gives a simple reference application
53 * for implementing a USB Keyboard using the basic USB HID drivers in all modern
54 * OSes (i.e. no special drivers required). It is boot protocol compatible, and thus
55 * works under compatible BIOS as if it was a native keyboard (e.g. PS/2).
56 *
57 * On start-up the system will automatically enumerate and function as a keyboard
58 * when the USB connection to a host is present. To use the keyboard example,
59 * manipulate the joystick to send the letters a, b, c, d and e. See the USB HID
60 * documentation for more information on sending keyboard event and key presses. Unlike
61 * other LUFA Keyboard demos, this example shows explicitly how to send multiple key presses
62 * inside the same report to the host.
63 *
64 * \section Sec_Options Project Options
65 *
66 * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
67 *
68 * <table>
69 * <tr>
70 * <td>
71 * None
72 * </td>
73 * </tr>
74 * </table>
75 */
76
Imprint / Impressum