summaryrefslogtreecommitdiff
path: root/digital/avr/modules/usb/lufa/Demos/KeyboardHost/KeyboardHost.txt
blob: 92e380789d319abe8503127cc40520dd989ae998 (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
45
46
/** \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 Host Demo
 *  
 *  Keyboard host demonstration application. This gives a simple reference
 *  application for implementing a USB Mouse keyboard, for USB keyboards using
 *  the standard keyboard HID profile.
 *  
 *  Pressed alpha-numeric, enter or space key is transmitted through the serial
 *  USART at serial settings 9600, 8, N, 1.
 *  
 *  This uses a naive method where the keyboard is set to Boot Protocol mode, so
 *  that the report structure is fixed and known. A better implementation
 *  uses the HID report parser for correct report data processing across
 *  all compatable mice with advanced characteristics, as shown in the
 *  KeyboardHostWithParser demo application.
 *  
 *  Currently only single interface keyboards are supported.	
 *
 *  <table>
 *   <tr>
 *    <td><b>USB Mode:</b></td>
 *    <td>Host</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>
 */