protocol/lufa/LUFA-git/Projects/MediaController/MediaController.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 Media Controller Project
   8  *
   9  *  \section Sec_Compat Project Compatibility:
  10  *
  11  *  The following list indicates what microcontrollers are compatible with this project.
  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  *
  18  *  \section Sec_Info USB Information:
  19  *
  20  *  The following table gives a rundown of the USB utilization of this demo.
  21  *
  22  *  <table>
  23  *   <tr>
  24  *    <td><b>USB Mode:</b></td>
  25  *    <td>Device</td>
  26  *   </tr>
  27  *   <tr>
  28  *    <td><b>USB Class:</b></td>
  29  *    <td>Human Interface Device (HID)</td>
  30  *   </tr>
  31  *   <tr>
  32  *    <td><b>USB Subclass:</b></td>
  33  *    <td>N/A</td>
  34  *   </tr>
  35  *   <tr>
  36  *    <td><b>Relevant Standards:</b></td>
  37  *    <td>USBIF HID Specification \n
  38  *        USBIF HID Usage Tables</td>
  39  *   </tr>
  40  *   <tr>
  41  *    <td><b>Supported USB Speeds:</b></td>
  42  *    <td>Low Speed Mode \n
  43  *        Full Speed Mode</td>
  44  *   </tr>
  45  *  </table>
  46  *
  47  *  \section Sec_Description Project Description:
  48  *
  49  *  Media Controller project. This project implements a basic Media Control device, to signal the host to play, pause, toggle playback,
  50  *  mute and/or adjust the host volume, in addition to other such media commands. This project may be extended to create a dedicated
  51  *  media playback control device, for home media centers or other equipment. By default, some of the most commonly used playback controls
  52  *  are controlled by the board joystick and LEDs, however this may be altered as desired.
  53  *
  54  *  \section Sec_Options Project Options
  55  *
  56  *  The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
  57  *
  58  *  <table>
  59  *   <tr>
  60  *    <td>
  61  *     None
  62  *    </td>
  63  *   </tr>
  64  *  </table>
  65  */
  66