Demos/Host/ClassDriver/JoystickHostWithParser/JoystickHostWithParser.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 Joystick Host With HID Descriptor Parser 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  *
  15  *  \section SSec_Info USB Information:
  16  *
  17  *  The following table gives a rundown of the USB utilization of this demo.
  18  *
  19  *  <table>
  20  *   <tr>
  21  *    <td><b>USB Mode:</b></td>
  22  *    <td>Host</td>
  23  *   </tr>
  24  *   <tr>
  25  *    <td><b>USB Class:</b></td>
  26  *    <td>Human Interface Device (HID)</td>
  27  *   </tr>
  28  *   <tr>
  29  *    <td><b>USB Subclass:</b></td>
  30  *    <td>N/A</td>
  31  *   </tr>
  32  *   <tr>
  33  *    <td><b>Relevant Standards:</b></td>
  34  *    <td>USBIF HID Specification \n
  35  *        USBIF HID Usage Tables</td>
  36  *   </tr>
  37  *   <tr>
  38  *    <td><b>Usable Speeds:</b></td>
  39  *    <td>Low Speed Mode \n
  40  *        Full Speed Mode</td>
  41  *   </tr>
  42  *  </table>
  43  *
  44  *  \section SSec_Description Project Description:
  45  *
  46  *  Joystick host demonstration application. This gives a simple reference
  47  *  application for implementing a USB Joystick host, for USB joysticks using
  48  *  the standard joystick HID profile. It uses a HID parser for the HID
  49  *  reports, allowing for correct operation across all USB joysticks. This
  50  *  demo supports joysticks with a single HID report.
  51  *
  52  *  Joystick movement and button presses are displayed on the board LEDs.
  53  *  On connection to a USB joystick, the report items will be processed and
  54  *  printed as a formatted list through the USART before the joystick is
  55  *  fully enumerated.
  56  *
  57  *  Currently only single interface joysticks are supported.
  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  */