Appendix B - Microham Control Protocol - microHAM micro2R u2R User Manual

Introduction
This appendix describes the commands in the microHAM Control Protocol that are likely to be useful to
users in creating custom macros in loggers that support user defined "scenarios." These user level
commands can be used to select antenna outputs (e.g., the 4 bit value on pins 6-9 (Radio 1) and 10-13
(Radio 2) of the Accessory port), to select transmitter or receiver focus, or to control the Digital Voice Keyer,
CW Memory Keyer or FSK Message memories.
microHAM Control Protocol, as a whole or in any subset, is the intellectual property of
microHAM, s.r.o. and may not be used by any person in conjunction with any hardware
interface or control product ("controller") not manufactured by microHAM. Individuals who
have purchased a controller from microHAM, s.r.o or its dealers and distributors are
licensed to utilize the following subset of commands only with that controller. Complete
documentation is available on request and execution of a non-disclosure agreement to
qualified software developers who wish to support microHAM interfaces and controllers.
Disclosure of this sub-set of the microHAM Control Protocol shall not grant license to any
party to use these controls for any purpose not specifically authorized herein, nor shall this
disclosure grant license to use these controls, or any subset of these controls, with any
controller not produced by micoHAM.
Commands
All commands are ASCII and are case sensitive. Each command is uppercase and ends with <CR>. In this
document parameters (arguments) for the command are shown in lower case. Router responds to any
invalid command with an error message where the first character is an E is followed by copy of the
received command – e.g., Ecommand<CR>.
Focus control: These commands control transmit focus and headphone switching.
●
SetTxFocus(): active only when TX Auto Focus has been selected
FT1<CR> SetTxFocus(R1)
FT2<CR> SetTxFocus(R2)
SetRxFocus(): active only when RX Auto Focus has been selected
FR1<CR> SetRxFocus(R1)
FR2<CR> SetRxFocus(R2)
FRS<CR> SetRxFocus(STEREO)
ACC output control: The ACC output (Band Data or Antenna Relay) can be one of 16 values
●
represented by a 4-bit value. The output is set using a two digit value between 00 and 16.
AS1dd<CR> SetAccOutputSelection(R1, selection)
AS2dd<CR> SetAccOutputSelection(R2, selection)
Keyer mode control: This command sets the Keyer mode (operating mode) for each radio.
●
K1M<CR> SetKeyerMode(R1, selection)
K2M<CR> SetKeyerMode(R2, selection)
Mode values are C=CW, V=VOICE, F=FSK.
DVK, CW and FSK messages: These commands control playing and recording of messages. The
●
current operating mode will be used to determine if Voice, CW or FSK messages will be
played/recorded.
microHAM © 2010 All rights reserved
APPENDIX B – microHAM Control Protocol
55