Demos/Device/ClassDriver/VirtualSerialMouse/VirtualSerialMouse.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 /** \mainpage Combined Communications Device Class (Virtual Serial Port) and Mouse Demo
   8  *
   9  *  \section SSec_Compat Demo Compatibility:
  10  *
  11  *  The following list indicates what microcontrollers are compatible with this demo.
  12  *
  13  *  - Series 7 USB AVRs
  14  *  - Series 6 USB AVRs
  15  *  - Series 4 USB AVRs
  16  *  - Series 2 USB AVRs
  17  *
  18  *  \section SSec_Info USB Information:
  19  *
  20  *  The following table gives a rundown of the USB utilization of this demo.
  21  *
  22  *  <table>
  23  *   <tr>
  24  *    <td><b>USB Mode:</b></td>
  25  *    <td>Device</td>
  26  *   </tr>
  27  *   <tr>
  28  *    <td><b>USB Class:</b></td>
  29  *    <td>Communications Device Class (CDC) \n
  30  *        Human Interface Device Class (HID)</td>
  31  *   </tr>
  32  *   <tr>
  33  *    <td><b>USB Subclass:</b></td>
  34  *    <td>Abstract Control Model (ACM) \n
  35  *        Mouse Subclass</td>
  36  *   </tr>
  37  *   <tr>
  38  *    <td><b>Relevant Standards:</b></td>
  39  *    <td>USBIF CDC Class Standard</td>
  40  *    <td>USBIF HID Specification \n
  41  *        USBIF HID Usage Tables</td>
  42  *   </tr>
  43  *   <tr>
  44  *    <td><b>Usable Speeds:</b></td>
  45  *    <td>Full Speed Mode</td>
  46  *   </tr>
  47  *  </table>
  48  *
  49  *  \section SSec_Description Project Description:
  50  *
  51  *  Combined Communications Device Class/Mouse demonstration application.
  52  *  This gives a simple reference application for implementing a combined
  53  *  CDC and HID device acting as a both a virtual serial port and a mouse.
  54  *  Joystick actions are transmitted to the host as strings and as mouse
  55  *  movements. The device does not respond to serial data sent from the host.
  56  *
  57  *  After running this demo for the first time on a new computer,
  58  *  you will need to supply the .INF file located in this demo
  59  *  project's directory as the device's driver when running under
  60  *  Windows. This will enable Windows to use its inbuilt CDC drivers,
  61  *  negating the need for custom drivers for the device. Other
  62  *  Operating Systems should automatically use their own inbuilt
  63  *  CDC-ACM drivers.
  64  *
  65  *  \section SSec_Options Project Options
  66  *
  67  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  68  *
  69  *  <table>
  70  *   <tr>
  71  *    <td>
  72  *     None
  73  *    </td>
  74  *   </tr>
  75  *  </table>
  76  */