OpenARDF-WB8WFK-ARDF-Foxoring-Transmitter/README.md

<h2>WB8WFK ARDF Foxoring Transmitter</h2>
<p>This is a simple, inexpensive, transmitter controller for conducting ARDF Foxoring competitions and for demonstrating ARDF principles. The software project is an Arduino script that builds for and runs on most Arduino-like products, including <a href="https://www.adafruit.com/product/2590">AdaFruit's Metro Mini 328</a>, or <a href="https://www.sparkfun.com/products/11113">SparkFun's Arduino Pro Mini 328</a>, and many more.</p>

<p>After being programmed, the controller is configured via a serial port on the microprocessor. An Arduino board that includes a USB-to-Serial converter will allow you to configure the controller with a simple USB cable running between a USB port on your computer to one on the Arduino board. Less sophisticated Arduino boards lacking a USB-to-Serial converter will require a special FTDI cable like <a href="https://www.adafruit.com/product/70">AdaFruit's FTDI Serial TTL-232 USB Cable</a>, or <a href="https://www.sparkfun.com/products/9718">SparkFun's FTDI Cable 5V</a>.</p>

<p>The controller includes an output pin for controlling a transmitter for sending Morse code characters (high = key down; low = key up) and a separate pin that sends the Morse code as audio tones that can be used to drive a speaker. The controller can also provide a sequence of starting-tones prompting competitors to begin a competition, and can thus serve as an electronic starting "gun" for use in ARDF events.</p>

<h3>Serial Commands</h3>
<p>The controller serial interface operates at 57600 baud that can be accessed using any serial TTY interface program such as PuTTY or Arduino's own Serial Monitor tool. It provides a command prompt > indicating that it is ready to receive recognized the following commands.<p>

<pre><p><b>> CAL [num]</b>  <= <i>* Sets the clock calibration for precise timing</i><br>
<p><b>> CAL</b>  <= <i>Displays the clock calibration setting</i><br>
<p><b>> DIP [val]</b>  <= <i>* Sets the competition format, overriding the DIP switch settings<br>
<p><b>> DIP</b>  <= <i>Displays the competition format setting<br>
<p><b>> FAC</b>  <= <i>Sets saved EEPROM values to their original defaults</i><br>
<p><b>> GO</b>  <= <i>Starts operation from zero seconds, equivalent to pressing the synch button</i><br>
<p><b>> ID [string]</b>  <= <i>* Sets the callsign that gets sent</i><br>
<p><b>> ID</b>  <= <i>Displays the saved callsign setting</i><br>
<p><b>> LED [on|off]</b>  <= <i>* Turns on/off LED pin</i><br>
<p><b>> LED</b>  <= <i>Displays the LED pin setting</i><br>
<p><b>> RST</b>  <= <i>Resets the processor</i><br>
<p><b>> SPD ID [num]</b>  <= <i>* Sets the ID code speed in WPM<br>
<p><b>> SPD</b>  <= <i>Displays the ID code speed setting<br>
<p><b>> STA [on|off]</b>  <= <i>* Turns on/off the starting tones function</i><br>
<p><b>> STA</b>  <= <i>Displays the starting tones setting</i><br>
<p><b>> SYN [on|off]</b>  <= <i>* Turns on/off synchronization using sync button or "GO" command</i><br>
<p><b>> SYN</b>  <= <i>Displays the synchronization setting</i><br>
<p><b>> TEM</b>  <= <i>Displays the processor's temperature in C</i><br>
<p><b>> VER</b>  <= <i>Displays the software version number</i><br>
<p/></pre>
  
  <p>* These values get stored to EEPROM and are retained between power cycles. </p>

<p>A schematic design, a bill of materials, and a source for ordering a printed circuit board will be made available soon.</p>