Demos/Device/ClassDriver/Mouse/Mouse.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 Device 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  *  - Series 6 USB AVRs
  15  *  - Series 4 USB AVRs
  16  *  - Series 2 USB AVRs
  17  *
  18  *  \section SSec_Info USB Information:
  19  *
  20  *  The following table gives a rundown of the USB utilization of this demo.
  21  *
  22  *  <table>
  23  *   <tr>
  24  *    <td><b>USB Mode:</b></td>
  25  *    <td>Device</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>Mouse Subclass</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  *
  45  *  \section SSec_Description Project Description:
  46  *
  47  *  Mouse demonstration application. This gives a simple reference
  48  *  application for implementing a USB Mouse using the basic USB HID
  49  *  drivers in all modern OSes (i.e. no special drivers required). It is
  50  *  boot protocol compatible, and thus works under compatible BIOS as if
  51  *  it was a native mouse (e.g. PS/2).
  52  *
  53  *  On start-up the system will automatically enumerate and function
  54  *  as a mouse when the USB connection to a host is present. To use
  55  *  the mouse, move the joystick to move the pointer, and push the
  56  *  joystick inwards to simulate a left-button click. The HWB serves as
  57  *  the right mouse button.
  58  *
  59  *  \section SSec_Options Project Options
  60  *
  61  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  62  *
  63  *  <table>
  64  *   <tr>
  65  *    <td>
  66  *     None
  67  *    </td>
  68  *   </tr>
  69  *  </table>
  70  */