Update README.md

pull/4/head^2
OpenARDF 2020-06-12 21:24:49 -04:00 zatwierdzone przez GitHub
rodzic 5993d94ecc
commit 21f83a397a
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: 4AEE18F83AFDEB23
1 zmienionych plików z 123 dodań i 123 usunięć

246
README.md
Wyświetl plik

@ -12,9 +12,9 @@
<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 any of the following commands.
<p>
</p>
<pre><p><b>> CAL [num]</b> <= <i>* Sets the clock calibration for precise timing</i><br>
<pre><p><b>> CAL [num]</b> <= <i>* Sets the clock calibration for precise timing</i><br>
<b>> CAL</b> <= <i>Displays the clock calibration setting</i><br>
<b>> DIP [val]</b> <= <i>* Sets the competition format, overriding the DIP switch settings</i><br>
<b>> DIP</b> <= <i>Displays the competition format setting</i><br>
@ -34,11 +34,11 @@
<b>> TEM</b> <= <i>Displays the processor's temperature in C</i><br>
<b>> VER</b> <= <i>Displays the software version number</i></p></pre>
<p>* These values get stored to EEPROM and are retained between power cycles. </p>
<h2>Hardware</h2>
<p>Look in the Hardware folder for all hardware-related documents</p>
<h3>Pinout</h3>
<pre><p><b>PB1 - Board Pin 9 (Output)</b> <= Audio Out (=Gnd when no tone)<br>
<p>* These values get stored to EEPROM and are retained between power cycles. </p>
<h2>Hardware</h2>
<p>Look in the Hardware folder for all hardware-related documents</p>
<h3>Pinout</h3>
<pre><p><b>PB1 - Board Pin 9 (Output)</b> <= Audio Out (=Gnd when no tone)<br>
<b>PB5 - Board Pin 13 (Output)</b> <= LED On=+V<br>
<b>PD2 - Board Pin 2 (Output)</b> <= Key/PTT On=+V<br>
<b>PD3 - Board Pin 3 (Input)</b> <= Synchronize (mom. switch to Gnd)<br>
@ -46,120 +46,120 @@
<b>PD5 - Board Pin 5 (Input)</b> <= DIP Switch Bit 1 (switch to Gnd)<br>
<b>PD6 - Board Pin 6 (Input)</b> <= DIP Switch Bit 2 (switch to Gnd)</p></pre>
<h2>Usage</h2>
<p>The transmitter can be configured using the serial port, or using the DIP switch and sync-button hardware interface. Only a subset of the available configurations is available when using only the hardware interface. Configuring the DIP setting with a serial port command to anything but 0 (zero) will disable the hardware DIP switch.</p>
<p>
<table>
<tr>
<th>Configuration</th>
<th>Software Commands</th>
<th>Hardware Settings</th>
</tr>
<tr>
<td>Homing Beacon</td>
<td>> DIP CLASSIC BEACON<br>[Note: the DIP switch must also be set to 0-0-0]</td>
<td>DIP = 0-0-0</td>
</tr>
<tr>
<td>Classic Fox#1</td>
<td>> DIP CLASSIC 1<br>> GO</td>
<td>DIP = 0-0-1<br>Sync to start</td>
</tr>
<tr>
<td>Classic Fox#2</td>
<td>> DIP CLASSIC 2<br>> GO</td>
<td>DIP = 0-1-0<br>Sync to start</td>
</tr>
<tr>
<td>Classic Fox#3</td>
<td>> DIP CLASSIC 3<br>> GO</td>
<td>DIP = 0-1-1<br>Sync to start</td>
</tr>
<tr>
<td>Classic Fox#4</td>
<td>> DIP CLASSIC 4<br>> GO</td>
<td>DIP = 1-0-0<br>Sync to start</td>
</tr>
<tr>
<td>Classic Fox#5</td>
<td>> DIP CLASSIC 5<br>> GO</td>
<td>DIP = 1-0-1<br>Sync to start</td>
</tr>
<tr>
<td>Classic Demonstration</td>
<td>> DIP CLASSIC DEMO</td>
<td>DIP = 1-1-0</td>
</tr>
<tr>
<td>Foxoring</td>
<td>> DIP FOXORING</td>
<td>DIP = 1-1-1</td>
</tr>
<tr>
<td>Spectator Beacon</td>
<td>> DIP FOXORING SPEC</td>
<td>N/A</td>
</tr>
<tr>
<td>Sprint Fox Slow #1</td>
<td>> DIP SPRINT S1</td>
<td>N/A</td>
</tr>
<tr>
<td>Sprint Fox Slow #2</td>
<td>> DIP SPRINT S2</td>
<td>N/A</td>
</tr>
<tr>
<td>Sprint Fox Slow #3</td>
<td>> DIP SPRINT S3</td>
<td>N/A</td>
</tr>
<tr>
<td>Sprint Fox Slow #4</td>
<td>> DIP SPRINT S4</td>
<td>N/A</td>
</tr>
<tr>
<td>Sprint Fox Slow #5</td>
<td>> DIP SPRINT S5</td>
<td>N/A</td>
</tr>
<tr>
<td>Sprint Fox Fast #1</td>
<td>> DIP SPRINT F1</td>
<td>N/A</td>
</tr>
<tr>
<td>Sprint Fox Fast #2</td>
<td>> DIP SPRINT F2</td>
<td>N/A</td>
</tr>
<tr>
<td>Sprint Fox Fast #3</td>
<td>> DIP SPRINT F3</td>
<td>N/A</td>
</tr>
<tr>
<td>Sprint Fox Fast #4</td>
<td>> DIP SPRINT F4</td>
<td>N/A</td>
</tr>
<tr>
<td>Sprint Fox Fast #5</td>
<td>> DIP SPRINT F5</td>
<td>N/A</td>
</tr>
<tr>
<td>Sprint Demonstration</td>
<td>> DIP SPRINT DEMO</td>
<td>N/A</td>
</tr>
<tr>
<td>Starting Tone Generator</td>
<td>> DIP [any of the above]<br>> STA ON<br>> GO</td>
<td>DIP = any<br>Sync to start<br>[Note: Starting Tone Generator can only be enabled with a serial command.]</td>
</tr>
</table>
<h2>Usage</h2>
<p>The transmitter can be configured using the serial port, or using the DIP switch and sync-button hardware interface. Only a subset of the available configurations is available when using only the hardware interface. Configuring the DIP setting with a serial port command to anything but 0 (zero) will disable the hardware DIP switch.</p>
<p>
<table>
<tr>
<th>Configuration</th>
<th>Software Commands</th>
<th>Hardware Settings</th>
</tr>
<tr>
<td>Homing Beacon</td>
<td>> DIP CLASSIC BEACON<br>[Note: the DIP switch must also be set to 0-0-0]</td>
<td>DIP = 0-0-0</td>
</tr>
<tr>
<td>Classic Fox#1</td>
<td>> DIP CLASSIC 1<br>> GO</td>
<td>DIP = 0-0-1<br>Sync to start</td>
</tr>
<tr>
<td>Classic Fox#2</td>
<td>> DIP CLASSIC 2<br>> GO</td>
<td>DIP = 0-1-0<br>Sync to start</td>
</tr>
<tr>
<td>Classic Fox#3</td>
<td>> DIP CLASSIC 3<br>> GO</td>
<td>DIP = 0-1-1<br>Sync to start</td>
</tr>
<tr>
<td>Classic Fox#4</td>
<td>> DIP CLASSIC 4<br>> GO</td>
<td>DIP = 1-0-0<br>Sync to start</td>
</tr>
<tr>
<td>Classic Fox#5</td>
<td>> DIP CLASSIC 5<br>> GO</td>
<td>DIP = 1-0-1<br>Sync to start</td>
</tr>
<tr>
<td>Classic Demonstration</td>
<td>> DIP CLASSIC DEMO</td>
<td>DIP = 1-1-0</td>
</tr>
<tr>
<td>Foxoring</td>
<td>> DIP FOXORING</td>
<td>DIP = 1-1-1</td>
</tr>
<tr>
<td>Spectator Beacon</td>
<td>> DIP FOXORING SPEC</td>
<td>N/A</td>
</tr>
<tr>
<td>Sprint Fox Slow #1</td>
<td>> DIP SPRINT S1</td>
<td>N/A</td>
</tr>
<tr>
<td>Sprint Fox Slow #2</td>
<td>> DIP SPRINT S2</td>
<td>N/A</td>
</tr>
<tr>
<td>Sprint Fox Slow #3</td>
<td>> DIP SPRINT S3</td>
<td>N/A</td>
</tr>
<tr>
<td>Sprint Fox Slow #4</td>
<td>> DIP SPRINT S4</td>
<td>N/A</td>
</tr>
<tr>
<td>Sprint Fox Slow #5</td>
<td>> DIP SPRINT S5</td>
<td>N/A</td>
</tr>
<tr>
<td>Sprint Fox Fast #1</td>
<td>> DIP SPRINT F1</td>
<td>N/A</td>
</tr>
<tr>
<td>Sprint Fox Fast #2</td>
<td>> DIP SPRINT F2</td>
<td>N/A</td>
</tr>
<tr>
<td>Sprint Fox Fast #3</td>
<td>> DIP SPRINT F3</td>
<td>N/A</td>
</tr>
<tr>
<td>Sprint Fox Fast #4</td>
<td>> DIP SPRINT F4</td>
<td>N/A</td>
</tr>
<tr>
<td>Sprint Fox Fast #5</td>
<td>> DIP SPRINT F5</td>
<td>N/A</td>
</tr>
<tr>
<td>Sprint Demonstration</td>
<td>> DIP SPRINT DEMO</td>
<td>N/A</td>
</tr>
<tr>
<td>Starting Tone Generator</td>
<td>> DIP [any of the above]<br>> STA ON<br>> GO</td>
<td>DIP = any<br>Sync to start<br>[Note: Starting Tone Generator can only be enabled with a serial command.]</td>
</tr>
</table>
</p>
</p>