Projects/USBtoSerial/USBtoSerial.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 USB to Serial Converter Project
   8  *
   9  *  \section SSec_Compat Project Compatibility:
  10  *
  11  *  The following list indicates what microcontrollers are compatible with this project.
  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 project.
  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)</td>
  30  *   </tr>
  31  *   <tr>
  32  *    <td><b>USB Subclass:</b></td>
  33  *    <td>Abstract Control Model (ACM)</td>
  34  *   </tr>
  35  *   <tr>
  36  *    <td><b>Relevant Standards:</b></td>
  37  *    <td>USBIF CDC Class Standard</td>
  38  *   </tr>
  39  *   <tr>
  40  *    <td><b>Usable Speeds:</b></td>
  41  *    <td>Full Speed Mode</td>
  42  *   </tr>
  43  *  </table>
  44  *
  45  *  \section SSec_Description Project Description:
  46  *
  47  *  USB to Serial bridge project. This project allows a USB AVR to serve
  48  *  as a USB to USART bridge between a USB host and a device lacking a
  49  *  USB port. When programmed into a USB AVR, the AVR will enumerate as a
  50  *  virtual COM port.
  51  *
  52  *  The AVR's hardware USART's settings will change to mirror as closely as
  53  *  possible the serial settings set on the host. However, due to hardware
  54  *  limitations, some options may not be supported (baud rates with unacceptable
  55  *  error rates at the AVR's clock speed, data lengths other than 6, 7 or 8 bits,
  56  *  1.5 stop bits, parity other than none, even or odd).
  57  *
  58  *  After running this project for the first time on a new computer,
  59  *  you will need to supply the .INF file located in this project
  60  *  project's directory as the device's driver when running under
  61  *  Windows. This will enable Windows to use its inbuilt CDC drivers,
  62  *  negating the need for custom drivers for the device. Other
  63  *  Operating Systems should automatically use their own inbuilt
  64  *  CDC-ACM drivers.
  65  *
  66  *  \section SSec_Options Project Options
  67  *
  68  *  The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
  69  *
  70  *  <table>
  71  *   <tr>
  72  *    <td><b>Define Name:</b></td>
  73  *    <td><b>Location:</b></td>
  74  *    <td><b>Description:</b></td>
  75  *   </tr>
  76  *   <tr>
  77  *    <td>BUFF_STATICSIZE</td>
  78  *    <td>RingBuff.h</td>
  79  *    <td>Defines the maximum number of bytes which can be buffered in each Ring Buffer.</td>
  80  *   </tr>
  81  *  </table>
  82  */