1RIGCTLCOM(1) Hamlib Utilities RIGCTLCOM(1)
2
6 rigctlcom - COM port passthru as TS-2000 emulator to your rig
7
9 rigctlcom [-hlLuV] [-m id] [-r device] [-R device] [-p device]
10 [-d device] [-P type] [-D type] [-s baud] [-S baud] [-c id]
11 [-C parm=val] [-v[-Z]]
12
14 Allows programs which can connect to TS-2000 via COM port to use Hamlib
15 radios. Multiple programs can connect to the radio via FLRig or
16 rigctld.
17 Virtual serial/COM ports must be set up first using socat(1) or similar
19 on POSIX systems (BSD, Linux, OS/X). On Microsoft Windows available
20 utilities are com0com ⟨http://com0com.sourceforge.net⟩, Free Virtual
21 Serial Ports ⟨https://freevirtualserialports.com⟩, or VPSD
22 ⟨http://www.virtualserialportdriver.com/⟩.
23 Please report bugs and provide feedback at the e-mail address given in
25 the BUGS section below. Patches and code enhancements sent to the same
26 address are welcome.
27
29 This program follows the usual GNU command line syntax. Short options
30 that take an argument may have the value follow immediately or be sepa‐
31 rated by a space. Long options starting with two dashes (‘-’) require
32 an ‘=’ between the option and any argument.
33 Here is a summary of the supported options:
35 -m, --model=id
37 Select radio model number.
38 See model list (use “rigctlcom -l”).
40 Note: rigctlcom (or third party software using the C API) will
42 use radio model 2 for NET rigctl (communicating with rigctld).
43 -r, --rig-file=device
45 Use device as the file name of the port connected to the radio.
46 Often a serial port, but could be a USB to serial adapter. Typ‐
48 ically /dev/ttyS0, /dev/ttyS1, /dev/ttyUSB0, etc. on Linux,
49 COM1, COM2, etc. on MS Windows. The BSD flavors and Mac OS/X
50 have their own designations. See your system's documentation.
51 The special string “uh-rig” may be given to enable micro-ham
53 device support.
54 -R, --rig-file2=device
56 Use device as the file name of one of the virtual com ports --
57 your program will connect to the other com port of the virtual
58 pair.
59 Virtual serial ports on POSIX systems can be done with socat(1):
61 $ socat -d -d pty,raw,echo=0 pty,raw,echo=0
63 See this Stackoverflow answer for using socat
65 ⟨https://stackoverflow.com/a/19733677⟩.
66 On Microsoft Windows available utilities are com0com, Free Vir‐
68 tual Serial Ports, or VPSD (see DESCRIPTION above for WWW
69 links).
70 -p, --ptt-file=device
72 Use device as the file name of the Push-To-Talk device using a
73 device file as described above.
74 -d, --dcd-file=device
76 Use device as the file name of the Data Carrier Detect device
77 using a device file as described above.
78 -P, --ptt-type=type
80 Use type of Push-To-Talk device.
81 Supported types are ‘RIG’ (CAT command), ‘DTR’, ‘RTS’, ‘PARAL‐
83 LEL’, ‘NONE’, overriding PTT type defined in the rig's backend.
84 Some side effects of this command are that when type is set to
86 DTR, read PTT state comes from the Hamlib frontend, not read
87 from the radio. When set to NONE, PTT state cannot be read or
88 set even if rig backend supports reading/setting PTT status from
89 the rig.
90 -D, --dcd-type=type
92 Use type of Data Carrier Detect device.
93 Supported types are ‘RIG’ (CAT command), ‘DSR’, ‘CTS’, ‘CD’,
95 ‘PARALLEL’, ‘NONE’.
96 -s, --serial-speed=baud
98 Set serial speed to baud rate.
99 Uses maximum serial speed from radio backend capabilities (set
101 by -m above) as the default.
102 -S, --serial-speed2=baud
104 Set serial speed to baud rate for virtual com port (see -R).
105 Uses maximum serial speed from radio backend capabilities (set
107 by -m above) as the default.
108 -c, --civaddr=id
110 Use id as the CI-V address to communicate with the rig.
111 Only useful for Icom and some Ten-Tec rigs.
113 Note: The id is in decimal notation, unless prefixed by 0x, in
115 which case it is hexadecimal.
116 -L, --show-conf
118 List all config parameters for the radio defined with -m above.
119 -C, --set-conf=parm=val[,parm=val]
121 Set radio configuration parameter(s), e.g. stop_bits=2.
122 Use the -L option above for a list of configuration parameters
124 for a given model number.
125 -u, --dump-caps
127 Dump capabilities for the radio defined with -m above and exit.
128 -l, --list
130 List all model numbers defined in Hamlib and exit.
131 The list is sorted by model number.
133 Note: In Linux the list can be scrolled back using Shift-
135 PageUp/Shift-PageDown, or using the scrollbars of a virtual ter‐
136 minal in X or the cmd window in Windows. The output can be
137 piped to more(1) or less(1), e.g. “rigctl -l | more”.
138 -n, --no-restore-ai
140 On exit rigctl restores the state of auto information (AI) on
141 the controlled rig.
142 If this is not desired, for example if you are using rigctl to
144 turn AI mode on or off, pass this option.
145 -v, --verbose
147 Set verbose mode, cumulative (see DIAGNOSTICS below).
148 -Z, --debug-time-stamps
150 Enable time stamps for the debug messages.
151 Use only in combination with the -v option as it generates no
153 output on its own.
154 -h, --help
156 Show a summary of these options and exit.
157 -V, --version
159 Show version of rigctl and exit.
160 Note: Some options may not be implemented by a given backend and will
162 return an error. This is most likely to occur with the --set-conf and
163 --show-conf options.
164
166 The -v, --verbose option allows different levels of diagnostics to be
167 output to stderr and correspond to -v for BUG, -vv for ERR, -vvv for
168 WARN, -vvvv for VERBOSE, or -vvvvv for TRACE.
169 A given verbose level is useful for providing needed debugging informa‐
171 tion to the email address below. For example, TRACE output shows all
172 of the values sent to and received from the radio which is very useful
173 for radio backend library development and may be requested by the
174 developers.
175
177 rigctlcom exits with:
178 0 if all operations completed normally;
180 1 if there was an invalid command line option or argument;
182 2 if an error was returned by Hamlib.
184
186 Start rigctlcom with FLRig as the Hamlib model and virtual com port
187 pair COM9/COM10, e.g. N1MM Logger+ ⟨http://n1mm.hamdocs.com⟩ attaching
188 to COM10 and using the TS-2000 emulator attached to COM9 (assumes vir‐
189 tual serial/COM ports pipe has been created with the proper utility as
190 described above):
191 $ rigctlcom -m 4 -R COM9 -S 115200
193 The following diagram shows the communications flow that allows N1MM
195 Logger+ to communicate with a radio connected to Flrig:
196 Flrig -><- rigctlcom -> COM9 <- virt_port_pipe -> COM10 <- N1MM
198
200 Report bugs to:
201 Hamlib Developer mailing list
203 ⟨hamlib-developer@lists.sourceforge.net⟩
204
206 This file is part of Hamlib, a project to develop a library that sim‐
207 plifies radio, rotator, and amplifier control functions for developers
208 of software primarily of interest to radio amateurs and those inter‐
209 ested in radio communications.
210 Copyright © 2000-2011 Stephane Fillod
212 Copyright © 2000-2018 the Hamlib Group (various contributors)
213 Copyright © 2010-2020 Nate Bargmann
214 Copyright © 2019 Michael Black W9MDB
215 This is free software; see the file COPYING for copying conditions.
217 There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A
218 PARTICULAR PURPOSE.
219
221 rigctld(1), rigctl(1), socat(1), hamlib(7)
222
224 Links to the Hamlib Wiki, Git repository, release archives, and daily
225 snapshot archives are available via hamlib.org ⟨http://www.hamlib.org⟩.
226Hamlib 2020-09-09 RIGCTLCOM(1)