Macros

General

Macros are key words in a text to send which are being replaced when send. An example is the ! which will be replaced by the station entered in the callsign field. The macros can be used on several places in the program.

• Function key buttons (Entry window)
• Packet buttons (Packet window)
• RTTY programmable buttons (RTTY window)
• PSK programmable buttons (PSK window)

Note: Not every macro can be used on all the places mentioned above.

Macros are executed as they are interpreted, i.e. the program replaces all the macros with their values and then sends the cw. In the case of things like {log}, it logs the Q, then
sends the message. This is not a programming language, it's a substitution system.

When placing several macros under a function-key during the sending of it they will be substituted with the contents of the macros.
Example: * will be replaced with your call, so when your call is PA1M a * will be substituted with 4 characters.
Calling a few times another function key with several substitutions in it could bring this up to several 100 characters per function key. To prevent infinite loops the length of the string after substitutions may not exceed 1024 characters. After this length the program will stop substituting. 1024 characters is over 12 lines of text (from 80 characters).

Note: Macros may be in Upper, Lower or Mixed case.  The maximum macro length is 255 characters.

General macros

General macros can be used on all the places mentioned above.

++ = These macros can not be used in MMTTY and PSK.
The TNC Interface does accept all of the macros above.

Eight of the new commands provide flexibility to send ASCII or HEX commands to either radio in SO2R mode (or VFO in SO2V) mode based on Active or Inactive radio/VFO.

Radio specific commands were added for those SO2R users that do not have identical radios. The new macros follow the same syntax as the existing CAT1HEX and CAT1ASC macros.

The new macros CATA1HEX, CATA2HEX, CATA1ASC, CATA2ASC will send the command to the radio when it is the Active radio.

The new macros CATI1HEX, CATI2HEX, CATI1ASC, CATI2ASC will send the command to the radio when it is the Inactive radio.

The F-key macro text passes through a routine that removes CAT macros for radio(s) that do not qualify based on Active/Inactive radio(s). This allows one F-key string to be used for multiple purposes. An example of a Pro3 macro string that switches DualWatch and the Rx antenna based on the radio activity is shown below.

{catA1hex fefe6ee0 12 00 00fd}{catI1hex fefe6ee0 12 00 01fd}{catA2hex fefe6ee0 07 c0 fd}{catI2hex fefe6ee0 07 c1 fd}

The last macro is the CATDELAY macro. Radio communications are suspended while sending CW and users were unable to send CAT commands to the radio before the CW started. The CATDELAY macro simply delays the start of CW to allow the radio commands to be sent the radio. The form of the CATDELAY macro is {CATDELAY N} where "N" is a user programmable delay in 50ms increments. The value of N is internally limited to 20 (a delay of 1 second).

CW macros

CW macros are only substituted when used in substitutions for CW buttons.  
NB Note taht the ! needs to have a different character in the macro. Use a caret ^ in the macro to send a !

Tip: Some calls have letter combinations where it's hard for to copy correctly. E.g. 6Y2A is often copied as BY2A. To help make your call easier to copy, Go to Config > Change Packet/CW/SSB/Digital Message Buttons> Change CW Buttons, and try changing the default F1 and/or F4 message where * is used for your call. In this example, 6Y2A changes F4 from * to>6<~Y2A. Result: the 6 is sent 2 WPM slower compared to the rest of the call, and an additional half space is added between the 6 and Y. Try other combinations of <, >, or ~ to make your call easier to copy.

SSB macros

SSB macros are only substituted when used in substitutions for SSB buttons.
SSB macros can not be concatenated if the result will be two wav files. A combination with the # macro at the first place will work.

SO2R macros

SO2R macros are only substituted when SO2R is selected.

Multi User macros

Multi User macros are only substituted when in Multi User mode.

Digital (RTTY and PSK) macros

The following substitutions will be made when sending function key.
In the Digital interface the macros below can be used but also all other macros shown under general macros.

Some Remarks:

• Using the {TX} and {RX} macros will allow macros to be strung together as the radio will not unkey until it sees the {RX} or the RX button is pushed.
• Also ESC will switch the rig to RX.

It is best to add the command that your TNC uses to clear the transmit buffer to the end of your Abort Macro. If not, the transmit buffer still holds the remaining characters that were left in the sent string and will get sent the next time the TNC sends.

Packet/Telnet macros

Packet/Telnet macros are only substituted when used in the packet/telnet buttons.

Macro examples

CW macro examples

• Sent the call entered in the callsign field
  • Macro: !
    • Sent his call. The callsign entered in the callsign entry field will be send by the program via the serial of parallel port.

• Sent CQ with your call sent as a macro substitution
  • Macro: cq~test~de~*
    • The time between the words is a half space.
    • * will be replaced with the callsign from the Station dialog.

• Sent part of exchange faster (report sent 6 wpm faster)
  • Macro: <<<5nn>>>{EXCH}
    • The report 5nn is send 6 wpm faster than the exchange.

