Demos/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  *  Mouse demonstration application. This gives a simple reference
  10  *  application for implementing a USB Mouse using the basic USB HID
  11  *  drivers in all modern OSes (i.e. no special drivers required). It is
  12  *  boot protocol compatible, and thus works under compatible BIOS as if
  13  *  it was a native mouse (e.g. PS/2).
  14  *
  15  *  On startup the system will automatically enumerate and function
  16  *  as a mouse when the USB connection to a host is present. To use
  17  *  the mouse, move the joystick to move the pointer, and push the
  18  *  joystick inwards to simulate a left-button click. The HWB serves as
  19  *  the right mouse button.
  20  *
  21  *  <table>
  22  *   <tr>
  23  *    <td><b>USB Mode:</b></td>
  24  *    <td>Device</td>
  25  *   </tr>
  26  *   <tr>
  27  *    <td><b>USB Class:</b></td>
  28  *    <td>Human Interface Device (HID)</td>
  29  *   </tr>
  30  *   <tr>
  31  *    <td><b>USB Subclass:</b></td>
  32  *    <td>N/A</td>
  33  *   </tr>
  34  *   <tr>
  35  *    <td><b>Relevant Standards:</b></td>
  36  *    <td>USBIF HID Specification, USBIF HID Usage Tables</td>
  37  *   </tr>
  38  *   <tr>
  39  *    <td><b>Usable Speeds:</b></td>
  40  *    <td>Low Speed Mode, Full Speed Mode</td>
  41  *   </tr>
  42  *  </table>
  43  */