Moved all source to the trunk directory.
[pub/lufa.git] / Demos / KeyboardHostViaInt / KeyboardHostViaInt.txt
diff --git a/Demos/KeyboardHostViaInt/KeyboardHostViaInt.txt b/Demos/KeyboardHostViaInt/KeyboardHostViaInt.txt
new file mode 100644 (file)
index 0000000..07c1108
--- /dev/null
@@ -0,0 +1,47 @@
+/** \file\r
+ *\r
+ *  This file contains special DoxyGen information for the generation of the main page and other special\r
+ *  documentation pages. It is not a project source file.\r
+ */\r
\r
+/** \mainpage Keyboard Host Demo\r
+ *  \r
+ *  Keyboard host demonstration application, using pipe interrupts. This gives\r
+ *  a simple reference application for implementing a USB Keyboard host utilizing\r
+ *  the LUFA pipe interrupt system, for USB keyboards using the standard Keyboard\r
+ *  HID profile.\r
+ *  \r
+ *  Pressed alpha-numeric, enter or space key is transmitted through the serial\r
+ *  USART at serial settings 9600, 8, N, 1.\r
+ *  \r
+ *  This uses a naive method where the keyboard is set to Boot Protocol mode, so\r
+ *  that the report structure is fixed and known. A better implementation\r
+ *  uses the HID report parser for correct report data processing across\r
+ *  all compatable mice with advanced characteristics, as shown in the\r
+ *  KeyboardHostWithParser demo application.\r
+ *  \r
+ *  Currently only single interface keyboards are supported.   \r
+ *\r
+ *  <table>\r
+ *   <tr>\r
+ *    <td><b>USB Mode:</b></td>\r
+ *    <td>Host</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>USB Class:</b></td>\r
+ *    <td>Human Interface Device (HID)</td>\r
+ *   </tr>\r
+ *   <tr> \r
+ *    <td><b>USB Subclass:</b></td>\r
+ *    <td>N/A</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>Relevant Standards:</b></td>\r
+ *    <td>USBIF HID Specification, USBIF HID Usage Tables</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>Usable Speeds:</b></td>\r
+ *    <td>Low Speed Mode, Full Speed Mode</td>\r
+ *   </tr>\r
+ *  </table>\r
+ */
\ No newline at end of file