SSB macro examples

• Sent the call entered in the callsign field
  • Macro: !
    • Sent his call. The callsign entered in the callsign entry field will be send by the soundcard. In the 'Letters' directory all the wav files for the letters/numbers etc. must be present. Examples can be found on the N1MM website, select 'Other Files' under 'Downloads'.

• Let each operator have his own wav files
  • Macro: wav\{OPERATOR}\cq.wav
    • You can specify wav files like: wav\{OPERATOR}\cq.wav As you change operators in a multi user contest, the wav files will change as well. You will have to name them consistently. Note that the wav directory syntax indicates a subdirectory under install directory. You can also fully qualify, like: "C:\wavfiles\cq.wav".
    • If you **really** wanted to, you could have: \wav\{OPERATOR}CQ.wav and name them:
          N1MMCQ.wav
          PA1MCQ.wav
    • Play exchange with operators voice: wav\{OPERATOR}\5905.wav
    • {OPERATOR} is a string substitution only implemented for SSB buttons.

• Hear a 'click' and not call the dupe (in S&P)
• • If you set up S&P F6 to issue the command {BEEP}, you will hear a "click" when you try to work a dupe.

RTTY and PSK macro examples

• Example macros for the PK-232 (Digital interface window)
  
  

  Button text	Macro
  Abort	{CTRL-C}R{ENTER}TC{ENTER}
  TX	X{ENTER}
  RX	{CTRL-D}
  Band Up	RB U{ENTER}
  RxReverse	RXREV T{ENTER}

• Example function key macros for the PK-232 (Entry window function keys)
  
  

  Mode	Button text	Macro
  Running	F1 CQ	X{ENTER}CQ CQ CQ TEST DE {MYCALL} {MYCALL} K CQ{CTRL-D}
  Running	F2 Exch.	X{ENTER} ! UR 599 {EXCH} 599 {EXCH} BK{CTRL-D}
  Running	F3 Tnx/Qrz	X{ENTER} ! TU GL DE {MYCALL} QRZ{CTRL-D}
  S&P	F1 {MYCALL}	X{ENTER}! DE {MYCALL} {MYCALL}{CTRL-D}
  S&P	F2 Exch.	X{ENTER}! UR 599 {EXCH} 599 {EXCH} GL DE {MYCALL}{CTRL-D}

• Example macros for the KAM
  
  

  Button text	Macro
  Abort	{CTRL-C}R RTTY {ENTER}
  TX	{CTRL-C}T
  RX	{CTRL-C}E

• Example macros for the SCS PTC (Digital interface window)
  
  

  Button text	Macro
  Abort	{ESC}CLR{ENTER}{CTRL-D}{ENTER}
  TX/RX	{CTRL-Y}
  RX-Reverse	{ESC}TR 1{ENTER}
  RX-Norm	{ESC}TR 0{ENTER}
  45 Baud	{ESC}BAU 45{ENTER}
  75 Baud	{ESC}BAU 75{ENTER}
  Command mode	{ESC}Q{ENTER}

  Button text	Macro
  RTTY	{ESC}Q{ENTER}BAU{ENTER}
  PSK31	{ESC}Q{ENTER}PSKT{ENTER}
  CW	{ESC}Q{ENTER}CWT{ENTER}
  AMTOR	{ESC}Q{ENTER}AMTOR{ENTER}
  PACTOR	{ESC}Q{ENTER}PT{ENTER}
  PACKET	{ESC}Q{ENTER}PACKET{ENTER}

• Example function key macros for the SCS PTC (Entry window function keys)
  
  

  Mode	Button text	Macro
  Running	F1 CQ	{CTRL-Y}CQ TEST DE * * * k{ENTER}{CTRL-Y}
  Running	F2 EXCH	{CTRL-Y}! HI 599 {EXCH} {EXCH} K{CTRL-Y}
  Running	F3 CFM	{CTRL-Y}! QSL TU DE * QRZ? K{CTRL-Y}
  S&P	F1 CALL	{CTRL-Y}! DE * * K{CTRL-Y}
  S&P	F2 EXCH	{CTRL-Y}DE * TU 599 {EXCH} {EXCH} GL DE *{CTRL-Y}

• Example macros for MMTTY (Entry window function keys)
  
  

  Mode	Button text	Macro
  Running	F1 CQ	{TX} CQ CQ CQ TEST DE {MYCALL} {MYCALL} K CQ {RX}
  Running	F2 Exch.	{TX} ! UR 599 {EXCH} 599 {EXCH} BK{RX}
  Running	F3 Tnx/Qrz	{TX} ! TU GL DE {MYCALL} QRZ {RX}
  S&P	F1 {MYCALL}	{TX} ! DE {MYCALL} {MYCALL}{RX}
  S&P	F2 Exch.	{TX} ! UR 599 {EXCH} 599 {EXCH} GL DE {MYCALL}{RX}
  Send CQ which starts on a new line		{TX}{ENTERLF} CQ DE {MYCALL}{RX}

