Demos/KeyboardHost/KeyboardHost.txt

   1 /** \file
   2  *
   3  *  This file contains special DoxyGen information for the generation of the main page and other special
   4  *  documentation pages. It is not a project source file.
   5  */
   6
   7 /** \mainpage Keyboard Host Demo
   8  *
   9  *  Keyboard host demonstration application. This gives a simple reference
  10  *  application for implementing a USB Mouse keyboard, for USB keyboards using
  11  *  the standard keyboard HID profile.
  12  *
  13  *  Pressed alpha-numeric, enter or space key is transmitted through the serial
  14  *  USART at serial settings 9600, 8, N, 1.
  15  *
  16  *  This uses a naive method where the keyboard is set to Boot Protocol mode, so
  17  *  that the report structure is fixed and known. A better implementation
  18  *  uses the HID report parser for correct report data processing across
  19  *  all compatable mice with advanced characteristics, as shown in the
  20  *  KeyboardHostWithParser demo application.
  21  *
  22  *  Currently only single interface keyboards are supported.
  23  *
  24  *  <table>
  25  *   <tr>
  26  *    <td><b>USB Mode:</b></td>
  27  *    <td>Host</td>
  28  *   </tr>
  29  *   <tr>
  30  *    <td><b>USB Class:</b></td>
  31  *    <td>Human Interface Device (HID)</td>
  32  *   </tr>
  33  *   <tr>
  34  *    <td><b>USB Subclass:</b></td>
  35  *    <td>N/A</td>
  36  *   </tr>
  37  *   <tr>
  38  *    <td><b>Relevant Standards:</b></td>
  39  *    <td>USBIF HID Specification, USBIF HID Usage Tables</td>
  40  *   </tr>
  41  *   <tr>
  42  *    <td><b>Usable Speeds:</b></td>
  43  *    <td>Low Speed Mode, Full Speed Mode</td>
  44  *   </tr>
  45  *  </table>
  46  */