X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/c1a1b6eeecb375259968ef6d989833312047f2d8..9991321321d30ca9383d795ea7e796098c92045f:/Demos/KeyboardHostWithParser/KeyboardHostWithParser.txt

diff --git a/Demos/KeyboardHostWithParser/KeyboardHostWithParser.txt b/Demos/KeyboardHostWithParser/KeyboardHostWithParser.txt
new file mode 100644
index 000000000..09a83ca57
--- /dev/null
+++ b/Demos/KeyboardHostWithParser/KeyboardHostWithParser.txt
@@ -0,0 +1,44 @@
+/** \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 With HID Descriptor Parser Demo
+ *  
+ *  Keyboard host demonstration application. This gives a simple reference
+ *  application for implementing a USB Keyboard host, for USB keyboards using
+ *  the standard Keyboard HID profile. It uses a HID parser for the HID reports,
+ *  allowing for correct operation across all USB keyboards. This demo supports
+ *  keyboards with a single HID report.
+ *  
+ *  Pressed alpha-numeric, enter or space key is transmitted through the serial
+ *  USART at serial settings 9600, 8, N, 1. On connection to a USB keyboard, the
+ *  report items will be processed and printed as a formatted list through the
+ *  USART before the keyboard is fully enumerated.
+ *  
+ *  Currently only single interface keyboards are supported.	
+ *
+ *  <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>
+ */
\ No newline at end of file