summaryrefslogtreecommitdiff
path: root/digital/avr/modules/usb/lufa/Demos/MouseHostWithParser/MouseHostWithParser.txt
blob: 97ee8bfb8648ee8e5aaee5073937934da68d9ae3 (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
/** \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 Mouse Host With HID Descriptor Parser Demo
 *  
 *  Mouse host demonstration application. This gives a simple reference
 *  application for implementing a USB Mouse host, for USB mice using
 *  the standard mouse HID profile. It uses a HID parser for the HID
 *  reports, allowing for correct operation across all USB mice. This
 *  demo supports mice with a single HID report.
 *  
 *  Mouse movement and button presses are displayed on the board LEDs.
 *  On connection to a USB mouse, the report items will be processed and
 *  printed as a formatted list through the USART before the mouse is
 *  fully enumerated.
 *  
 *  Currently only single interface mice 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>
 */