]> git.gir.st - tmk_keyboard.git/blob - protocol/lufa/LUFA-git/Demos/Device/ClassDriver/VirtualSerialMouse/VirtualSerialMouse.txt
Squashed 'tmk_core/' changes from caca2c0..dc0e46e
[tmk_keyboard.git] / protocol / lufa / LUFA-git / Demos / Device / ClassDriver / VirtualSerialMouse / VirtualSerialMouse.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 Combined Communications Device Class (Virtual Serial Port) and Mouse 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 AU XMEGA AVRs (ATXMEGAxxxAxU)
17 * \li Series B XMEGA AVRs (ATXMEGAxxxBxU)
18 * \li Series C XMEGA AVRs (ATXMEGAxxxCxU)
19 *
20 * \section Sec_Info USB Information:
21 *
22 * The following table gives a rundown of the USB utilization of this demo.
23 *
24 * <table>
25 * <tr>
26 * <td><b>USB Mode:</b></td>
27 * <td>Device</td>
28 * </tr>
29 * <tr>
30 * <td><b>USB Class:</b></td>
31 * <td>Communications Device Class (CDC) \n
32 * Human Interface Device Class (HID)</td>
33 * </tr>
34 * <tr>
35 * <td><b>USB Subclass:</b></td>
36 * <td>Abstract Control Model (ACM) \n
37 * Mouse Subclass</td>
38 * </tr>
39 * <tr>
40 * <td><b>Relevant Standards:</b></td>
41 * <td>USBIF CDC Class Standard</td>
42 * <td>USBIF HID Specification \n
43 * USBIF HID Usage Tables</td>
44 * </tr>
45 * <tr>
46 * <td><b>Supported USB Speeds:</b></td>
47 * <td>Full Speed Mode</td>
48 * </tr>
49 * </table>
50 *
51 * \section Sec_Description Project Description:
52 *
53 * Combined Communications Device Class/Mouse demonstration application.
54 * This gives a simple reference application for implementing a combined
55 * CDC and HID device acting as a both a virtual serial port and a mouse.
56 * Joystick actions are transmitted to the host as strings and as mouse
57 * movements. The device does not respond to serial data sent from the host.
58 *
59 * After running this demo for the first time on a new computer,
60 * you will need to supply the .INF file located in this demo
61 * project's directory as the device's driver when running under
62 * Windows. This will enable Windows to use its inbuilt CDC drivers,
63 * negating the need for custom drivers for the device. Other
64 * Operating Systems should automatically use their own inbuilt
65 * CDC-ACM drivers.
66 *
67 * \section Sec_Options Project Options
68 *
69 * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
70 *
71 * <table>
72 * <tr>
73 * <td>
74 * None
75 * </td>
76 * </tr>
77 * </table>
78 */
79
Imprint / Impressum