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