Created HamShield Serial Mode (markdown)

spaceneedle 2015-07-06 17:16:50 -07:00
parent d383dab578
commit 72a3dd6014
1 changed files with 48 additions and 0 deletions

48
HamShield-Serial-Mode.md Normal file

@ -0,0 +1,48 @@
We have written a very powerful sketch for Arduino called HamShield Serial Mode. This allows you to control your HamShield using any serial interface, including a computer over USB. This can be helpful when using one of the Chrome applications.
With the exception of some special commands, all serial commands are terminated with a semicolon ; and does not require any carriage return, line feed, etc. (ie: no new lines or enter keys required). The command is executed immediately after the reception of the ; character and waits for the next command.
Commands are not echoed to the sender. Only status responses are provided back over the serial port.
HamShield Serial Interface Commands
`
<table border=1>
<tr>
<td>Mode</td>
<td>ASCII</td>
<td>Description</td>
</tr>
<tr><td>Transmit</td><td>[Spacebar]</td><td>Space must be received at least every 500 milliseconds</td></tr>
</table>
`
Mode ASCII Description Implemented
-------------- ----------- -------------------------------------------------------------------------------------------------------------------------------------------- -----------------
Transmit space Space must be received at least every 500 mS Yes
Receive not space If space is not received and/or 500 mS timeout of space occurs, unit will go into receive mode Yes
CTCSS In A<tone>; <tone> must be a numerical ascii value with decimal point indicating CTCSS receive tone required to unsquelch No
CTCSS Out B<tone>; <tone> must be a numerical ascii value with decimal point indicating CTCSS transmit tone No
CTCSS Enable C<state>; Turns on CTCSS mode (analog tone) with 1, off with 0. No
CDCSS Enable D<state>; Turns on CDCSS mode (digital tone) with 1, off with 0. No
Bandwidth E<mode>; for 12.5KHz mode is 0, for 25KHz, mode is 1 No
Frequency F<freq>; Set the receive frequency in KHz, if offset is disabled, this is the transmit frequency No
CDCSS In G<code>; <code> must be a valid CDCSS code No
CDCSS Out H<code>; <code> must be a valid CDCSS code No
Print tones I Prints out all configured tones and codes, coma delimited in format: CTCSS In, CTCSS Out, CDCSS In, CDCSS Out No
Power level P<level>; Set the power amp level, 0 = lowest, 15 = highest No
Enable Offset R<state>; 1 turns on repeater offset mode, 0 turns off repeater offset mode No
Squelch S<level>; Set the squelch level No
TX Offset T<freq>; The absolute frequency of the repeater offset to transmit on in KHz No
Volume V<level>; Set the volume level of the receiver No
Reset X Reset all settings to default No
Sleep Z Sleep radio No
Filters @<state>; Set bit to enable, clear bit to disable: 0 = pre/de-emphasis, 1 = high pass filter, 2 = low pass filter (default: ascii 7, all enabled) No
Vox mode $<state>; 0 = vox off, >= 1 audio sensitivity. lower value more sensitive No
Mic Channel *<state>; Set the voice channel. 0 = signal from mic or arduino, 1 = internal tone generator No
RSSI ? Respond with the current receive level in - dBm (no sign provided on numerical response) No
Tone Gen % (notes) To send a tone, use the following format: Single tone: %1,<freq>,<length>; Dual tone: %2,<freq>,<freq>,<length>; DTMF: %3,<key>,<length>; No
Voice Level ^ Respond with the current voice level (VSSI)
`