/** \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. */ /** \page Page_LibraryApps Included Library Applications * * The LUFA library ships with several different host and device demos, located in the /Demos/ subdirectory. Within this * directory the demos are seperated by USB mode (Device, Host, OTG) and further seperated by the use or non-use of the * library USB Class drivers (which abstract out the actual implementation of the USB classes to simplify development even * further at the expense of a loss of flexibility). * * With one or two exceptions (e.g. proprietary classes such as RNDIS) all the included demos will work across all OSes without * the need for special drivers. On Windows, some demos require the supplied .INF file to be used as the device driver, which * directs the OS to use its inbuilt class drivers for the device. * * Also included with the library are three fully functional bootloaders, located in the /Bootloaders/ subdirectory. * The DFU class bootloader is compatible with Atmel's FLIP software or the open source dfu-programmer project, the * CDC class (AVR109 protocol) is compatible with such open source software as AVRDUDE and AVR-OSP, and the TeensyLoader * HID class bootloader is compatible with the software from PJRC (http://www.pjrc.com/teensy/index.html). * * User-submitted projects are located in the /Projects/ subdirectory. If you wish to have your LUFA project included, * please email it to the Library author. * * \section Sec_AppOverview Overview of Included Library Applications * The following shows the folder structure of the included library applications, including demos, bootloaders and user-submitted * open source projects. * * * * - Demos * - Device * - ClassDriver * - AudioInput - Audio In (microphone) demo, using the library USB Audio Class driver framework * - AudioOutput - Audio Out (speaker) demo, using the library USB Audio Class driver framework * - DualVirtualSerial - Dual Virtual Serial Port demo, using the library USB CDC Class driver framework * - GenericHID - Generic Human Interface Class demo, using the library USB HID Class driver framework * - Joystick - USB Joystick demo, using the library USB HID Class driver framework * - Keyboard - USB Keyboard demo, using the library USB HID Class driver framework * - KeyboardMouse - Dual Keyboard/Mouse demo, using the library USB HID Class driver framework * - MassStorage - Dual Drive Mass Storage demo, using the library USB Mass Storage Class driver framework * - MassStorageKeyboard - Mass Storage and Keyboard demo, using the library USB Mass Storage/HID Class driver frameworks * - MIDI - MIDI In demo, using the library USB MIDI-Audio Class driver framework * - Mouse - USB Mouse demo, using the library USB HID driver framework * - RNDISEthernet - RNDIS Ethernet Webserver demo, using the library USB RNDIS driver framework * - VirtualSerial - Virtual Serial Port demo, using the library USB CDC Class driver framework * - VirtualSerialMouse - Virtual Serial Port and Mouse demo, using the library USB CDC and HID Class driver frameworks * - LowLevel * - AudioInput - Audio In (microphone) demo, using the low level LUFA APIs to implement the USB Audio class * - AudioOutput - Audio Out (speaker) demo, using the low level LUFA APIs to implement the USB Audio class * - DualVirtualSerial - Dual Virtual Serial Port demo, using the low level LUFA APIs to implement the USB CDC class * - GenericHID - Generic Human Interface Class demo, using the low level LUFA APIs to implement the USB HID class * - Joystick - USB Joystick demo, using the low level LUFA APIs to implement the USB HID class * - Keyboard - USB Keyboard demo, using the low level LUFA APIs to implement the USB HID class * - KeyboardMouse - Dual Keyboard/Mouse demo, using the low level LUFA APIs to implement the USB HID class * - MassStorage - Dual Drive Mass Storage demo, using the low level LUFA APIs to implement the USB Mass Storage class * - MIDI - MIDI In demo, using the low level LUFA APIs to implement the USB MIDI-Audio class * - Mouse - USB Mouse demo, using the low level LUFA APIs to implement the USB HID class * - RNDISEthernet - RNDIS Ethernet Webserver demo, using the low level LUFA APIs to implement the USB RNDIS class * - VirtualSerial - Virtual Serial Port demo, using the low level LUFA APIs to implement the USB CDC class * - Incomplete * - SideShow - Incomplete Windows SideShow demo, using the low level LUFA APIs to implement the USB SideShow class * - Host * - ClassDriver * - JoystickHostWithParser - Joystick host demo with HID Descriptor parser, using the library USB HID Class driver framework * - KeyboardHost - USB Keyboard host demo, using the library USB HID Class driver framework * - KeyboardHostWithParser - USB Keyboard host demo with HID Descriptor parser, using the library USB HID Class * driver framework * - MassStorageHost - Mass Storage host demo, using the library USB Mass Storage Class driver framework * - MouseHost - Mouse host demo, using the library USB HID Class driver framework * - MouseHostWithParser - Mouse host demo with HID Descriptor parser, using the library USB HID Class driver framework * - RNDISHost - RNDIS Ethernet host demo, using the library USB RNDIS Class driver framework * - StillImageHost - Still Image Camera host demo, using the library USB Still Image Class driver framework * - VirtualSerialHost - Virtual Serial Port host demo, using the library USB CDC Class driver framework * - LowLevel * - JoystickHostWithParser - Joystick host demo with HID Descriptor parser, using the low level LUFA APIs to implement * the USB HID class * - GenericHIDHost - Generic HID host demo, using the low level LUFA APIs to implement the USB HID class * - KeyboardHost - USB Keyboard host demo, using the low level LUFA APIs to implement the USB HID class * - KeyboardHostWithParser - USB Keyboard host demo with HID Descriptor parser, using the low level LUFA APIs to * implement the USB HID class * - MassStorageHost - Mass Storage host demo, using the low level LUFA APIs to implement the USB Mass Storage class * - MouseHost - Mouse host demo, using the low level LUFA APIs to implement the USB HID class * - MouseHostWithParser - Mouse host demo with HID Descriptor parser, using the low level LUFA APIs to implement the * USB HID class * - PrinterHost - Printer host demo, using the low level LUFA APIs to implement the USB Printer class * - RNDISHost - RNDIS Ethernet host demo, using the low level LUFA APIs to implement the RNDIS class * - StillImageHost - Still Image Camera host demo, using the low level LUFA APIs to implement the USB Still Image class * - VirtualSerialHost - Virtual Serial Port host demo, using the low level LUFA APIs to implement the USB CDC class * - Incomplete * - BluetoothHost - Incomplete Bluetooth host demo, using the low level LUFA APIs to implement the USB Bluetooth class * - DualRole * - ClassDriver * - MouseHostDevice - Dual role Mouse Host and Mouse Device demo, using the library USB CDC Class driver framework * - Bootloaders * - DFU - DFU Class USB bootloader, compatible with Atmel's FLIP and the open source dfu-programmer software * - CDC - CDC Class USB bootloader, compatible with any AVR910 protocol programming software such as AVRDude * - TeensyHID - HID Class bootloader, compatible with the PJRC TeensyLoader software * - Projects * - AVRISP - AVRISP-MKII Programmer Clone project * - Benito - Benito Board Arduino Programmer project * - Magstripe - Magnetic Stripe Card Reader project * - MissileLaucher - Toy Missile Launcher Host project * - USBtoSerial - USB to USART Serial Converter project * * */