Fixed incorrect interface values in the VirtualSerialMouse and KeyboardMouse demo...

[pub/USBasp.git] / LUFA / ManPages / LibraryApps.txt

diff --git a/LUFA/ManPages/LibraryApps.txt b/LUFA/ManPages/LibraryApps.txt
index 3a6fecc..c79463e 100644 (file)
--- a/LUFA/ManPages/LibraryApps.txt
+++ b/LUFA/ManPages/LibraryApps.txt
@@ -6,14 +6,19 @@
 \r
 /** \page Page_LibraryApps Included Library Applications\r
  *\r
 \r
 /** \page Page_LibraryApps Included Library Applications\r
  *\r

- *  The LUFA library ships with several different host and device demos, located in the /Demos/ subdirectory.\r
- *  If this directory is missing, please re-download the project from the project homepage. Within this directory the demos\r
- *  are seperated by USB mode (Device, Host, OTG) and further seperated by the use or non-use of the library USB Class drivers.\r
+ *  The LUFA library ships with several different host and device demos, located in the /Demos/ subdirectory. Within this\r
+ *  directory the demos are seperated by USB mode (Device, Host, OTG) and further seperated by the use or non-use of the\r
+ *  library USB Class drivers (which abstract out the actual implementation of the USB classes to simplify development even\r
+ *  further at the expense of a loss of flexibility).\r
+ *\r
+ *  With one or two exceptions (e.g. proprietary classes such as RNDIS) all the included demos will work across all OSes without\r
+ *  the need for special drivers. On Windows, some demos require the supplied .INF file to be used as the device driver, which\r
+ *  directs the OS to use its inbuilt class drivers for the device.\r

  *\r
  *  Also included with the library are three fully functional bootloaders, located in the /Bootloaders/ subdirectory.\r
  *  The DFU class bootloader is compatible with Atmel's FLIP software or the open source dfu-programmer project, the\r
  *  CDC class (AVR109 protocol) is compatible with such open source software as AVRDUDE and AVR-OSP, and the TeensyLoader\r
  *\r
  *  Also included with the library are three fully functional bootloaders, located in the /Bootloaders/ subdirectory.\r
  *  The DFU class bootloader is compatible with Atmel's FLIP software or the open source dfu-programmer project, the\r
  *  CDC class (AVR109 protocol) is compatible with such open source software as AVRDUDE and AVR-OSP, and the TeensyLoader\r

- *  HID class bootloader is compatible with the software from PJRC (http://www.pjrc.com/teensy/index.html).\r
+ *  HID class bootloader is compatible with the software from PJRC (<a>http://www.pjrc.com/teensy/index.html</a>).\r

  *\r
  *  User-submitted projects are located in the /Projects/ subdirectory. If you wish to have your LUFA project included,\r
  *  please email it to the Library author.\r
  *\r
  *  User-submitted projects are located in the /Projects/ subdirectory. If you wish to have your LUFA project included,\r
  *  please email it to the Library author.\r


@@ -29,22 +34,22 @@
  *      - <b>ClassDriver</b>\r
  *        - <b>AudioInput</b> - Audio In (microphone) demo, using the library USB Audio Class driver framework\r
  *        - <b>AudioOutput</b> - Audio Out (speaker) demo, using the library USB Audio Class driver framework\r
  *      - <b>ClassDriver</b>\r
  *        - <b>AudioInput</b> - Audio In (microphone) demo, using the library USB Audio Class driver framework\r
  *        - <b>AudioOutput</b> - Audio Out (speaker) demo, using the library USB Audio Class driver framework\r

- *        - <b>CDC</b> - Virtual Serial Port demo, using the library USB CDC Class driver framework\r
- *        - <b>DualCDC</b> - Dual Virtual Serial Port demo, using the library USB CDC Class driver framework\r
+ *        - <b>DualVirtualSerial</b> - Dual Virtual Serial Port demo, using the library USB CDC Class driver framework\r

  *        - <b>GenericHID</b> - Generic Human Interface Class demo, using the library USB HID Class driver framework\r
  *        - <b>Joystick</b> - USB Joystick demo, using the library USB HID Class driver framework\r
  *        - <b>Keyboard</b> - USB Keyboard demo, using the library USB HID Class driver framework\r
  *        - <b>KeyboardMouse</b> - Dual Keyboard/Mouse demo, using the library USB HID Class driver framework\r
  *        - <b>MassStorage</b> - Dual Drive Mass Storage demo, using the library USB Mass Storage Class driver framework\r
  *        - <b>GenericHID</b> - Generic Human Interface Class demo, using the library USB HID Class driver framework\r
  *        - <b>Joystick</b> - USB Joystick demo, using the library USB HID Class driver framework\r
  *        - <b>Keyboard</b> - USB Keyboard demo, using the library USB HID Class driver framework\r
  *        - <b>KeyboardMouse</b> - Dual Keyboard/Mouse demo, using the library USB HID Class driver framework\r
  *        - <b>MassStorage</b> - Dual Drive Mass Storage demo, using the library USB Mass Storage Class driver framework\r

+ *        - <b>MassStorageKeyboard</b> - Mass Storage and Keyboard demo, using the library USB Mass Storage/HID Class driver frameworks\r

  *        - <b>MIDI</b> - MIDI In demo, using the library USB MIDI-Audio Class driver framework\r
  *        - <b>Mouse</b> - USB Mouse demo, using the library USB HID driver framework\r
  *        - <b>RNDISEthernet</b> - RNDIS Ethernet Webserver demo, using the library USB RNDIS driver framework\r
  *        - <b>MIDI</b> - MIDI In demo, using the library USB MIDI-Audio Class driver framework\r
  *        - <b>Mouse</b> - USB Mouse demo, using the library USB HID driver framework\r
  *        - <b>RNDISEthernet</b> - RNDIS Ethernet Webserver demo, using the library USB RNDIS driver framework\r

- *        - <b>USBtoSerial</b> - USB to USART Serial converter demo, using the library USB CDC driver framework\r
+ *        - <b>VirtualSerial</b> - Virtual Serial Port demo, using the library USB CDC Class driver framework\r
+ *        - <b>VirtualSerialMouse</b> - Virtual Serial Port and Mouse demo, using the library USB CDC and HID Class driver frameworks\r

  *      - <b>LowLevel</b>\r
  *        - <b>AudioInput</b> - Audio In (microphone) demo, using the low level LUFA APIs to implement the USB Audio class\r
  *        - <b>AudioOutput</b> - Audio Out (speaker) demo, using the low level LUFA APIs to implement the USB Audio class\r
  *      - <b>LowLevel</b>\r
  *        - <b>AudioInput</b> - Audio In (microphone) demo, using the low level LUFA APIs to implement the USB Audio class\r
  *        - <b>AudioOutput</b> - Audio Out (speaker) demo, using the low level LUFA APIs to implement the USB Audio class\r

- *        - <b>CDC</b> - Virtual Serial Port demo, using the low level LUFA APIs to implement the USB CDC class\r
- *        - <b>DualCDC</b> - Dual Virtual Serial Port demo, using the low level LUFA APIs to implement the USB CDC class\r
+ *        - <b>DualVirtualSerial</b> - Dual Virtual Serial Port demo, using the low level LUFA APIs to implement the USB CDC class\r

  *        - <b>GenericHID</b> - Generic Human Interface Class demo, using the low level LUFA APIs to implement the USB HID class\r
  *        - <b>Joystick</b> - USB Joystick demo, using the low level LUFA APIs to implement the USB HID class\r
  *        - <b>Keyboard</b> - USB Keyboard demo, using the low level LUFA APIs to implement the USB HID class\r
  *        - <b>GenericHID</b> - Generic Human Interface Class demo, using the low level LUFA APIs to implement the USB HID class\r
  *        - <b>Joystick</b> - USB Joystick demo, using the low level LUFA APIs to implement the USB HID class\r
  *        - <b>Keyboard</b> - USB Keyboard demo, using the low level LUFA APIs to implement the USB HID class\r


@@ -53,22 +58,24 @@
  *        - <b>MIDI</b> - MIDI In demo, using the low level LUFA APIs to implement the USB MIDI-Audio class\r
  *        - <b>Mouse</b> - USB Mouse demo, using the low level LUFA APIs to implement the USB HID class\r
  *        - <b>RNDISEthernet</b> - RNDIS Ethernet Webserver demo, using the low level LUFA APIs to implement the USB RNDIS class\r
  *        - <b>MIDI</b> - MIDI In demo, using the low level LUFA APIs to implement the USB MIDI-Audio class\r
  *        - <b>Mouse</b> - USB Mouse demo, using the low level LUFA APIs to implement the USB HID class\r
  *        - <b>RNDISEthernet</b> - RNDIS Ethernet Webserver demo, using the low level LUFA APIs to implement the USB RNDIS class\r

- *        - <b>USBtoSerial</b> - USB to USART Serial converter demo, using the low level LUFA APIs to implement the USB CDC class\r
+ *        - <b>VirtualSerial</b> - Virtual Serial Port demo, using the low level LUFA APIs to implement the USB CDC class\r

  *      - <b>Incomplete</b>\r
  *        - <b>SideShow</b> - Incomplete Windows SideShow demo, using the low level LUFA APIs to implement the USB SideShow class\r
  *    - <b>Host</b>\r
  *      - <b>ClassDriver</b>\r
  *      - <b>Incomplete</b>\r
  *        - <b>SideShow</b> - Incomplete Windows SideShow demo, using the low level LUFA APIs to implement the USB SideShow class\r
  *    - <b>Host</b>\r
  *      - <b>ClassDriver</b>\r

- *        - <b>CDCHost</b> - Virtual Serial Port host demo, using the library USB CDC Class driver framework\r
- *        - <b>GenericHIDHost</b> - Generic HID host demo, using the library USB HID Class driver framework\r
+ *        - <b>JoystickHostWithParser</b> - Joystick host demo with HID Descriptor parser, using the library USB HID Class driver framework\r

  *        - <b>KeyboardHost</b> - USB Keyboard host demo, using the library USB HID Class driver framework\r
  *        - <b>KeyboardHostWithParser</b> - USB Keyboard host demo with HID Descriptor parser, using the library USB HID Class\r
  *                                          driver framework\r
  *        - <b>MassStorageHost</b> - Mass Storage host demo, using the library USB Mass Storage Class driver framework\r
  *        - <b>MouseHost</b> - Mouse host demo, using the library USB HID Class driver framework\r
  *        - <b>MouseHostWithParser</b> - Mouse host demo with HID Descriptor parser, using the library USB HID Class driver framework\r
  *        - <b>KeyboardHost</b> - USB Keyboard host demo, using the library USB HID Class driver framework\r
  *        - <b>KeyboardHostWithParser</b> - USB Keyboard host demo with HID Descriptor parser, using the library USB HID Class\r
  *                                          driver framework\r
  *        - <b>MassStorageHost</b> - Mass Storage host demo, using the library USB Mass Storage Class driver framework\r
  *        - <b>MouseHost</b> - Mouse host demo, using the library USB HID Class driver framework\r
  *        - <b>MouseHostWithParser</b> - Mouse host demo with HID Descriptor parser, using the library USB HID Class driver framework\r

+ *        - <b>RNDISHost</b> - RNDIS Ethernet host demo, using the library USB RNDIS Class driver framework\r

  *        - <b>StillImageHost</b> - Still Image Camera host demo, using the library USB Still Image Class driver framework\r
  *        - <b>StillImageHost</b> - Still Image Camera host demo, using the library USB Still Image Class driver framework\r

+ *        - <b>VirtualSerialHost</b> - Virtual Serial Port host demo, using the library USB CDC Class driver framework\r

  *      - <b>LowLevel</b>\r
  *      - <b>LowLevel</b>\r

- *        - <b>CDCHost</b> - Virtual Serial Port host demo, using the low level LUFA APIs to implement the USB CDC class\r
+ *        - <b>JoystickHostWithParser</b> - Joystick host demo with HID Descriptor parser, using the low level LUFA APIs to implement \r
+ *                                          the USB HID class\r

  *        - <b>GenericHIDHost</b> - Generic HID host demo, using the low level LUFA APIs to implement the USB HID class\r
  *        - <b>KeyboardHost</b> - USB Keyboard host demo, using the low level LUFA APIs to implement the USB HID class\r
  *        - <b>KeyboardHostWithParser</b> - USB Keyboard host demo with HID Descriptor parser, using the low level LUFA APIs to\r
  *        - <b>GenericHIDHost</b> - Generic HID host demo, using the low level LUFA APIs to implement the USB HID class\r
  *        - <b>KeyboardHost</b> - USB Keyboard host demo, using the low level LUFA APIs to implement the USB HID class\r
  *        - <b>KeyboardHostWithParser</b> - USB Keyboard host demo with HID Descriptor parser, using the low level LUFA APIs to\r


@@ -77,16 +84,27 @@
  *        - <b>MouseHost</b> - Mouse host demo, using the low level LUFA APIs to implement the USB HID class\r
  *        - <b>MouseHostWithParser</b> - Mouse host demo with HID Descriptor parser, using the low level LUFA APIs to implement the\r
  *                                       USB HID class\r
  *        - <b>MouseHost</b> - Mouse host demo, using the low level LUFA APIs to implement the USB HID class\r
  *        - <b>MouseHostWithParser</b> - Mouse host demo with HID Descriptor parser, using the low level LUFA APIs to implement the\r
  *                                       USB HID class\r

+ *        - <b>PrinterHost</b> - Printer host demo, using the low level LUFA APIs to implement the USB Printer class\r
+ *        - <b>RNDISHost</b> - RNDIS Ethernet host demo, using the low level LUFA APIs to implement the RNDIS class\r

  *        - <b>StillImageHost</b> - Still Image Camera host demo, using the low level LUFA APIs to implement the USB Still Image class\r
  *        - <b>StillImageHost</b> - Still Image Camera host demo, using the low level LUFA APIs to implement the USB Still Image class\r

+ *        - <b>VirtualSerialHost</b> - Virtual Serial Port host demo, using the low level LUFA APIs to implement the USB CDC class\r

  *      - <b>Incomplete</b>\r
  *        - <b>BluetoothHost</b> - Incomplete Bluetooth host demo, using the low level LUFA APIs to implement the USB Bluetooth class\r
  *      - <b>Incomplete</b>\r
  *        - <b>BluetoothHost</b> - Incomplete Bluetooth host demo, using the low level LUFA APIs to implement the USB Bluetooth class\r

+ *    - <b>DualRole</b>\r
+ *      - <b>ClassDriver</b>\r
+ *        - <b>MouseHostDevice</b> - Dual role Mouse Host and Mouse Device demo, using the library USB CDC Class driver framework\r

  *  - <b>Bootloaders</b>\r
  *    - <b>DFU</b> - DFU Class USB bootloader, compatible with Atmel's FLIP and the open source dfu-programmer software\r
  *    - <b>CDC</b> - CDC Class USB bootloader, compatible with any AVR910 protocol programming software such as AVRDude\r
  *    - <b>TeensyHID</b> - HID Class bootloader, compatible with the PJRC TeensyLoader software\r
  *  - <b>Projects</b>\r
  *  - <b>Bootloaders</b>\r
  *    - <b>DFU</b> - DFU Class USB bootloader, compatible with Atmel's FLIP and the open source dfu-programmer software\r
  *    - <b>CDC</b> - CDC Class USB bootloader, compatible with any AVR910 protocol programming software such as AVRDude\r
  *    - <b>TeensyHID</b> - HID Class bootloader, compatible with the PJRC TeensyLoader software\r
  *  - <b>Projects</b>\r

+ *    - <b>AVRISP-MKII</b> - AVRISP-MKII Programmer Clone project\r
+ *    - <b>Benito</b> - Benito Board Arduino Programmer project\r
+ *    - <b>LEDNotifier</b> - USB LED Notification project\r

  *    - <b>Magstripe</b> - Magnetic Stripe Card Reader project\r
  *    - <b>MissileLaucher</b> - Toy Missile Launcher Host project\r
  *    - <b>Magstripe</b> - Magnetic Stripe Card Reader project\r
  *    - <b>MissileLaucher</b> - Toy Missile Launcher Host project\r

+ *    - <b>TemperatureDataLogger</b> - Temperature Datalogging project\r
+ *    - <b>USBtoSerial</b> - USB to USART Serial Converter project\r

  *\r
  *  </small>\r
  */
\ No newline at end of file
  *\r
  *  </small>\r
  */
\ No newline at end of file