summaryrefslogtreecommitdiff
path: root/digital/avr/modules/usb/lufa/Demos/MouseHostViaInt/MouseHostViaInt.txt
blob: 72ee1dbeee5979e7ecf4eedb466d07836017ae2b (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 Mouse Host Demo
 *  
 *  Mouse host demonstration application, using pipe interrupts. This
 *  gives a simple reference application for implementing a USB Mouse
 *  host utilizing the LUFA pipe interrupt system, for USB mice using
 *  the standard mouse HID profile.
 *  
 *  Mouse movement and button presses are displayed on the board LEDs,
 *  as well as printed out the serial terminal as formatted dY, dY and
 *  button status information.
 *  
 *  This uses a naive method where the mouse 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
 *  MouseHostWithParser demo application.
 *  
 *  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>
 */