Projects/Benito/Benito.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 Benito Arduino Programmer Project
   8  *
   9  *  \section Sec_Compat Project Compatibility:
  10  *
  11  *  The following list indicates what microcontrollers are compatible with this project.
  12  *
  13  *  \li Series 7 USB AVRs (AT90USBxxx7)
  14  *  \li Series 6 USB AVRs (AT90USBxxx6)
  15  *  \li Series 4 USB AVRs (ATMEGAxxU4)
  16  *  \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
  17  *
  18  *  \section Sec_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 \n
  38  *       Arduino Bootloader Specification</td>
  39  *  </tr>
  40  *  <tr>
  41  *   <td><b>Supported USB Speeds:</b></td>
  42  *   <td>Full Speed Mode</td>
  43  *  </tr>
  44  * </table>
  45  *
  46  *  \section Sec_Description Project Description:
  47  *
  48  *  Firmware for a USB AVR powered programmer for Arduino boards using the official Arduino bootloader. This
  49  *  project acts like a regular USB to Serial bridge, except that asserting the DTR line will cause a pulse
  50  *  to appear on a given port pin, to control the target's /RESET pin.
  51  *
  52  *  This is primarily designed to fit the Benito board from www.dorkbotpdx.org, but will suit all USB AVRs.
  53  *
  54  *  After running this project for the first time on a new computer, you will need to supply the .INF file located
  55  *  in this project's directory as the device's driver when running under Windows. This will enable Windows to use
  56  *  its inbuilt CDC drivers, negating the need for custom drivers for the device. Other Operating Systems should
  57  *  automatically use their own inbuilt CDC-ACM drivers.
  58  *
  59  *  \section Sec_Options Project Options
  60  *
  61  *  The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
  62  *
  63  *  <table>
  64  *   <tr>
  65  *    <th><b>Define Name:</b></th>
  66  *    <th><b>Location:</b></th>
  67  *    <th><b>Description:</b></th>
  68  *   </tr>
  69  *   <tr>
  70  *    <td>AVR_RESET_LINE_PORT</td>
  71  *    <td>AppConfig.h</td>
  72  *    <td>Indicates the PORT register of the pin used to generate the target /RESET line pulse.</td>
  73  *   </tr>
  74  *   <tr>
  75  *    <td>AVR_RESET_LINE_DDR</td>
  76  *    <td>AppConfig.h</td>
  77  *    <td>Indicates the DDR register of the pin used to generate the target /RESET line pulse.</td>
  78  *   </tr>
  79  *   <tr>
  80  *    <td>AVR_RESET_LINE_MASK</td>
  81  *    <td>AppConfig.h</td>
  82  *    <td>Indicates the mask of the pin used to generate the target /RESET line pulse.</td>
  83  *   </tr>
  84  *   <tr>
  85  *    <td>AVR_RESET_PULSE_MS</td>
  86  *    <td>AppConfig.h</td>
  87  *    <td>Pulse length in milliseconds for the target /RESET pulse.</td>
  88  *   </tr>
  89  *   <tr>
  90  *    <td>TX_RX_LED_PULSE_MS</td>
  91  *    <td>AppConfig.h</td>
  92  *    <td>Pulse length in milliseconds for the activity Tx/Rx LEDs.</td>
  93  *   </tr>
  94  *   <tr>
  95  *    <td>PING_PONG_LED_PULSE_MS</td>
  96  *    <td>AppConfig.h</td>
  97  *    <td>Pulse length in milliseconds for the enumeration LED ping-ponging between toggles.</td>
  98  *   </tr>
  99  *   <tr>
 100  *    <td>RECEIVE_BUFFER_FLUSH_MS</td>
 101  *    <td>AppConfig.h</td>
 102  *    <td>Period between flushings of received data buffer to the attached USB host.</td>
 103  *   </tr>
 104  *  </table>
 105  */
 106