diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-06-05 07:56:39 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-06-05 07:56:39 +0000 |
| commit | f1199200e167a737a4676378da184387e543830c (patch) | |
| tree | 9d49d9d0f932ccef70da579e70c19b0f03c9a88d /Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.txt | |
| parent | f51017f8fb5a02029bce577e3d7226cb5158d830 (diff) | |
| download | lufa-f1199200e167a737a4676378da184387e543830c.tar.gz lufa-f1199200e167a737a4676378da184387e543830c.tar.bz2 lufa-f1199200e167a737a4676378da184387e543830c.zip | |
Copy existing Host mode demos to new ClassDriver and LowLevel subfolders.
Diffstat (limited to 'Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.txt')
| -rw-r--r-- | Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.txt | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.txt b/Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.txt new file mode 100644 index 000000000..a3d5f717d --- /dev/null +++ b/Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.txt @@ -0,0 +1,64 @@ +/** \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 Keyboard Host Demo
+ *
+ * \section SSec_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, USBIF HID Usage Tables</td>
+ * </tr>
+ * <tr>
+ * <td><b>Usable Speeds:</b></td>
+ * <td>Low Speed Mode, Full Speed Mode</td>
+ * </tr>
+ * </table>
+ *
+ * \section SSec_Description Project Description:
+ *
+ * Keyboard host demonstration application. This gives a simple reference
+ * application for implementing a USB keyboard, for USB keyboards using
+ * the standard keyboard HID profile.
+ *
+ * Pressed alpha-numeric, enter or space key is transmitted through the serial
+ * USART at serial settings 9600, 8, N, 1.
+ *
+ * This uses a naive method where the keyboard 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
+ * KeyboardHostWithParser demo application.
+ *
+ * Currently only single interface keyboards 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>
+ */
|