Demos/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  *  Test application. Demonstrates several aspects of the LUFA
  10  *  Library. On startup the current temperature will be printed
  11  *  through the USART every 10 seconds, and the current joystick
  12  *  position will be indicated via the LEDs on the selected board.
  13  *  Pressing the HWB will initiate the USB subsystem, enumerating
  14  *  the device (which has <b>no actual functionality beyond
  15  *  enumeration as a device or as a host in this demo</b>, and serves
  16  *  only to demonstrate the USB portion of the library). It will
  17  *  also suspend the joystick and temperature monitoring tasks.
  18  *
  19  *  Pressing the HWB a second time will turn off the USB system
  20  *  and resume the temperature printing task (but not the joystick
  21  *  monitoring task).
  22  *
  23  *  When activated, the USB events will be printed through the
  24  *  serial USART.
  25  *
  26  *  When the USB subsystem is activated, the board LEDs will show
  27  *  the current USB status.
  28  *
  29  *  <table>
  30  *   <tr>
  31  *    <td><b>USB Mode:</b></td>
  32  *    <td>Host/Device (Dual Role)</td>
  33  *   </tr>
  34  *   <tr>
  35  *    <td><b>USB Class:</b></td>
  36  *    <td>N/A</td>
  37  *   </tr>
  38  *   <tr>
  39  *    <td><b>USB Subclass:</b></td>
  40  *    <td>N/A</td>
  41  *   </tr>
  42  *   <tr>
  43  *    <td><b>Relevant Standards:</b></td>
  44  *    <td>N/A</td>
  45  *   </tr>
  46  *   <tr>
  47  *    <td><b>Usable Speeds:</b></td>
  48  *    <td>Low Speed Mode, Full Speed Mode</td>
  49  *   </tr>
  50  *  </table>
  51  */