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

NAME

6       rigswr - measure VSWR vs frequency.
7

SYNOPSIS

9       rigswr [-hvV] [-m id] [-r device] [-s baud] [-c id] [-C parm=val]
10              [-p device] [-P type] start_freq stop_freq [freq_step]
11
12

DESCRIPTION

14       rigswr uses Hamlib to control a radio to measure VSWR (Voltage Standing
15       Wave Ratio) over a frequency range.
16
17       It scans frequencies from start_freq to stop_freq with an optional
18       increment of freq_step (default step is 100 kHz).  All values must be
19       entered as an integer in Hertz (cycles per second).
20
21       Note: rigswr assumes that start_freq is less than or equal to
22       stop_freq.  If it is greater, rigswr will exit without doing anything.
23
24       For each frequency, it transmits at 25% of total POWER during 0.5
25       second in CW mode and reads VSWR.
26
27       Frequency and the corresponding VSWR are then printed on stdout.
28
29       To work correctly, rigswr needs a radio that can measure VSWR and a
30       Hamlib backend that supports reading VSWR from the radio.
31
32       Keep in mind that Hamlib is BETA level software.  While a lot of
33       backend libraries lack complete radio support, the basic functions are
34       usually well supported.
35
36       Please report bugs and provide feedback at the e-mail address given in
37       the BUGS section below.  Patches and code enhancements sent to the same
38       address are welcome.
39

OPTIONS

41       This program follows the usual GNU command line syntax.  Short options
42       that take an argument may have the value follow immediately or be
43       separated by a space.  Long options starting with two dashes (‘-’)
44       require an ‘=’ between the option and any argument.
45
46       Here is a summary of the supported options:
47
48       -m, --model=id
49              Select radio model number.
50
51              See model list (use “rigctl -l”).
52
53       -r, --rig-file=device
54              Use device as the file name of the port connected to the radio.
55
56              Often a serial port, but could be a USB to serial adapter.
57              Typically /dev/ttyS0, /dev/ttyS1, /dev/ttyUSB0, etc. on Linux,
58              COM1, COM2, etc. on MS Windows.  The BSD flavors and Mac OS/X
59              have their own designations.  See your system's documentation.
60
61       -s, --serial-speed=baud
62              Set radio serial speed to baud rate.
63
64              Uses maximum serial speed from radio backend capabilities as the
65              default.
66
67       -c, --civaddr=id
68              Use id as the CI-V address to communicate with the radio.
69
70              Only useful for Icom and some Ten-Tec radios.
71
72              Note: The id is in decimal notation, unless prefixed by 0x, in
73              which case it is hexadecimal.
74
75       -C, --set-conf=parm=val[,parm=val]
76              Set radio configuration parameter(s),  e.g.  stop_bits=2.
77
78              Use the -L option of rigctl for a list of configuration
79              parameters for a given model number.
80
81       -p, --ptt-file=device
82              Use device as the file name of the Push-To-Talk port using a
83              device file as with the -r option above.
84
85              This is only needed if the radio doesn't have CAT PTT control
86              and requires a separate device port to key the transmitter.
87
88       -P, --ptt-type=type
89              Use type of Push-To-Talk device.
90
91              Supported types are RIG (CAT), DTR, RTS, PARALLEL, NONE.
92
93       -v, --verbose
94              Set verbose mode, cumulative (see DIAGNOSTICS below).
95
96       -h, --help
97              Show a summary of these options and exit.
98
99       -V, --version
100              Show version of rigswr and exit.
101
102       Note: Some options may not be implemented by a given backend and will
103       return an error.  This is most likely to occur with the --set-conf
104       option.
105

DIAGNOSTICS

107       The -v, --verbose option allows different levels of diagnostics to be
108       output to stderr and correspond to -v for BUG, -vv for ERR, -vvv for
109       WARN, -vvvv for VERBOSE, or -vvvvv for TRACE.
110
111       A given verbose level is useful for providing needed debugging
112       information to the email address below.  For example, TRACE output
113       shows all of the values sent to and received from the radio which is
114       very useful for radio backend library development and may be requested
115       by the developers.
116

EXIT STATUS

118       rigswr exits with:
119
120       0      if all operations completed normally;
121
122       1      if there was an invalid command line option or argument;
123
124       2      if an error was returned by Hamlib;
125
126       3      if the rig doesn't have the required capabilities.
127

EXAMPLE

129       Scans frequencies between 14.000 MHz and 14.200 MHz with 50 kHz step on
130       a TS-850 and records VSWR measurements in file cswr (typed text shown
131       in bold):
132
133           $ rigswr -m 2009 -r /dev/ttyS1 14000000 14200000 50000 > cswr
134
135       After completion, cswr contains the following lines:
136
137           14000000 1.50
138           14050000 1.31
139           14100000 1.22
140           14150000 1.07
141           14200000 1.07
142
143       The result can be plotted with gnuplot(1):
144
145           $ gnuplot
146           set data style linespoints
147           set grid
148           plot cswr
149

BUGS

151       Depending on keyer/QSK setup, transmissions in CW mode may not be modu‐
152       lated thus possibly giving a wrong result. Please report this situation
153       if it happens.
154
155       Report bugs to:
156
157              Hamlib Developer mailing list
158              ⟨hamlib-developer@lists.sourceforge.net⟩
159

COPYING

161       This file is part of Hamlib, a project to develop a library that sim‐
162       plifies radio, rotator, and amplifier control functions for developers
163       of software primarily of interest to radio amateurs and those inter‐
164       ested in radio communications.
165
166       Copyright © 2004 Thierry Leconte
167       Copyright © 2004-2011 Stephane Fillod
168       Copyright © 2007,2018-2020 Nate Bargmann
169
170       This is free software; see the file COPYING for copying conditions.
171       There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A
172       PARTICULAR PURPOSE.
173

SEE ALSO

175       gnuplot(1), rigctl(1), hamlib(7)
176

COLOPHON

178       Links to the Hamlib Wiki, Git repository, release archives, and daily
179       snapshot archives are available via hamlib.org ⟨http://www.hamlib.org⟩.
180
181
182
183Hamlib                            2020-09-09                         RIGSWR(1)
Impressum