]> git.gir.st - tmk_keyboard.git/blob - tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/Mouse/Mouse.txt
Merge commit 'f6d56675f9f981c5464f0ca7a1fbb0162154e8c5'
[tmk_keyboard.git] / tmk_core / protocol / lufa / LUFA-git / Demos / Device / ClassDriver / Mouse / Mouse.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 Mouse Device 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 * \li Series 6 USB AVRs (AT90USBxxx6)
15 * \li Series 4 USB AVRs (ATMEGAxxU4)
16 * \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
17 * \li Series AU XMEGA AVRs (ATXMEGAxxxAxU)
18 * \li Series B XMEGA AVRs (ATXMEGAxxxBxU)
19 * \li Series C XMEGA AVRs (ATXMEGAxxxCxU)
20 *
21 * \section Sec_Info USB Information:
22 *
23 * The following table gives a rundown of the USB utilization of this demo.
24 *
25 * <table>
26 * <tr>
27 * <td><b>USB Mode:</b></td>
28 * <td>Device</td>
29 * </tr>
30 * <tr>
31 * <td><b>USB Class:</b></td>
32 * <td>Human Interface Device (HID)</td>
33 * </tr>
34 * <tr>
35 * <td><b>USB Subclass:</b></td>
36 * <td>Mouse Subclass</td>
37 * </tr>
38 * <tr>
39 * <td><b>Relevant Standards:</b></td>
40 * <td>USBIF HID Specification \n
41 * USBIF HID Usage Tables</td>
42 * </tr>
43 * <tr>
44 * <td><b>Supported USB Speeds:</b></td>
45 * <td>Low Speed Mode \n
46 * Full Speed Mode</td>
47 * </tr>
48 * </table>
49 *
50 * \section Sec_Description Project Description:
51 *
52 * Mouse demonstration application. This gives a simple reference
53 * application for implementing a USB Mouse using the basic USB HID
54 * drivers in all modern OSes (i.e. no special drivers required). It is
55 * boot protocol compatible, and thus works under compatible BIOS as if
56 * it was a native mouse (e.g. PS/2).
57 *
58 * On start-up the system will automatically enumerate and function
59 * as a mouse when the USB connection to a host is present. To use
60 * the mouse, move the joystick to move the pointer, and push the
61 * joystick inwards to simulate a left-button click. The HWB serves as
62 * the right mouse button.
63 *
64 * \section Sec_Options Project Options
65 *
66 * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
67 *
68 * <table>
69 * <tr>
70 * <td>
71 * None
72 * </td>
73 * </tr>
74 * </table>
75 */
76
Imprint / Impressum