summaryrefslogtreecommitdiff
path: root/digital/avr/modules/usb/lufa/Demos/KeyboardMouse/KeyboardMouse.txt
blob: 969e2871b4a2580fe787e2d7b66865f8cc0c0593 (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
47
48
/** \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 Dual HID Keyboard and Mouse Device Demo
 *
 *  Keyboard/Mouse demonstration application. This gives a simple reference
 *  application for implementing a composite device containing both USB Keyboard
 *  and USB Mouse functionality using the basic USB HID drivers in all modern OSes
 *  (i.e. no special drivers required). This example uses two seperate HID
 *  interfaces for each function. It is boot protocol compatible, and thus works under
 *  compatible BIOS as if it was a native keyboard and mouse (e.g. PS/2).
 *  
 *  On startup the system will automatically enumerate and function
 *  as a keyboard when the USB connection to a host is present and the HWB is not
 *  pressed. When enabled, manipulate the joystick to send the letters
 *  a, b, c, d and e. See the USB HID documentation for more information
 *  on sending keyboard event and keypresses.
 *  
 *  When the HWB is pressed, the mouse mode is enabled. When enabled, move the
 *  joystick to move the pointer, and push the joystick inwards to simulate a
 *  left-button click.
 *
 *  <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>
 */