1RIGCTL(1)                      Hamlib Utilities                      RIGCTL(1)
2
3
4

NAME

6       rigctl - control radio transceivers and receivers
7

SYNOPSIS

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

DESCRIPTION

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
18       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
22       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

OPTIONS

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
32       Here is a summary of the supported options:
33
34       -m, --model=id
35              Select radio model number. Defaults to dummy rig.
36
37              See model list (use “rigctl -l”).
38
39              Note: rigctl (or third party software using the C API) will  use
40              radio model 2 for NET rigctl (communicating with rigctld).
41
42       -r, --rig-file=device
43              Use device as the file name of the port connected to the radio.
44
45              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
50              Can be a network address:port, e.g. 127.0.0.1:12345
51
52              The special string “uh-rig” may be given to enable micro-ham de‐
53              vice support.
54
55       -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
59       -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
63       -P, --ptt-type=type
64              Use type of Push-To-Talk device.
65
66              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
70              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
76       -D, --dcd-type=type
77              Use type of Data Carrier Detect device.
78
79              Supported  types  are  ‘RIG’  (CAT command), ‘DSR’, ‘CTS’, ‘CD’,
80              ‘PARALLEL’, ‘CM108’, ‘GPIO’, ‘GPION’, ‘NONE’.
81
82       -s, --serial-speed=baud
83              Set serial speed to baud rate.
84
85              Uses maximum serial speed from radio backend  capabilities  (set
86              by -m above) as the default.
87
88       -c, --civaddr=id
89              Use id as the CI-V address to communicate with the rig.
90
91              Only useful for Icom and some Ten-Tec rigs.
92
93              Note:  The  id is in decimal notation, unless prefixed by 0x, in
94              which case it is hexadecimal.
95
96       -t, --send-cmd-term=char
97              Change the termination char for text  protocol  when  using  the
98              send_cmd command.
99
100              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
107              For example, to specify a command terminator for  Kenwood  style
108              text commands pass “-t ';'” to rigctl.  See EXAMPLE below.
109
110       -L, --show-conf
111              List  all config parameters for the radio defined with -m above.
112              Note the dummy device has no serial parameters.
113
114       -C, --set-conf=parm=val[,parm=val]
115              Set radio configuration parameter(s), e.g.  stop_bits=2.
116
117              Use the -L option above for a list of  configuration  parameters
118              for a given model number.
119
120       -u, --dump-caps
121              Dump capabilities for the radio defined with -m above and exit.
122
123       -l, --list
124              List all model numbers defined in Hamlib and exit.
125
126              The list is sorted by model number.
127
128              Note:  In  Linux  the  list  can  be  scrolled back using Shift-
129              PageUp/Shift-PageDown, or using the scrollbars of a virtual ter‐
130              minal  in  X  or  the  cmd window in Windows.  The output can be
131              piped to more(1) or less(1), e.g. “rigctl -l | more”.
132
133       -o, --vfo
134              Enable vfo mode.
135
136              An extra VFO argument will be required in front of  each  appro‐
137              priate  command  (except set_vfo).  Otherwise, ‘currVFO’ is used
138              when this option is not set and an extra  VFO  argument  is  not
139              used.
140
141       -n, --no-restore-ai
142              On  exit  rigctl  restores the state of auto information (AI) on
143              the controlled rig.
144
145              If this is not desired, for example if you are using  rigctl  to
146              turn AI mode on or off, pass this option.
147
148       -i, --read-history
149              Read  previously  saved command and argument history from a file
150              (default $HOME/.rigctl_history) for the current session.
151
152              Available when rigctl is built with Readline support (see  READ‐
153              LINE below).
154
155              Note:  To  read  a history file stored in another directory, set
156              the     RIGCTL_HIST_DIR     environment      variable,      e.g.
157              “RIGCTL_HIST_DIR=~/tmp  rigctl -i”.  When RIGCTL_HIST_DIR is not
158              set, the value of HOME is used.
159
160       -I, --save-history
161              Write current session (and previous session(s), if -i option  is
162              given)   command   and  argument  history  to  a  file  (default
163              $HOME/.rigctl_history) at the end of the current session.
164
165              Complete commands with arguments are saved as a single  line  to
166              be  recalled and used or edited.  Available when rigctl is built
167              with Readline support (see READLINE below).
168
169              Note: To write a history file  in  another  directory,  set  the
170              RIGCTL_HIST_DIR         environment        variable,        e.g.
171              “RIGCTL_HIST_DIR=~/tmp rigctl -IRq.  When RIGCTL_HIST_DIR is not
172              set, the value of HOME is used.
173
174       -v, --verbose
175              Set verbose mode, cumulative (see DIAGNOSTICS below).
176
177       -Y,--ignore-err
178              Ignores rig open errors
179
180       -Z, --debug-time-stamps
181              Enable time stamps for the debug messages.
182
183              Use  only  in  combination with the -v option as it generates no
184              output on its own.
185
186       -h, --help
187              Show a summary of these options and exit.
188
189       -V, --version
190              Show version of rigctl and exit.
191
192       -      Stop option processing and read commands from standard input.
193
194              See Standard Input below.
195
196       Note: Some options may not be implemented by a given backend  and  will
197       return  an error.  This is most likely to occur with the --set-conf and
198       --show-conf options.
199
200       Please note that the backend for the radio to be controlled, or the ra‐
201       dio  itself may not support some commands.  In that case, the operation
202       will fail with a Hamlib error code.
203