Packet macro examples

• Connect the local DXcluster using TAPR firmware:
  • {CTRL-C}C {CLUSTER}{ENTER}
    the above sentence is specified for a function key in the Packet Window.
    • {CTRL-C} sends a Control-C character to the TNC which is placed in command mode.
    • {CLUSTER} will be substituted with the Packet Node Call from the Station Information dialog. As example: PI8XXX.
    • {ENTER} will be substituted with the Enter key.
  • The result is that the TNC is placed in Command mode (with Ctrl+C) and C PI8XXX is sent to the TNC because an Enter is sent after the command.

• Connect the Local DXcluster using TF/Nordlink firmware:
  • {ESC}C {CLUSTER}{ENTER}
    the above sentence is specified for a function key in the Packet Window.
    • {ESC} places an Escape character in the command line buffer. This is the same as Shift+Escape when the cursor is on the command line from the Packet Window.
    • {CLUSTER} will be substituted with the Packet Node Call from the Station Information dialog. As example: PI8XXX.
    • {ENTER} will be substituted with the Enter key.
  • The result is that the TNC is placed in Command mode (with ESC) and C PI8XXX is sent to the TNC because an Enter is sent after the command.

• This is an example where more commands are placed under one function key:
  • {ESC}I {MYCALL}{ENTER}{ESC}P 100{ENTER}{ESC}S1{ENTER}{ESC}C {CLUSTER}{ENTER}
    the above sentence is specified for a function key in the Packet Window.
    • {ESC}I {MYCALL}{ENTER}
      Sends my call to the TNC.
    • {ESC}P 100{ENTER}
      Change the Persistence to 100
    • {ESC}S1{ENTER}
      Change to channel 1
    • {ESC}C {CLUSTER}{ENTER}
      Connects my local DXcluster
    So one function keys does it all!!

• This is an example using the {WAIT} macro:
  • In the substitutions you can include things like {CTRL-M}. There is also a {WAIT} macro that waits 5 seconds.
• • So if you needed to press CTRL-M, then wait for a prompt, then C PE1M-7 then enter your callsign, you could change the button to send
  • {CTRL-M}{WAIT}C PE1M-7{WAIT}PA1M
  • Enter is sent automatically after each command.  This may cause a problem with some systems.
  • 
    
• Example to send Ctrl-Z to the DX-cluster to send packet mail (end message)
• • When you have no way to send CTRL-Z to the packet TNC.  Then set one of the packet macros to {CTRL-Z} and that works just fine.
  • Example F12:  {CTRL-Z}

{MESSAGE} macro example

The {MESSAGE} macro sends a message (via a functionkey) to other connected stations over the network. The info will be shown in big red letters in the Info window from the receiving station(s). Place a number directly after the {MESSAGE} macro  if you want to send the message to one specific station. If you don't want to send to a specific station, but want to start your message with a number put "- " in front of the message. Because "*" is used by macro substitution to indicate a callsign, you cannot put a * a the beginning of a message to indicate that the message should be sent to all stations. Since sending to all stations is the default behavior, this is not a problem. Just don't start the message with a number if you want to send the message to all stations.

{END} macro examples

The {END} macro signals to the program that the remaining {} commands are to be executed when the program returns from sending the CW, SSB or DIGI messages (this may not yet work for digi). Here is an example:

F1:  {STEREOOFF}CQ TEST *{END}{STEREOON}

Whenever the F1 key is pressed, the stereo bit on the LPT port will be set to OFF.  CQ will be sent via the current mode, and after the message is complete, the stereo bit on the LPT port will be turned back on.  Thus, one can listen to just the second radio while the CQ is being sent, then listen to both radios after it is finished.
Note: Only {} macros with side effects are used when they are placed after the {END} macro. I.e. if you put {MYCALL} or "5NN" after the {END} macro, they will be ignored.  Why?  well the message is over, there is nothing more to send.

So the rule is: All macros with side effects are executed before the message is sent, except for those that appear after the {END} macro.

So where could this lead?  Well, what if I created a radio control macro? That is, a macro where you could define commands for your particular radio. The syntax would be something like {R1 cmd}.  "cmd" would be replaced with user settable, radio specific commands, like are used with the bandwidth functions accessible from the bandmap.  Using the Orion as an example, a macro could be set up like this:

F1:   {R1 *UM0}CQ TEST *{END}{R1 *UM85}

This would set radio 1's (an Orion) volume to zero at the beginning of a cq, then back to 85 at the end of the cq.  This is equivalent to turning off monitor just for CQ's.   The possibilities are pretty interesting. (There would also be an {R2} macro for SO2R.)

This could lead to controlling RX mute/unmute, monitor on/off, frequency QSY ala NA Sprint rule, possibly letting keyboard entry and or transmit focus follow the moving VFO etc.