aboutsummaryrefslogtreecommitdiffstats
path: root/Demos/Device/MIDI/MIDI.txt
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2009-03-20 06:34:41 +0000
committerDean Camera <dean@fourwalledcubicle.com>2009-03-20 06:34:41 +0000
commited031c1df2f5b053b9cd9f48c63e66a42b7c049e (patch)
tree8e49d639484d53a6e00700b20e2b804e9775242f /Demos/Device/MIDI/MIDI.txt
parentecf7538430c01b95104682f0f7493e57b9168125 (diff)
downloadlufa-ed031c1df2f5b053b9cd9f48c63e66a42b7c049e.tar.gz
lufa-ed031c1df2f5b053b9cd9f48c63e66a42b7c049e.tar.bz2
lufa-ed031c1df2f5b053b9cd9f48c63e66a42b7c049e.zip
Seperated out OTG, Device and Host mode demos into seperate folders for clarity. Adjusted makefiles so that the path to the LUFA library can be set in one place.
Diffstat (limited to 'Demos/Device/MIDI/MIDI.txt')
-rw-r--r--Demos/Device/MIDI/MIDI.txt65
1 files changed, 65 insertions, 0 deletions
diff --git a/Demos/Device/MIDI/MIDI.txt b/Demos/Device/MIDI/MIDI.txt
new file mode 100644
index 000000000..3eb60cdc6
--- /dev/null
+++ b/Demos/Device/MIDI/MIDI.txt
@@ -0,0 +1,65 @@
+/** \file
+ *
+ * This file contains special DoxyGen information for the generation of the main page and other special
+ * documentation pages. It is not a project source file.
+ */
+
+/** \mainpage MIDI Input Device Demo
+ *
+ * \section SSec_Info USB Information:
+ *
+ * The following table gives a rundown of the USB utilization of this demo.
+ *
+ * <table>
+ * <tr>
+ * <td><b>USB Mode:</b></td>
+ * <td>Device</td>
+ * </tr>
+ * <tr>
+ * <td><b>USB Class:</b></td>
+ * <td>Audio Class</td>
+ * </tr>
+ * <tr>
+ * <td><b>USB Subclass:</b></td>
+ * <td>Standard Audio Device</td>
+ * </tr>
+ * <tr>
+ * <td><b>Relevant Standards:</b></td>
+ * <td>USBIF Audio Class Specification</td>
+ * <td>USB-MIDI Audio Class Extention Specification</td>
+ * <td>General MIDI Specification</td>
+ * </tr>
+ * <tr>
+ * <td><b>Usable Speeds:</b></td>
+ * <td>Full Speed Mode</td>
+ * </tr>
+ * </table>
+ *
+ * \section SSec_Description Project Description:
+ *
+ * MIDI demonstration application. This gives a simple reference
+ * application for implementing the USB-MIDI class in USB devices.
+ * It is built upon the USB Audio class.
+ *
+ * Joystick movements are translated into note on/off messages and
+ * are sent to the host PC as MIDI streams which can be read by any
+ * MIDI program supporting MIDI IN devices.
+ *
+ * If the HWB is not pressed, channel 1 (default piano) is used. If
+ * the HWB is set, then channel 10 (default percussion) is selected.
+ *
+ * This device implements MIDI-THRU mode, with the IN MIDI data being
+ * generated by the device itself. OUT MIDI data is discarded.
+ *
+ * \section SSec_Options Project Options
+ *
+ * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
+ *
+ * <table>
+ * <tr>
+ * <td>
+ * None
+ * </td>
+ * </tr>
+ * </table>
+ */ \ No newline at end of file