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.
7 /** \mainpage Multiple Report HID Keyboard and Mouse Device Demo
9 * \section Sec_Compat Demo Compatibility:
11 * The following list indicates what microcontrollers are compatible with this demo.
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)
21 * \section Sec_Info USB Information:
23 * The following table gives a rundown of the USB utilization of this demo.
27 * <td><b>USB Mode:</b></td>
31 * <td><b>USB Class:</b></td>
32 * <td>Human Interface Device (HID)</td>
35 * <td><b>USB Subclass:</b></td>
39 * <td><b>Relevant Standards:</b></td>
40 * <td>USBIF HID Specification \n
41 * USBIF HID Usage Tables</td>
44 * <td><b>Supported USB Speeds:</b></td>
45 * <td>Low Speed Mode \n
46 * Full Speed Mode</td>
50 * \section Sec_Description Project Description:
52 * Keyboard/Mouse demonstration application, using a single HID interface. This gives
53 * a simple reference application for implementing a multiple HID report device
54 * containing both USB Keyboard and USB Mouse functionality using the basic USB HID
55 * drivers in all modern OSes (i.e. no special drivers required). This example uses a
56 * single HID interface that is shared between the two functions.
58 * On start-up the system will automatically enumerate and function as a keyboard when
59 * the USB connection to a host is present and the HWB is not pressed. When enabled,
60 * manipulate the joystick to send the letters a, b, c, d and e. See the USB HID
61 * documentation for more information on sending keyboard event and key presses.
63 * When the HWB is pressed, the mouse mode is enabled. When enabled, move the joystick
64 * to move the pointer, and push the joystick inwards to simulate a left-button click.
66 * \section Sec_Options Project Options
68 * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.