diff options
Diffstat (limited to 'lib/lufa/Demos/DualRole/ClassDriver/MouseHostDevice/MouseHostDevice.txt')
-rw-r--r-- | lib/lufa/Demos/DualRole/ClassDriver/MouseHostDevice/MouseHostDevice.txt | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/lib/lufa/Demos/DualRole/ClassDriver/MouseHostDevice/MouseHostDevice.txt b/lib/lufa/Demos/DualRole/ClassDriver/MouseHostDevice/MouseHostDevice.txt new file mode 100644 index 000000000..d3fb9a561 --- /dev/null +++ b/lib/lufa/Demos/DualRole/ClassDriver/MouseHostDevice/MouseHostDevice.txt @@ -0,0 +1,80 @@ +/** \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/Device Dual Role Demo + * + * \section Sec_Compat Demo Compatibility: + * + * The following list indicates what microcontrollers are compatible with this demo. + * + * \li Series 7 USB AVRs (AT90USBxxx7) + * + * \section Sec_Info USB Information: + * + * The following table gives a rundown of the USB utilization of this demo. + * + * <table> + * <tr> + * <td><b>USB Mode:</b></td> + * <td>Dual Mode Host/Device</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>Supported USB Speeds:</b></td> + * <td>Low Speed Mode, Full Speed Mode</td> + * </tr> + * </table> + * + * \section Sec_Description Project Description: + * + * Mouse host/device dual role demonstration application. This gives a simple + * reference application for implementing a dual role USB Mouse, for USB mice + * using the standard mouse boot protocol HID profile. + * + * <b>When in host mode:</b> + * 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 compatible mice with advanced characteristics, as shown in the + * MouseHostWithParser Host demo application. + * + * Currently only single interface mice are supported. + * + * <b>When in device mode:</b> + * Upon enumeration the system will automatically enumerate and function + * as a mouse when the USB connection to a host is present. To use + * the mouse, move the joystick to move the pointer, and push the + * joystick inwards to simulate a left-button click. The HWB serves as + * the right mouse button. + * + * \section Sec_Options Project Options + * + * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value. + * + * <table> + * <tr> + * <td> + * None + * </td> + * </tr> + * </table> + */ + |