aboutsummaryrefslogtreecommitdiffstats
path: root/Projects/MediaController/MediaController.txt
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2011-05-23 12:54:15 +0000
committerDean Camera <dean@fourwalledcubicle.com>2011-05-23 12:54:15 +0000
commitb88e0a7b90671a6b96196acc04fb811035663f22 (patch)
tree4b9b9a6f82720e7d4fb99188aede6430eb56bd16 /Projects/MediaController/MediaController.txt
parent4343e68779751605274e80336b56a2793f7482f0 (diff)
downloadlufa-b88e0a7b90671a6b96196acc04fb811035663f22.tar.gz
lufa-b88e0a7b90671a6b96196acc04fb811035663f22.tar.bz2
lufa-b88e0a7b90671a6b96196acc04fb811035663f22.zip
Add new MediaController project, a simple Media Playback control manipulator (Play/Pause/Next Track/Volume/etc.).
Diffstat (limited to 'Projects/MediaController/MediaController.txt')
-rw-r--r--Projects/MediaController/MediaController.txt66
1 files changed, 66 insertions, 0 deletions
diff --git a/Projects/MediaController/MediaController.txt b/Projects/MediaController/MediaController.txt
new file mode 100644
index 000000000..ac1506b29
--- /dev/null
+++ b/Projects/MediaController/MediaController.txt
@@ -0,0 +1,66 @@
+/** \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 Media Controller Project
+ *
+ * \section Sec_Compat Project Compatibility:
+ *
+ * The following list indicates what microcontrollers are compatible with this project.
+ *
+ * - Series 7 USB AVRs (AT90USBxxx7)
+ * - Series 6 USB AVRs (AT90USBxxx6)
+ * - Series 4 USB AVRs (ATMEGAxxU4)
+ * - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
+ *
+ * \section Sec_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>Human Interface Device (HID)</td>
+ * </tr>
+ * <tr>
+ * <td><b>USB Subclass:</b></td>
+ * <td>N/A</td>
+ * </tr>
+ * <tr>
+ * <td><b>Relevant Standards:</b></td>
+ * <td>USBIF HID Specification \n
+ * USBIF HID Usage Tables</td>
+ * </tr>
+ * <tr>
+ * <td><b>Usable Speeds:</b></td>
+ * <td>Low Speed Mode \n
+ * Full Speed Mode</td>
+ * </tr>
+ * </table>
+ *
+ * \section Sec_Description Project Description:
+ *
+ * Media Controller project. This project implements a basic Media Control device, to signal the host to play, pause, toggle playback,
+ * mute and/or adjust the host volume, in addition to other such media commands. This project may be extended to create a dedicated
+ * media playback control device, for home media centers or other equipment. By default, some of the most commonly used playback controls
+ * are controlled by the board joystick and LEDs, however this may be altered as desired.
+ *
+ * \section Sec_Options Project Options
+ *
+ * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
+ *
+ * <table>
+ * <tr>
+ * <td>
+ * None
+ * </td>
+ * </tr>
+ * </table>
+ */
+