Commands can be entered either as a single char, or as a long command name. The commands are not
prefixed with a dash as the options are. They may be typed in when in interactive mode or provided as
argument(s) in command line interface mode. In interactive mode commands and their arguments may be
entered on a single line:
MLSB2400
Since most of the Hamlib operations have a set and a get method, a single upper case letter will often be
used for a set method whereas the corresponding single lower case letter refers to the get method. Each
operation also has a long name; in interactive mode, prepend a backslash, ‘\’, to enter a long command
name all lower case.
Example: Use “\dump_caps” to see what capabilities this radio and backend support.
Note: The backend for the radio to be controlled, or the radio itself may not support some
commands. In that case, the operation will fail with a Hamlib error message.
StandardInput
As an alternative to the READLINE interactive command entry or a single command for each run, rigctl
features a special option where a single dash (‘-’) may be used to read commands from standard input
(stdin). Commands must be separated by whitespace similar to the commands given on the command line.
Comments may be added using the ‘#’ character, all text up until the end of the current line including
the ‘#’ character is ignored.
A simple example (typed text is in bold):
$ cat<<.EOF.>cmds.txt
> #Fileofcommands
> vfm#queryrig
> VVFOBF14200000MCW500#setrig
> vfm#queryrig
> .EOF.
$ rigctl-m1-<cmds.txt
v VFOA
f 145000000
m FM
15000
V VFOB
F 14200000
M CW 500
v VFOB
f 14200000
m CW
500
$
rigctlCommands
A summary of commands is included below (In the case of set commands the quoted italicized string is
replaced by the value in the description. In the case of get commands the quoted italicized string is
the key name of the value returned.):
Q|q, exit rigctl
Exit rigctl in interactive mode.
When rigctl is controlling the rig directly, will close the rig backend and port. When rigctl is
connected to rigctld (radio model 2), the TCP/IP connection to rigctld is closed and rigctld
remains running, available for another TCP/IP network connection.
F, set_freq 'Frequency'
Set 'Frequency', in Hz.
Frequency may be a floating point or integer value.
f, get_freq
Get 'Frequency', in Hz.
Returns an integer value and the VFO hamlib thinks is active. Note that some rigs (e.g. all
Icoms) cannot track current VFO so hamlib can get out of sync with the rig if the user presses rig
buttons like the VFO.
M, set_mode 'Mode' 'Passband'
Set 'Mode' and 'Passband'.
Mode is a token: ‘USB’, ‘LSB’, ‘CW’, ‘CWR’, ‘RTTY’, ‘RTTYR’, ‘AM’, ‘FM’, ‘WFM’, ‘AMS’, ‘PKTLSB’,
‘PKTUSB’, ‘PKTFM’, ‘ECSSUSB’, ‘ECSSLSB’, ‘FA’, ‘SAM’, ‘SAL’, ‘SAH’, ‘DSB’.
Passband is in Hz as an integer, -1 for no change, or ‘0’ for the radio backend default. IC7300
can use 1,2,3 to select which filter to use
Note: Passing a ‘?’ (query) as the first argument instead of a Mode token will return a space
separated list of radio backend supported Modes. Use this to determine the supported Modes of a
given radio backend.
m, get_mode
Get 'Mode' and 'Passband'.
Returns Mode as a token and Passband in Hz as in set_mode above.
V, set_vfo 'VFO'
Set 'VFO'.
VFO is a token: ‘VFOA’, ‘VFOB’, ‘VFOC’, ‘currVFO’, ‘VFO’, ‘MEM’, ‘Main’, ‘Sub’, ‘TX’, ‘RX’.
In VFO mode (see --vfo option above) only a single VFO parameter is required:
$ rigctl-m229-r/dev/rig-o
Rig command: V
VFO: VFOB
Rig command:
v, get_vfo
Get current 'VFO'.
Returns VFO as a token as in set_vfo above.
J, set_rit 'RIT'
Set 'RIT'.
RIT is in Hz and can be + or -. A value of ‘0’ resets RIT (Receiver Incremental Tuning) to match
the VFO frequency.
Note: RIT needs to be explicitly activated or deactivated with the set_func command. This allows
setting the RIT offset independently of its activation and allows RIT to remain active while
setting the offset to ‘0’.
j, get_rit
Get 'RIT' in Hz.
Returned value is an integer.
Z, set_xit 'XIT'
Set 'XIT'.
XIT is in Hz and can be + or -. A value of ‘0’ resets XIT (Transmitter Incremental Tuning) to
match the VFO frequency.
Note: XIT needs to be explicitly activated or deactivated with the set_func command. This allows
setting the XIT offset independently of its activation and allows XIT to remain active while
setting the offset to ‘0’.
z, get_xit
Get 'XIT' in Hz.
Returned value is an integer.
T, set_ptt 'PTT'
Set 'PTT'.
PTT is a value: ‘0’ (RX), ‘1’ (TX), ‘2’ (TX mic), or ‘3’ (TX data).
t, get_ptt
Get 'PTT' status.
Returns PTT as a value in set_ptt above.
S, set_split_vfo 'Split' 'TXVFO'
Set 'Split' mode.
Split is either ‘0’ = Normal or ‘1’ = Split.
Set 'TXVFO'.
TX VFO is a token: ‘VFOA’, ‘VFOB’, ‘VFOC’, ‘currVFO’, ‘VFO’, ‘MEM’, ‘Main’, ‘Sub’, ‘TX’, ‘RX’.
s, get_split_vfo
Get 'Split' mode.
Split is either ‘0’ = Normal or ‘1’ = Split.
Get 'TXVFO'.
TX VFO is a token as in set_split_vfo above.
I, set_split_freq 'TxFrequency'
Set 'TXFrequency', in Hz.
Frequency may be a floating point or integer value.
i, get_split_freq
Get 'TXFrequency', in Hz.
Returns an integer value.
X, set_split_mode 'TXMode' 'TXPassband'
Set 'TXMode' and 'TXPassband'.
TX Mode is a token: ‘USB’, ‘LSB’, ‘CW’, ‘CWR’, ‘RTTY’, ‘RTTYR’, ‘AM’, ‘FM’, ‘WFM’, ‘AMS’,
‘PKTLSB’, ‘PKTUSB’, ‘PKTFM’, ‘ECSSUSB’, ‘ECSSLSB’, ‘FA’, ‘SAM’, ‘SAL’, ‘SAH’, ‘DSB’.
TX Passband is in Hz as an integer, or ‘0’ for the radio backend default.
Note: Passing a ‘?’ (query) as the first argument instead of a TX Mode token will return a space
separated list of radio backend supported TX Modes. Use this to determine the supported TX Modes
of a given radio backend.
x, get_split_mode
Get 'TXMode' and 'TXPassband'.
Returns TX Mode as a token and TX Passband in Hz as in set_split_mode above.
Y, set_ant 'Antenna' 'Option'
Set 'Antenna' and 'Option'.
Number is 1-based antenna# (‘1’, ‘2’, ‘3’, ...).
Option depends on rig..for Icom it probably sets the Tx & Rx antennas as in the IC-7851. See your
manual for rig specific option values. Most rigs don't care about the option.
For the IC-7851, FTDX3000 (and perhaps others) it means this:
1 = TX/RX = ANT1 FTDX3000=ANT1/ANT3
2 = TX/RX = ANT2 FTDX3000=ANT2/ANT3
3 = TX/RX = ANT3 FTDX3000=ANT3
4 = TX/RX = ANT1/ANT4
5 = TX/RX = ANT2/ANT4
6 = TX/RX = ANT3/ANT4
y, get_ant 'Antenna'
Get 'Antenna'
A value of 0 for Antenna will return the current TX antenna
> 0 is 1-based antenna# (‘1’, ‘2’, ‘3’, ...).
Option returned depends on rig..for Icom is likely the RX only flag.
b, send_morse 'Morse'
Send 'Morse' symbols. For Yaesu rigs use memory#1-5 or up to 50 char msg
Example from command line: rigctl -m 3073 -r /dev/ttyUSB0 b "CQ CQ DE ME"
Yaesu example to send message#1: rigctl -m 1035 -r /dev/ttyUSB0 b 1
0xbb, stop_morse
Stop sending the current morse code.
0xbc, wait_morse
Wait for morse to finish -- only works on full break-in
0x94, send_voice_mem 'Msgnum'
Have rig transmit internal message
'Msgnum'
0x8b, get_dcd
Get
'DCD'
(squelch) status: ‘0’ (Closed) or ‘1’ (Open).
R, set_rptr_shift 'RptrShift'
Set
'RptrShift'.
Rptr Shift is one of: ‘+’, ‘-’, or something else for
‘None’.
r, get_rptr_shift
Get
'RptrShift'.
Returns ‘+’, ‘-’, or ‘None’.
O, set_rptr_offs 'RptrOffset'
Set
'RptrOffset',
in Hz.
o, get_rptr_offs
Get
'RptrOffset',
in Hz.
C, set_ctcss_tone 'CTCSSTone'
Set
'CTCSSTone',
in tenths of Hz.
c, get_ctcss_tone
Get
'CTCSSTone',
in tenths of Hz.
D, set_dcs_code 'DCSCode'
Set
'DCSCode'.
d, get_dcs_code
Get
'DCSCode'.
0x90, set_ctcss_sql 'CTCSSSql'
Set
'CTCSSSql'
tone, in tenths of Hz.
0x91, get_ctcss_sql
Get
'CTCSSSql'
tone, in tenths of Hz.
0x92, set_dcs_sql 'DCSSql'
Set
'DCSSql'
code.
0x93, get_dcs_sql
Get
'DCSSql'
code.
N, set_ts 'TuningStep'
Set
'TuningStep',
in Hz.
n, get_ts
Get
'TuningStep',
in Hz.
U, set_func 'Func' 'FuncStatus'
Set
'Func'
and
'FuncStatus'.
Func is a token: ‘FAGC’, ‘NB’, ‘COMP’, ‘VOX’,
‘TONE’, ‘TSQL’, ‘SBKIN’, ‘FBKIN’, ‘ANF’,
‘NR’, ‘AIP’, ‘APF’, ‘MON’, ‘MN’, ‘RF’,
‘ARO’, ‘LOCK’, ‘MUTE’, ‘VSC’, ‘REV’,
‘SQL’, ‘ABM’, ‘BC’, ‘MBC’, ‘RIT’, ‘AFC’,
‘SATMODE’, ‘SCOPE’, ‘RESUME’, ‘TBURST’, ‘TUNER’,
‘XIT’, ‘NB2’, ‘DSQL’, ‘AFLT’, ‘ANL’, ‘BC2’,
‘DUAL_WATCH’, ‘DIVERSITY’, ‘CSQL’, ‘SCEN’,
‘TRANSCEIVE’, ‘SPECTRUM’, ‘SPECTRUM_HOLD’, ‘SEND_MORSE’,
‘SEND_VOICE_MEM’, ‘OVF_STATUS’.
FAGC -- Fast AGC
NB -- Noise Blanker
COMP -- Speech Compression
VOX -- Voice Operated Relay
TONE -- CTCSS Tone TX
TSQL -- CTCSS Activate/De-activate RX
SBKIN -- Semi Break-in (CW mode)
FBKIN -- Full Break-in (CW mode)
ANF -- Automatic Notch Filter (DSP)
NR -- Noise Reduction (DSP)
AIP -- RF pre-amp (AIP on Kenwood, IPO on Yaesu, etc.)
APF -- Audio Peak Filter
MON -- Monitor transmitted signal
MN -- Manual Notch
RF -- RTTY Filter
ARO -- Auto Repeater Offset
LOCK -- Lock
MUTE -- Mute
VSC -- Voice Scan Control
REV -- Reverse transmit and receive frequencies
SQL -- Turn Squelch Monitor on/off
ABM -- Auto Band Mode
BC -- Beat Canceller
MBC -- Manual Beat Canceller
RIT -- Receiver Incremental Tuning
AFC -- Auto Frequency Control ON/OFF
SATMODE -- Satellite mode ON/OFF
SCOPE -- Simple bandscope ON/OFF
RESUME -- Scan auto-resume
TBURST -- 1750 Hz tone burst
TUNER -- Enable automatic tuner
XIT -- Transmitter Incremental Tuning
NB2 -- 2nd Noise Blanker
CSQL -- DCS Squelch setting
AFLT -- AF Filter setting
ANL -- Noise limiter setting
BC2 -- 2nd Beat Cancel
DUAL_WATCH -- Dual Watch / Sub Receiver
DIVERSITY -- Diversity receive
DSQL -- Digital modes squelch
SCEN -- scrambler/encryption
SLICE -- Rig slice selection -- Flex
TRANSCEIVE -- Send radio state changes automatically ON/OFF
SPECTRUM -- Spectrum scope data output ON/OFF
SPECTRUM_HOLD -- Pause spectrum scope updates ON/OFF
SEND_MORSE -- Send specified characters using CW
SEND_VOICE_MEM -- Transmit in SSB message stored in memory
OVF -- Read overflow status 0=Off, 1=On
Func Status is a non null value for “activate” or “de-activate”
otherwise, much as TRUE/FALSE definitions in the C language (true is non-zero
and false is zero, ‘0’).
Note:
Passing a ‘?’ (query) as the first argument instead of a Func token will
return a space separated list of radio backend supported set function tokens.
Use this to determine the supported functions of a given radio backend.
u, get_func 'Func'
Get
'FuncStatus'.
Returns Func Status as a non null value for the Func token given as in
set_func
above.
Note:
Passing a ‘?’ (query) as the first argument instead of a Func token will
return a space separated list of radio backend supported get function tokens.
Use this to determine the supported functions of a given radio backend.
L, set_level 'Level' 'LevelValue'
Set
'Level'
and
'LevelValue'.
Level is a token: ‘PREAMP’, ‘ATT’, ‘VOXDELAY’, ‘AF’,
‘RF’, ‘SQL’, ‘IF’, ‘APF’, ‘NR’, ‘PBT_IN’,
‘PBT_OUT’, ‘CWPITCH’, ‘RFPOWER’, ‘MICGAIN’,
‘KEYSPD’, ‘NOTCHF’, ‘COMP’, ‘AGC’, ‘BKINDL’,
‘BAL’, ‘METER’, ‘VOXGAIN’, ‘ANTIVOX’,
‘SLOPE_LOW’, ‘SLOPE_HIGH’, ‘BKIN_DLYMS’, ‘RAWSTR’, ‘SWR’,
‘ALC’, ‘STRENGTH’, ‘RFPOWER_METER’, ‘COMPMETER’, ‘VD_METER’, ‘ID_METER’,
‘NOTCHF_RAW’, ‘MONITOR_GAIN’, ‘NQ’, ‘RFPOWER_METER_WATTS’, ‘SPECTRUM_MODE’,
‘SPECTRUM_SPAN’, ‘SPECTRUM_EDGE_LOW’, ‘SPECTRUM_EDGE_HIGH’, ‘SPECTRUM_SPEED’,
‘SPECTRUM_REF’, ‘SPECTRUM_AVG’, ‘SPECTRUM_ATT’, ‘TEMP_METER’, ‘BANDSELECT’,
‘USB_AF’.
The Level Value can be a float or an integer value. For the AGC token the
value is one of ‘0’ = OFF, ‘1’ = SUPERFAST, ‘2’ = FAST,
‘3’ = SLOW, ‘4’ = USER, ‘5’ = MEDIUM, ‘6’ = AUTO.
Note that not all values work on all rigs. To list usable values do "rigctl -m [modelnum] -u | grep AGC levels" or for Windows "rigctl -m [modelnum] -u | find "AGC levels"".
Level units
0.0-1.0 where 0=0% and 1.0=100% (except for BAL where 50% is center)
AF, ALC, ANTIVOX, BAL, COMP, MICGAIN, MONITOR_GAIN, NOTCHF_RAW, NR, RF, RFPOWER, RFPOWER_METER, USB_AF, VOXGAIN
Amps
ID_METER(A)
dB
NL, COMP_METER, PREAMP, ATT, SLOPE_LOW, SLOPE_HIGH, SPECTRUM_REF, SPECTRUM_ATT, STRENGTH
Degrees(temperature)
TEMP_METER(C)
Hz
CWPITCH, IF, NOTCHF, PBT_IN, PBT_OUT, SPECTRUM_EDGE_LOW, SPECTRUM_EDGE_HIGH, SPECTRUM_SPAN
Seconds
VOXDELAY(ds), BKINDL(ms), BKIN_DLYMS(ms)
Raw info from rig
RAWSTR, BANDSELECT (subject to change -- index right now but may convert to band name)
SWR
SWR
Volts
VD_METER
Lookup - if level shows 0/0/0 then it's probably a lookup value
METER RIG_METER_XXXX 1=SWR, 2=COMP, 4=ALC, 8=IC, 16=DB, 32=PO, 64=VDD, 128=Temp
AGC 0=None, 1=SuperFast, 2=Fast, 3=Slow, 4=User, 5=Medium, 6=Auto
Note: Not all AGC values may be available -- see AGC Level in dumpcaps (e.g. rigctl -m 1035 -u | grep AGC)
SPECTRUM_MODE 0=None, 1=Center, 2=Fixed, 3=Center Scroll, 4=Fixed Scroll
SPECTRUM_AVG rig specific
METER -- SWR,COMP,ALC,IC/ID,DB,PO,VDD,TEMP or can use the numbers above in Lookup l METER returns the meter number=name
Watts
RFPOWER_METER_WATTS
WPM
KEYSPD
Note: Passing a ‘?’ (query) as the first argument instead of a Level token will return a space
separated list of radio backend supported set level tokens. Use this to determine the supported
levels of a given radio backend.
l, get_level 'Level'
Get 'LevelValue'.
Returns Level Value as a float or integer for the Level token given as in set_level above.
Note: Passing a ‘?’ (query) as the first argument instead of a Level token will return a space
separated list of radio backend supported get level tokens. Use this to determine the supported
levels of a given radio backend.
P, set_parm 'Parm' 'ParmValue'
Set 'Parm' and 'ParmValue'.
Parm is a token: ‘ANN’, ‘APO’, ‘BACKLIGHT’, ‘BEEP’, ‘TIME’, ‘BAT’, ‘KEYLIGHT’, ‘SCREENSAVER’,
‘AFIF’, ‘BANDSELECT’, ‘KEYERTYPE’.
Note: Passing a ‘?’ (query) as the first argument instead of a Parm token will return a space
separated list of radio backend supported set parameter tokens. Use this to determine the
supported parameters of a given radio backend.
ANN -- "Announce" level, see ann_t
APO -- Auto power off, int in minute
BACKLIGHT -- LCD light, float [0.0 ... 1.0]
BEEP -- Beep on keypressed, int (0,1)
TIME -- hh:mm:ss, int in seconds from 00:00:00
BAT -- battery level, float [0.0 ... 1.0]
KEYLIGHT -- Button backlight, on/off
SCREENSAVER -- rig specific timeouts
AFIF -- 0=AF audio, 1=IF audio -- see IC-7300/9700/705
BANDSELECT -- band name, e.g. BAND160M, BAND80M.... a ? instead of band will show band
possibilities
KEYERTYPE -- Icom keyer type 0,1,2 or STRAIGHT,BUG,PADDLE
p, get_parm 'Parm'
Get 'ParmValue'.
Returns Parm Value as a float or integer for the Parm token given as in set_parm above.
Note: Passing a ‘?’ (query) as the first argument instead of a Parm token will return a space
separated list of radio backend supported get parameter tokens. Use this to determine the
supported parameters of a given radio backend.
B, set_bank 'Bank'
Set 'Bank'.
Sets the current memory bank number.
E, set_mem 'Memory#'
Set 'Memory#' channel number.
e, get_mem
Get 'Memory#' channel number.
G, vfo_op 'Mem/VFOOp'
Perform a 'Mem/VFOOp'.
Mem/VFO Operation is a token: ‘CPY’, ‘XCHG’, ‘FROM_VFO’, ‘TO_VFO’, ‘MCL’, ‘UP’, ‘DOWN’, ‘BAND_UP’,
‘BAND_DOWN’, ‘LEFT’, ‘RIGHT’, ‘TUNE’, ‘TOGGLE’.
Note: Passing a ‘?’ (query) as the first argument instead of a Mem/VFO Op token will return a
space separated list of radio backend supported Set Mem/VFO Op tokens. Use this to determine the
supported Mem/VFO Ops of a given radio backend.
g, scan 'ScanFct' 'ScanChannel'
Perform a 'ScanFct' on a 'ScanOption'.
Scan Function is a token: ‘STOP’, ‘MEM’, ‘SLCT’, ‘PRIO’, ‘PROG’, ‘DELTA’, ‘VFO’, ‘PLT’.
Scan Option is an integer.
Scan Option for Yaesu rigs 0=STOP, 1=UP, 2=DOWN.
Scan Option for Icom rigs is a channel number to program with G otherwise not used.
Scan Option for Kenwood rigs is not used.
Note: Passing a ‘?’ (query) as the first argument instead of a Scan Fct token will return a space
separated list of radio backend supported Scan Function tokens. Use this to determine the
supported Scan Functions of a given radio backend.
H, set_channel 'Channel'
Set memory 'Channel' data.
Sets memory channel information
h, get_channel 'readonly'
Get channel memory.
If readonly!=0 then only channel data is returned and rig remains on the current channel. If
readonly=0 then rig will be set to the channel requested. data.
A, set_trn 'Transceive'
Set 'Transceive' mode.
Transceive is a token: ‘OFF’, ‘RIG’, ‘POLL’.
Transceive is a mechanism for radios to report events without a specific call for information.
Note: Passing a ‘?’ (query) as the first argument instead of a Transceive token will return a
space separated list of radio backend supported Transceive mode tokens. Use this to determine the
supported Transceive modes of a given radio backend.
a, get_trn
Get 'Transceive' mode.
Transceive mode (reporting event) as in set_trn above.
*, reset 'Reset'
Perform rig 'Reset'.
Reset is a value: ‘0’ = None, ‘1’ = Software reset, ‘2’ = VFO reset, ‘4’ = Memory Clear reset, ‘8’
= Master reset.
Since these values are defined as a bitmask in include/hamlib/rig.h, it should be possible to OR
these values together to do multiple resets at once, if the backend supports it or supports a
reset action via rig control at all.
0x87, set_powerstat 'PowerStatus'
Set 'PowerStatus'.
Power Status is a value: ‘0’ = Power Off, ‘1’ = Power On, ‘2’ = Power Standby (enter standby), ‘4’
= Power Operate (leave standby).
0x88, get_powerstat
Get 'PowerStatus' as in set_powerstat above.
0x89, send_dtmf 'Digits'
Set DTMF 'Digits'.
0x8a, recv_dtmf
Get DTMF 'Digits'.
_, get_info
Get misc information about the rig.
0xf5, get_rig_info
Get misc information about the rig vfo status and other info.
0xf3, get_vfo_info 'VFO'
Get misc information about a specific vfo.
dump_state
Return certain state information about the radio backend.
1, dump_caps
Not a real rig remote command, it just dumps capabilities, i.e. what the backend knows about this
model, and what it can do.
TODO: Ensure this is in a consistent format so it can be read into a hash, dictionary, etc. Bug
reports requested.
Note: This command will produce many lines of output so be very careful if using a fixed length
array! For example, running this command against the Dummy backend results in over 5kB of text
output.
VFO parameter not used in 'VFO mode'.
2, power2mW 'Power[0.0..1.0]' 'Frequency' 'Mode'
Returns 'PowermW'.
Converts a Power value in a range of 0.0...1.0 to the real transmit power in milli-Watts
(integer).
'Frequency' and 'Mode' also need to be provided as output power may vary according to these
values.
VFO parameter is not used in VFO mode.
4, mW2power 'PowermW' 'Frequency' 'Mode'
Returns 'Power[0.0..1.0]'.
Converts the real transmit power in milli-Watts (integer) to a Power value in a range of 0.0...1.0.
'Frequency' and 'Mode' also need to be provided as output power may vary according to these
values.
VFO parameter is not used in VFO mode.
w, send_cmd 'Cmd'
Send a raw command string to the radio.
This is useful for testing and troubleshooting radio commands and responses when developing a
backend.
For binary protocols enter values as \0xAA\0xBB. Expect a 'Reply' from the radio which will
likely be a binary block or an ASCII string depending on the radio's protocol (see your radio's
computer control documentation). If you are testing a protocol like SmartSDR where there are
spaces in the commands use quote, e.g. w "C0|set slice 0 tx=1"
The command terminator, set by the send-cmd-term option above, will terminate each command string
sent to the radio. This character should not be a part of the input string.
W, send_cmd_rx 'Cmd'nbytes_or_terminator_char
Send a raw command string to the radio and expect nbytes returned or the terminator char (e.g. ;).
This is useful for testing and troubleshooting radio commands and responses when developing a
backend. If the # of bytes requested is <= the number actually returned no timeout will occur. If
a char is provided it will be used to terminate reading the string so ';' is popular for
Kenwood/Yaesu commands for example.
The command argument can have no spaces in it. For binary protocols enter values as \0xAA\0xBB.
Expect a 'Reply' from the radio which will likely be a binary block or an ASCII string depending
on the radio's protocol (see your radio's computer control documentation).
The command terminator, set by the send-cmd-term option above, will terminate each command string
sent to the radio. This character should not be a part of the input string.
set_clock 'DateTime'
Set 'DateTime'
Sets rig clock -- note that some rigs do not handle seconds or milliseconds. If you try to set
sec/msec and rig does not support it you will get a debug warning message. Format is ISO8601,
Formats accepted allow for 2-digit or 4-digit time zone
YYYY-MM-DDTHH:MM:SS.SSS+ZZ (where +ZZ is either -/+ UTC offset HH)
YYYY-MM-DDTHH:MM:SS.SSS+ZZZZ (where +ZZZZ is either -/+ UTC offset HHMM)
YYYY-MM-DDTHH:MM:SS+ZZ
YYYY-MM-DDTHH:MM:SS+ZZZZ
YYYY-MM-DDTHH:MM+ZZ
YYYY-MM-DDTHH:MM+ZZZZ
YYYY-MM-DD (sets date only)
local (sets both clocks to local time)
utc (sets both clocks to utc time)
Note: Icom rigs expect you to set local time and the hours off to UTC.
So...4PM EST example would be 2021-12-01T16:00:00-0500
But...if you want to display GMT you must set the clock for GMT with zero UTC offset.
Hopefully Icom will allow displaying either clock in the future
Note: Kenwood rigs only allow setting local clock, and then only if not autoset by NTP.
Trying to set clock when NTP is in use will set the offset, but not the time -
and no error status will be returned.
Time displayed on the auxiliary clock is solely determined by UTC and the aux offset.
get_clock
Get 'RigTime'
Gets rig clock -- note that some rigs do not handle seconds or milliseconds. Format is ISO8601
YYYY-MM-DDTHH:MM:SS.sss+ZZ where +ZZ is either -/+ UTC offset
chk_vfo
Get 'Status'
Returns Status as 1 if vfo option is on and 0 if vfo option is off. This command reflects the -o
switch for rigctl and ritctld and can be dynamically changed by set_vfo_opt.set_vfo_opt 'Status'
Set 'Status'
Set vfo option Status 1=on or 0=off This is the same as using the -o switch for rigctl and
ritctld. This can be dynamically changed while running.
get_separator
Get 'SeparatorChar'
Shows the current SeparatorChar
set_separator 'SeparatorChar'
Set 'SeparatorChar'
Change rigctld response to use a special char instead of newline (recommend #). Handy for node-
red's tcprequest node. This can be dynamically changed while running.
pause 'Seconds'
Pause for the given whole (integer) number of 'Seconds' before sending the next command to the
radio.
password 'Password'
Sends password to rigctld when rigctld has been secured with -A. Must use the 32-char shared
secret from rigctld.
set_lock_mode 'Locked'
Turns mode lock on(1) or off(0) (only when using rigctld). Turning on will prevent all clients
from changing the rig mode. For example this is useful when running CW Skimmer in FM mode on an
IC-7300. Clicking spots in a spotting program will not change the VFOA mode when lock is on. So
"set_lock_mode 1" when CW Skimmer is started and "set_lock_mode 0" when CW Skimmer is stopped.
get_lock_mode
Returns current lock mode status 1=On, 2=Off (only useful when using rigctld)
send_raw 'Terminator' 'String'
Can send ASCII string or 0xnn values or xnn values -- there can be no spaces in the command string.
Possible terminator values are CR, LF, ;, ICOM, 0-100 (bytes to read), or -1 meaning unknown (will timeout on read)
Examples (note that a ; must be escaped in Unix/Linux):
For Windows & Unix/Linux we have a new colon-separated format for hex digits
send_raw icom 0xFE:0xFE:0x94:0x03:0xFD Note: colon-separated does not have to be escaped on Unix/Linux
send_raw -1 0xFE:0xFE:0x94:0x03:0xFD
send_raw 14 0xFE:0xFE:0x94:0x03:0xFD
Note that ASCII commands still require escaping the semicolon on Unix/Linux
send_raw ; FA;MD;
For Windows:
send_raw icom 0xFE;0xFE;0x94;0x03;0xFD
send_raw -1 0xFE;0xFE;0x94;0x03;0xFD
send_raw 14 0xFE;0xFE;0x94;0x03;0xFD
For Unix/Linux
send_raw icom 0xFE;0xFE;0x94;0x03;0xFD
send_raw ; FA;MD;
send_raw -1 0xFE;0xFE;0x94;0x03;0xFD
send_raw 14 0xFE;0xFE;0x94;0x03;0xFD
client_version 'String'
Client can send its version to rigctld and get feedback on compatibility, deprecation, and alternatives
hamlib_version
Returns hamlib version with ISO8601 date/time
test
Performs test routines. Under development.
set_gpio 'GPIO#'
Sets GPIO1, GPIO2, GPIO3, GPIO4 on the GPIO ptt port
Can also use 1,2,3,4
get_gpio 'GPIO#'
Reads GPIO1, GPIO2, GPIO3, GPIO4 on the GPIO ptt port
Can also use 1,2,3,4
skip_init
Skips rig initialization -- useful when executing commands with rigctl to speed up things
freq_skip'skip'
When skip!=0 skips setting freq on TX_VFO when in RX and on RX_VFO when in TX -- for use with gpredict and rigs that do not have TARGETABLE_VFO
Install Now
Emojis
PNG Icons
