X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/aa640330a1b9421a16e425f5e0043a08558fb9bf..6c5c9212d816674c67aa3708b73558b023478b94:/Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.txt

diff --git a/Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.txt b/Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.txt
new file mode 100644
index 000000000..42009a3ca
--- /dev/null
+++ b/Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.txt
@@ -0,0 +1,71 @@
+/** \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_Compat Demo Compatibility:
+ *
+ *  The following table indicates what microcontrollers are compatible with this demo.
+ *
+ *  - AT90USB1287
+ *  - AT90USB647
+ *
+ *  \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>
+ */