Demos/OTG/TestApp/TestApp.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 Test Application for the LUFA library
   8  *
   9  *  \section SSec_Info USB Information:
  10  *
  11  *  The following table gives a rundown of the USB utilization of this demo.
  12  *
  13  *  <table>
  14  *   <tr>
  15  *    <td><b>USB Mode:</b></td>
  16  *    <td>Host/Device (Dual Role)</td>
  17  *   </tr>
  18  *   <tr>
  19  *    <td><b>USB Class:</b></td>
  20  *    <td>N/A</td>
  21  *   </tr>
  22  *   <tr>
  23  *    <td><b>USB Subclass:</b></td>
  24  *    <td>N/A</td>
  25  *   </tr>
  26  *   <tr>
  27  *    <td><b>Relevant Standards:</b></td>
  28  *    <td>N/A</td>
  29  *   </tr>
  30  *   <tr>
  31  *    <td><b>Usable Speeds:</b></td>
  32  *    <td>Low Speed Mode, Full Speed Mode</td>
  33  *   </tr>
  34  *  </table>
  35  *
  36  *  \section SSec_Description Project Description:
  37  *
  38  *  Test application. Demonstrates several aspects of the LUFA
  39  *  Library. On start-up the current temperature will be printed
  40  *  through the USART every 10 seconds, and the current joystick
  41  *  position will be indicated via the LEDs on the selected board.
  42  *  Pressing the HWB will initiate the USB subsystem, enumerating
  43  *  the device (which has <b>no actual functionality beyond
  44  *  enumeration as a device or as a host in this demo</b>, and serves
  45  *  only to demonstrate the USB portion of the library). It will
  46  *  also suspend the joystick and temperature monitoring tasks.
  47  *
  48  *  Pressing the HWB a second time will turn off the USB system
  49  *  and resume the temperature printing task (but not the joystick
  50  *  monitoring task).
  51  *
  52  *  When activated, the USB events will be printed through the
  53  *  serial USART.
  54  *
  55  *  When the USB subsystem is activated, the board LEDs will show
  56  *  the current USB status.
  57  *
  58  *  \section SSec_Options Project Options
  59  *
  60  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  61  *
  62  *  <table>
  63  *   <tr>
  64  *    <td>
  65  *     None
  66  *    </td>
  67  *   </tr>
  68  *  </table>
  69  */