Demos/Host/ClassDriver/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  *  \section SSec_Compat Demo Compatibility:
  10  *
  11  *  The following list indicates what microcontrollers are compatible with this demo.
  12  *
  13  *  - Series 7 USB AVRs
  14  *
  15  *  \section SSec_Info USB Information:
  16  *
  17  *  The following table gives a rundown of the USB utilization of this demo.
  18  *
  19  *  <table>
  20  *   <tr>
  21  *    <td><b>USB Mode:</b></td>
  22  *    <td>Host</td>
  23  *   </tr>
  24  *   <tr>
  25  *    <td><b>USB Class:</b></td>
  26  *    <td>Human Interface Device (HID)</td>
  27  *   </tr>
  28  *   <tr>
  29  *    <td><b>USB Subclass:</b></td>
  30  *    <td>N/A</td>
  31  *   </tr>
  32  *   <tr>
  33  *    <td><b>Relevant Standards:</b></td>
  34  *    <td>USBIF HID Specification \n
  35  *        USBIF HID Usage Tables</td>
  36  *   </tr>
  37  *   <tr>
  38  *    <td><b>Usable Speeds:</b></td>
  39  *    <td>Low Speed Mode \n
  40  *        Full Speed Mode</td>
  41  *   </tr>
  42  *  </table>
  43  *
  44  *  \section SSec_Description Project Description:
  45  *
  46  *  Mouse host demonstration application. This gives a simple reference
  47  *  application for implementing a USB Mouse host, for USB mice using
  48  *  the standard mouse HID profile.
  49  *
  50  *  Mouse movement and button presses are displayed on the board LEDs,
  51  *  as well as printed out the serial terminal as formatted dY, dY and
  52  *  button status information.
  53  *
  54  *  This uses a naive method where the mouse is set to Boot Protocol mode, so
  55  *  that the report structure is fixed and known. A better implementation
  56  *  uses the HID report parser for correct report data processing across
  57  *  all compatible mice with advanced characteristics, as shown in the
  58  *  MouseHostWithParser demo application.
  59  *
  60  *  Currently only single interface mice are supported.
  61  *
  62  *  \section SSec_Options Project Options
  63  *
  64  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  65  *
  66  *  <table>
  67  *   <tr>
  68  *    <td>
  69  *     None
  70  *    </td>
  71  *   </tr>
  72  *  </table>
  73  */