diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2011-01-26 21:33:07 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2011-01-26 21:33:07 +0000 |
| commit | a852ea8e43d6df9642df3524a974073d2229fa4c (patch) | |
| tree | 7524d3d7c881de32080cb0ed82fc4aa16d6f7755 /Demos/Device/ClassDriver/KeyboardMouseMultiReport/KeyboardMouseMultiReport.txt | |
| parent | 6c7ed7ecd6d4727e33ddb8c5e4321499a2b76151 (diff) | |
| download | lufa-a852ea8e43d6df9642df3524a974073d2229fa4c.tar.gz lufa-a852ea8e43d6df9642df3524a974073d2229fa4c.tar.bz2 lufa-a852ea8e43d6df9642df3524a974073d2229fa4c.zip | |
Added new KeyboardMouseMultiReport Device ClassDriver demo.
Fixed ReportID not being removed from the feature/out report data array in the HID class driver when Report IDs are used.
Added new MAX() and MIN() convenience macros.
Diffstat (limited to 'Demos/Device/ClassDriver/KeyboardMouseMultiReport/KeyboardMouseMultiReport.txt')
| -rw-r--r-- | Demos/Device/ClassDriver/KeyboardMouseMultiReport/KeyboardMouseMultiReport.txt | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/Demos/Device/ClassDriver/KeyboardMouseMultiReport/KeyboardMouseMultiReport.txt b/Demos/Device/ClassDriver/KeyboardMouseMultiReport/KeyboardMouseMultiReport.txt new file mode 100644 index 000000000..3e0d36940 --- /dev/null +++ b/Demos/Device/ClassDriver/KeyboardMouseMultiReport/KeyboardMouseMultiReport.txt @@ -0,0 +1,75 @@ +/** \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 Multiple Report HID Keyboard and Mouse Device Demo
+ *
+ * \section Sec_Compat Demo Compatibility:
+ *
+ * The following list indicates what microcontrollers are compatible with this demo.
+ *
+ * - Series 7 USB AVRs (AT90USBxxx7)
+ * - Series 6 USB AVRs (AT90USBxxx6)
+ * - Series 4 USB AVRs (ATMEGAxxU4)
+ * - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
+ *
+ * \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>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 \n
+ * USBIF HID Usage Tables</td>
+ * </tr>
+ * <tr>
+ * <td><b>Usable Speeds:</b></td>
+ * <td>Low Speed Mode \n
+ * Full Speed Mode</td>
+ * </tr>
+ * </table>
+ *
+ * \section Sec_Description Project Description:
+ *
+ * Keyboard/Mouse demonstration application, using a single HID interface. This gives
+ * a simple reference application for implementing a multiple HID report device
+ * containing both USB Keyboard and USB Mouse functionality using the basic USB HID
+ * drivers in all modern OSes (i.e. no special drivers required). This example uses a
+ * single HID interface that is shared between the two functions.
+ *
+ * On start-up the system will automatically enumerate and function as a keyboard when
+ * the USB connection to a host is present and the HWB is not pressed. When enabled,
+ * manipulate the joystick to send the letters a, b, c, d and e. See the USB HID
+ * documentation for more information on sending keyboard event and key presses.
+ *
+ * When the HWB is pressed, the mouse mode is enabled. When enabled, move the joystick
+ * to move the pointer, and push the joystick inwards to simulate a left-button click.
+ *
+ * \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>
+ */
+
|