Demos/Device/ClassDriver/MIDI/MIDI.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 MIDI Input Device Demo
   8  *
   9  *  \section Sec_Compat Demo Compatibility:
  10  *
  11  *  The following list indicates what microcontrollers are compatible with this demo.
  12  *
  13  *  - Series 7 USB AVRs (AT90USBxxx7)
  14  *  - Series 6 USB AVRs (AT90USBxxx6)
  15  *  - Series 4 USB AVRs (ATMEGAxxU4)
  16  *  - 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>Audio Class</td>
  30  *   </tr>
  31  *   <tr>
  32  *    <td><b>USB Subclass:</b></td>
  33  *    <td>Standard Audio Device</td>
  34  *   </tr>
  35  *   <tr>
  36  *    <td><b>Relevant Standards:</b></td>
  37  *    <td>USBIF Audio Class Specification \n
  38  *        USB-MIDI Audio Class Extension Specification \n
  39  *        General MIDI Specification</td>
  40  *   </tr>
  41  *   <tr>
  42  *    <td><b>Usable Speeds:</b></td>
  43  *    <td>Full Speed Mode</td>
  44  *   </tr>
  45  *  </table>
  46  *
  47  *  \section Sec_Description Project Description:
  48  *
  49  *  MIDI demonstration application. This gives a simple reference
  50  *  application for implementing the USB-MIDI class in USB devices.
  51  *  It is built upon the USB Audio class.
  52  *
  53  *  Joystick movements are translated into note on/off messages and
  54  *  are sent to the host PC as MIDI streams which can be read by any
  55  *  MIDI program supporting MIDI IN devices.
  56  *
  57  *  If the HWB is not pressed, channel 1 (default piano) is used. If
  58  *  the HWB is set, then channel 10 (default percussion) is selected.
  59  *
  60  *  This device implements MIDI-THRU mode, with the IN MIDI data being
  61  *  generated by the device itself. OUT MIDI data is discarded.
  62  *
  63  *  \section Sec_Options Project Options
  64  *
  65  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  66  *
  67  *  <table>
  68  *   <tr>
  69  *    <td>
  70  *     None
  71  *    </td>
  72  *   </tr>
  73  *  </table>
  74  */
  75