COMMANDS

205       Commands can be entered either as a single char, or as a  long  command
206       name.   The  commands  are not prefixed with a dash as the options are.
207       They may be typed in when in interactive  mode  or  provided  as  argu‐
208       ment(s)  in  command line interface mode.  In interactive mode commands
209       and their arguments may be entered on a single line:
210
211           M LSB 2400
212
213       Since most of the Hamlib operations have a set and a get method, an up‐
214       per  case letter will often be used for a set method whereas the corre‐
215       sponding lower case letter refers to the get  method.   Each  operation
216       also has a long name; in interactive mode, prepend a backslash, ‘\’, to
217       enter a long command name.
218
219       Example: Use “\dump_caps” to see what capabilities this radio and back‐
220       end support.
221
222              Note:  The  backend for the radio to be controlled, or the radio
223              itself may not support some commands. In that case,  the  opera‐
224              tion will fail with a Hamlib error message.
225
226   Standard Input
227       As an alternative to the READLINE interactive command entry or a single
228       command for each run, rigctl features a special option where  a  single
229       dash  (‘-’)  may  be used to read commands from standard input (stdin).
230       Commands must be separated by whitespace similar to the commands  given
231       on  the  command  line.  Comments may be added using the ‘#’ character,
232       all text up until the end of the current line including the ‘#’ charac‐
233       ter is ignored.
234
235       A simple example (typed text is in bold):
236
237           $ cat <<.EOF. >cmds.txt
238           > # File of commands
239           > v f m   # query rig
240           > V VFOB F 14200000 M CW 500  # set rig
241           > v f m   # query rig
242           > .EOF.
243
244           $ rigctl -m1 - <cmds.txt
245
246           v VFOA
247
248           f 145000000
249
250           m FM
251           15000
252
253           V VFOB
254           F 14200000
255           M CW 500
256           v VFOB
257
258           f 14200000
259
260           m CW
261           500
262
263           $
264
265   rigctl Commands
266       A  summary  of  commands is included below (In the case of set commands
267       the quoted italicized string is replaced by the value in  the  descrip‐
268       tion.   In the case of get commands the quoted italicized string is the
269       key name of the value returned.):
270
271       Q|q, exit rigctl
272              Exit rigctl in interactive mode.
273
274              When rigctl is controlling the rig directly, will close the  rig
275              backend  and  port.   When rigctl is connected to rigctld (radio
276              model 2), the TCP/IP connection to rigctld is closed and rigctld
277              remains  running,  available  for another TCP/IP network connec‐
278              tion.
279
280       F, set_freq 'Frequency'
281              Set 'Frequency', in Hz.
282
283              Frequency may be a floating point or integer value.
284
285       f, get_freq
286              Get 'Frequency', in Hz.
287
288              Returns an integer value and the VFO hamlib  thinks  is  active.
289              Note that some rigs (e.g. all Icoms) cannot track current VFO so
290              hamlib can get out of sync with the rig if the user presses  rig
291              buttons like the VFO.
292
293       M, set_mode 'Mode' 'Passband'
294              Set 'Mode' and 'Passband'.
295
296              Mode  is  a  token:  ‘USB’, ‘LSB’, ‘CW’, ‘CWR’, ‘RTTY’, ‘RTTYR’,
297              ‘AM’, ‘FM’, ‘WFM’,  ‘AMS’,  ‘PKTLSB’,  ‘PKTUSB’,  ‘PKTFM’,  ‘EC‐
298              SSUSB’, ‘ECSSLSB’, ‘FA’, ‘SAM’, ‘SAL’, ‘SAH’, ‘DSB’.
299
300              Passband  is  in  Hz as an integer, -1 for no change, or ‘0’ for
301              the radio backend default.
302
303              Note: Passing a ‘?’ (query) as the first argument instead  of  a
304              Mode  token  will return a space separated list of radio backend
305              supported Modes.  Use this to determine the supported Modes of a
306              given radio backend.
307
308       m, get_mode
309              Get 'Mode' and 'Passband'.
310
311              Returns Mode as a token and Passband in Hz as in set_mode above.
312
313       V, set_vfo 'VFO'
314              Set 'VFO'.
315
316              VFO is a token: ‘VFOA’, ‘VFOB’, ‘VFOC’, ‘currVFO’, ‘VFO’, ‘MEM’,
317              ‘Main’, ‘Sub’, ‘TX’, ‘RX’.
318
319              In VFO mode (see --vfo option above) only a single VFO parameter
320              is required:
321
322                  $ rigctl -m 229 -r /dev/rig -o
323
324                  Rig command: V
325                  VFO: VFOB
326
327                  Rig command:
328
329       v, get_vfo
330              Get current 'VFO'.
331
332              Returns VFO as a token as in set_vfo above.
333
334       J, set_rit 'RIT'
335              Set 'RIT'.
336
337              RIT  is in Hz and can be + or -.  A value of ‘0’ resets RIT (Re‐
338              ceiver Incremental Tuning) to match the VFO frequency.
339
340              Note: RIT needs to be explicitly activated or  deactivated  with
341              the  set_func command.  This allows setting the RIT offset inde‐
342              pendently of its activation and  allows  RIT  to  remain  active
343              while setting the offset to ‘0’.
344
345       j, get_rit
346              Get 'RIT' in Hz.
347
348              Returned value is an integer.
349
350       Z, set_xit 'XIT'
351              Set 'XIT'.
352
353              XIT  is  in  Hz  and  can  be + or -.  A value of ‘0’ resets XIT
354              (Transmitter Incremental Tuning) to match the VFO frequency.
355
356              Note: XIT needs to be explicitly activated or  deactivated  with
357              the  set_func command.  This allows setting the XIT offset inde‐
358              pendently of its activation and  allows  XIT  to  remain  active
359              while setting the offset to ‘0’.
360
361       z, get_xit
362              Get 'XIT' in Hz.
363
364              Returned value is an integer.
365
366       T, set_ptt 'PTT'
367              Set 'PTT'.
368
369              PTT  is  a  value:  ‘0’ (RX), ‘1’ (TX), ‘2’ (TX mic), or ‘3’ (TX
370              data).
371
372       t, get_ptt
373              Get 'PTT' status.
374
375              Returns PTT as a value in set_ptt above.
376
377       S, set_split_vfo 'Split' 'TX VFO'
378              Set 'Split' mode.
379
380              Split is either ‘0’ = Normal or ‘1’ = Split.
381
382              Set 'TX VFO'.
383
384              TX VFO is a token: ‘VFOA’,  ‘VFOB’,  ‘VFOC’,  ‘currVFO’,  ‘VFO’,
385              ‘MEM’, ‘Main’, ‘Sub’, ‘TX’, ‘RX’.
386
387       s, get_split_vfo
388              Get 'Split' mode.
389
390              Split is either ‘0’ = Normal or ‘1’ = Split.
391
392              Get 'TX VFO'.
393
394              TX VFO is a token as in set_split_vfo above.
395
396       I, set_split_freq 'Tx Frequency'
397              Set 'TX Frequency', in Hz.
398
399              Frequency may be a floating point or integer value.
400
401       i, get_split_freq
402              Get 'TX Frequency', in Hz.
403
404              Returns an integer value.
405
406       X, set_split_mode 'TX Mode' 'TX Passband'
407              Set 'TX Mode' and 'TX Passband'.
408
409              TX  Mode is a token: ‘USB’, ‘LSB’, ‘CW’, ‘CWR’, ‘RTTY’, ‘RTTYR’,
410              ‘AM’, ‘FM’, ‘WFM’,  ‘AMS’,  ‘PKTLSB’,  ‘PKTUSB’,  ‘PKTFM’,  ‘EC‐
411              SSUSB’, ‘ECSSLSB’, ‘FA’, ‘SAM’, ‘SAL’, ‘SAH’, ‘DSB’.
412
413              TX Passband is in Hz as an integer, or ‘0’ for the radio backend
414              default.
415
416              Note: Passing a ‘?’ (query) as the first argument instead  of  a
417              TX  Mode token will return a space separated list of radio back‐
418              end supported TX Modes.  Use this to determine the supported  TX
419              Modes of a given radio backend.
420
421       x, get_split_mode
422              Get 'TX Mode' and 'TX Passband'.
423
424              Returns  TX  Mode  as  a  token  and  TX  Passband  in  Hz as in
425              set_split_mode above.
426
427       Y, set_ant 'Antenna' 'Option'
428              Set 'Antenna' and 'Option'.
429
430              Number is 1-based antenna# (‘1’, ‘2’, ‘3’, ...).
431
432              Option depends on rig..for Icom it probably sets the Tx & Rx an‐
433              tennas  as  in the IC-7851. See your manual for rig specific op‐
434              tion values. Most rigs don't care about the option.
435
436              For the IC-7851, FTDX3000 (and perhaps others) it means this:
437
438                  1 = TX/RX = ANT1  FTDX3000=ANT1/ANT3
439                  2 = TX/RX = ANT2  FTDX3000=ANT2/ANT3
440                  3 = TX/RX = ANT3  FTDX3000=ANT3
441                  4 = TX/RX = ANT1/ANT4
442                  5 = TX/RX = ANT2/ANT4
443                  6 = TX/RX = ANT3/ANT4
444
445       y, get_ant 'Antenna'
446              Get 'Antenna'
447
448              A value of 0 for Antenna will return the current TX antenna
449
450              > 0 is 1-based antenna# (‘1’, ‘2’, ‘3’, ...).
451
452
453
454              Option returned depends on rig..for Icom is likely the  RX  only
455              flag.
456
457       b, send_morse 'Morse'
458              Send 'Morse' symbols.  For Yaesu rigs use memory#.
459
460       0x8b, get_dcd
461              Get 'DCD' (squelch) status: ‘0’ (Closed) or ‘1’ (Open).
462
463       R, set_rptr_shift 'Rptr Shift'
464              Set 'Rptr Shift'.
465
466              Rptr Shift is one of: ‘+’, ‘-’, or something else for ‘None’.
467
468       r, get_rptr_shift
469              Get 'Rptr Shift'.
470
471              Returns ‘+’, ‘-’, or ‘None’.
472
473       O, set_rptr_offs 'Rptr Offset'
474              Set 'Rptr Offset', in Hz.
475
476       o, get_rptr_offs
477              Get 'Rptr Offset', in Hz.
478
479       C, set_ctcss_tone 'CTCSS Tone'
480              Set 'CTCSS Tone', in tenths of Hz.
481
482       c, get_ctcss_tone
483              Get 'CTCSS Tone', in tenths of Hz.
484
485       D, set_dcs_code 'DCS Code'
486              Set 'DCS Code'.
487
488       d, get_dcs_code
489              Get 'DCS Code'.
490
491       0x90, set_ctcss_sql 'CTCSS Sql'
492              Set 'CTCSS Sql' tone, in tenths of Hz.
493
494       0x91, get_ctcss_sql
495              Get 'CTCSS Sql' tone, in tenths of Hz.
496
497       0x92, set_dcs_sql 'DCS Sql'
498              Set 'DCS Sql' code.
499
500       0x93, get_dcs_sql
501              Get 'DCS Sql'
502               code.
503
504       N, set_ts 'Tuning Step'
505              Set 'Tuning Step', in Hz.
506
507       n, get_ts
508              Get 'Tuning Step', in Hz.
509
510       U, set_func 'Func' 'Func Status'
511              Set 'Func' and 'Func Status'.
512
513              Func  is  a  token: ‘FAGC’, ‘NB’, ‘COMP’, ‘VOX’, ‘TONE’, ‘TSQL’,
514              ‘SBKIN’, ‘FBKIN’, ‘ANF’, ‘NR’, ‘AIP’, ‘APF’, ‘MON’, ‘MN’,  ‘RF’,
515              ‘ARO’,  ‘LOCK’, ‘MUTE’, ‘VSC’, ‘REV’, ‘SQL’, ‘ABM’, ‘BC’, ‘MBC’,
516              ‘RIT’, ‘AFC’, ‘SATMODE’, ‘SCOPE’, ‘RESUME’,  ‘TBURST’,  ‘TUNER’,
517              ‘XIT’.
518
519              Func  Status is a non null value for “activate” or “de-activate”
520              otherwise, much as TRUE/FALSE  definitions  in  the  C  language
521              (true is non-zero and false is zero, ‘0’).
522
523              Note:  Passing  a ‘?’ (query) as the first argument instead of a
524              Func token will return a space separated list of  radio  backend
525              supported  set  function tokens.  Use this to determine the sup‐
526              ported functions of a given radio backend.
527
528       u, get_func 'Func'
529              Get 'Func Status'.
530
531              Returns Func Status as a non null value for the Func token given
532              as in set_func above.
533
534              Note:  Passing  a ‘?’ (query) as the first argument instead of a
535              Func token will return a space separated list of  radio  backend
536              supported  get  function tokens.  Use this to determine the sup‐
537              ported functions of a given radio backend.
538
539       L, set_level 'Level' 'Level Value'
540              Set 'Level' and 'Level Value'.
541
542              Level is a token: ‘PREAMP’, ‘ATT’,  ‘VOX’,  ‘AF’,  ‘RF’,  ‘SQL’,
543              ‘IF’,  ‘APF’,  ‘NR’,  ‘PBT_IN’, ‘PBT_OUT’, ‘CWPITCH’, ‘RFPOWER’,
544              ‘RFPOWER_METER’,  ‘RFPOWER_METER_WATTS’,   ‘MICGAIN’,  ‘KEYSPD’,
545              ‘NOTCHF’,  ‘COMP’,  ‘AGC’,  ‘BKINDL’, ‘BAL’, ‘METER’, ‘VOXGAIN’,
546              ‘ANTIVOX’, ‘SLOPE_LOW’, ‘SLOPE_HIGH’,  ‘RAWSTR’,  ‘SWR’,  ‘ALC’,
547              ‘STRENGTH’.
548
549              The Level Value can be a float or an integer value.  For the AGC
550              token the value is one of ‘0’ = OFF,  ‘1’  =  SUPERFAST,  ‘2’  =
551              FAST, ‘3’ = SLOW, ‘4’ = USER, ‘5’ = MEDIUM, ‘6’ = AUTO.
552
553              Note:  Passing  a ‘?’ (query) as the first argument instead of a
554              Level token will return a space separated list of radio  backend
555              supported set level tokens.  Use this to determine the supported
556              levels of a given radio backend.
557
558       l, get_level 'Level'
559              Get 'Level Value'.
560
561              Returns Level Value as a float or integer for  the  Level  token
562              given as in set_level above.
563
564              Note:  Passing  a ‘?’ (query) as the first argument instead of a
565              Level token will return a space separated list of radio  backend
566              supported get level tokens.  Use this to determine the supported
567              levels of a given radio backend.
568
569       P, set_parm 'Parm' 'Parm Value'
570              Set 'Parm' and 'Parm Value'.
571
572              Parm is a token:  ‘ANN’,  ‘APO’,  ‘BACKLIGHT’,  ‘BEEP’,  ‘TIME’,
573              ‘BAT’, ‘KEYLIGHT’.
574
575              Note:  Passing  a ‘?’ (query) as the first argument instead of a
576              Parm token will return a space separated list of  radio  backend
577              supported  set parameter tokens.  Use this to determine the sup‐
578              ported parameters of a given radio backend.
579
580       p, get_parm 'Parm'
581              Get 'Parm Value'.
582
583              Returns Parm Value as a float or  integer  for  the  Parm  token
584              given as in set_parm above.
585
586              Note:  Passing  a ‘?’ (query) as the first argument instead of a
587              Parm token will return a space separated list of  radio  backend
588              supported  get parameter tokens.  Use this to determine the sup‐
589              ported parameters of a given radio backend.
590
591       B, set_bank 'Bank'
592              Set 'Bank'.
593
594              Sets the current memory bank number.
595
596       E, set_mem 'Memory#'
597              Set 'Memory#' channel number.
598
599       e, get_mem
600              Get 'Memory#' channel number.
601
602       G, vfo_op 'Mem/VFO Op'
603              Perform a 'Mem/VFO Op'.
604
605              Mem/VFO  Operation  is  a  token:  ‘CPY’,  ‘XCHG’,   ‘FROM_VFO’,
606              ‘TO_VFO’,  ‘MCL’,  ‘UP’, ‘DOWN’, ‘BAND_UP’, ‘BAND_DOWN’, ‘LEFT’,
607              ‘RIGHT’, ‘TUNE’, ‘TOGGLE’.
608
609              Note: Passing a ‘?’ (query) as the first argument instead  of  a
610              Mem/VFO  Op  token  will  return a space separated list of radio
611              backend supported Set Mem/VFO Op tokens.  Use this to  determine
612              the supported Mem/VFO Ops of a given radio backend.
613
614       g, scan 'Scan Fct' 'Scan Channel'
615              Perform a 'Scan Fct' on a 'Scan Channel'.
616
617              Scan Function is a token: ‘STOP’, ‘MEM’, ‘SLCT’, ‘PRIO’, ‘PROG’,
618              ‘DELTA’, ‘VFO’, ‘PLT’.
619
620              Scan Channel is an integer (maybe?).
621
622              Note: Passing a ‘?’ (query) as the first argument instead  of  a
623              Scan Fct token will return a space separated list of radio back‐
624              end supported Scan Function tokens.  Use this to  determine  the
625              supported Scan Functions of a given radio backend.
626
627       H, set_channel 'Channel'
628              Set memory 'Channel' data.
629
630              Sets memory channel information
631
632       h, get_channel 'readonly'
633              Get channel memory.
634
635              If  readonly!=0  then  only channel data is returned and rig re‐
636              mains on the current channel.  If readonly=0 then  rig  will  be
637              set to the channel requested.  data.
638
639       A, set_trn 'Transceive'
640              Set 'Transceive' mode.
641
642              Transcieve is a token: ‘OFF’, ‘RIG’, ‘POLL’.
643
644              Transceive  is a mechanism for radios to report events without a
645              specific call for information.
646
647              Note: Passing a ‘?’ (query) as the first argument instead  of  a
648              Transceive  token  will  return  a space separated list of radio
649              backend supported Transceive mode tokens.  Use this to determine
650              the supported Transceive modes of a given radio backend.
651
652       a, get_trn
653              Get 'Transceive' mode.
654
655              Transceive mode (reporting event) as in set_trn above.
656
657       *, reset 'Reset'
658              Perform rig 'Reset'.
659
660              Reset  is  a  value: ‘0’ = None, ‘1’ = Software reset, ‘2’ = VFO
661              reset, ‘4’ = Memory Clear reset, ‘8’ = Master reset.
662
663              Since these values are defined  as  a  bitmask  in  include/ham‐
664              lib/rig.h, it should be possible to AND these values together to
665              do multiple resets at once, if the backend supports it  or  sup‐
666              ports a reset action via rig control at all.
667
668       0x87, set_powerstat 'Power Status'
669              Set 'Power Status'.
670
671              Power  Status is a value: ‘0’ = Power Off, ‘1’ = Power On, ‘2’ =
672              Power Standby  (enter  standby),  ‘4’  =  Power  Operate  (leave
673              standby).
674
675       0x88, get_powerstat
676              Get 'Power Status' as in set_powerstat above.
677
678       0x89, send_dtmf 'Digits'
679              Set DTMF 'Digits'.
680
681       0x8a, recv_dtmf
682              Get DTMF 'Digits'.
683
684       _, get_info
685              Get misc information about the rig.
686
687       0xf5, get_rig_info
688              Get misc information about the rig vfo status and other info.
689
690       0xf3, get_vfo_info 'VFO'
691              Get misc information about a specific vfo.
692
693       dump_state
694              Return certain state information about the radio backend.
695
696       1, dump_caps
697              Not  a real rig remote command, it just dumps capabilities, i.e.
698              what the backend knows about this model, and what it can do.
699
700              TODO: Ensure this is in a consistent format so it  can  be  read
701              into a hash, dictionary, etc.  Bug reports requested.
702
703              Note:  This command will produce many lines of output so be very
704              careful if using a fixed length  array!   For  example,  running
705              this  command  against  the Dummy backend results in over 5kB of
706              text output.
707
708              VFO parameter not used in 'VFO mode'.
709
710       2, power2mW 'Power [0.0..1.0]' 'Frequency' 'Mode'
711              Returns 'Power mW'.
712
713              Converts a Power value in a  range  of  0.0...1.0  to  the  real
714              transmit power in milli-Watts (integer).
715
716              'Frequency'  and 'Mode' also need to be provided as output power
717              may vary according to these values.
718
719              VFO parameter is not used in VFO mode.
720
721       4, mW2power 'Power mW' 'Frequency' 'Mode'
722              Returns 'Power [0.0..1.0]'.
723
724              Converts the real transmit power in milli-Watts (integer)  to  a
725              Power value in a range of 0.0 ... 1.0.
726
727              'Frequency'  and 'Mode' also need to be provided as output power
728              may vary according to these values.
729
730              VFO parameter is not used in VFO mode.
731
732       w, send_cmd 'Cmd'
733              Send a raw command string to the radio.
734
735              This is useful for testing and  troubleshooting  radio  commands
736              and responses when developing a backend.
737
738              For  binary protocols enter values as \0xAA\0xBB.  Expect a 'Re‐
739              ply' from the radio which will likely be a binary  block  or  an
740              ASCII string depending on the radio's protocol (see your radio's
741              computer control documentation).
742
743              The command terminator, set by the send-cmd-term  option  above,
744              will  terminate  each  command  string  sent to the radio.  This
745              character should not be a part of the input string.
746
747       W, send_cmd_rx 'Cmd' nbytes
748              Send a raw command string to the radio  and  expect  nbytes  re‐
749              turned.
750
751              This  is  useful  for testing and troubleshooting radio commands
752              and responses when developing a backend.  If the # of bytes  re‐
753              quested  is  <= the number actually returned no timeout will oc‐
754              cur.
755
756              The command argument can have no spaces in it.  For binary  pro‐
757              tocols  enter  values  as \0xAA\0xBB.  Expect a 'Reply' from the
758              radio which will likely be a binary block or an ASCII string de‐
759              pending  on the radio's protocol (see your radio's computer con‐
760              trol documentation).
761
762              The command terminator, set by the send-cmd-term  option  above,
763              will  terminate  each  command  string  sent to the radio.  This
764              character should not be a part of the input string.
765
766       set_clock 'DateTime'
767              Set 'DateTime'
768
769              Sets rig clock -- note that some rigs do not handle  seconds  or
770              milliseconds.   If you try to set sec/msec and rig does not sup‐
771              port it you  will  get  a  debug  warning  message.   Format  is
772              ISO8601,
773              Formats accepted
774              YYYY-MM-DDTHH:MM:SS.SSS+ZZ (where +ZZ is either -/+ UTC offset)
775              YYYY-MM-DDTHH:MM:SS+ZZ
776              YYYY-MM-DDTHH:MM+ZZ
777              YYYY-MM-DD (sets date only)
778              Note: Icom rigs expect you to set local time and the hours off to UTC.
779              So...4PM EST example would be 2021-12-01T16:00:00+05
780              But...if you want to display GMT you must set the clock for GMT with zero UTC offset.
781              Hopefully Icom will allow displaying either clock in the future
782
783
784       get_clock
785              Get 'RigTime'
786
787              Gets  rig  clock -- note that some rigs do not handle seconds or
788              milliseconds.   Format  is  ISO8601   YYYY-MM-DDTHH:MM:SS.sss+ZZ
789              where +ZZ is either -/+ UTC offset
790
791       chk_vfo
792              Get 'Status'
793
794              Returns  Status  as 1 if vfo option is on and 0 if vfo option is
795              off.  This command reflects the -o switch for rigctl and ritctld
796              and can be dynamically changed by set_vfo_opt.
797
798       set_vfo_opt 'Status'
799              Set 'Status'
800
801              Set  vfo  option  Status 1=on or 0=off This is the same as using
802              the -o switch for rigctl and ritctld.  This  can  be  dyamically
803              changed while running.
804
805       pause 'Seconds'
806              Pause  for  the given whole (integer) number of 'Seconds' before
807              sending the next command to the radio.
808

