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
36 when using rpc.rigd or rig model 2 for NET rigctl (rigctld).
37 -r, --rig-file=device
39 Use device as the file name of the port the radio is connected.
40 Often a serial port, but could be a USB to serial adapter. Typ‐
41 ically /dev/ttyS0, /dev/ttyS1, /dev/ttyUSB0, etc.
42 Default is /dev/rig (may be a symbolic link to the actual
44 device).
45 -p, --ptt-file=device
47 Use device as the file name of the Push-To-Talk device using a
48 device file as described above.
49 -d, --dcd-file=device
51 Use device as the file name of the Data Carrier Detect device
52 using a device file as described above.
53 -P, --ptt-type=type
55 Use type of Push-To-Talk device. Supported types are RIG, DTR,
56 RTS, PARALLEL, NONE, overriding PTT type defined in the rig's
57 backend.
58 Some side effects of this command are that when type is set to
60 DTR, read PTT state comes from Hamlib frontend, not read from
61 the radio. When set to NONE, PTT state cannot be read or set
62 even if rig backend supports reading/setting PTT status from the
63 rig.
64 -D, --dcd-type=type
66 Use type of Data Carrier Detect device. Supported types are
67 RIG, DSR, CTS, CD, PARALLEL, NONE.
68 -s, --serial-speed=baud
70 Set serial speed to baud rate. Uses maximum serial speed from
71 rig backend capabilities as the default.
72 -c, --civaddr=id
74 Use id as the CI-V address to communicate with the rig. Only
75 useful for Icom rigs.
76 NB: the id is in decimal notation, unless prefixed by 0x, in
78 which case it is hexadecimal.
79 -t, --send-cmd-term=char
81 Change the termination char for text protocol when using the
82 send_cmd command. The default value is <CR>. Non ASCII print‐
83 able characters can be specified as an ASCII number, in hexadec‐
84 imal format, prepended with 0x. You may pass an empty string for
85 no termination char. The string -1 tells rigctl to switch to
86 binary protocol. See the send_cmd command for further explana‐
87 tion.
88 -L, --show-conf
90 List all config parameters for the radio defined with -m above.
91 -C, --set-conf=parm=val[,parm=val]*
93 Set config parameter. e.g. stop_bits=2
94 Use -L option for a list.
96 -l, --list
98 List all model numbers defined in Hamlib and exit.
99 -u, --dump-caps
101 Dump capabilities for the radio defined with -m above and exit.
102 -o, --vfo
104 Set vfo mode, requiring an extra VFO argument in front of each
105 appropriate command. Otherwise, VFO_CURR is assumed when this
106 option is not set.
107 -v, --verbose
109 Set verbose mode, cumulative (see DIAGNOSTICS below).
110 -h, --help
112 Show summary of these options and exit.
113 -V, --version
115 Show version of rigctl and exit.
116 N.B. Some options may not be implemented by a given backend and will
118 return an error. This is most likely to occur with the --set-conf and
119 --show-conf options.
120 Please note that the backend for the radio to be controlled, or the
122 radio itself may not support some commands. In that case, the operation
123 will fail with a Hamlib error code.
124
126 Commands can be entered either as a single char, or as a long command
127 name. Basically, the commands do not take a dash in front of them on
128 the command line, as the options do. They may be typed in when in
129 interactive mode or provided as argument(s) in command line interface
130 mode.
131 Since most of the Hamlib operations have a set and a get method, an
133 upper case letter will be used for set method whereas the corresponding
134 lower case letter refers to the get method. Each operation also has a
135 long name; in interactive mode, prepend a backslash to enter a long
136 command name.
137 Example: Use "\dump_caps" to see what this radio can do.
139 Please note that the backend for the radio to be controlled, or the
141 radio itself may not support some commands. In that case, the operation
142 will fail with a Hamlib error message.
143 Here is a summary of the supported commands (In the case of "set" com‐
145 mands the quoted string is replaced by the value in the description.
146 In the case of "get" commands the quoted string is the key name of the
147 value returned.):
148 F, set_freq 'Frequency'
150 Set 'Frequency', in Hz.
151 f, get_freq
153 Get 'Frequency', in Hz.
154 M, set_mode 'Mode' 'Passband'
156 Set 'Mode': USB, LSB, CW, CWR, RTTY, RTTYR, AM, FM, WFM, AMS,
157 PKTLSB, PKTUSB, PKTFM, ECSSUSB, ECSSLSB, FAX, SAM, SAL, SAH,
158 DSB.
159 Set 'Passband' in Hz, or '0' for the Hamlib backend default.
161 m, get_mode
163 Get 'Mode' 'Passband'.
164 Returns Mode as a string from set_mode above and Passband in Hz.
166 V, set_vfo 'VFO'
168 Set 'VFO': VFOA, VFOB, VFOC, currVFO, VFO, MEM, Main, Sub, TX,
169 RX.
170 In VFO mode only a single VFO parameter is required.
172 v, get_vfo
174 Get current 'VFO'.
175 Returns VFO as a string from set_vfo above.
177 J, set_rit 'RIT'
179 Set 'RIT', in Hz, can be + or -.
180 A value of '0' resets RIT and *should* turn RIT off. If not,
182 file a bug report against the Hamlib backend.
183 j, get_rit
185 Get 'RIT', in Hz.
186 Z, set_xit 'XIT'
188 Set 'XIT', in Hz can be + or -.
189 A value of '0' resets RIT and *should* turn RIT off. If not,
191 file a bug report against the Hamlib backend.
192 z, get_xit
194 Get 'XIT', in Hz.
195 T, set_ptt 'PTT'
197 Set 'PTT', 0 (RX) or 1 (TX).
198 t, get_ptt
200 Get 'PTT' status.
201 0x8b, get_dcd
203 Get 'DCD' (squelch) status, 0 (Closed) or 1 (Open)
204 R, set_rptr_shift 'Rptr Shift'
206 Set 'Rptr Shift': "+", "-" or something else for none.
207 r, get_rptr_shift
209 Get 'Rptr Shift'. Returns "+", "-" or "None".
210 O, set_rptr_offs 'Rptr Offset'
212 Set 'Rptr Offset', in Hz.
213 o, get_rptr_offs
215 Get 'Rptr Offset', in Hz.
216 C, set_ctcss_tone 'CTCSS Tone'
218 Set 'CTCSS Tone', in tenths of Hz.
219 c, get_ctcss_tone
221 Get 'CTCSS Tone', in tenths of Hz.
222 D, set_dcs_code 'DCS Code'
224 Set 'DCS Code'.
225 d, get_dcs_code
227 Get 'DCS Code'.
228 0x90, set_ctcss_sql 'CTCSS Sql'
230 Set 'CTCSS Sql' tone, in tenths of Hz.
231 0x91, get_ctcss_sql
233 Get 'CTCSS Sql' tone, in tenths of Hz.
234 0x92, set_dcs_sql 'DCS Sql'
236 Set 'DCS Sql' code.
237 0x93, get_dcs_sql
239 Get 'DCS Sql' code.
240 I, set_split_freq 'Tx Frequency'
242 Set 'TX Frequency', in Hz.
243 i, get_split_freq
245 Get 'TX Frequency', in Hz.
246 X, set_split_mode 'TX Mode' 'TX Passband'
248 Set 'TX Mode': AM, FM, CW, CWR, USB, LSB, RTTY, RTTYR, WFM, AMS,
249 PKTLSB, PKTUSB, PKTFM, ECSSUSB, ECSSLSB, FAX, SAM, SAL, SAH,
250 DSB.
251 The 'TX Passband' is the exact passband in Hz, or '0' for the
253 Hamlib backend default.
254 x, get_split_mode
256 Get 'TX Mode' and 'TX Passband'.
257 Returns TX mode as a string from set_split_mode above and TX
259 passband in Hz.
260 S, set_split_vfo 'Split' 'TX VFO'
262 Set 'Split' mode, '0' or '1', and 'TX VFO' from set_vfo above.
263 s, get_split_vfo
265 Get 'Split' mode, '0' or '1', and 'TX VFO'.
266 N, set_ts 'Tuning Step'
268 Set 'Tuning Step', in Hz.
269 n, get_ts
271 Get 'Tuning Step', in Hz.
272 U, set_func 'Func' 'Func Status'
274 Set 'Func' 'Func Status'.
275 Func is one of: FAGC, NB, COMP, VOX, TONE, TSQL, SBKIN, FBKIN,
277 ANF, NR, AIP, APF, MON, MN, RF, ARO, LOCK, MUTE, VSC, REV, SQL,
278 ABM, BC, MBC, AFC, SATMODE, SCOPE, RESUME, TBURST, TUNER.
279 Func Status argument is a non null value for "activate", "de-
281 activate" otherwise, much as TRUE/FALSE definitions in C lan‐
282 guage.
283 u, get_func
285 Get 'Func' 'Func Status'.
286 Returns Func as a string from set_func above and Func status as
288 a non null value.
289 L, set_level 'Level' 'Level Value'
291 Set 'Level' and 'Level Value'.
292 Level is one of: PREAMP, ATT, VOX, AF, RF, SQL, IF, APF, NR,
294 PBT_IN, PBT_OUT, CWPITCH, RFPOWER, MICGAIN, KEYSPD, NOTCHF,
295 COMP, AGC (0:OFF, 1:SUPERFAST, 2:FAST, 3:SLOW, 4:USER, 5:MEDIUM,
296 6:AUTO), BKINDL, BAL, METER, VOXGAIN, ANTIVOX. SLOPE_LOW,
297 SLOPE_HIGH, RAWSTR, SWR, ALC, STRENGTH.
298 The Level Value can be a float or an integer.
300 l, get_level
302 Get 'Level' 'Level Value'.
303 Returns Level as a string from set_level above and Level value
305 as a float or integer.
306 P, set_parm 'Parm' 'Parm Value'
308 Set 'Parm' 'Parm Value'
309 Parm is one of: ANN, APO, BACKLIGHT, BEEP, TIME, BAT, KEYLIGHT.
311 p, get_parm
313 Get 'Parm' 'Parm Value'.
314 Returns Parm as a string from set_parm above and Parm Value as a
316 float or integer.
317 B, set_bank 'Bank'
319 Set 'Bank'. Sets the current memory bank number.
320 E, set_mem 'Memory#'
322 Set 'Memory#' channel number.
323 e, get_mem
325 Get 'Memory#' channel number.
326 G, vfo_op 'Mem/VFO Op'
328 Perform 'Mem/VFO Op'.
329 Mem VFO operation is one of: CPY, XCHG, FROM_VFO, TO_VFO, MCL,
331 UP, DOWN, BAND_UP, BAND_DOWN, LEFT, RIGHT, TUNE, TOGGLE.
332 g, scan 'Scan Fct' 'Scan Channel'
334 Perform 'Scan Fct' 'Scan Channel'.
335 Scan function/channel is one of: STOP, MEM, SLCT, PRIO, PROG,
337 DELTA, VFO, PLT.
338 H, set_channel 'Channel'
340 Set memory 'Channel' data. Not implemented yet.
341 h, get_channel
343 Get memory 'Channel' data. Not implemented yet.
344 A, set_trn 'Transceive'
346 Set 'Transceive' mode (reporting event): OFF, RIG, POLL.
347 a, get_trn
349 Get 'Transceive' mode (reporting event) as in set_trn above.
350 Y, set_ant 'Antenna'
352 Set 'Antenna' number (0, 1, 2, ..).
353 y, get_ant
355 Get 'Antenna' number (0, 1, 2, ..).
356 *, reset 'Reset'
358 Perform rig 'Reset'.
359 0 = None, 1 = Software reset, 2 = VFO reset, 4 = Memory Clear
361 reset, 8 = Master reset. Since these values are defined as a
362 bitmask in rig.h, it should be possible to AND these values
363 together to do multiple resets at once, if the backend supports
364 it or supports a reset action via rig control at all.
365 b, send_morse 'Morse'
367 Send 'Morse' symbols.
368 0x87, set_powerstat 'Power Status'
370 Set power On/Off/Standby 'Power Status'.
371 0 = Power Off, 1 = Power On, 2 = Power Standby. Defined as a
373 bitmask in rig.h.
374 0x88, get_powerstat
376 Get power On/Off/Standby 'Power Status' as in set_powerstat
377 above.
378 0x89, send_dtmf 'Digits'
380 Set DTMF 'Digits'.
381 0x8a, recv_dtmf
383 Get DTMF 'Digits'.
384 _, get_info
386 Get misc information about the rig (no VFO in 'VFO mode' or
387 value is passed).
388 1, dump_caps
390 Not a real rig remote command, it just dumps capabilities, i.e.
391 what the backend knows about this model, and what it can do.
392 TODO: Ensure this is in a consistent format so it can be read
393 into a hash, dictionary, etc. Bug reports requested.
394 N.B.: This command will produce many lines of output so be very
396 careful if using a fixed length array! For example, running
397 this command against the Dummy backend results in over 5kB of
398 text output.
399 VFO parameter not used in 'VFO mode'.
401 2, power2mW 'Power [0.0..1.0]' 'Frequency' 'Mode'
403 Returns 'Power mW'
404 Converts a Power value in a range of 0.0 ... 1.0 to the real
406 transmit power in milli-Watts (integer). The frequency and mode
407 also need to be provided as output power may vary according to
408 these values.
409 VFO parameter not used in 'VFO mode'.
411 4, mW2power 'Power mW' 'Frequency' 'Mode'
413 Returns 'Power [0.0..1.0]'
414 Converts the real transmit power in milli-Watts (integer) to a
416 Power value in a range of 0.0 ... 1.0. The frequency and mode
417 also need to be provided as output power may vary according to
418 these values.
419 VFO parameter not used in 'VFO mode'.
421 w, send_cmd 'Cmd'
423 Send raw command string to rig.
424 For binary protocols enter values as \0xAA\0xBB. Expect a
426 'Reply' from the rig which will likely be a binary block or an
427 ASCII string.
428
430 Start rigctl for a Yaesu FT-920 using a USB to serial adapter in inter‐
431 active mode:
432 $ rigctl -m 114 -r /dev/ttyUSB1
434 Start rigctl for a Yaesu FT-920 using COM1 while generating TRACE out‐
436 put to stderr:
437 $ rigctl -m 114 -r /dev/ttyS0 -vvvvv
439 Start rigctl for a Yaesu FT-920 using a USB to serial adapter while
441 setting baud rate and stop bits:
442 $ rigctl -m 114 -r /dev/ttyUSB1 -s 4800 -C stop_bits=2
444 Start rigctl using rpc.rigd and setting the frequency and mode:
446 $ rigctl -m 1901 -r localhost F 7253500 M LSB 0
448 Connect to a running rigctld with rig model 2 ("NET rigctl") on the
450 local host and specifying the TCP port:
451 $ rotctl -m 2 -r localhost:4532
453
455 The -v, --verbose option allows different levels of diagnostics to be
456 output to stderr and correspond to -v for BUG, -vv for ERR, -vvv for
457 WARN, -vvvv for VERBOSE, or -vvvvv for TRACE.
458 A given verbose level is useful for providing needed debugging informa‐
460 tion to the email address below. For example, TRACE output shows all
461 of the values sent to and received from the radio which is very useful
462 for radio backend library development and may be requested by the
463 developers.
464
466 rigctl exits with:
467 0 if all operations completed normally;
468 1 if there was an invalid command line option or argument;
469 2 if an error was returned by Hamlib.
470
472 set_chan has no entry method as of yet, hence left unimplemented.
473 This almost empty section...
475
477 Report bugs to <hamlib-developer@lists.sourceforge.net>.
478 We are already aware of the bugs in the previous section :-)
480
482 Written by Stephane Fillod, Nate Bargmann, and the Hamlib Group
483 <http://www.hamlib.org>.
485
487 Copyright © 2000-2010 Stephane Fillod
488 Copyright © 2010 Nate Bargmann
489 Copyright © 2000-2010 the Hamlib Group.
490 This is free software; see the source for copying conditions. There is
492 NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
493 PURPOSE.
494
496 hamlib(3), rpc.rigd(8) rigctld(8)
497Hamlib April 14, 2010 RIGCTL(1)