E LECRAFT K3 AND KX3 P ROGRAMMER'S R EFERENCE Rev. E11, Oct.
Command Set Overview All K3/KX3 remote control commands are listed in Table 1. The KX3 accepts all K3 commands, though some have no functional effect on the KX3 (*). Some commands are recognized only by the KX3 (**). For K2 commands, see the KIO2 Programmer’s Reference. Table 1 K3/KX3 Control Commands. (*) = Not functionally applicable to KX3. (**) = KX3 only. ($) = Add ‘$’ for VFO B/sub RX (VFO B/dual watch for KX3).
Command Format Note: In the remainder of this document, K3 references apply to the KX3 as well unless otherwise noted. Commands sent from the computer to the K3 are considered either GETs or SETs. GET commands are used by the computer to get information from the K3; the K3 will then provide an appropriate response message (RSP). SET commands are sent by the computer to change the radio's configuration or initiate an event.
Meta-commands: AI, K2 and K3 Meta-commands change the behavior of other commands to provide automatic responses or compatibility with older application software. In general they should not be embedded in K3 or KX3 front-panel switch macros, as they may adversely affect software applications that control meta-command modes. The Command Reference section explains when to use them with specific commands.
Command Examples Macros Macros – strings containing one or more control commands – can be used to automate K3/KX3 front panel switch sequences. Table 2 lists some examples. See Creating and Using Macros (page 6) for complete instructions. Table 2 Sample Macros. These can be altered or combined as needed (see the Command Reference section).
Creating and Using Macros K3 Utility and KX3 Utility can be used to create and test macros. The first eight of these can be sent to the transceiver, where they can be assigned to any of the programmable function switches. Macros can have a length of up to 120 characters, along with a label of up to 7 characters. Example (“SPLIT+2”): A>B, A>B, SPLIT, VFO B up 2 kHz, RIT/XIT off, assigned to PF1 To create this macro and assign it to a K3 front panel switch, you’ll need to complete all of steps 1-8 below.
Command Reference Note: Commands marked with a dollar sign ($) apply to VFO B (and the sub receiver, in the case of the K3). Commands marked with an asterisk (*) are not functionally applicable to the Elecraft KX3, but the KX3 will accept and reply to all K3 commands. For K2 commands, see the KIO2 Programmer’s Reference. This section describes all K3 GET, SET and RSP (response) command formats. Unless otherwise noted, the GET format is just the 2 or 3 letters of the command followed by a semicolon.
BR (Serial I/O Baud Rate; SET only) SET format: BRn; where n is 0 (4800 b), 1 (9600 b), 2 (19200 b), or 3 (38400 b). Note: The K3 firmware download utility automatically sets the K3 to 38400 baud for downloads, then restores the baud rate to the user’s selection (made using the K3’s CONFIG:RS232 menu entry). BW $ (Filter Bandwidth; GET/SET) SET/RSP format: BWxxxx; where xxxx is 0-9999, the bandwidth in 10-Hz units. May be quantized and/or range limited based on the present operating mode.
DS (VFO A and Basic Icon Read; GET only) GET format: DS; (no data). Returns everything needed to reproduce the contents of the VFO A display, as well as a basic subset of the LCDs icons (also see IC command, which provides many more status indicators and does not require that K31 be in effect). The format of the response message is: DSttttttttaf; where tttttttt is the LCD text and decimal point data, a is icon data, and f is icon flash data (all 0 for the K3), or additional K3 icon data.
DT (DATA Sub-Mode; GET/SET) SET/RSP format: DTn; where n is the data sub-mode last used with VFO A, whether or not DATA mode is in effect: 0 (DATA A), 1 (AFSK A), 2 (FSK D), or 3 (PSK D). See MD for data normal/reverse considerations. In Diversity Mode (K3 only, accessed by sending DV1 or via a long hold of S U B ), sending DTn matches the sub receiver’s mode to the main receiver’s. Notes: (1) Use DT only when the transceiver is in DATA mode; otherwise, the returned value may not be valid.
FW $ (Filter Bandwidth and Number; GET/SET) NOTE: FW is a legacy K2 command with side-effects based on the K3x and K2x meta command settings. For the KX3 and K3, use BW if possible. Also use BW in switch macros. K3 Extended SET/RSP format (K31): FWxxxx; where xxxx is 0-9999, the bandwidth in 10-Hz units. May be quantized and/or range limited based on the present operating mode. Basic and K2 Extended formats: See KIO2 Programmer’s Reference (K2).
IC (Misc. Icons and Status; GET only) RSP format: ICabcde; where abcde are 8-bit ASCII characters (Byte in Table 4 below) used as collections of flags (Bit in table). Each flag represents the status of an LCD icon and/or a specific transceiver function. Some functions whose status is indicated by IC command flags can be controlled using other commands. For example, the K3 can be put into TX TEST by sending SWH18. The condition can be verified at any time using the IC command (byte a, bit 5).
ID (Transceiver Identifier; GET only) RSP format: IDnnn; where nnn is 017. This command is provided only for compatibility with existing software, which may use ID in order to distinguish between transceivers. New or modified software should send the K3 command to the transceiver; if a K3n; response is received, the computer must be connected to a K3 or KX3. The K3 and KX3 can be differentiated from each other using the OM command.
K3 * (Command Mode; GET/SET) SET/RSP format: K3n; where n is 0-1. If n is 1, enables K3-specific command extensions to legacy “2-letter” commands. Not needed for new commands that are unique to the K3. In most cases the effects of the K3 command are independent from those of the K2 command (see above), and the two can both be non-zero at the same time. The FW command is an exception; see meta-commands and FW for details.
sets both main and sub mode to n. (2) DATA and DATA-REV select the data sub-mode that was last in effect on the present band. (To read/set data sub-mode, use DT.) The norm/rev conditions for the K3’s data sub-modes are handled in two pairs at present: DATA A/PSK D, and AFSK A/FSK D. E.g., if the radio is set up for DATA A mode, alternating between MD6 and MD9 will cause both DATA A and PSK D to be set to the same normal/reverse condition.
MN (Menu Selection; GET/SET; K3 and KX3 variants) SET/RSP format: MNnnn; where nnn is shown in Table 5 (K3) or Table 6 (KX3). MN255 is returned if the menu is not in use. MN commands can be sent in any order. To exit the menu, send MN255. To change the parameter, use UP / DN (or MP and MQ commands—see table notes). IMPORTANT: T E C H M D menu entry must be set to ON to access tech-mode menu entries; otherwise MN will skip these entries. Use MN072 to access the T E C H M D menu entry.
Table 6 KX3 MN values. These are the same as the K3’s only if the two are functionally identical. nnn is permanently associated with a menu entry, even if entries are moved. ‡ = can be read/set using MP command (or MQ in the case of TXCRNUL). In many cases the get/set value requires interpretation, or must be bit-masked to isolate the relevant field. See MP command for details.
MP (8-bit Direct Menu Parameter Access; GET/SET) SET/RSP format: MPnnn; where the useful range of nnn is determined by the present menu entry (255 max, or 8 bits). Only menu entries marked with ‡ in Table 5 or 6 can be accessed with MP, while others will return “?;” (use UP / DN, DS, and SWT/SWH in such cases). There is also no range checking with MP in most cases, so the user’s macro or application must verify the correct range. Details: MN (described above) accesses menu entries.
SET/RSP format: NBn; or NB$n; where n is 0 (O F F ) or 1 (O N ). Notes: NB0 always turns the noise blanker off, overriding any non-zero NL settings (see NL). In K2 extended mode, an additional ‘0’ is appended to the NB response to provide legacy (K2) format compatibility. NL $ (DSP and IF Noise Blanker Level; GET/SET) SET/RSP format: NLddii; or NL$ddii; where dd is DSP NB level (00-21), and ii is IF NB level (00-21).
PS (Transceiver Power Status; GET/SET) SET/RSP format: PSn; where n = 1 indicates transceiver on. Note: PS0 turns the transceiver off, but this removes power, so PS1 cannot be used to turn it on. To turn power on, the K3’s POWER_ON line (aux I/O jack) must be pulled low by an external device, or it can be turned on manually using the power switch. RA $ (Receive Attenuator Control; GET/SET) SET/RSP format: RAnn; or RA$nn; where nn is 00 (attenuator OFF) or 01 (attenuator ON).
SB * (Sub Receiver or Dual Watch On/Off) SET/RSP format: SBn; where n is 0 (sub receiver or dual watch off) or 1 (on). K3: Sub RX; KX3: Dual watch. SD (QSK Delay, GET only) SET/RSP format: SDnnnn; where nnnn is the semi-break-in delay in 50-ms increments. Provided for backwards compatibility with older applications. If the K3 is in full QSK mode, SD will still read the same value even though the actual break-in delay is set to as close to 0 as possible.
SWT/SWH (Switch Emulation; SET only; K3 and KX3 variants) SET format: SWTnn; (TAP functions) or SWHnn; (HOLD functions). nn is determined from Table 7 (K3) or Table 8 (KX3). Switch emulation commands must sometimes be followed by a delay if successive commands expect the switch function to have been executed (example: SWT16; [XMIT], delay, TQ; [transmit status check]). Activating some switch functions results in icon or status changes that can be checked using the IC or DS commands.
TB (Received Text Read/Transmit Text Count; GET only) RSP format: TBtrrs; where t is the count of buffered CW/data characters remaining to be sent (from KY packets); rr is the count of received CW/data characters available (00-40), and s is the corresponding variablelength text string. If no received text is available, and no transmit text to be sent, the response is TB000; . t can be 0-9; if there are more than 9 characters remaining to be sent, then t will be 9.
XF $ (XFIL Number; GET only) RSP format: XFn; where n is the present XFIL selection (1-5) for the target receiver. In the K3, the XFIL selection refers to crystal filters. In the KX3, the XFIL selection refers to the analog I/Q filters on the KXFL3 module. XT (XIT Control; GET/SET) SET/RSP format: XTn; where n is 0 (XIT OFF) or 1 (XIT ON). XIT is disabled in QRQ CW mode.
Appendix A: Change History [Applicable MCU revisions shown in brackets] Note: Prior to revision D1 this document applied only to the K3. For earlier change history, see rev C14. D1, 1-18-2012 [K3, rev 4.48; KX3, rev 0.58] § § Document now pertains to both the K3 and KX3. Asterisks in Table 1 now show K3 commands that are not functionally applicable to the KX3. (For K2 commands, refer to the KIO2 Programmer’s Reference.) SWT/SWH, MN, and OM descriptions updated to show differences between K3 and KX3.
E5, 1-3-2013 [K3, rev 4.51; KX3, rev 1.35] § [KX3] Added bit to “IC” command to show state of OFS/VFOB LEDs. See byte (e) bit (1). E6, 2-26-2013 [K3, rev 4.62; KX3, rev 1.38] § [KX3] Added MACRO menu function to MN table. E8, 4-15-2013 [K3, rev 4.66; KX3, rev 1.42] § [KX3] Added LED BRT to MN table (MN145). E9, 7-30-2013 [K3, rev 4.66; KX3, rev 1.54] § [KX3] Added PA MODE to MN table (MN146). E10, 10-7-2013 [K3, rev 4.66; KX3, rev 1.
