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 SSec_Compat Demo Compatibility:
  10  *
  11  *  The following table indicates what microcontrollers are compatible with this demo.
  12  *
  13  *  - AT90USB1287
  14  *  - AT90USB1286
  15  *  - AT90USB647
  16  *  - AT90USB646
  17  *  - ATMEGA32U6
  18  *  - ATMEGA32U4
  19  *  - ATMEGA16U4
  20  *  - AT90USB162
  21  *  - AT90USB82
  22  *
  23  *  \section SSec_Info USB Information:
  24  *
  25  *  The following table gives a rundown of the USB utilization of this demo.
  26  *
  27  * <table>
  28  *  <tr>
  29  *   <td><b>USB Mode:</b></td>
  30  *   <td>Device</td>
  31  *  </tr>
  32  *  <tr>
  33  *   <td><b>USB Class:</b></td>
  34  *   <td>Communications Device Class (CDC)</td>
  35  *  </tr>
  36  *  <tr>
  37  *   <td><b>USB Subclass:</b></td>
  38  *   <td>Abstract Control Model (ACM)</td>
  39  *  </tr>
  40  *  <tr>
  41  *   <td><b>Relevant Standards:</b></td>
  42  *   <td>USBIF CDC Class Standard</td>
  43  *   <td>Arduino Bootloader Specification</td>
  44  *  </tr>
  45  *  <tr>
  46  *   <td><b>Usable Speeds:</b></td>
  47  *   <td>Full Speed Mode</td>
  48  *  </tr>
  49  * </table>
  50  *
  51  *  \section SSec_Description Project Description:
  52  *
  53  *  Firmware for a USB AVR powered programmer for Arduino boards using the official Arduino bootloader. This
  54  *  project acts like a regular USB to Serial bridge, except that asserting the DTR line will cause a pulse
  55  *  to appear on a given port pin, to control the target's /RESET pin.
  56  *
  57  *  This is primarily designed to fit the Benito board from www.dorkbotpdx.org, but will suit all USB AVRs.
  58  *
  59  *  After running this project for the first time on a new computer, you will need to supply the .INF file located
  60  *  in this project's directory as the device's driver when running under Windows. This will enable Windows to use
  61  *  its inbuilt CDC drivers, negating the need for custom drivers for the device. Other Operating Systems should
  62  *  automatically use their own inbuilt CDC-ACM drivers.
  63  *
  64  *  \section SSec_Options Project Options
  65  *
  66  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  67  *
  68  *  <table>
  69  *   <tr>
  70  *    <td><b>Define Name:</b></td>
  71  *    <td><b>Location:</b></td>
  72  *    <td><b>Description:</b></td>
  73  *   </tr>
  74  *   <tr>
  75  *    <td>AVR_RESET_LINE_PORT</td>
  76  *    <td>Makefile CDEFS</td>
  77  *    <td>Indicates the PORT register of the pin used to generate the target /RESET line pulse.</td>
  78  *   </tr>
  79  *   <tr>
  80  *    <td>AVR_RESET_LINE_DDR</td>
  81  *    <td>Makefile CDEFS</td>
  82  *    <td>Indicates the DDR register of the pin used to generate the target /RESET line pulse.</td>
  83  *   </tr>
  84  *   <tr>
  85  *    <td>AVR_RESET_LINE_MASK</td>
  86  *    <td>Makefile CDEFS</td>
  87  *    <td>Indicates the mask of the pin used to generate the target /RESET line pulse.</td>
  88  *   </tr>
  89  *   <tr>
  90  *    <td>AVR_RESET_PULSE_MS</td>
  91  *    <td>Makefile CDEFS</td>
  92  *    <td>Pulse length in milliseconds for the target /RESET pulse.</td>
  93  *   </tr>
  94  *   <tr>
  95  *    <td>TX_RX_LED_PULSE_MS</td>
  96  *    <td>Makefile CDEFS</td>
  97  *    <td>Pulse length in milliseconds for the activity Tx/Rx LEDs.</td>
  98  *   </tr>
  99  *   <tr>
 100  *    <td>PING_PONG_LED_PULSE_MS</td>
 101  *    <td>Makefile CDEFS</td>
 102  *    <td>Pulse length in milliseconds for the enumeration LED ping-poning between toggles.</td>
 103  *   </tr>
 104  *  </table>
 105  */