1RIGCTL(1) Hamlib Utilities RIGCTL(1)
2
6 rigctl - control radio transceivers and receivers
7
9 rigctl [-hiIlLnouV] [-m id] [-r device] [-p device] [-d device]
10 [-P type] [-D type] [-s baud] [-c id] [-t char] [-C parm=val]
11 [-v[-Z]] [command|-]
12
14 Control radio transceivers and receivers. rigctl accepts commands from
15 the command line as well as in interactive mode if none are provided on
16 the command line.
17 Keep in mind that Hamlib is BETA level software. While a lot of back‐
19 end libraries lack complete rig support, the basic functions are usu‐
20 ally well supported.
21 Please report bugs and provide feedback at the e-mail address given in
23 the BUGS section below. Patches and code enhancements sent to the same
24 address are welcome.
25
27 This program follows the usual GNU command line syntax. Short options
28 that take an argument may have the value follow immediately or be sepa‐
29 rated by a space. Long options starting with two dashes (‘-’) require
30 an ‘=’ between the option and any argument.
31 Here is a summary of the supported options:
33 -m, --model=id
35 Select radio model number.
36 See model list (use “rigctl -l”).
38 Note: rigctl (or third party software using the C API) will use
40 radio model 2 for NET rigctl (communicating with rigctld).
41 -r, --rig-file=device
43 Use device as the file name of the port connected to the radio.
44 Often a serial port, but could be a USB to serial adapter. Typ‐
46 ically /dev/ttyS0, /dev/ttyS1, /dev/ttyUSB0, etc. on Linux,
47 COM1, COM2, etc. on MS Windows. The BSD flavors and Mac OS/X
48 have their own designations. See your system's documentation.
49 The special string “uh-rig” may be given to enable micro-ham
51 device support.
52 -p, --ptt-file=device
54 Use device as the file name of the Push-To-Talk device using a
55 device file as described above.
56 -d, --dcd-file=device
58 Use device as the file name of the Data Carrier Detect device
59 using a device file as described above.
60 -P, --ptt-type=type
62 Use type of Push-To-Talk device.
63 Supported types are ‘RIG’ (CAT command), ‘DTR’, ‘RTS’, ‘PARAL‐
65 LEL’, ‘NONE’, overriding PTT type defined in the rig's backend.
66 Some side effects of this command are that when type is set to
68 DTR, read PTT state comes from the Hamlib frontend, not read
69 from the radio. When set to NONE, PTT state cannot be read or
70 set even if rig backend supports reading/setting PTT status from
71 the rig.
72 -D, --dcd-type=type
74 Use type of Data Carrier Detect device.
75 Supported types are ‘RIG’ (CAT command), ‘DSR’, ‘CTS’, ‘CD’,
77 ‘PARALLEL’, ‘NONE’.
78 -s, --serial-speed=baud
80 Set serial speed to baud rate.
81 Uses maximum serial speed from radio backend capabilities (set
83 by -m above) as the default.
84 -c, --civaddr=id
86 Use id as the CI-V address to communicate with the rig.
87 Only useful for Icom and some Ten-Tec rigs.
89 Note: The id is in decimal notation, unless prefixed by 0x, in
91 which case it is hexadecimal.
92 -t, --send-cmd-term=char
94 Change the termination char for text protocol when using the
95 send_cmd command.
96 The default value is ASCII CR (‘0x0D’). ASCII non-printing
98 characters can be given as the ASCII number in hexadecimal for‐
99 mat prepended with “0x”. You may pass an empty string for no
100 termination char. The string “-1” tells rigctl to switch to
101 binary protocol. See the send_cmd command for further explana‐
102 tion.
103 For example, to specify a command terminator for Kenwood style
105 text commands pass “-t ';'” to rigctl. See EXAMPLE below.
106 -L, --show-conf
108 List all config parameters for the radio defined with -m above.
109 -C, --set-conf=parm=val[,parm=val]
111 Set radio configuration parameter(s), e.g. stop_bits=2.
112 Use the -L option above for a list of configuration parameters
114 for a given model number.
115 -u, --dump-caps
117 Dump capabilities for the radio defined with -m above and exit.
118 -l, --list
120 List all model numbers defined in Hamlib and exit.
121 The list is sorted by model number.
123 Note: In Linux the list can be scrolled back using Shift-
125 PageUp/Shift-PageDown, or using the scrollbars of a virtual ter‐
126 minal in X or the cmd window in Windows. The output can be
127 piped to more(1) or less(1), e.g. “rigctl -l | more”.
128 -o, --vfo
130 Enable vfo mode.
131 An extra VFO argument will be required in front of each appro‐
133 priate command (except set_vfo). Otherwise, ‘currVFO’ is used
134 when this option is not set and an extra VFO argument is not
135 used.
136 -n, --no-restore-ai
138 On exit rigctl restores the state of auto information (AI) on
139 the controlled rig.
140 If this is not desired, for example if you are using rigctl to
142 turn AI mode on or off, pass this option.
143 -i , --read-history
145 Read previously saved command and argument history from a file
146 (default $HOME/.rigctl_history) for the current session.
147 Available when rigctl is built with Readline support (see READ‐
149 LINE below).
150 Note: To read a history file stored in another directory, set
152 the RIGCTL_HIST_DIR environment variable, e.g.
153 “RIGCTL_HIST_DIR=~/tmp rigctl -i”. When RIGCTL_HIST_DIR is not
154 set, the value of HOME is used.
155 -I, --save-history
157 Write current session (and previous session(s), if -i option is
158 given) command and argument history to a file (default
159 $HOME/.rigctl_history) at the end of the current session.
160 Complete commands with arguments are saved as a single line to
162 be recalled and used or edited. Available when rigctl is built
163 with Readline support (see READLINE below).
164 Note: To write a history file in another directory, set the
166 RIGCTL_HIST_DIR environment variable, e.g.
167 “RIGCTL_HIST_DIR=~/tmp rigctl -IRq. When RIGCTL_HIST_DIR is not
168 set, the value of HOME is used.
169 -v, --verbose
171 Set verbose mode, cumulative (see DIAGNOSTICS below).
172 -Z, --debug-time-stamps
174 Enable time stamps for the debug messages.
175 Use only in combination with the -v option as it generates no
177 output on its own.
178 -h, --help
180 Show a summary of these options and exit.
181 -V, --version
183 Show version of rigctl and exit.
184 - Stop option processing and read commands from standard input.
186 See Standard Input below.
188 Note: Some options may not be implemented by a given backend and will
190 return an error. This is most likely to occur with the --set-conf and
191 --show-conf options.
192 Please note that the backend for the radio to be controlled, or the
194 radio itself may not support some commands. In that case, the opera‐
195 tion will fail with a Hamlib error code.
196
198 Commands can be entered either as a single char, or as a long command
199 name. The commands are not prefixed with a dash as the options are.
200 They may be typed in when in interactive mode or provided as argu‐
201 ment(s) in command line interface mode. In interactive mode commands
202 and their arguments may be entered on a single line:
203 M LSB 2400
205 Since most of the Hamlib operations have a set and a get method, an
207 upper case letter will often be used for a set method whereas the cor‐
208 responding lower case letter refers to the get method. Each operation
209 also has a long name; in interactive mode, prepend a backslash, ‘\’, to
210 enter a long command name.
211 Example: Use “\dump_caps” to see what this radio and backend support.
213 Note: The backend for the radio to be controlled, or the radio itself
215 may not support some commands. In that case, the operation will fail
216 with a Hamlib error message.
217 Standard Input
219 As an alternative to the READLINE interactive command entry or a single
220 command for each run, rigctl features a special option where a single
221 dash (‘-’) may be used to read commands from standard input (stdin).
222 Commands must be separated by whitespace similar to the commands given
223 on the command line. Comments may be added using the ‘#’ character,
224 all text up until the end of the current line including the ‘#’ charac‐
225 ter is ignored.
226 A simple example:
228 $ cat <<.EOF. >cmds.txt
230 > # File of commands
231 > v f m # query rig
232 > V VFOB F 14200000 M CW 500 # set rig
233 > v f m # query rig
234 > .EOF.
235 $ rigctl -m1 - <cmds.txt
237 v VFOA
239 f 145000000
241 m FM
243 15000
244 V VFOB
246 F 14200000
247 M CW 500
248 v VFOB
249 f 14200000
251 m CW
253 500
254 $
256 Radio Commands
258 A summary of commands is included below (In the case of set commands
259 the quoted italicized string is replaced by the value in the descrip‐
260 tion. In the case of get commands the quoted italicized string is the
261 key name of the value returned.):
262 Q|q, exit rigctl
264 Exit rigctl in interactive mode.
265 When rigctl is controlling the rig directly, will close the rig
267 backend and port. When rigctl is connected to rigctld (radio
268 model 2), the TCP/IP connection to rigctld is closed and rigctld
269 remains running, available for another TCP/IP network connec‐
270 tion.
271 F, set_freq 'Frequency'
273 Set 'Frequency', in Hz.
274 Frequency may be a floating point or integer value.
276 f, get_freq
278 Get 'Frequency', in Hz.
279 Returns an integer value.
281 M, set_mode 'Mode' 'Passband'
283 Set 'Mode' and 'Passband'.
284 Mode is a token: ‘USB’, ‘LSB’, ‘CW’, ‘CWR’, ‘RTTY’, ‘RTTYR’,
286 ‘AM’, ‘FM’, ‘WFM’, ‘AMS’, ‘PKTLSB’, ‘PKTUSB’, ‘PKTFM’,
287 ‘ECSSUSB’, ‘ECSSLSB’, ‘FA’, ‘SAM’, ‘SAL’, ‘SAH’, ‘DSB’.
288 Passband is in Hz as an integer, or ‘0’ for the radio backend
290 default.
291 Note: Passing a ‘?’ (query) as the first argument instead of a
293 Mode token will return a space separated list of radio backend
294 supported Modes. Use this to determine the supported Modes of a
295 given radio backend.
296 m, get_mode
298 Get 'Mode' and 'Passband'.
299 Returns Mode as a token and Passband in Hz as in set_mode above.
301 V, set_vfo 'VFO'
303 Set 'VFO'.
304 VFO is a token: ‘VFOA’, ‘VFOB’, ‘VFOC’, ‘currVFO’, ‘VFO’, ‘MEM’,
306 ‘Main’, ‘Sub’, ‘TX’, ‘RX’.
307 In VFO mode (see --vfo option above) only a single VFO parameter
309 is required:
310 $ rigctl -m 229 -r /dev/rig -o
312 Rig command: V
314 VFO: VFOB
315 Rig command:
317 v, get_vfo
319 Get current 'VFO'.
320 Returns VFO as a token as in set_vfo above.
322 J, set_rit 'RIT'
324 Set 'RIT'.
325 RIT is in Hz and can be + or -. A value of ‘0’ resets RIT
327 (Receiver Incremental Tuning) to match the VFO frequency.
328 Note: RIT needs to be explicitly activated or deactivated with
330 the set_func command. This allows setting the RIT offset inde‐
331 pendently of its activation and allows RIT to remain active
332 while setting the offset to ‘0’.
333 j, get_rit
335 Get 'RIT' in Hz.
336 Returned value is an integer.
338 Z, set_xit 'XIT'
340 Set 'XIT'.
341 XIT is in Hz and can be + or -. A value of ‘0’ resets XIT
343 (Transmitter Incremental Tuning) to match the VFO frequency.
344 Note: XIT needs to be explicitly activated or deactivated with
346 the set_func command. This allows setting the XIT offset inde‐
347 pendently of its activation and allows XIT to remain active
348 while setting the offset to ‘0’.
349 z, get_xit
351 Get 'XIT' in Hz.
352 Returned value is an integer.
354 T, set_ptt 'PTT'
356 Set 'PTT'.
357 PTT is a value: ‘0’ (RX), ‘1’ (TX), ‘2’ (TX mic), or ‘3’ (TX
359 data).
360 t, get_ptt
362 Get 'PTT' status.
363 Returns PTT as a value in set_ptt above.
365 S, set_split_vfo 'Split' 'TX VFO'
367 Set 'Split' mode.
368 Split is either ‘0’ = Normal or ‘1’ = Split.
370 Set 'TX VFO'.
372 TX VFO is a token: ‘VFOA’, ‘VFOB’, ‘VFOC’, ‘currVFO’, ‘VFO’,
374 ‘MEM’, ‘Main’, ‘Sub’, ‘TX’, ‘RX’.
375 s, get_split_vfo
377 Get 'Split' mode.
378 Split is either ‘0’ = Normal or ‘1’ = Split.
380 Get 'TX VFO'.
382 TX VFO is a token as in set_split_vfo above.
384 I, set_split_freq 'Tx Frequency'
386 Set 'TX Frequency', in Hz.
387 Frequency may be a floating point or integer value.
389 i, get_split_freq
391 Get 'TX Frequency', in Hz.
392 Returns an integer value.
394 X, set_split_mode 'TX Mode' 'TX Passband'
396 Set 'TX Mode' and 'TX Passband'.
397 TX Mode is a token: ‘USB’, ‘LSB’, ‘CW’, ‘CWR’, ‘RTTY’, ‘RTTYR’,
399 ‘AM’, ‘FM’, ‘WFM’, ‘AMS’, ‘PKTLSB’, ‘PKTUSB’, ‘PKTFM’,
400 ‘ECSSUSB’, ‘ECSSLSB’, ‘FA’, ‘SAM’, ‘SAL’, ‘SAH’, ‘DSB’.
401 TX Passband is in Hz as an integer, or ‘0’ for the radio backend
403 default.
404 Note: Passing a ‘?’ (query) as the first argument instead of a
406 TX Mode token will return a space separated list of radio back‐
407 end supported TX Modes. Use this to determine the supported TX
408 Modes of a given radio backend.
409 x, get_split_mode
411 Get 'TX Mode' and 'TX Passband'.
412 Returns TX Mode as a token and TX Passband in Hz as in
414 set_split_mode above.
415 Y, set_ant 'Antenna'
417 Set 'Antenna' number (‘0’, ‘1’, ‘2’, ...).
418 y, get_ant
420 Get 'Antenna' number (‘0’, ‘1’, ‘2’, ...).
421 b, send_morse 'Morse'
423 Send 'Morse' symbols.
424 0x8b, get_dcd
426 Get 'DCD' (squelch) status: ‘0’ (Closed) or ‘1’ (Open).
427 R, set_rptr_shift 'Rptr Shift'
429 Set 'Rptr Shift'.
430 Rptr Shift is one of: ‘+’, ‘-’, or something else for ‘None’.
432 r, get_rptr_shift
434 Get 'Rptr Shift'.
435 Returns ‘+’, ‘-’, or ‘None’.
437 O, set_rptr_offs 'Rptr Offset'
439 Set 'Rptr Offset', in Hz.
440 o, get_rptr_offs
442 Get 'Rptr Offset', in Hz.
443 C, set_ctcss_tone 'CTCSS Tone'
445 Set 'CTCSS Tone', in tenths of Hz.
446 c, get_ctcss_tone
448 Get 'CTCSS Tone', in tenths of Hz.
449 D, set_dcs_code 'DCS Code'
451 Set 'DCS Code'.
452 d, get_dcs_code
454 Get 'DCS Code'.
455 0x90, set_ctcss_sql 'CTCSS Sql'
457 Set 'CTCSS Sql' tone, in tenths of Hz.
458 0x91, get_ctcss_sql
460 Get 'CTCSS Sql' tone, in tenths of Hz.
461 0x92, set_dcs_sql 'DCS Sql'
463 Set 'DCS Sql' code.
464 0x93, get_dcs_sql
466 Get 'DCS Sql'
467 code.
468 N, set_ts 'Tuning Step'
470 Set 'Tuning Step', in Hz.
471 n, get_ts
473 Get 'Tuning Step', in Hz.
474 U, set_func 'Func' 'Func Status'
476 Set 'Func' and 'Func Status'.
477 Func is a token: ‘FAGC’, ‘NB’, ‘COMP’, ‘VOX’, ‘TONE’, ‘TSQL’,
479 ‘SBKIN’, ‘FBKIN’, ‘ANF’, ‘NR’, ‘AIP’, ‘APF’, ‘MON’, ‘MN’, ‘RF’,
480 ‘ARO’, ‘LOCK’, ‘MUTE’, ‘VSC’, ‘REV’, ‘SQL’, ‘ABM’, ‘BC’, ‘MBC’,
481 ‘RIT’, ‘AFC’, ‘SATMODE’, ‘SCOPE’, ‘RESUME’, ‘TBURST’, ‘TUNER’,
482 ‘XIT’.
483 Func Status is a non null value for “activate” or “de-activate”
485 otherwise, much as TRUE/FALSE definitions in the C language
486 (true is non-zero and false is zero, ‘0’).
487 Note: Passing a ‘?’ (query) as the first argument instead of a
489 Func token will return a space separated list of radio backend
490 supported set function tokens. Use this to determine the sup‐
491 ported functions of a given radio backend.
492 u, get_func 'Func'
494 Get 'Func Status'.
495 Returns Func Status as a non null value for the Func token given
497 as in set_func above.
498 Note: Passing a ‘?’ (query) as the first argument instead of a
500 Func token will return a space separated list of radio backend
501 supported get function tokens. Use this to determine the sup‐
502 ported functions of a given radio backend.
503 L, set_level 'Level' 'Level Value'
505 Set 'Level' and 'Level Value'.
506 Level is a token: ‘PREAMP’, ‘ATT’, ‘VOX’, ‘AF’, ‘RF’, ‘SQL’,
508 ‘IF’, ‘APF’, ‘NR’, ‘PBT_IN’, ‘PBT_OUT’, ‘CWPITCH’, ‘RFPOWER’,
509 ‘MICGAIN’, ‘KEYSPD’, ‘NOTCHF’, ‘COMP’, ‘AGC’, ‘BKINDL’, ‘BAL’,
510 ‘METER’, ‘VOXGAIN’, ‘ANTIVOX’, ‘SLOPE_LOW’, ‘SLOPE_HIGH’, ‘RAW‐
511 STR’, ‘SWR’, ‘ALC’, ‘STRENGTH’.
512 The Level Value can be a float or an integer value. For the AGC
514 token the value is one of ‘0’ = OFF, ‘1’ = SUPERFAST, ‘2’ =
515 FAST, ‘3’ = SLOW, ‘4’ = USER, ‘5’ = MEDIUM, ‘6’ = AUTO.
516 Note: Passing a ‘?’ (query) as the first argument instead of a
518 Level token will return a space separated list of radio backend
519 supported set level tokens. Use this to determine the supported
520 levels of a given radio backend.
521 l, get_level 'Level'
523 Get 'Level Value'.
524 Returns Level Value as a float or integer for the Level token
526 given as in set_level above.
527 Note: Passing a ‘?’ (query) as the first argument instead of a
529 Level token will return a space separated list of radio backend
530 supported get level tokens. Use this to determine the supported
531 levels of a given radio backend.
532 P, set_parm 'Parm' 'Parm Value'
534 Set 'Parm' and 'Parm Value'.
535 Parm is a token: ‘ANN’, ‘APO’, ‘BACKLIGHT’, ‘BEEP’, ‘TIME’,
537 ‘BAT’, ‘KEYLIGHT’.
538 Note: Passing a ‘?’ (query) as the first argument instead of a
540 Parm token will return a space separated list of radio backend
541 supported set parameter tokens. Use this to determine the sup‐
542 ported parameters of a given radio backend.
543 p, get_parm 'Parm'
545 Get 'Parm Value'.
546 Returns Parm Value as a float or integer for the Parm token
548 given as in set_parm above.
549 Note: Passing a ‘?’ (query) as the first argument instead of a
551 Parm token will return a space separated list of radio backend
552 supported get parameter tokens. Use this to determine the sup‐
553 ported parameters of a given radio backend.
554 B, set_bank 'Bank'
556 Set 'Bank'.
557 Sets the current memory bank number.
559 E, set_mem 'Memory#'
561 Set 'Memory#' channel number.
562 e, get_mem
564 Get 'Memory#' channel number.
565 G, vfo_op 'Mem/VFO Op'
567 Perform a 'Mem/VFO Op'.
568 Mem/VFO Operation is a token: ‘CPY’, ‘XCHG’, ‘FROM_VFO’,
570 ‘TO_VFO’, ‘MCL’, ‘UP’, ‘DOWN’, ‘BAND_UP’, ‘BAND_DOWN’, ‘LEFT’,
571 ‘RIGHT’, ‘TUNE’, ‘TOGGLE’.
572 Note: Passing a ‘?’ (query) as the first argument instead of a
574 Mem/VFO Op token will return a space separated list of radio
575 backend supported Set Mem/VFO Op tokens. Use this to determine
576 the supported Mem/VFO Ops of a given radio backend.
577 g, scan 'Scan Fct' 'Scan Channel'
579 Perform a 'Scan Fct' on a 'Scan Channel'.
580 Scan Function is a token: ‘STOP’, ‘MEM’, ‘SLCT’, ‘PRIO’, ‘PROG’,
582 ‘DELTA’, ‘VFO’, ‘PLT’.
583 Scan Channel is an integer (maybe?).
585 Note: Passing a ‘?’ (query) as the first argument instead of a
587 Scan Fct token will return a space separated list of radio back‐
588 end supported Scan Function tokens. Use this to determine the
589 supported Scan Functions of a given radio backend.
590 H, set_channel 'Channel'
592 Set memory 'Channel' data.
593 Not implemented yet.
595 h, get_channel
597 Get memory 'Channel' data.
598 Not implemented yet.
600 A, set_trn 'Transceive'
602 Set 'Transceive' mode.
603 Transcieve is a token: ‘OFF’, ‘RIG’, ‘POLL’.
605 Transceive is a mechanism for radios to report events without a
607 specific call for information.
608 Note: Passing a ‘?’ (query) as the first argument instead of a
610 Transceive token will return a space separated list of radio
611 backend supported Transceive mode tokens. Use this to determine
612 the supported Transceive modes of a given radio backend.
613 a, get_trn
615 Get 'Transceive' mode.
616 Transceive mode (reporting event) as in set_trn above.
618 *, reset 'Reset'
620 Perform rig 'Reset'.
621 Reset is a value: ‘0’ = None, ‘1’ = Software reset, ‘2’ = VFO
623 reset, ‘4’ = Memory Clear reset, ‘8’ = Master reset.
624 Since these values are defined as a bitmask in include/ham‐
626 lib/rig.h, it should be possible to AND these values together to
627 do multiple resets at once, if the backend supports it or sup‐
628 ports a reset action via rig control at all.
629 0x87, set_powerstat 'Power Status'
631 Set 'Power Status'.
632 Power Status is a value: ‘0’ = Power Off, ‘1’ = Power On, ‘2’ =
634 Power Standby.
635 0x88, get_powerstat
637 Get 'Power Status' as in set_powerstat above.
638 0x89, send_dtmf 'Digits'
640 Set DTMF 'Digits'.
641 0x8a, recv_dtmf
643 Get DTMF 'Digits'.
644 _, get_info
646 Get misc information about the rig (no VFO in 'VFO mode' or
647 value is passed).
648 1, dump_caps
650 Not a real rig remote command, it just dumps capabilities, i.e.
651 what the backend knows about this model, and what it can do.
652 TODO: Ensure this is in a consistent format so it can be read
654 into a hash, dictionary, etc. Bug reports requested.
655 Note: This command will produce many lines of output so be very
657 careful if using a fixed length array! For example, running
658 this command against the Dummy backend results in over 5kB of
659 text output.
660 VFO parameter not used in 'VFO mode'.
662 2, power2mW 'Power [0.0..1.0]' 'Frequency' 'Mode'
664 Returns 'Power mW'.
665 Converts a Power value in a range of 0.0...1.0 to the real
667 transmit power in milli-Watts (integer).
668 'Frequency' and 'Mode' also need to be provided as output power
670 may vary according to these values.
671 VFO parameter is not used in VFO mode.
673 4, mW2power 'Power mW' 'Frequency' 'Mode'
675 Returns 'Power [0.0..1.0]'.
676 Converts the real transmit power in milli-Watts (integer) to a
678 Power value in a range of 0.0 ... 1.0.
679 'Frequency' and 'Mode' also need to be provided as output power
681 may vary according to these values.
682 VFO parameter is not used in VFO mode.
684 w, send_cmd 'Cmd'
686 Send a raw command string to the radio.
687 This is useful for testing and troubleshooting radio commands
689 and responses when developing a backend.
690 For binary protocols enter values as \0xAA\0xBB. Expect a
692 'Reply' from the radio which will likely be a binary block or an
693 ASCII string depending on the radio's protocol (see your radio's
694 computer control documentation).
695 The command terminator, set by the send-cmd-term option above,
697 will terminate each command string sent to the radio. This
698 character should not be a part of the input string.
699 pause 'Seconds'
701 Pause for the given whole (integer) number of 'Seconds' before
702 sending the next command to the radio.
703
705 If Readline library development files are found at configure time,
706 rigctl will be conditonally built with Readline support for command and
707 argument entry. Readline command key bindings are at their defaults as
708 described in the Readline manual
709 ⟨https://tiswww.cwru.edu/php/chet/readline/rluserman.html⟩. rigctl
710 sets the name “rigctl” which can be used in Conditional Init Constructs
711 in the Readline Init File ($HOME/.inputrc by default) for custom key‐
712 bindings unique to rigctl.
713 Command history is available with Readline support as described in the
715 Readline History manual
716 ⟨https://tiswww.case.edu/php/chet/readline/history.html#SEC1⟩. Command
717 and argument strings are stored as single lines even when arguments are
718 prompted for input individually. Commands and arguments are not vali‐
719 dated and are stored as typed with values separated by a single space.
720 Normally session history is not saved, however, use of either of the
722 -i/--read-history or -I/--save-history options when starting rigctl
723 will cause any previously saved history to be read in and/or the cur‐
724 rent and any previous session history (assuming the -i and -I options
725 are given together) will be written out when rigctl is closed. Each
726 option is mutually exclusive, i.e. either may be given separately or in
727 combination. This is useful to save a set of commands and then read
728 them later but not write the modified history for a consistent set of
729 test commands in interactive mode, for example.
730 History is stored in $HOME/.rigctl_history by default although the des‐
732 tination directory may be changed by setting the RIGCTL_HIST_DIR envi‐
733 ronment variable. When RIGCTL_HIST_DIR is unset, the value of the HOME
734 environment variable is used instead. Only the destination directory
735 may be changed at this time.
736 If Readline support is not found at configure time the original inter‐
738 nal command handler is used. Readline is not used for rigctl commands
739 entered on the command line regardless if Readline support is built in
740 or not.
741 Note: Readline support is not included in the MS Windows 32 or 64 bit
743 binary builds supplied by the Hamlib Project. Running rigctl on the MS
744 Windows platform in the ‘cmd’ shell does give session command line his‐
745 tory, however, it is not saved to disk between sessions.
746
748 The -v, --verbose option allows different levels of diagnostics to be
749 output to stderr and correspond to -v for BUG, -vv for ERR, -vvv for
750 WARN, -vvvv for VERBOSE, or -vvvvv for TRACE.
751 A given verbose level is useful for providing needed debugging informa‐
753 tion to the email address below. For example, TRACE output shows all
754 of the values sent to and received from the radio which is very useful
755 for radio backend library development and may be requested by the
756 developers.
757
759 rigctl exits with:
760 0 if all operations completed normally;
762 1 if there was an invalid command line option or argument;
764 2 if an error was returned by Hamlib.
766
768 Start rigctl for a Yaesu FT-920 using a USB to serial adapter on Linux
769 in interactive mode:
770 $ rigctl -m 114 -r /dev/ttyUSB1
772 Start rigctl for a Yaesu FT-920 using COM1 on MS Windows while generat‐
774 ing TRACE output to stderr:
775 > rigctl -m 114 -r COM1 -vvvvv
777 Start rigctl for a Yaesu FT-920 using a USB to serial adapter while
779 setting baud rate and stop bits:
780 $ rigctl -m 114 -r /dev/ttyUSB1 -s 4800 -C stop_bits=2
782 Start rigctl for an Elecraft K3 using a USB to serial adapter while
784 specifying a command terminator for the w command:
785 $ rigctl -m 229 -r /dev/ttyUSB0 -t';'
787 Connect to a running rigctld with radio model 2 (“NET rigctl”) on the
789 local host and specifying the TCP port, setting frequency and mode:
790 $ rigctl -m 2 -r localhost:4532 F 7253500 M LSB 0
792
794 set_chan has no entry method as of yet, hence left unimplemented.
795 This almost empty section...
797 Report bugs to:
799 Hamlib Developer mailing list
801 ⟨hamlib-developer@lists.sourceforge.net⟩
802
804 This file is part of Hamlib, a project to develop a library that sim‐
805 plifies radio and rotator control functions for developers of software
806 primarily of interest to radio amateurs and those interested in radio
807 communications.
808 Copyright © 2000-2011 Stephane Fillod
810 Copyright © 2000-2018 the Hamlib Group (various contributors)
811 Copyright © 2010-2018 Nate Bargmann
812 This is free software; see the file COPYING for copying conditions.
814 There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A
815 PARTICULAR PURPOSE.
816
818 less(1), more(1), rigctld(1), hamlib(7)
819
821 Links to the Hamlib Wiki, Git repository, release archives, and daily
822 snapshot archives:
823 hamlib.org ⟨http://www.hamlib.org⟩.
825Hamlib 2018-04-29 RIGCTL(1)