LUFA/ManPages/LibraryApps.txt

   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 seperated by USB mode (Device, Host, OTG) and further seperated 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 three 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, the
  20  *  CDC class (AVR109 protocol) is compatible with such open source software as AVRDUDE and AVR-OSP, and the TeensyLoader
  21  *  HID class bootloader is compatible with the software from PJRC (<a>http://www.pjrc.com/teensy/index.html</a>).
  22  *
  23  *  User-submitted projects are located in the /Projects/ subdirectory. If you wish to have your LUFA project included,
  24  *  please email it to the Library author.
  25  *
  26  *  \section Sec_AppOverview Overview of Included Library Applications
  27  *  The following shows the folder structure of the included library applications, including demos, bootloaders and user-submitted
  28  *  open source projects.
  29  *
  30  *  <small>
  31  *
  32  *  - <b>Demos</b>
  33  *    - <b>Device</b>
  34  *      - <b>ClassDriver</b>
  35  *        - <b>AudioInput</b> - Audio In (microphone) demo, using the library USB Audio Class driver framework
  36  *        - <b>AudioOutput</b> - Audio Out (speaker) demo, using the library USB Audio Class driver framework
  37  *        - <b>DualVirtualSerial</b> - Dual Virtual Serial Port demo, using the library USB CDC Class driver framework
  38  *        - <b>GenericHID</b> - Generic Human Interface Class demo, using the library USB HID Class driver framework
  39  *        - <b>Joystick</b> - USB Joystick demo, using the library USB HID Class driver framework
  40  *        - <b>Keyboard</b> - USB Keyboard demo, using the library USB HID Class driver framework
  41  *        - <b>KeyboardMouse</b> - Dual 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>VirtualSerialMouse</b> - Virtual Serial Port and Mouse demo, using the library USB CDC and HID Class driver frameworks
  49  *      - <b>LowLevel</b>
  50  *        - <b>AudioInput</b> - Audio In (microphone) demo, using the low level LUFA APIs to implement the USB Audio class
  51  *        - <b>AudioOutput</b> - Audio Out (speaker) demo, using the low level LUFA APIs to implement the USB Audio class
  52  *        - <b>DualVirtualSerial</b> - Dual Virtual Serial Port demo, using the low level LUFA APIs to implement the USB CDC class
  53  *        - <b>GenericHID</b> - Generic Human Interface Class demo, using the low level LUFA APIs to implement the USB HID class
  54  *        - <b>Joystick</b> - USB Joystick demo, using the low level LUFA APIs to implement the USB HID class
  55  *        - <b>Keyboard</b> - USB Keyboard demo, using the low level LUFA APIs to implement the USB HID class
  56  *        - <b>KeyboardMouse</b> - Dual Keyboard/Mouse demo, using the low level LUFA APIs to implement the USB HID class
  57  *        - <b>MassStorage</b> - Dual Drive Mass Storage demo, using the low level LUFA APIs to implement the USB Mass Storage class
  58  *        - <b>MIDI</b> - MIDI In demo, using the low level LUFA APIs to implement the USB MIDI-Audio class
  59  *        - <b>Mouse</b> - USB Mouse demo, using the low level LUFA APIs to implement the USB HID class
  60  *        - <b>RNDISEthernet</b> - RNDIS Ethernet Webserver demo, using the low level LUFA APIs to implement the USB RNDIS class
  61  *        - <b>VirtualSerial</b> - Virtual Serial Port demo, using the low level LUFA APIs to implement the USB CDC class
  62  *      - <b>Incomplete</b>
  63  *        - <b>SideShow</b> - Incomplete Windows SideShow demo, using the low level LUFA APIs to implement the USB SideShow class
  64  *    - <b>Host</b>
  65  *      - <b>ClassDriver</b>
  66  *        - <b>JoystickHostWithParser</b> - Joystick host demo with HID Descriptor parser, using the library USB HID Class driver framework
  67  *        - <b>KeyboardHost</b> - USB Keyboard host demo, using the library USB HID Class driver framework
  68  *        - <b>KeyboardHostWithParser</b> - USB Keyboard host demo with HID Descriptor parser, using the library USB HID Class
  69  *                                          driver framework
  70  *        - <b>MassStorageHost</b> - Mass Storage host demo, using the library USB Mass Storage Class driver framework
  71  *        - <b>MouseHost</b> - Mouse host demo, using the library USB HID Class driver framework
  72  *        - <b>MouseHostWithParser</b> - Mouse host demo with HID Descriptor parser, using the library USB HID Class driver framework
  73  *        - <b>RNDISHost</b> - RNDIS Ethernet host demo, using the library USB RNDIS Class driver framework
  74  *        - <b>StillImageHost</b> - Still Image Camera host demo, using the library USB Still Image Class driver framework
  75  *        - <b>VirtualSerialHost</b> - Virtual Serial Port host demo, using the library USB CDC Class driver framework
  76  *      - <b>LowLevel</b>
  77  *        - <b>JoystickHostWithParser</b> - Joystick host demo with HID Descriptor parser, using the low level LUFA APIs to implement
  78  *                                          the USB HID class
  79  *        - <b>GenericHIDHost</b> - Generic HID host demo, using the low level LUFA APIs to implement the USB HID class
  80  *        - <b>KeyboardHost</b> - USB Keyboard host demo, using the low level LUFA APIs to implement the USB HID class
  81  *        - <b>KeyboardHostWithParser</b> - USB Keyboard host demo with HID Descriptor parser, using the low level LUFA APIs to
  82  *                                          implement the USB HID class
  83  *        - <b>MassStorageHost</b> - Mass Storage host demo, using the low level LUFA APIs to implement the USB Mass Storage class
  84  *        - <b>MouseHost</b> - Mouse host demo, using the low level LUFA APIs to implement the USB HID class
  85  *        - <b>MouseHostWithParser</b> - Mouse host demo with HID Descriptor parser, using the low level LUFA APIs to implement the
  86  *                                       USB HID class
  87  *        - <b>PrinterHost</b> - Printer host demo, using the low level LUFA APIs to implement the USB Printer class
  88  *        - <b>RNDISHost</b> - RNDIS Ethernet host demo, using the low level LUFA APIs to implement the RNDIS class
  89  *        - <b>StillImageHost</b> - Still Image Camera host demo, using the low level LUFA APIs to implement the USB Still Image class
  90  *        - <b>VirtualSerialHost</b> - Virtual Serial Port host demo, using the low level LUFA APIs to implement the USB CDC class
  91  *      - <b>Incomplete</b>
  92  *        - <b>BluetoothHost</b> - Incomplete Bluetooth host demo, using the low level LUFA APIs to implement the USB Bluetooth class
  93  *    - <b>DualRole</b>
  94  *      - <b>ClassDriver</b>
  95  *        - <b>MouseHostDevice</b> - Dual role Mouse Host and Mouse Device demo, using the library USB CDC Class driver framework
  96  *  - <b>Bootloaders</b>
  97  *    - <b>DFU</b> - DFU Class USB bootloader, compatible with Atmel's FLIP and the open source dfu-programmer software
  98  *    - <b>CDC</b> - CDC Class USB bootloader, compatible with any AVR910 protocol programming software such as AVRDude
  99  *    - <b>TeensyHID</b> - HID Class bootloader, compatible with the PJRC TeensyLoader software
 100  *  - <b>Projects</b>
 101  *    - <b>AVRISP</b> - AVRISP-MKII Programmer Clone project
 102  *    - <b>Benito</b> - Benito Board Arduino Programmer project
 103  *    - <b>LEDNotifier</b> - USB LED Notification project
 104  *    - <b>Magstripe</b> - Magnetic Stripe Card Reader project
 105  *    - <b>MissileLaucher</b> - Toy Missile Launcher Host project
 106  *    - <b>USBtoSerial</b> - USB to USART Serial Converter project
 107  *
 108  *  </small>
 109  */