READLINE

810       If Readline library development files  are  found  at  configure  time,
811       rigctl will be conditonally built with Readline support for command and
812       argument entry.  Readline command key bindings are at their defaults as
813       described           in           the           Readline          manual
814https://tiswww.cwru.edu/php/chet/readline/rluserman.html⟩.      rigctl
815       sets the name “rigctl” which can be used in Conditional Init Constructs
816       in the Readline Init File ($HOME/.inputrc by default) for  custom  key‐
817       bindings unique to rigctl.
818
819       Command  history is available with Readline support as described in the
820       Readline                         History                         manual
821https://tiswww.case.edu/php/chet/readline/history.html#SEC1⟩.  Command
822       and argument strings are stored as single lines even when arguments are
823       prompted  for input individually.  Commands and arguments are not vali‐
824       dated and are stored as typed with values separated by a single space.
825
826       Normally session history is not saved, however, use of  either  of  the
827       -i/--read-history  or  -I/--save-history  options  when starting rigctl
828       will cause any previously saved history to be read in and/or  the  cur‐
829       rent  and  any previous session history (assuming the -i and -I options
830       are given together) will be written out when rigctl  is  closed.   Each
831       option is mutually exclusive, i.e. either may be given separately or in
832       combination.  This is useful to save a set of commands  and  then  read
833       them  later  but not write the modified history for a consistent set of
834       test commands in interactive mode, for example.
835
836       History is stored in $HOME/.rigctl_history by default although the des‐
837       tination  directory may be changed by setting the RIGCTL_HIST_DIR envi‐
838       ronment variable.  When RIGCTL_HIST_DIR is unset, the value of the HOME
839       environment  variable  is used instead.  Only the destination directory
840       may be changed at this time.
841
842       If Readline support is not found at configure time the original  inter‐
843       nal  command handler is used.  Readline is not used for rigctl commands
844       entered on the command line regardless if Readline support is built  in
845       or not.
846
847       Note:  Readline  support is not included in the MS Windows 32 or 64 bit
848       binary builds supplied by the Hamlib Project.  Running rigctl on the MS
849       Windows platform in the ‘cmd’ shell does give session command line his‐
850       tory, however, it is not saved to disk between sessions.
851

