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 Can be a network address:port, e.g. 127.0.0.1:12345
51 The special string “uh-rig” may be given to enable micro-ham de‐
53 vice support.
54 -p, --ptt-file=device
56 Use device as the file name of the Push-To-Talk device using a
57 device file as described above.
58 -d, --dcd-file=device
60 Use device as the file name of the Data Carrier Detect device
61 using a device file as described above.
62 -P, --ptt-type=type
64 Use type of Push-To-Talk device.
65 Supported types are ‘RIG’ (CAT command), ‘DTR’, ‘RTS’, ‘PARAL‐
67 LEL’, ‘CM108’, ‘GPIO’, ‘GPION’, ‘NONE’, overriding PTT type de‐
68 fined in the rig's backend.
69 Some side effects of this command are that when type is set to
71 DTR, read PTT state comes from the Hamlib frontend, not read
72 from the radio. When set to NONE, PTT state cannot be read or
73 set even if rig backend supports reading/setting PTT status from
74 the rig.
75 -D, --dcd-type=type
77 Use type of Data Carrier Detect device.
78 Supported types are ‘RIG’ (CAT command), ‘DSR’, ‘CTS’, ‘CD’,
80 ‘PARALLEL’, ‘CM108’, ‘GPIO’, ‘GPION’, ‘NONE’.
81 -s, --serial-speed=baud
83 Set serial speed to baud rate.
84 Uses maximum serial speed from radio backend capabilities (set
86 by -m above) as the default.
87 -c, --civaddr=id
89 Use id as the CI-V address to communicate with the rig.
90 Only useful for Icom and some Ten-Tec rigs.
92 Note: The id is in decimal notation, unless prefixed by 0x, in
94 which case it is hexadecimal.
95 -t, --send-cmd-term=char
97 Change the termination char for text protocol when using the
98 send_cmd command.
99 The default value is ASCII CR (‘0x0D’). ASCII non-printing
101 characters can be given as the ASCII number in hexadecimal for‐
102 mat prepended with “0x”. You may pass an empty string for no
103 termination char. The string “-1” tells rigctl to switch to bi‐
104 nary protocol. See the send_cmd command for further explana‐
105 tion.
106 For example, to specify a command terminator for Kenwood style
108 text commands pass “-t ';'” to rigctl. See EXAMPLE below.
109 -L, --show-conf
111 List all config parameters for the radio defined with -m above.
112 -C, --set-conf=parm=val[,parm=val]
114 Set radio configuration parameter(s), e.g. stop_bits=2.
115 Use the -L option above for a list of configuration parameters
117 for a given model number.
118 -u, --dump-caps
120 Dump capabilities for the radio defined with -m above and exit.
121 -l, --list
123 List all model numbers defined in Hamlib and exit.
124 The list is sorted by model number.
126 Note: In Linux the list can be scrolled back using Shift-
128 PageUp/Shift-PageDown, or using the scrollbars of a virtual ter‐
129 minal in X or the cmd window in Windows. The output can be
130 piped to more(1) or less(1), e.g. “rigctl -l | more”.
131 -o, --vfo
133 Enable vfo mode.
134 An extra VFO argument will be required in front of each appro‐
136 priate command (except set_vfo). Otherwise, ‘currVFO’ is used
137 when this option is not set and an extra VFO argument is not
138 used.
139 -n, --no-restore-ai
141 On exit rigctl restores the state of auto information (AI) on
142 the controlled rig.
143 If this is not desired, for example if you are using rigctl to
145 turn AI mode on or off, pass this option.
146 -i, --read-history
148 Read previously saved command and argument history from a file
149 (default $HOME/.rigctl_history) for the current session.
150 Available when rigctl is built with Readline support (see READ‐
152 LINE below).
153 Note: To read a history file stored in another directory, set
155 the RIGCTL_HIST_DIR environment variable, e.g.
156 “RIGCTL_HIST_DIR=~/tmp rigctl -i”. When RIGCTL_HIST_DIR is not
157 set, the value of HOME is used.
158 -I, --save-history
160 Write current session (and previous session(s), if -i option is
161 given) command and argument history to a file (default
162 $HOME/.rigctl_history) at the end of the current session.
163 Complete commands with arguments are saved as a single line to
165 be recalled and used or edited. Available when rigctl is built
166 with Readline support (see READLINE below).
167 Note: To write a history file in another directory, set the
169 RIGCTL_HIST_DIR environment variable, e.g.
170 “RIGCTL_HIST_DIR=~/tmp rigctl -IRq. When RIGCTL_HIST_DIR is not
171 set, the value of HOME is used.
172 -v, --verbose
174 Set verbose mode, cumulative (see DIAGNOSTICS below).
175 -Y,--ignore-err
177 Ignores rig open errors
178 -Z, --debug-time-stamps
180 Enable time stamps for the debug messages.
181 Use only in combination with the -v option as it generates no
183 output on its own.
184 -h, --help
186 Show a summary of these options and exit.
187 -V, --version
189 Show version of rigctl and exit.
190 - Stop option processing and read commands from standard input.
192 See Standard Input below.
194 Note: Some options may not be implemented by a given backend and will
196 return an error. This is most likely to occur with the --set-conf and
197 --show-conf options.
198 Please note that the backend for the radio to be controlled, or the ra‐
200 dio itself may not support some commands. In that case, the operation
201 will fail with a Hamlib error code.
202
204 Commands can be entered either as a single char, or as a long command
205 name. The commands are not prefixed with a dash as the options are.
206 They may be typed in when in interactive mode or provided as argu‐
207 ment(s) in command line interface mode. In interactive mode commands
208 and their arguments may be entered on a single line:
209 M LSB 2400
211 Since most of the Hamlib operations have a set and a get method, an up‐
213 per case letter will often be used for a set method whereas the corre‐
214 sponding lower case letter refers to the get method. Each operation
215 also has a long name; in interactive mode, prepend a backslash, ‘\’, to
216 enter a long command name.
217 Example: Use “\dump_caps” to see what capabilities this radio and back‐
219 end support.
220 Note: The backend for the radio to be controlled, or the radio
222 itself may not support some commands. In that case, the opera‐
223 tion will fail with a Hamlib error message.
224 Standard Input
226 As an alternative to the READLINE interactive command entry or a single
227 command for each run, rigctl features a special option where a single
228 dash (‘-’) may be used to read commands from standard input (stdin).
229 Commands must be separated by whitespace similar to the commands given
230 on the command line. Comments may be added using the ‘#’ character,
231 all text up until the end of the current line including the ‘#’ charac‐
232 ter is ignored.
233 A simple example (typed text is in bold):
235 $ cat <<.EOF. >cmds.txt
237 > # File of commands
238 > v f m # query rig
239 > V VFOB F 14200000 M CW 500 # set rig
240 > v f m # query rig
241 > .EOF.
242 $ rigctl -m1 - <cmds.txt
244 v VFOA
246 f 145000000
248 m FM
250 15000
251 V VFOB
253 F 14200000
254 M CW 500
255 v VFOB
256 f 14200000
258 m CW
260 500
261 $
263 rigctl Commands
265 A summary of commands is included below (In the case of set commands
266 the quoted italicized string is replaced by the value in the descrip‐
267 tion. In the case of get commands the quoted italicized string is the
268 key name of the value returned.):
269 Q|q, exit rigctl
271 Exit rigctl in interactive mode.
272 When rigctl is controlling the rig directly, will close the rig
274 backend and port. When rigctl is connected to rigctld (radio
275 model 2), the TCP/IP connection to rigctld is closed and rigctld
276 remains running, available for another TCP/IP network connec‐
277 tion.
278 F, set_freq 'Frequency'
280 Set 'Frequency', in Hz.
281 Frequency may be a floating point or integer value.
283 f, get_freq
285 Get 'Frequency', in Hz.
286 Returns an integer value and the VFO hamlib thinks is active.
288 Note that some rigs (e.g. all Icoms) cannot track current VFO so
289 hamlib can get out of sync with the rig if the user presses rig
290 buttons like the VFO.
291 M, set_mode 'Mode' 'Passband'
293 Set 'Mode' and 'Passband'.
294 Mode is a token: ‘USB’, ‘LSB’, ‘CW’, ‘CWR’, ‘RTTY’, ‘RTTYR’,
296 ‘AM’, ‘FM’, ‘WFM’, ‘AMS’, ‘PKTLSB’, ‘PKTUSB’, ‘PKTFM’, ‘EC‐
297 SSUSB’, ‘ECSSLSB’, ‘FA’, ‘SAM’, ‘SAL’, ‘SAH’, ‘DSB’.
298 Passband is in Hz as an integer, -1 for no change, or ‘0’ for
300 the radio backend default.
301 Note: Passing a ‘?’ (query) as the first argument instead of a
303 Mode token will return a space separated list of radio backend
304 supported Modes. Use this to determine the supported Modes of a
305 given radio backend.
306 m, get_mode
308 Get 'Mode' and 'Passband'.
309 Returns Mode as a token and Passband in Hz as in set_mode above.
311 V, set_vfo 'VFO'
313 Set 'VFO'.
314 VFO is a token: ‘VFOA’, ‘VFOB’, ‘VFOC’, ‘currVFO’, ‘VFO’, ‘MEM’,
316 ‘Main’, ‘Sub’, ‘TX’, ‘RX’.
317 In VFO mode (see --vfo option above) only a single VFO parameter
319 is required:
320 $ rigctl -m 229 -r /dev/rig -o
322 Rig command: V
324 VFO: VFOB
325 Rig command:
327 v, get_vfo
329 Get current 'VFO'.
330 Returns VFO as a token as in set_vfo above.
332 J, set_rit 'RIT'
334 Set 'RIT'.
335 RIT is in Hz and can be + or -. A value of ‘0’ resets RIT (Re‐
337 ceiver Incremental Tuning) to match the VFO frequency.
338 Note: RIT needs to be explicitly activated or deactivated with
340 the set_func command. This allows setting the RIT offset inde‐
341 pendently of its activation and allows RIT to remain active
342 while setting the offset to ‘0’.
343 j, get_rit
345 Get 'RIT' in Hz.
346 Returned value is an integer.
348 Z, set_xit 'XIT'
350 Set 'XIT'.
351 XIT is in Hz and can be + or -. A value of ‘0’ resets XIT
353 (Transmitter Incremental Tuning) to match the VFO frequency.
354 Note: XIT needs to be explicitly activated or deactivated with
356 the set_func command. This allows setting the XIT offset inde‐
357 pendently of its activation and allows XIT to remain active
358 while setting the offset to ‘0’.
359 z, get_xit
361 Get 'XIT' in Hz.
362 Returned value is an integer.
364 T, set_ptt 'PTT'
366 Set 'PTT'.
367 PTT is a value: ‘0’ (RX), ‘1’ (TX), ‘2’ (TX mic), or ‘3’ (TX
369 data).
370 t, get_ptt
372 Get 'PTT' status.
373 Returns PTT as a value in set_ptt above.
375 S, set_split_vfo 'Split' 'TX VFO'
377 Set 'Split' mode.
378 Split is either ‘0’ = Normal or ‘1’ = Split.
380 Set 'TX VFO'.
382 TX VFO is a token: ‘VFOA’, ‘VFOB’, ‘VFOC’, ‘currVFO’, ‘VFO’,
384 ‘MEM’, ‘Main’, ‘Sub’, ‘TX’, ‘RX’.
385 s, get_split_vfo
387 Get 'Split' mode.
388 Split is either ‘0’ = Normal or ‘1’ = Split.
390 Get 'TX VFO'.
392 TX VFO is a token as in set_split_vfo above.
394 I, set_split_freq 'Tx Frequency'
396 Set 'TX Frequency', in Hz.
397 Frequency may be a floating point or integer value.
399 i, get_split_freq
401 Get 'TX Frequency', in Hz.
402 Returns an integer value.
404 X, set_split_mode 'TX Mode' 'TX Passband'
406 Set 'TX Mode' and 'TX Passband'.
407 TX Mode is a token: ‘USB’, ‘LSB’, ‘CW’, ‘CWR’, ‘RTTY’, ‘RTTYR’,
409 ‘AM’, ‘FM’, ‘WFM’, ‘AMS’, ‘PKTLSB’, ‘PKTUSB’, ‘PKTFM’, ‘EC‐
410 SSUSB’, ‘ECSSLSB’, ‘FA’, ‘SAM’, ‘SAL’, ‘SAH’, ‘DSB’.
411 TX Passband is in Hz as an integer, or ‘0’ for the radio backend
413 default.
414 Note: Passing a ‘?’ (query) as the first argument instead of a
416 TX Mode token will return a space separated list of radio back‐
417 end supported TX Modes. Use this to determine the supported TX
418 Modes of a given radio backend.
419 x, get_split_mode
421 Get 'TX Mode' and 'TX Passband'.
422 Returns TX Mode as a token and TX Passband in Hz as in
424 set_split_mode above.
425 Y, set_ant 'Antenna' 'Option'
427 Set 'Antenna' and 'Option'.
428 Number is 1-based antenna# (‘1’, ‘2’, ‘3’, ...).
430 Option depends on rig..for Icom it probably sets the Tx & Rx an‐
432 tennas as in the IC-7851. See your manual for rig specific op‐
433 tion values. Most rigs don't care about the option.
434 For the IC-7851, FTDX3000 (and perhaps others) it means this:
436 1 = TX/RX = ANT1 FTDX3000=ANT1/ANT3
438 2 = TX/RX = ANT2 FTDX3000=ANT2/ANT3
439 3 = TX/RX = ANT3 FTDX3000=ANT3
440 4 = TX/RX = ANT1/ANT4
441 5 = TX/RX = ANT2/ANT4
442 6 = TX/RX = ANT3/ANT4
443 y, get_ant 'Antenna'
445 Get 'Antenna'
446 A value of 0 for Antenna will return the current TX antenna
448 > 0 is 1-based antenna# (‘1’, ‘2’, ‘3’, ...).
450 Option returned depends on rig..for Icom is likely the RX only
454 flag.
455 b, send_morse 'Morse'
457 Send 'Morse' symbols.
458 0x8b, get_dcd
460 Get 'DCD' (squelch) status: ‘0’ (Closed) or ‘1’ (Open).
461 R, set_rptr_shift 'Rptr Shift'
463 Set 'Rptr Shift'.
464 Rptr Shift is one of: ‘+’, ‘-’, or something else for ‘None’.
466 r, get_rptr_shift
468 Get 'Rptr Shift'.
469 Returns ‘+’, ‘-’, or ‘None’.
471 O, set_rptr_offs 'Rptr Offset'
473 Set 'Rptr Offset', in Hz.
474 o, get_rptr_offs
476 Get 'Rptr Offset', in Hz.
477 C, set_ctcss_tone 'CTCSS Tone'
479 Set 'CTCSS Tone', in tenths of Hz.
480 c, get_ctcss_tone
482 Get 'CTCSS Tone', in tenths of Hz.
483 D, set_dcs_code 'DCS Code'
485 Set 'DCS Code'.
486 d, get_dcs_code
488 Get 'DCS Code'.
489 0x90, set_ctcss_sql 'CTCSS Sql'
491 Set 'CTCSS Sql' tone, in tenths of Hz.
492 0x91, get_ctcss_sql
494 Get 'CTCSS Sql' tone, in tenths of Hz.
495 0x92, set_dcs_sql 'DCS Sql'
497 Set 'DCS Sql' code.
498 0x93, get_dcs_sql
500 Get 'DCS Sql'
501 code.
502 N, set_ts 'Tuning Step'
504 Set 'Tuning Step', in Hz.
505 n, get_ts
507 Get 'Tuning Step', in Hz.
508 U, set_func 'Func' 'Func Status'
510 Set 'Func' and 'Func Status'.
511 Func is a token: ‘FAGC’, ‘NB’, ‘COMP’, ‘VOX’, ‘TONE’, ‘TSQL’,
513 ‘SBKIN’, ‘FBKIN’, ‘ANF’, ‘NR’, ‘AIP’, ‘APF’, ‘MON’, ‘MN’, ‘RF’,
514 ‘ARO’, ‘LOCK’, ‘MUTE’, ‘VSC’, ‘REV’, ‘SQL’, ‘ABM’, ‘BC’, ‘MBC’,
515 ‘RIT’, ‘AFC’, ‘SATMODE’, ‘SCOPE’, ‘RESUME’, ‘TBURST’, ‘TUNER’,
516 ‘XIT’.
517 Func Status is a non null value for “activate” or “de-activate”
519 otherwise, much as TRUE/FALSE definitions in the C language
520 (true is non-zero and false is zero, ‘0’).
521 Note: Passing a ‘?’ (query) as the first argument instead of a
523 Func token will return a space separated list of radio backend
524 supported set function tokens. Use this to determine the sup‐
525 ported functions of a given radio backend.
526 u, get_func 'Func'
528 Get 'Func Status'.
529 Returns Func Status as a non null value for the Func token given
531 as in set_func above.
532 Note: Passing a ‘?’ (query) as the first argument instead of a
534 Func token will return a space separated list of radio backend
535 supported get function tokens. Use this to determine the sup‐
536 ported functions of a given radio backend.
537 L, set_level 'Level' 'Level Value'
539 Set 'Level' and 'Level Value'.
540 Level is a token: ‘PREAMP’, ‘ATT’, ‘VOX’, ‘AF’, ‘RF’, ‘SQL’,
542 ‘IF’, ‘APF’, ‘NR’, ‘PBT_IN’, ‘PBT_OUT’, ‘CWPITCH’, ‘RFPOWER’,
543 ‘RFPOWER_METER’, ‘RFPOWER_METER_WATTS’, ‘MICGAIN’, ‘KEYSPD’,
544 ‘NOTCHF’, ‘COMP’, ‘AGC’, ‘BKINDL’, ‘BAL’, ‘METER’, ‘VOXGAIN’,
545 ‘ANTIVOX’, ‘SLOPE_LOW’, ‘SLOPE_HIGH’, ‘RAWSTR’, ‘SWR’, ‘ALC’,
546 ‘STRENGTH’.
547 The Level Value can be a float or an integer value. For the AGC
549 token the value is one of ‘0’ = OFF, ‘1’ = SUPERFAST, ‘2’ =
550 FAST, ‘3’ = SLOW, ‘4’ = USER, ‘5’ = MEDIUM, ‘6’ = AUTO.
551 Note: Passing a ‘?’ (query) as the first argument instead of a
553 Level token will return a space separated list of radio backend
554 supported set level tokens. Use this to determine the supported
555 levels of a given radio backend.
556 l, get_level 'Level'
558 Get 'Level Value'.
559 Returns Level Value as a float or integer for the Level token
561 given as in set_level above.
562 Note: Passing a ‘?’ (query) as the first argument instead of a
564 Level token will return a space separated list of radio backend
565 supported get level tokens. Use this to determine the supported
566 levels of a given radio backend.
567 P, set_parm 'Parm' 'Parm Value'
569 Set 'Parm' and 'Parm Value'.
570 Parm is a token: ‘ANN’, ‘APO’, ‘BACKLIGHT’, ‘BEEP’, ‘TIME’,
572 ‘BAT’, ‘KEYLIGHT’.
573 Note: Passing a ‘?’ (query) as the first argument instead of a
575 Parm token will return a space separated list of radio backend
576 supported set parameter tokens. Use this to determine the sup‐
577 ported parameters of a given radio backend.
578 p, get_parm 'Parm'
580 Get 'Parm Value'.
581 Returns Parm Value as a float or integer for the Parm token
583 given as in set_parm above.
584 Note: Passing a ‘?’ (query) as the first argument instead of a
586 Parm token will return a space separated list of radio backend
587 supported get parameter tokens. Use this to determine the sup‐
588 ported parameters of a given radio backend.
589 B, set_bank 'Bank'
591 Set 'Bank'.
592 Sets the current memory bank number.
594 E, set_mem 'Memory#'
596 Set 'Memory#' channel number.
597 e, get_mem
599 Get 'Memory#' channel number.
600 G, vfo_op 'Mem/VFO Op'
602 Perform a 'Mem/VFO Op'.
603 Mem/VFO Operation is a token: ‘CPY’, ‘XCHG’, ‘FROM_VFO’,
605 ‘TO_VFO’, ‘MCL’, ‘UP’, ‘DOWN’, ‘BAND_UP’, ‘BAND_DOWN’, ‘LEFT’,
606 ‘RIGHT’, ‘TUNE’, ‘TOGGLE’.
607 Note: Passing a ‘?’ (query) as the first argument instead of a
609 Mem/VFO Op token will return a space separated list of radio
610 backend supported Set Mem/VFO Op tokens. Use this to determine
611 the supported Mem/VFO Ops of a given radio backend.
612 g, scan 'Scan Fct' 'Scan Channel'
614 Perform a 'Scan Fct' on a 'Scan Channel'.
615 Scan Function is a token: ‘STOP’, ‘MEM’, ‘SLCT’, ‘PRIO’, ‘PROG’,
617 ‘DELTA’, ‘VFO’, ‘PLT’.
618 Scan Channel is an integer (maybe?).
620 Note: Passing a ‘?’ (query) as the first argument instead of a
622 Scan Fct token will return a space separated list of radio back‐
623 end supported Scan Function tokens. Use this to determine the
624 supported Scan Functions of a given radio backend.
625 H, set_channel 'Channel'
627 Set memory 'Channel' data.
628 Sets memory channel information
630 h, get_channel 'readonly'
632 Get channel memory.
633 If readonly!=0 then only channel data is returned and rig re‐
635 mains on the current channel. If readonly=0 then rig will be
636 set to the channel requested. data.
637 A, set_trn 'Transceive'
639 Set 'Transceive' mode.
640 Transcieve is a token: ‘OFF’, ‘RIG’, ‘POLL’.
642 Transceive is a mechanism for radios to report events without a
644 specific call for information.
645 Note: Passing a ‘?’ (query) as the first argument instead of a
647 Transceive token will return a space separated list of radio
648 backend supported Transceive mode tokens. Use this to determine
649 the supported Transceive modes of a given radio backend.
650 a, get_trn
652 Get 'Transceive' mode.
653 Transceive mode (reporting event) as in set_trn above.
655 *, reset 'Reset'
657 Perform rig 'Reset'.
658 Reset is a value: ‘0’ = None, ‘1’ = Software reset, ‘2’ = VFO
660 reset, ‘4’ = Memory Clear reset, ‘8’ = Master reset.
661 Since these values are defined as a bitmask in include/ham‐
663 lib/rig.h, it should be possible to AND these values together to
664 do multiple resets at once, if the backend supports it or sup‐
665 ports a reset action via rig control at all.
666 0x87, set_powerstat 'Power Status'
668 Set 'Power Status'.
669 Power Status is a value: ‘0’ = Power Off, ‘1’ = Power On, ‘2’ =
671 Power Standby (enter standby), ‘4’ = Power Operate (leave
672 standby).
673 0x88, get_powerstat
675 Get 'Power Status' as in set_powerstat above.
676 0x89, send_dtmf 'Digits'
678 Set DTMF 'Digits'.
679 0x8a, recv_dtmf
681 Get DTMF 'Digits'.
682 _, get_info
684 Get misc information about the rig.
685 0xf5, get_rig_info
687 Get misc information about the rig vfo status and other info.
688 0xf3, get_vfo_info 'VFO'
690 Get misc information about a specific vfo.
691 dump_state
693 Return certain state information about the radio backend.
694 1, dump_caps
696 Not a real rig remote command, it just dumps capabilities, i.e.
697 what the backend knows about this model, and what it can do.
698 TODO: Ensure this is in a consistent format so it can be read
700 into a hash, dictionary, etc. Bug reports requested.
701 Note: This command will produce many lines of output so be very
703 careful if using a fixed length array! For example, running
704 this command against the Dummy backend results in over 5kB of
705 text output.
706 VFO parameter not used in 'VFO mode'.
708 2, power2mW 'Power [0.0..1.0]' 'Frequency' 'Mode'
710 Returns 'Power mW'.
711 Converts a Power value in a range of 0.0...1.0 to the real
713 transmit power in milli-Watts (integer).
714 'Frequency' and 'Mode' also need to be provided as output power
716 may vary according to these values.
717 VFO parameter is not used in VFO mode.
719 4, mW2power 'Power mW' 'Frequency' 'Mode'
721 Returns 'Power [0.0..1.0]'.
722 Converts the real transmit power in milli-Watts (integer) to a
724 Power value in a range of 0.0 ... 1.0.
725 'Frequency' and 'Mode' also need to be provided as output power
727 may vary according to these values.
728 VFO parameter is not used in VFO mode.
730 w, send_cmd 'Cmd'
732 Send a raw command string to the radio.
733 This is useful for testing and troubleshooting radio commands
735 and responses when developing a backend.
736 For binary protocols enter values as \0xAA\0xBB. Expect a 'Re‐
738 ply' from the radio which will likely be a binary block or an
739 ASCII string depending on the radio's protocol (see your radio's
740 computer control documentation).
741 The command terminator, set by the send-cmd-term option above,
743 will terminate each command string sent to the radio. This
744 character should not be a part of the input string.
745 W, send_cmd_rx 'Cmd' nbytes
747 Send a raw command string to the radio and expect nbytes re‐
748 turned.
749 This is useful for testing and troubleshooting radio commands
751 and responses when developing a backend. If the # of bytes re‐
752 quested is <= the number actually returned no timeout will oc‐
753 cur.
754 The command argument can have no spaces in it. For binary pro‐
756 tocols enter values as \0xAA\0xBB. Expect a 'Reply' from the
757 radio which will likely be a binary block or an ASCII string de‐
758 pending on the radio's protocol (see your radio's computer con‐
759 trol documentation).
760 The command terminator, set by the send-cmd-term option above,
762 will terminate each command string sent to the radio. This
763 character should not be a part of the input string.
764 chk_vfo
766 Get 'Status'
767 Returns Status as 1 if vfo option is on and 0 if vfo option is
769 off. This command reflects the -o switch for rigctl and ritctld
770 and can be dynamically changed by set_vfo_opt.
771 set_vfo_opt 'Status'
773 Set 'Status'
774 Set vfo option Status 1=on or 0=off This is the same as using
776 the -o switch for rigctl and ritctld. This can be dyamically
777 changed while running.
778 pause 'Seconds'
780 Pause for the given whole (integer) number of 'Seconds' before
781 sending the next command to the radio.
782
784 If Readline library development files are found at configure time,
785 rigctl will be conditonally built with Readline support for command and
786 argument entry. Readline command key bindings are at their defaults as
787 described in the Readline manual
788 ⟨https://tiswww.cwru.edu/php/chet/readline/rluserman.html⟩. rigctl
789 sets the name “rigctl” which can be used in Conditional Init Constructs
790 in the Readline Init File ($HOME/.inputrc by default) for custom key‐
791 bindings unique to rigctl.
792 Command history is available with Readline support as described in the
794 Readline History manual
795 ⟨https://tiswww.case.edu/php/chet/readline/history.html#SEC1⟩. Command
796 and argument strings are stored as single lines even when arguments are
797 prompted for input individually. Commands and arguments are not vali‐
798 dated and are stored as typed with values separated by a single space.
799 Normally session history is not saved, however, use of either of the
801 -i/--read-history or -I/--save-history options when starting rigctl
802 will cause any previously saved history to be read in and/or the cur‐
803 rent and any previous session history (assuming the -i and -I options
804 are given together) will be written out when rigctl is closed. Each
805 option is mutually exclusive, i.e. either may be given separately or in
806 combination. This is useful to save a set of commands and then read
807 them later but not write the modified history for a consistent set of
808 test commands in interactive mode, for example.
809 History is stored in $HOME/.rigctl_history by default although the des‐
811 tination directory may be changed by setting the RIGCTL_HIST_DIR envi‐
812 ronment variable. When RIGCTL_HIST_DIR is unset, the value of the HOME
813 environment variable is used instead. Only the destination directory
814 may be changed at this time.
815 If Readline support is not found at configure time the original inter‐
817 nal command handler is used. Readline is not used for rigctl commands
818 entered on the command line regardless if Readline support is built in
819 or not.
820 Note: Readline support is not included in the MS Windows 32 or 64 bit
822 binary builds supplied by the Hamlib Project. Running rigctl on the MS
823 Windows platform in the ‘cmd’ shell does give session command line his‐
824 tory, however, it is not saved to disk between sessions.
825
827 The -v, --verbose option allows different levels of diagnostics to be
828 output to stderr and correspond to -v for BUG, -vv for ERR, -vvv for
829 WARN, -vvvv for VERBOSE, or -vvvvv for TRACE.
830 A given verbose level is useful for providing needed debugging informa‐
832 tion to the email address below. For example, TRACE output shows all
833 of the values sent to and received from the radio which is very useful
834 for radio backend library development and may be requested by the de‐
835 velopers.
836
838 rigctl exits with:
839 0 if all operations completed normally;
841 1 if there was an invalid command line option or argument;
843 2 if an error was returned by Hamlib.
845
847 Start rigctl for a Yaesu FT-920 using a USB to serial adapter on Linux
848 in interactive mode:
849 $ rigctl -m 1014 -r /dev/ttyUSB1
851 Start rigctl for a Yaesu FT-920 using COM1 on MS Windows while generat‐
853 ing TRACE output to stderr:
854 > rigctl -m 1014 -r COM1 -vvvvv
856 Start rigctl for a Yaesu FT-920 using a USB to serial adapter while
858 setting baud rate and stop bits:
859 $ rigctl -m 1014 -r /dev/ttyUSB1 -s 4800 -C stop_bits=2
861 Start rigctl for an Elecraft K3 using a USB to serial adapter while
863 specifying a command terminator for the w command:
864 $ rigctl -m 2029 -r /dev/ttyUSB0 -t';'
866 Connect to a running rigctld with radio model 2 (“NET rigctl”) on the
868 local host and specifying the TCP port, setting frequency and mode:
869 $ rigctl -m 2 -r localhost:4532 F 7253500 M LSB 0
871
873 set_chan has no entry method as of yet, hence left unimplemented.
874 This almost empty section...
876 Report bugs to:
878 Hamlib Developer mailing list
880 ⟨hamlib-developer@lists.sourceforge.net⟩
881
883 This file is part of Hamlib, a project to develop a library that sim‐
884 plifies radio, rotator, and amplifier control functions for developers
885 of software primarily of interest to radio amateurs and those inter‐
886 ested in radio communications.
887 Copyright © 2000-2011 Stephane Fillod
889 Copyright © 2000-2018 the Hamlib Group (various contributors)
890 Copyright © 2010-2020 Nate Bargmann
891 This is free software; see the file COPYING for copying conditions.
893 There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A
894 PARTICULAR PURPOSE.
895
897 less(1), more(1), rigctld(1), hamlib(7)
898
900 Links to the Hamlib Wiki, Git repository, release archives, and daily
901 snapshot archives are available via hamlib.org ⟨http://www.hamlib.org⟩.
902Hamlib 2020-09-09 RIGCTL(1)