Statistics
| Branch: | Tag: | Revision:

root / LUFA / ManPages / LibraryApps.txt @ 978b99e5

History | View | Annotate | Download (10.5 KB)

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
/** \page Page_LibraryApps Included Library Applications
8
 *
9
 *  The LUFA library ships with several different host and device demos, located in the /Demos/ subdirectory. Within this
10
 *  directory the demos are separated by USB mode (Device, Host, OTG) and further separated by the use or non-use of the
11
 *  library USB Class drivers (which abstract out the actual implementation of the USB classes to simplify development even
12
 *  further at the expense of a loss of flexibility).
13
 *
14
 *  With one or two exceptions (e.g. proprietary classes such as RNDIS) all the included demos will work across all OSes without
15
 *  the need for special drivers. On Windows, some demos require the supplied .INF file to be used as the device driver, which
16
 *  directs the OS to use its inbuilt class drivers for the device.
17
 *
18
 *  Also included with the library are two fully functional bootloaders, located in the /Bootloaders/ subdirectory.
19
 *  The DFU class bootloader is compatible with Atmel's FLIP software or the open source dfu-programmer project, while
20
 *  the CDC class (AVR109 protocol) is compatible with such open source software as AVRDUDE and AVR-OSP.
21
 *
22
 *  User-submitted projects are located in the /Projects/ subdirectory. If you wish to have your LUFA project included,
23
 *  please email it to the Library author.
24
 *
25
 *  \section Sec_AppOverview Overview of Included Library Applications
26
 *  The following shows the folder structure of the included library applications, including demos, bootloaders and user-submitted
27
 *  open source projects.
28
 *
29
 *  <small>
30
 *
31
 *  - <b>Demos</b>
32
 *    - <b>Device</b>
33
 *      - <b>ClassDriver</b>
34
 *        - <b>AudioInput</b> - Audio In (microphone) demo, using the library USB Audio Class driver framework
35
 *        - <b>AudioOutput</b> - Audio Out (speaker) demo, using the library USB Audio Class driver framework
36
 *        - <b>DualVirtualSerial</b> - Dual Virtual Serial Port demo, using the library USB CDC Class driver framework
37
 *        - <b>GenericHID</b> - Generic Human Interface Class demo, using the library USB HID Class driver framework
38
 *        - <b>Joystick</b> - USB Joystick demo, using the library USB HID Class driver framework
39
 *        - <b>Keyboard</b> - USB Keyboard demo, using the library USB HID Class driver framework
40
 *        - <b>KeyboardMouse</b> - Dual Keyboard/Mouse demo, using the library USB HID Class driver framework
41
 *        - <b>KeyboardMouseMultiReport</b> - Multi HID report Keyboard/Mouse demo, using the library USB HID Class driver framework
42
 *        - <b>MassStorage</b> - Dual Drive Mass Storage demo, using the library USB Mass Storage Class driver framework
43
 *        - <b>MassStorageKeyboard</b> - Mass Storage and Keyboard demo, using the library USB Mass Storage/HID Class driver frameworks
44
 *        - <b>MIDI</b> - MIDI In demo, using the library USB MIDI-Audio Class driver framework
45
 *        - <b>Mouse</b> - USB Mouse demo, using the library USB HID driver framework
46
 *        - <b>RNDISEthernet</b> - RNDIS Ethernet Webserver demo, using the library USB RNDIS driver framework
47
 *        - <b>VirtualSerial</b> - Virtual Serial Port demo, using the library USB CDC Class driver framework
48
 *        - <b>VirtualSerialMassStorage</b> - Virtual Serial Port and Mass Storage demo, using the library USB CDC and Mass Storage Class driver frameworks
49
 *        - <b>VirtualSerialMouse</b> - Virtual Serial Port and Mouse demo, using the library USB CDC and HID Class driver frameworks
50
 *      - <b>LowLevel</b>
51
 *        - <b>AudioInput</b> - Audio In (microphone) demo, using the low level LUFA APIs to implement the USB Audio class
52
 *        - <b>AudioOutput</b> - Audio Out (speaker) demo, using the low level LUFA APIs to implement the USB Audio class
53
 *        - <b>DualVirtualSerial</b> - Dual Virtual Serial Port demo, using the low level LUFA APIs to implement the USB CDC class
54
 *        - <b>GenericHID</b> - Generic Human Interface Class demo, using the low level LUFA APIs to implement the USB HID class
55
 *        - <b>Joystick</b> - USB Joystick demo, using the low level LUFA APIs to implement the USB HID class
56
 *        - <b>Keyboard</b> - USB Keyboard demo, using the low level LUFA APIs to implement the USB HID class
57
 *        - <b>KeyboardMouse</b> - Dual Keyboard/Mouse demo, using the low level LUFA APIs to implement the USB HID class
58
 *        - <b>MassStorage</b> - Dual Drive Mass Storage demo, using the low level LUFA APIs to implement the USB Mass Storage class
59
 *        - <b>MIDI</b> - MIDI In demo, using the low level LUFA APIs to implement the USB MIDI-Audio class
60
 *        - <b>Mouse</b> - USB Mouse demo, using the low level LUFA APIs to implement the USB HID class
61
 *        - <b>RNDISEthernet</b> - RNDIS Ethernet Webserver demo, using the low level LUFA APIs to implement the USB RNDIS class
62
 *        - <b>VirtualSerial</b> - Virtual Serial Port demo, using the low level LUFA APIs to implement the USB CDC class
63
 *      - <b>Incomplete</b>
64
 *        - <b>SideShow</b> - Incomplete Windows SideShow demo, using the low level LUFA APIs to implement the USB SideShow class
65
 *        - <b>TestAndMeasurement</b> - Incomplete Test and Measurement demo, using the low level LUFA APIs to implement the USB Test and
66
 *                                      Measurement class
67
 *    - <b>Host</b>
68
 *      - <b>ClassDriver</b>
69
 *        - <b>AudioInputHost</b> - Audio Input host demo, using the library USB Audio Class driver framework
70
 *        - <b>AudioOutputHost</b> - Audio Output host demo, using the library USB Audio Class driver framework
71
 *        - <b>JoystickHostWithParser</b> - Joystick host demo with HID Descriptor parser, using the library USB HID Class driver framework
72
 *        - <b>KeyboardHost</b> - USB Keyboard host demo, using the library USB HID Class driver framework
73
 *        - <b>KeyboardHostWithParser</b> - USB Keyboard host demo with HID Descriptor parser, using the library USB HID Class
74
 *                                          driver framework
75
 *        - <b>MassStorageHost</b> - Mass Storage host demo, using the library USB Mass Storage Class driver framework
76
 *        - <b>MouseHost</b> - Mouse host demo, using the library USB HID Class driver framework
77
 *        - <b>MouseHostWithParser</b> - Mouse host demo with HID Descriptor parser, using the library USB HID Class driver framework
78
 *        - <b>RNDISHost</b> - RNDIS Ethernet host demo, using the library USB RNDIS Class driver framework
79
 *        - <b>StillImageHost</b> - Still Image Camera host demo, using the library USB Still Image Class driver framework
80
 *        - <b>VirtualSerialHost</b> - Virtual Serial Port host demo, using the library USB CDC Class driver framework
81
 *      - <b>LowLevel</b>
82
 *        - <b>AudioInputHost</b> - Audio Input host demo, using the low level LUFA APIs to implement the USB Audio class
83
 *        - <b>AudioOutputHost</b> - Audio Output host demo, using the low level LUFA APIs to implement the USB Audio class
84
 *        - <b>GenericHIDHost</b> - Generic HID host demo, using the low level LUFA APIs to implement the USB HID class
85
 *        - <b>JoystickHostWithParser</b> - Joystick host demo with HID Descriptor parser, using the low level LUFA APIs to implement
86
 *                                          the USB HID class
87
 *        - <b>KeyboardHost</b> - USB Keyboard host demo, using the low level LUFA APIs to implement the USB HID class
88
 *        - <b>KeyboardHostWithParser</b> - USB Keyboard host demo with HID Descriptor parser, using the low level LUFA APIs to
89
 *                                          implement the USB HID class
90
 *        - <b>MassStorageHost</b> - Mass Storage host demo, using the low level LUFA APIs to implement the USB Mass Storage class
91
 *        - <b>MouseHost</b> - Mouse host demo, using the low level LUFA APIs to implement the USB HID class
92
 *        - <b>MouseHostWithParser</b> - Mouse host demo with HID Descriptor parser, using the low level LUFA APIs to implement the
93
 *                                       USB HID class
94
 *        - <b>PrinterHost</b> - Printer host demo, using the low level LUFA APIs to implement the USB Printer class
95
 *        - <b>RNDISHost</b> - RNDIS Ethernet host demo, using the low level LUFA APIs to implement the RNDIS class
96
 *        - <b>StillImageHost</b> - Still Image Camera host demo, using the low level LUFA APIs to implement the USB Still Image class
97
 *        - <b>VirtualSerialHost</b> - Virtual Serial Port host demo, using the low level LUFA APIs to implement the USB CDC class
98
 *      - <b>Incomplete</b>
99
 *        - <b>BluetoothHost</b> - Incomplete Bluetooth host demo, using the low level LUFA APIs to implement the USB Bluetooth class
100
 *    - <b>DualRole</b>
101
 *      - <b>ClassDriver</b>
102
 *        - <b>MouseHostDevice</b> - Dual role Mouse Host and Mouse Device demo, using the library USB CDC Class driver framework
103
 *  - <b>Bootloaders</b>
104
 *    - <b>CDC</b> - CDC Class USB bootloader, compatible with any AVR910 protocol programming software such as AVRDude
105
 *    - <b>DFU</b> - DFU Class USB bootloader, compatible with Atmel's FLIP and the open source dfu-programmer software
106
 *    - <b>HID</b> - HID Class USB bootloader, compatible with a modified PJRC TeensyHID protocol loader application software
107
 *  - <b>Projects</b>
108
 *    - <b>AVRISP-MKII</b> - AVRISP-MKII Programmer Clone project
109
 *    - <b>Benito</b> - Benito Board Arduino Programmer project
110
 *    - <b>HIDReportViewer</b> - HID Device Report Viewer project
111
 *    - <b>LEDNotifier</b> - USB LED Notification project
112
 *    - <b>Magstripe</b> - Magnetic Stripe Card Reader project
113
 *    - <b>MediaController</b> - Media Playback Controller project
114
 *    - <b>MIDIToneGenerator</b> - MIDI Note Tone Generator project
115
 *    - <b>MissileLaucher</b> - Toy Missile Launcher Host project
116
 *    - <b>RelayBoard</b> - Relay board controller, controllable via the "sismpctl" Linux application
117
 *    - <b>TempDataLogger</b> - Temperature Datalogging project, using the FatFS library
118
 *    - <b>USBtoSerial</b> - USB to USART Serial Converter project
119
 *    - <b>Webserver</b> - RNDIS Host Webserver with DHCP client, powered by uIP TCP/IP stack project and FatFS library
120
 *    - <b>XPLAINBridge</b> - XPLAIN alternative PDI Programmer/USB to Serial Bridge firmware project
121
 *    - <b>Incomplete</b>
122
 *      - <b>StandaloneProgrammer</b> - Incomplete Standalone AVR Programmer application, to program AVRs directly from a Mass Storage disk
123
 *
124
 *  </small>
125
 */
126