1RIGCTL(1) Radio Control Program RIGCTL(1)
2
6 rigctl - control radio transceivers and receivers
7
9 rigctl [OPTION]... [COMMAND]...
10
12 Control radio transceivers and receivers. rigctl accepts commands from
13 the command line as well as in interactive mode if none are provided on
14 the command line.
15 Keep in mind that Hamlib is BETA level software. While a lot of back‐
17 end libraries lack complete rig support, the basic functions are usu‐
18 ally well supported. The API may change without publicized notice,
19 while an advancement of the minor version (e.g. 1.1.x to 1.2.x) indi‐
20 cates such a change.
21 Please report bugs and provide feedback at the e-mail address given in
23 the REPORTING BUGS section. Patches and code enhancements are also
24 welcome.
25
27 This program follows the usual GNU command line syntax, with long
28 options starting with two dashes (`-').
29 Here is a summary of the supported options:
31 -m, --model=id
33 Select radio model number. See model list (use 'rigctl -l').
34 NB: rigctl (or third party software) will use rig model 1901
35 when using rpc.rigd.
36 -r, --rig-file=device
38 Use device as the file name of the port the radio is connected.
39 Often a serial port, but could be a USB to serial adapter. Typ‐
40 ically /dev/ttyS0, /dev/ttyS1, /dev/ttyUSB0, etc.
41 -p, --ptt-file=device
43 Use device as the file name of the Push-To-Talk device using a
44 device file as described above.
45 -d, --dcd-file=device
47 Use device as the file name of the Data Carrier Detect device
48 using a device file as described above.
49 -p, --ptt-type=type
51 Use type of Push-To-Talk device. Supported types are RIG, DTR,
52 RTS, PARALLEL, NONE.
53 -d, --dcd-type=type
55 Use type of Data Carrier Detect device. Supported types are
56 RIG, DSR, CTS, CD, PARALLEL, NONE.
57 -s, --serial-speed=baud
59 Set serial speed to baud rate. Uses maximum serial speed from
60 rig backend capabilities as the default.
61 -c, --civaddr=id
63 Use id as the CI-V address to communicate with the rig. Only
64 useful for Icom rigs.
65 NB: the id is in decimal notation, unless prefixed by 0x, in
66 which case it is hexadecimal.
67 -L, --show-conf
69 List all config parameters for the radio defined with -m above.
70 -C, --set-conf=parm=val[,parm=val]*
72 Set config parameter. e.g. stop_bits=2
73 Use -L option for a list.
74 -l, --list
76 List all model numbers defined in Hamlib and exit.
77 -u, --dump-caps
79 Dump capabilities for the radio defined with -m above and exit.
80 -o, --vfo
82 Set vfo mode, requiring an extra VFO argument in front of each
83 appropriate command. Otherwise, VFO_CURR is assumed when this
84 option is not set.
85 -v, --verbose
87 Set verbose mode, cumulative (see DIAGNOSTICS below).
88 -h, --help
90 Show summary of these options and exit.
91 -V, --version
93 Show version of rigctl and exit.
94 NOTE! Some options may not be implemented by a given backend and will
96 return an error. This is most likely to occur with the --set-conf and
97 --show-conf options.
98
100 Commands can be entered either as a single char, or as a long command
101 name. Basically, the commands do not take a dash in front of them on
102 the command line, as the options do. They may be typed in when in
103 interactive mode or provided as argument(s) in command line interface
104 mode.
105 Since most of the Hamlib operations have a set and a get method, an
107 upper case letter will be used for set method whereas the corresponding
108 lower case letter refers to the get method. In interactive mode,
109 prepend a backslash to enter a long command name.
110 Example: Use "\dump_caps" to see what this radio can do.
111 Please note that the backend for the radio to be controlled, or the
113 radio itself may not support some commands. In that case, the operation
114 will fail with a Hamlib error message.
115 Here is a summary of the supported commands:
117 F, set_freq
119 Set frequency, in Hz.
120 f, get_freq
122 Get frequency, in Hz.
123 M, set_mode
125 Set mode/passband: AM, FM, CW, CWR, USB, LSB, RTTY, RTTYR, WFM,
126 AMS, PKTLSB, PKTUSB, PKTFM, ECSSUSB, ECSSLSB, FAX.
127 The passband is the exact passband in Hz, or 0 for the default.
129 m, get_mode
131 Get mode/passband.
132 V, set_vfo
134 Set VFO: VFOA, VFOB, VFOC, VFO, MEM, Main, Sub, etc.
135 v, get_vfo
137 Get current VFO.
138 J, set_rit
140 Set RIT, in Hz.
141 j, get_rit
143 Get RIT, in Hz.
144 Z, set_xit
146 Set XIT, in Hz.
147 z, get_xit
149 Get XIT, in Hz.
150 T, set_ptt
152 Set PTT, 0 or 1.
153 t, get_ptt
155 Get PTT status.
156 R, set_rptr_shift
158 Set repeater shift: "+", "-" or something else for none.
159 r, get_rptr_shift
161 Get repeater shift.
162 O, set_rptr_offs
164 Set repeater offset, in Hz.
165 o, get_rptr_offs
167 Get repeater offset.
168 C, set_ctcss_tone
170 Set CTCSS tone, in tenth of Hz.
171 c, get_ctcss_tone
173 Get CTCSS tone, in tenth of Hz.
174 D, set_dcs_code
176 Set DCS code.
177 d, get_dcs_code
179 Get DCS code.
180 I, set_split_freq
182 Set TX frequency, in Hz.
183 i, get_split_freq
185 Get TX frequency.
186 X, set_split_mode
188 Set transmit mode/passband: AM, FM, CW, CWR, USB, LSB, RTTY,
189 RTTYR, WFM, AMS, PKTLSB, PKTUSB, PKTFM, ECSSUSB, ECSSLSB, FAX.
190 The passband is the exact passband in Hz, or 0 for the default.
192 x, get_split_mode
194 Get transmit mode/passband.
195 S, set_split_vfo
197 Set split mode, 0 or 1, and transmit VFO.
198 s, get_split_vfo
200 Get split mode and transmit VFO.
201 N, set_ts
203 Set tuning step, in Hz.
204 n, get_ts
206 Get tuning step.
207 U, set_func
209 Set func/status: FAGC, NB, COMP, VOX, TONE, TSQL, SBKIN, FBKIN,
210 ANF, NR, AIP, MON, MN, RNF, ARO, LOCK, MUTE, VSC, REV, SQL, BC,
211 MBC, AFC, SATMODE, SCOPE, RESUME, TUNER.
212 u, get_func
214 Get func status.
215 L, set_level
217 Set level/value: PREAMP, ATT, VOX, AF, RF, SQL, IF, APF, NR,
218 PBT_IN, PBT_OUT, CWPITCH, RFPOWER, MICGAIN, KEYSPD, NOTCHF,
219 COMP, AGC, BKINDL, BAL, METER, VOXGAIN, ANTIVOX. Plus "extra"
220 levels.
221 l, get_level
223 Get level value: also SWR, ALC, STRENGTH, RAWSTR.
224 P, set_parm
226 Set parm/value: ANN, APO, BACKLIGHT, BEEP, TIME, BAT. Plus
227 "extra" parameters.
228 p, get_parm
230 Get parm value.
231 B, set_bank
233 Set bank.
234 E, set_mem
236 Set memory channel number.
237 e, get_mem
239 Get memory channel number.
240 G, vfo_op
242 Perform VFO operation: CPY, XCHG, FROM_VFO, TO_VFO, MCL, UP,
243 DOWN, BAND_UP, BAND_DOWN, LEFT, RIGHT, TUNER, TOGGLE.
244 g, scan_op
246 Perform scan operation/channel: STOP, MEM, SLCT, PRIO, DELTA,
247 VFO, PLT.
248 H, set_channel
250 Set memory channel data. Not implemented yet.
251 h, get_channel
253 Get memory channel data.
254 A, set_trn
256 Set transceive mode (reporting event): OFF, RIG, POLL.
257 a, get_trn
259 Get transceive mode (reporting event).
260 set_ant
262 Set antenna number (0, 1, 2, ..).
263 get_ant
265 Get antenna number (0, 1, 2, ..).
266 reset Reset.
268 send_morse
270 Send morse symbols.
271 set_powerstat
273 Set power status.
274 get_powerstat
276 Get power status.
277 _, get_info
279 Get misc information about the rig.
280 1, dump_caps
282 Not a real rig remote command, it just dumps capabilities, i.e.
283 what the backend knows about this model, and what it can do.
284 2, power2mW
286 Converts a power value in a range of 0.0 ... 1.0 to the real
287 transmit power in milli-Watts. The frequency and mode also need
288 to be provided as output power may vary according to these val‐
289 ues.
290 w, send_cmd
292 Send raw command string to rig. Binary protocols enter values as
293 xAA xBB
294
296 Start rigctl for a Yaesu FT-920 using a USB to serial adapter in inter‐
297 active mode:
298 $ rigctl -m 114 -r /dev/ttyUSB1
300 Start rigctl for a Yaesu FT-920 using COM1 while generating TRACE out‐
302 put to stderr:
303 $ rigctl -m 114 -r /dev/ttyS0 -vvvvv
305 Start rigctl for a Yaesu FT-920 using a USB to serial adapter while
307 setting baud rate and stop bits:
308 $ rigctl -m 114 -r /dev/ttyUSB1 -s 4800 -C stop_bits=2
310 Start rigctl using rpc.rigd and setting the frequency and mode:
312 $ rigctl -m 1901 -r localhost F 7253500 M LSB 0
314
316 The -v, --version option allows different levels of diagnostics to be
317 output to stderr and correspond to -v for BUG, -vv for ERR, -vvv for
318 WARN, -vvvv for VERBOSE, or -vvvvv for TRACE.
319 A given verbose level is useful for providing needed debugging informa‐
321 tion to the email address below. For example, TRACE output shows all
322 of the values sent to and received from the radio which is very useful
323 for radio backend library development and may be requested by the
324 developers.
325
327 rigctl exits with:
328 0 if all operations completed normally;
329 1 if there was an invalid command line option or argument;
330 2 if an error was returned by Hamlib.
331
333 set_chan has no entry method as of yet, hence left unimplemented.
334 This almost empty section...
336
338 Report bugs to <hamlib-developer@lists.sourceforge.net>.
339 We are already aware of the bugs in the previous section :-)
340
342 Written by Stephane Fillod and the Hamlib Group
343 <http://www.hamlib.org>.
344
346 Copyright © 2000-2007 Stephane Fillod, Frank Singleton, and the Hamlib
347 Group.
348 This is free software; see the source for copying conditions. There is
349 NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
350 PURPOSE.
351
353 hamlib(3), rpc.rigd(8)
354Hamlib February 24, 2007 RIGCTL(1)