summaryrefslogtreecommitdiff
path: root/digital/avr/modules/usb/lufa/Demos/TestApp/TestApp.txt
blob: e5b268aa54974b75626414e2267519166f906ebd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
/** \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
 *
 *  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.
 *
 *  <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>
 */