Speed up Mass Storage bootloader by turning off the internal clock divider, as there...

[pub/USBasp.git] / Projects / RelayBoard / RelayBoard.txt

diff --git a/Projects/RelayBoard/RelayBoard.txt b/Projects/RelayBoard/RelayBoard.txt
index bb484be..4b190df 100644 (file)
--- a/Projects/RelayBoard/RelayBoard.txt
+++ b/Projects/RelayBoard/RelayBoard.txt
@@ -6,13 +6,13 @@
 
 /** \mainpage OB's Quad-Relay outlet control using a Teensy2++
  *
 
 /** \mainpage OB's Quad-Relay outlet control using a Teensy2++
  *

- *  \section SSec_Compat Project Compatibility:
+ *  \section Sec_Compat Project Compatibility:

  *
  *  The following list indicates what microcontrollers are compatible with this project.
  *
  *
  *  The following list indicates what microcontrollers are compatible with this project.
  *

- *  - AT90USB1286
+ *  \li AT90USB1286

  *
  *

- *  \section SSec_Info USB Information:
+ *  \section Sec_Info USB Information:

  *
  *  The following table gives a rundown of the USB utilization of this project.
  *
  *
  *  The following table gives a rundown of the USB utilization of this project.
  *


@@ -34,12 +34,12 @@
  *   <td>USB Standards</td>
  *  </tr>
  *  <tr>
  *   <td>USB Standards</td>
  *  </tr>
  *  <tr>

- *   <td><b>Usable Speeds:</b></td>
+ *   <td><b>Supported USB Speeds:</b></td>

  *   <td>Low Speed Mode, Full Speed Mode</td>
  *  </tr>
  * </table>
  *
  *   <td>Low Speed Mode, Full Speed Mode</td>
  *  </tr>
  * </table>
  *

- *  \section SSec_Description Project Description:
+ *  \section Sec_Description Project Description:

  *
  *  Firmware for a Teensy2++ AVR-based miniboard to control four relays, using the
  *  same protocol used by the commercially available Silver Shield PM power outlets
  *
  *  Firmware for a Teensy2++ AVR-based miniboard to control four relays, using the
  *  same protocol used by the commercially available Silver Shield PM power outlets


@@ -50,8 +50,8 @@
  *
  *  Relays 1 to 4 are respectively wired to pins C4, C5, C6 and C7 of the Teensy++ V2,
  *  which are the PORTC bits 4 to 7 of the AT90USB1286. The relays MUST be wired through
  *
  *  Relays 1 to 4 are respectively wired to pins C4, C5, C6 and C7 of the Teensy++ V2,
  *  which are the PORTC bits 4 to 7 of the AT90USB1286. The relays MUST be wired through

- *  a transistor, and a diode must be added on the relay's contact pins to protect
- *  the transistor from back EMF generated from the relay when the coil is turned off.
+ *  a transistor, and a diode must be added in antiparallel on the relay's coil pins to
+ *  protect the transistor from back EMF generated from the relay when the coil is turned off.

  *  The transistor base pin is wired to the Teensy data port through a 10K resistor. A
  *  LED may be also be added as a relay status indicator on each channel.
  *
  *  The transistor base pin is wired to the Teensy data port through a 10K resistor. A
  *  LED may be also be added as a relay status indicator on each channel.
  *


@@ -92,4 +92,15 @@
  *   </tr>
  *  </table>
  *
  *   </tr>
  *  </table>
  *

- */
\ No newline at end of file
+ *  \section Sec_Options Project Options
+ *
+ *  The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
+ *
+ *  <table>
+ *   <tr>
+ *    <td>
+ *     None
+ *    </td>
+ *   </tr>
+ *  </table>
+ */