diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-03-19 14:16:12 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-03-19 14:16:12 +0000 |
| commit | 88051e78a281f5776538558aec113ff2b66e056c (patch) | |
| tree | cfdd65c067c9c660b7e3d3f6edcefe25596f5f6f /Demos/MouseHostViaInt | |
| parent | 48400df13c7f9f4f0fd8e7f841d49f9502557cb1 (diff) | |
| download | lufa-88051e78a281f5776538558aec113ff2b66e056c.tar.gz lufa-88051e78a281f5776538558aec113ff2b66e056c.tar.bz2 lufa-88051e78a281f5776538558aec113ff2b66e056c.zip | |
Combined Mouse, MouseViaInt and MouseFullInt demos into a single unified demo.
Corrections to Keyboard demo.
Removed AVRISP_Programmer project due to code quality concerns.
Diffstat (limited to 'Demos/MouseHostViaInt')
| -rw-r--r-- | Demos/MouseHostViaInt/MouseHostViaInt.txt | 54 |
1 files changed, 36 insertions, 18 deletions
diff --git a/Demos/MouseHostViaInt/MouseHostViaInt.txt b/Demos/MouseHostViaInt/MouseHostViaInt.txt index 72ee1dbee..749865544 100644 --- a/Demos/MouseHostViaInt/MouseHostViaInt.txt +++ b/Demos/MouseHostViaInt/MouseHostViaInt.txt @@ -4,24 +4,9 @@ * documentation pages. It is not a project source file.
*/
-/** \mainpage Mouse Host Demo
- *
- * Mouse host demonstration application, using pipe interrupts. This
- * gives a simple reference application for implementing a USB Mouse
- * host utilizing the LUFA pipe interrupt system, 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.
+/** \mainpage Mouse Host Demo (via interrupts)
+ *
+ * \section SSec_Info USB Information:
*
* <table>
* <tr>
@@ -45,4 +30,37 @@ * <td>Low Speed Mode, Full Speed Mode</td>
* </tr>
* </table>
+ *
+ * \section SSec_Description Project Description:
+ *
+ * The following table gives a rundown of the USB utilization of this demo.
+ *
+ * Mouse host demonstration application, using pipe interrupts. This
+ * gives a simple reference application for implementing a USB Mouse
+ * host utilizing the LUFA pipe interrupt system, 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.
+ *
+ * \section SSec_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>
*/
\ No newline at end of file |