Demos/MouseHostWithParser/MouseHostWithParser.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 Mouse Host With HID Descriptor Parser Demo
   8  *
   9  *  Mouse host demonstration application. This gives a simple reference
  10  *  application for implementing a USB Mouse host, for USB mice using
  11  *  the standard mouse HID profile. It uses a HID parser for the HID
  12  *  reports, allowing for correct operation across all USB mice. This
  13  *  demo supports mice with a single HID report.
  14  *
  15  *  Mouse movement and button presses are displayed on the board LEDs.
  16  *  On connection to a USB mouse, the report items will be processed and
  17  *  printed as a formatted list through the USART before the mouse is
  18  *  fully enumerated.
  19  *
  20  *  Currently only single interface mice are supported.
  21  *
  22  *  <table>
  23  *   <tr>
  24  *    <td><b>USB Mode:</b></td>
  25  *    <td>Host</td>
  26  *   </tr>
  27  *   <tr>
  28  *    <td><b>USB Class:</b></td>
  29  *    <td>Human Interface Device (HID)</td>
  30  *   </tr>
  31  *   <tr>
  32  *    <td><b>USB Subclass:</b></td>
  33  *    <td>N/A</td>
  34  *   </tr>
  35  *   <tr>
  36  *    <td><b>Relevant Standards:</b></td>
  37  *    <td>USBIF HID Specification, USBIF HID Usage Tables</td>
  38  *   </tr>
  39  *   <tr>
  40  *    <td><b>Usable Speeds:</b></td>
  41  *    <td>Low Speed Mode, Full Speed Mode</td>
  42  *   </tr>
  43  *  </table>
  44  */