diff options
author | Jack Humbert <jack.humb@gmail.com> | 2015-10-27 12:42:30 -0400 |
---|---|---|
committer | Jack Humbert <jack.humb@gmail.com> | 2015-10-27 12:42:30 -0400 |
commit | 547da78335298df6666200c6063ac6f1aba312fd (patch) | |
tree | 47df0252ee24b1ecc27b9dd0458c51f20bf088c3 /tmk_core/protocol/lufa/LUFA-git/Demos/Host/ClassDriver/MouseHostWithParser/MouseHostWithParser.txt | |
parent | a766918d5c48204375f4c207b30bbbf1389df14f (diff) | |
parent | fa33719adab1393753312d298b8c365e04e844b9 (diff) |
merging tmk
Diffstat (limited to 'tmk_core/protocol/lufa/LUFA-git/Demos/Host/ClassDriver/MouseHostWithParser/MouseHostWithParser.txt')
-rw-r--r-- | tmk_core/protocol/lufa/LUFA-git/Demos/Host/ClassDriver/MouseHostWithParser/MouseHostWithParser.txt | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Host/ClassDriver/MouseHostWithParser/MouseHostWithParser.txt b/tmk_core/protocol/lufa/LUFA-git/Demos/Host/ClassDriver/MouseHostWithParser/MouseHostWithParser.txt new file mode 100644 index 0000000000..9b1b7d055c --- /dev/null +++ b/tmk_core/protocol/lufa/LUFA-git/Demos/Host/ClassDriver/MouseHostWithParser/MouseHostWithParser.txt @@ -0,0 +1,71 @@ +/** \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 With HID Descriptor Parser 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>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 \n + * USBIF HID Usage Tables</td> + * </tr> + * <tr> + * <td><b>Supported USB Speeds:</b></td> + * <td>Low Speed Mode \n + * Full Speed Mode</td> + * </tr> + * </table> + * + * \section Sec_Description Project Description: + * + * Mouse host demonstration application. This gives a simple reference + * application for implementing a USB Mouse host, for USB mice using + * the standard mouse HID profile. It uses a HID parser for the HID + * reports, allowing for correct operation across all USB mice. This + * demo supports mice with a single HID report. + * + * Mouse and scroll wheel movement and button presses are displayed + * on the board LEDs. On connection to a USB mouse, the report items + * will be processed and printed as a formatted list through the USART + * before the mouse is fully enumerated. + * + * Currently only single interface mice are supported. + * + * \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> + */ + |