Difference between revisions of "Message variables"

Revision as of 16:33, 26 August 2016

Messages Variables

These variables can be used in programming CW messages using the F-keys. Some of these variables do not actually create output but rather perform actions at specific points in time, like the $CR symbol.

CW / RTTY automation

$CHECK: send license year (ARRL SS only)
$CORRECT: sends a call correction, if any (see correction)
$CURRENT (or $CURRENTCALL): Sends the callsign of the current QSO despite the presence of a $CR later in the message. The $CR (carriage return) is always executed on message keypress. See Windows | Partner for usage examples. It is also useful in ESM (Enter Sends Message) mode in lieu of $LOGGEDCALL.
$F1...$F7: sends the message associated with F1 ... F7 function key
$FREQnn: Where nn is a band (e.g. $FREQ160, $FREQ80 etc.). Useful in a multi-op as a canned message "PSE QSY $FREQ15". Sends the frequency of the primary radio of the first networked station found on this band with the following priority : R, R+, M, and M+. In addition, in CW, if the frequency is within 100 Hz of a kHz boundary, the decimal point is omitted, e.g. 14021.09 is sent as 14021 and 14021.10 is sent as 14021R1.
$FREQP: contains the frequency of the primary radio (useful for passing mults)
$FREQS: contains the frequency of the secondary radio (useful for passing mults)
$GRIDFIELD (or $LOC4, $GRID4): contains the 4-char QTH locator (Maidenhead square) of the entrant
$GRIDSQUARE (or $LOC6, $GRID6): contains the 6-char QTH locator (Maidenhead square) of the entrant
$INSERT: sends message in the [Ins] key
$ISLAND: sends IOTA Reference (i.e. EU001, AF001, ...) (IOTA Contest)
$LOGGED (or $LOGGEDCALL): sends what is typed in the callsign field of the current QSO, or if blank, the previous QSO
$MSG1...$MSG12: sends additional CW messages (see Modify additional messages)
$MYCALL: sends callsign set in contest configuration
$MYNAME: sends operator name, set in contest configuration
$NEXT (or $NEXTCALL): sends the callsign of the next QSO line when a $CR is included in the message.
$NEXTSERIAL: sends next QSO serial number (current QSO serial number plus 1)
$PLUS: sends message in the [+] key
$PREV (or $PREVCALL): sends the callsign on the previous QSO line.
$PREVSERIAL: sends previous QSO serial number (current QSO serial number minus 1)
$QQSLC: sends Quick QSL message based QSOs made (see Intelligent Quick QSL)
$QQSLT: sends Quick QSL message based on time passed (see Intelligent Quick QSL)
$QQSLRESET: reset the timer or the counter like if the long QSL message were just sent.
$QSOB4: sends the QSOB4 message and cancels the remainder of the current message, if the current QSO is a dupe, otherwise sends nothing (see Modify standard messages)
$RST: sends report from RST Sent field (normally 5NN)
$SERIAL: sends current QSO Serial Number, or previous serial number if the line with the cursor is blank.
$STATE: sends State/Province set in contest configuration (Exchange)
$YEAR: sends year nr set in contest configuration (i.e. EUHFC, AA)
$ZONE: sends zone nr set in contest configuration
&xy: sends a Morse prosign where xy represents the two characters forming the prosign, e.g. &AS, &AR, &BK, &BT, &CL, &KN, &SK, etc.
+: increase speed by 4 wpm
-: decrease speed by 4 wpm
^: the halfspace character with 1/2 dot duration
~: (tilde) at then end of a variable means "no space" will be inserted, e.g. $NEXT~? sends the next callsign followed by a question mark, with no space in between

RTTY only

$13: send carriage return character (start print on a new line)
$SERIE: send the complete QTC block (WAEDC only)

Action