DIAGNOSTICS

853       The -v, --verbose option allows different levels of diagnostics  to  be
854       output  to  stderr  and correspond to -v for BUG, -vv for ERR, -vvv for
855       WARN, -vvvv for VERBOSE, or -vvvvv for TRACE.
856
857       A given verbose level is useful for providing needed debugging informa‐
858       tion  to  the email address below.  For example, TRACE output shows all
859       of the values sent to and received from the radio which is very  useful
860       for  radio  backend library development and may be requested by the de‐
861       velopers.
862

EXIT STATUS

864       rigctl exits with:
865
866       0      if all operations completed normally;
867
868       1      if there was an invalid command line option or argument;
869
870       2      if an error was returned by Hamlib.
871

EXAMPLES

873       Start rigctl for a Yaesu FT-920 using a USB to serial adapter on  Linux
874       in interactive mode:
875
876           $ rigctl -m 1014 -r /dev/ttyUSB1
877
878       Start rigctl for a Yaesu FT-920 using COM1 on MS Windows while generat‐
879       ing TRACE output to stderr:
880
881           > rigctl -m 1014 -r COM1 -vvvvv
882
883       Start rigctl for a Yaesu FT-920 using a USB  to  serial  adapter  while
884       setting baud rate and stop bits:
885
886           $ rigctl -m 1014 -r /dev/ttyUSB1 -s 4800 -C stop_bits=2
887
888       Start  rigctl  for  an  Elecraft K3 using a USB to serial adapter while
889       specifying a command terminator for the w command:
890
891           $ rigctl -m 2029 -r /dev/ttyUSB0 -t';'
892
893       Connect to a running rigctld with radio model 2 (“NET rigctl”)  on  the
894       local host and specifying the TCP port, setting frequency and mode:
895
896           $ rigctl -m 2 -r localhost:4532 F 7253500 M LSB 0
897

BUGS

899       set_chan has no entry method as of yet, hence left unimplemented.
900
901       This almost empty section...
902
903       Report bugs to:
904
905              Hamlib Developer mailing list
906              ⟨hamlib-developer@lists.sourceforge.net⟩
907

COPYING

909       This  file  is part of Hamlib, a project to develop a library that sim‐
910       plifies radio, rotator, and amplifier control functions for  developers
911       of  software  primarily  of interest to radio amateurs and those inter‐
912       ested in radio communications.
913
914       Copyright © 2000-2011 Stephane Fillod
915       Copyright © 2000-2018 the Hamlib Group (various contributors)
916       Copyright © 2010-2020 Nate Bargmann
917
918       This is free software; see the file  COPYING  for  copying  conditions.
919       There  is  NO  warranty;  not even for MERCHANTABILITY or FITNESS FOR A
920       PARTICULAR PURPOSE.
921

SEE ALSO

923       less(1), more(1), rigctld(1), hamlib(7)
924

COLOPHON

926       Links to the Hamlib Wiki, Git repository, release archives,  and  daily
927       snapshot archives are available via hamlib.org ⟨http://www.hamlib.org⟩.
928
929
930
931Hamlib                            2020-09-09                         RIGCTL(1)
Impressum