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 SSec_Compat Demo Compatibility:
  10  *
  11  *  The following table indicates what microcontrollers are compatible with this demo.
  12  *
  13  *  - AT90USB1287
  14  *  - AT90USB1286
  15  *  - AT90USB647
  16  *  - AT90USB646
  17  *  - ATMEGA32U6
  18  *  - ATMEGA32U4
  19  *  - ATMEGA16U4
  20  *  - AT90USB162
  21  *  - AT90USB82
  22  *
  23  *  \section SSec_Info USB Information:
  24  *
  25  *  The following table gives a rundown of the USB utilization of this demo.
  26  *
  27  *  <table>
  28  *   <tr>
  29  *    <td><b>USB Mode:</b></td>
  30  *    <td>Device</td>
  31  *   </tr>
  32  *   <tr>
  33  *    <td><b>USB Class:</b></td>
  34  *    <td>Audio Class</td>
  35  *   </tr>
  36  *   <tr>
  37  *    <td><b>USB Subclass:</b></td>
  38  *    <td>Standard Audio Device</td>
  39  *   </tr>
  40  *   <tr>
  41  *    <td><b>Relevant Standards:</b></td>
  42  *    <td>USBIF Audio Class Specification</td>
  43  *    <td>USB-MIDI Audio Class Extension Specification</td>
  44  *    <td>General MIDI Specification</td>
  45  *   </tr>
  46  *   <tr>
  47  *    <td><b>Usable Speeds:</b></td>
  48  *    <td>Full Speed Mode</td>
  49  *   </tr>
  50  *  </table>
  51  *
  52  *  \section SSec_Description Project Description:
  53  *
  54  *  MIDI demonstration application. This gives a simple reference
  55  *  application for implementing the USB-MIDI class in USB devices.
  56  *  It is built upon the USB Audio class.
  57  *
  58  *  Joystick movements are translated into note on/off messages and
  59  *  are sent to the host PC as MIDI streams which can be read by any
  60  *  MIDI program supporting MIDI IN devices.
  61  *
  62  *  If the HWB is not pressed, channel 1 (default piano) is used. If
  63  *  the HWB is set, then channel 10 (default percussion) is selected.
  64  *
  65  *  This device implements MIDI-THRU mode, with the IN MIDI data being
  66  *  generated by the device itself. OUT MIDI data is discarded.
  67  *
  68  *  \section SSec_Options Project Options
  69  *
  70  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  71  *
  72  *  <table>
  73  *   <tr>
  74  *    <td>
  75  *     None
  76  *    </td>
  77  *   </tr>
  78  *  </table>
  79  */