Demos/MouseHost/MouseHost.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 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.
  12  *
  13  *  Mouse movement and button presses are displayed on the board LEDs,
  14  *  as well as printed out the serial terminal as formatted dY, dY and
  15  *  button status information.
  16  *
  17  *  This uses a naive method where the mouse is set to Boot Protocol mode, so
  18  *  that the report structure is fixed and known. A better implementation
  19  *  uses the HID report parser for correct report data processing across
  20  *  all compatable mice with advanced characteristics, as shown in the
  21  *  MouseHostWithParser demo application.
  22  *
  23  *  Currently only single interface mice are supported.
  24  *
  25  *  <table>
  26  *   <tr>
  27  *    <td><b>USB Mode:</b></td>
  28  *    <td>Host</td>
  29  *   </tr>
  30  *   <tr>
  31  *    <td><b>USB Class:</b></td>
  32  *    <td>Human Interface Device (HID)</td>
  33  *   </tr>
  34  *   <tr>
  35  *    <td><b>USB Subclass:</b></td>
  36  *    <td>N/A</td>
  37  *   </tr>
  38  *   <tr>
  39  *    <td><b>Relevant Standards:</b></td>
  40  *    <td>USBIF HID Specification, USBIF HID Usage Tables</td>
  41  *   </tr>
  42  *   <tr>
  43  *    <td><b>Usable Speeds:</b></td>
  44  *    <td>Low Speed Mode, Full Speed Mode</td>
  45  *   </tr>
  46  *  </table>
  47  */