diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-02-23 07:08:17 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-02-23 07:08:17 +0000 |
| commit | 9991321321d30ca9383d795ea7e796098c92045f (patch) | |
| tree | cd3bd40eef421cc83c9d63e58f5def8a233acab6 /Demos/MouseHost/MouseHost.txt | |
| parent | c1a1b6eeecb375259968ef6d989833312047f2d8 (diff) | |
| download | lufa-9991321321d30ca9383d795ea7e796098c92045f.tar.gz lufa-9991321321d30ca9383d795ea7e796098c92045f.tar.bz2 lufa-9991321321d30ca9383d795ea7e796098c92045f.zip | |
Moved all source to the trunk directory.
Diffstat (limited to 'Demos/MouseHost/MouseHost.txt')
| -rw-r--r-- | Demos/MouseHost/MouseHost.txt | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/Demos/MouseHost/MouseHost.txt b/Demos/MouseHost/MouseHost.txt new file mode 100644 index 000000000..11c434c69 --- /dev/null +++ b/Demos/MouseHost/MouseHost.txt @@ -0,0 +1,47 @@ +/** \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 Demo
+ *
+ * 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.
+ *
+ * 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 compatable mice with advanced characteristics, as shown in the
+ * MouseHostWithParser demo application.
+ *
+ * Currently only single interface mice are supported.
+ *
+ * <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, USBIF HID Usage Tables</td>
+ * </tr>
+ * <tr>
+ * <td><b>Usable Speeds:</b></td>
+ * <td>Low Speed Mode, Full Speed Mode</td>
+ * </tr>
+ * </table>
+ */
\ No newline at end of file |