$CR: works like hitting [Enter] (log QSO)
$GRAB1 - $GRAB9: Grabs spot 1 to 9 from the Partner window and inserts it in the callsign field.
$GRABRT1 - $GRABRT3: Grabs realtime spot 1 to 3 from the Partner window and inserts it in the callsign field.
$GRABPARTNER: grabs the first callsign from the Partner window and inserts it in the callsign field. See usage notes under Partner window.
$GRABSPOT: grabs spot on the current frequency
$GUESSEXCH (or $GUESSEXCHANGE): mimics a space bar hit, filling the exchange field(s) if possible, but the cursor remains in the same edit field.
$REPEAT: restarts the automatic repeating CQ sequence (if enabled), after pausing for the specified interval. Most useful at the end of the [Plus] key message to avoid having to press [F1] to start CQing again.
$RSTEXCHSENT: Resets the "exchangeSent" flag of the active QSO (useful only for ESM scripts)
$SETEXCHSENT: Sets the "exchangeSent" flag of the active QSO (useful only for ESM scripts)
$SPACEBAR: works like hitting spacebar-key (move cursor to the next most-used field)
$TAB: works like hitting [Tab] (move cursor to next field)

SO2R

$ALTERNATECQ (or $ACQ): swaps primary and secondary radios and send CQ on the secondary radio
$CQ: same as $ALTERNATECQ but does not swap radios
$LATCH: sets latch mode
$MK2R=cmd: send a specific MK2R command to the microHAM MK2R SO2R box. See Integrated_SO2R_boxes for usage notes.
$R1R1: set audio of Radio 1 to left and right ear
$R1R2: set audio of Radio 1 to left and audio of Radio 2 to right ear
$R2R1: set audio of Radio 2 to left and audio of Radio 1 to right ear
$R2R2: set audio of Radio 2 to left and right ear
$RESET: cancels any manual change made in the audio control
$TR1: transmit on primary radio
$TR2: transmit on secondary radio

WAEDC QTC related

$CALLSIGN: send callsign of the current QTC
$DONE: if all QTC are sent: mimic the [+] key
$FIELD: this variable takes the value "GROUP", "TIME", "CL" or "NR", depending on the kind of QTC field where the cursor is located
$GRNR: sends group & number of the received QTC
$NEXT: move focus to the next QTC line
$QTC: sends group & number of the transmitted QTC
$QTCROW: Row number of cursor location in the QTC window. Very useful to create a function key sending the message PSE RPT QTC NR $QTCROW $QTCROW in WAEDC RTTY to request repetition of a specific QTC.
$SERIAL: send serial number of the current QTC
$SERIE: send the complete QTC block (specific to RTTY)
$TIME: send time of the current QTC
$VALID: save everything and close the window

Back to Main Page

Custom variables

The user may define "custom" variables with any unused name. They can be used in messages and easily updated while operating. They are mostly intended for the DXPedition mode, but they work for all CW and RTTY logs.

For example, one could define

$REGION as "EU", "NA", etc.
$UP as "UP" or "UP 5"

See Options | CW | Custom variables... for usage notes.

@@ Line 12: / Line 12: @@
 *       '''<tt>$FREQP</tt>''': contains the frequency of the primary radio (useful for passing mults)
 *       '''<tt>$FREQS</tt>''': contains the frequency of the secondary radio (useful for passing mults)
-*       '''<tt>$GRIDFIELD</tt>''': contains the 4-char QTH locator (Maidenhead square) of the entrant
+*       '''<tt>$GRIDFIELD</tt>''' (or <tt>'''$LOC4</tt>''', '''$GRID4</tt>'''): contains the 4-char QTH locator (Maidenhead square) of the entrant
-*       '''<tt>$GRIDSQUARE</tt>''': contains the 6-char QTH locator (Maidenhead square) of the entrant
+*       '''<tt>$GRIDSQUARE</tt>''' (or <tt>'''$LOC6</tt>''', '''$GRID6</tt>'''): contains the 6-char QTH locator (Maidenhead square) of the entrant
 *       '''<tt>$INSERT</tt>''': sends message in the ['''<tt>Ins</tt>'''] key
 *       '''<tt>$ISLAND</tt>''': sends IOTA Reference (i.e. EU001, AF001, ...) (IOTA Contest)