diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-03-20 06:34:41 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-03-20 06:34:41 +0000 |
| commit | ed031c1df2f5b053b9cd9f48c63e66a42b7c049e (patch) | |
| tree | 8e49d639484d53a6e00700b20e2b804e9775242f /Demos/OTG/TestApp/TestApp.txt | |
| parent | ecf7538430c01b95104682f0f7493e57b9168125 (diff) | |
| download | lufa-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/OTG/TestApp/TestApp.txt')
| -rw-r--r-- | Demos/OTG/TestApp/TestApp.txt | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/Demos/OTG/TestApp/TestApp.txt b/Demos/OTG/TestApp/TestApp.txt new file mode 100644 index 000000000..aef55b761 --- /dev/null +++ b/Demos/OTG/TestApp/TestApp.txt @@ -0,0 +1,69 @@ +/** \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 Test Application for the LUFA library
+ *
+ * \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>Host/Device (Dual Role)</td>
+ * </tr>
+ * <tr>
+ * <td><b>USB Class:</b></td>
+ * <td>N/A</td>
+ * </tr>
+ * <tr>
+ * <td><b>USB Subclass:</b></td>
+ * <td>N/A</td>
+ * </tr>
+ * <tr>
+ * <td><b>Relevant Standards:</b></td>
+ * <td>N/A</td>
+ * </tr>
+ * <tr>
+ * <td><b>Usable Speeds:</b></td>
+ * <td>Low Speed Mode, Full Speed Mode</td>
+ * </tr>
+ * </table>
+ *
+ * \section SSec_Description Project Description:
+ *
+ * Test application. Demonstrates several aspects of the LUFA
+ * Library. On startup the current temperature will be printed
+ * through the USART every 10 seconds, and the current joystick
+ * position will be indicated via the LEDs on the selected board.
+ * Pressing the HWB will initiate the USB subsystem, enumerating
+ * the device (which has <b>no actual functionality beyond
+ * enumeration as a device or as a host in this demo</b>, and serves
+ * only to demonstrate the USB portion of the library). It will
+ * also suspend the joystick and temperature monitoring tasks.
+ *
+ * Pressing the HWB a second time will turn off the USB system
+ * and resume the temperature printing task (but not the joystick
+ * monitoring task).
+ *
+ * When activated, the USB events will be printed through the
+ * serial USART.
+ *
+ * When the USB subsystem is activated, the board LEDs will show
+ * the current USB status.
+ *
+ * \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 |