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