Demos/KeyboardMouse/KeyboardMouse.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 Dual HID Keyboard and Mouse Device Demo
   8  *
   9  *  Keyboard/Mouse demonstration application. This gives a simple reference
  10  *  application for implementing a composite device containing both USB Keyboard
  11  *  and USB Mouse functionality using the basic USB HID drivers in all modern OSes
  12  *  (i.e. no special drivers required). This example uses two seperate HID
  13  *  interfaces for each function. It is boot protocol compatible, and thus works under
  14  *  compatible BIOS as if it was a native keyboard and mouse (e.g. PS/2).
  15  *
  16  *  On startup the system will automatically enumerate and function
  17  *  as a keyboard when the USB connection to a host is present and the HWB is not
  18  *  pressed. When enabled, manipulate the joystick to send the letters
  19  *  a, b, c, d and e. See the USB HID documentation for more information
  20  *  on sending keyboard event and keypresses.
  21  *
  22  *  When the HWB is pressed, the mouse mode is enabled. When enabled, move the
  23  *  joystick to move the pointer, and push the joystick inwards to simulate a
  24  *  left-button click.
  25  *
  26  *  <table>
  27  *   <tr>
  28  *    <td><b>USB Mode:</b></td>
  29  *    <td>Device</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  */