lib/lufa/Demos/Device/ClassDriver/KeyboardMouseMultiReport/KeyboardMouseMultiReport.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 Multiple Report HID Keyboard and Mouse Device Demo
   8  *
   9  *  \section Sec_Compat Demo Compatibility:
  10  *
  11  *  The following list indicates what microcontrollers are compatible with this demo.
  12  *
  13  *  \li Series 7 USB AVRs (AT90USBxxx7)
  14  *  \li Series 6 USB AVRs (AT90USBxxx6)
  15  *  \li Series 4 USB AVRs (ATMEGAxxU4)
  16  *  \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
  17  *  \li Series AU XMEGA AVRs (ATXMEGAxxxAxU)
  18  *  \li Series B XMEGA AVRs (ATXMEGAxxxBx)
  19  *  \li Series C XMEGA AVRs (ATXMEGAxxxCx)
  20  *
  21  *  \section Sec_Info USB Information:
  22  *
  23  *  The following table gives a rundown of the USB utilization of this demo.
  24  *
  25  *  <table>
  26  *   <tr>
  27  *    <td><b>USB Mode:</b></td>
  28  *    <td>Device</td>
  29  *   </tr>
  30  *   <tr>
  31  *    <td><b>USB Class:</b></td>
  32  *    <td>Human Interface Device (HID)</td>
  33  *   </tr>
  34  *   <tr>
  35  *    <td><b>USB Subclass:</b></td>
  36  *    <td>N/A</td>
  37  *   </tr>
  38  *   <tr>
  39  *    <td><b>Relevant Standards:</b></td>
  40  *    <td>USBIF HID Specification \n
  41  *        USBIF HID Usage Tables</td>
  42  *   </tr>
  43  *   <tr>
  44  *    <td><b>Supported USB Speeds:</b></td>
  45  *    <td>Low Speed Mode \n
  46  *        Full Speed Mode</td>
  47  *   </tr>
  48  *  </table>
  49  *
  50  *  \section Sec_Description Project Description:
  51  *
  52  *  Keyboard/Mouse demonstration application, using a single HID interface. This gives
  53  *  a simple reference application for implementing a multiple HID report device
  54  *  containing both USB Keyboard and USB Mouse functionality using the basic USB HID
  55  *  drivers in all modern OSes (i.e. no special drivers required). This example uses a
  56  *  single HID interface that is shared between the two functions.
  57  *
  58  *  On start-up the system will automatically enumerate and function as a keyboard when
  59  *  the USB connection to a host is present and the HWB is not pressed. When enabled,
  60  *  manipulate the joystick to send the letters a, b, c, d and e. See the USB HID
  61  *  documentation for more information on sending keyboard event and key presses.
  62  *
  63  *  When the HWB is pressed, the mouse mode is enabled. When enabled, move the joystick
  64  *  to move the pointer, and push the joystick inwards to simulate a left-button click.
  65  *
  66  *  \section Sec_Options Project Options
  67  *
  68  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  69  *
  70  *  <table>
  71  *   <tr>
  72  *    <td>
  73  *     None
  74  *    </td>
  75  *   </tr>
  76  *  </table>
  77  */
  78