]> git.gir.st - tmk_keyboard.git/blob - protocol/lufa/LUFA-git/Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.txt
Squashed 'tmk_core/' changes from caca2c0..dc0e46e
[tmk_keyboard.git] / protocol / lufa / LUFA-git / Demos / Host / ClassDriver / KeyboardHost / KeyboardHost.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 Host 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 *
15 * \section Sec_Info USB Information:
16 *
17 * The following table gives a rundown of the USB utilization of this demo.
18 *
19 * <table>
20 * <tr>
21 * <td><b>USB Mode:</b></td>
22 * <td>Host</td>
23 * </tr>
24 * <tr>
25 * <td><b>USB Class:</b></td>
26 * <td>Human Interface Device (HID)</td>
27 * </tr>
28 * <tr>
29 * <td><b>USB Subclass:</b></td>
30 * <td>N/A</td>
31 * </tr>
32 * <tr>
33 * <td><b>Relevant Standards:</b></td>
34 * <td>USBIF HID Specification, USBIF HID Usage Tables</td>
35 * </tr>
36 * <tr>
37 * <td><b>Supported USB Speeds:</b></td>
38 * <td>Low Speed Mode, Full Speed Mode</td>
39 * </tr>
40 * </table>
41 *
42 * \section Sec_Description Project Description:
43 *
44 * Keyboard host demonstration application. This gives a simple reference
45 * application for implementing a USB keyboard host, for USB keyboards using
46 * the standard keyboard HID profile.
47 *
48 * Pressed alpha-numeric, enter or space key is transmitted through the serial
49 * USART at serial settings 9600, 8, N, 1.
50 *
51 * This uses a naive method where the keyboard is set to Boot Protocol mode, so
52 * that the report structure is fixed and known. A better implementation
53 * uses the HID report parser for correct report data processing across
54 * all compatible mice with advanced characteristics, as shown in the
55 * KeyboardHostWithParser demo application.
56 *
57 * Currently only single interface keyboards are supported.
58 *
59 * \section Sec_Options Project Options
60 *
61 * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
62 *
63 * <table>
64 * <tr>
65 * <td>
66 * None
67 * </td>
68 * </tr>
69 * </table>
70 */
71
Imprint / Impressum