rigswr(1)

1RIGSWR(1)                 Radio SWR Measurement Tool                 RIGSWR(1)
2
3
4

NAME

6       rigswr - measure VSWR vs frequency using Hamlib.
7

SYNOPSIS

9       rigswr [OPTION]... start_freq stop_freq [freq_step]
10

DESCRIPTION

12       rigswr uses Hamlib to control a rig to measure VSWR vs frequency:
13       It  scans  frequencies  from  start_freq  to  stop_freq  with a step of
14       freq_step. For each frequency, it transmits at 25% of total POWER  dur‐
15       ing 0.5 second in CW mode and reads VSWR.
16
17       Frequency and the corresponding VSWR are then printed on stdout.
18
19       To  work correctly, rigswr needs a rig that can measure VSWR and a Ham‐
20       lib backend that supports reading VSWR from the rig.
21
22       Keep in mind that Hamlib is BETA level software.  While a lot of  back‐
23       end  libraries  lack complete rig support, the basic functions are usu‐
24       ally well supported.  The API may  change  without  publicized  notice,
25       while  an  advancement of the minor version (e.g. 1.1.x to 1.2.x) indi‐
26       cates such a change.
27
28       Please report bugs and provide feedback at the e-mail address given  in
29       the  REPORTING  BUGS  section.   Patches and code enhancements are also
30       welcome.
31

OPTIONS

33       This program follows the usual  GNU  command  line  syntax,  with  long
34       options starting with two dashes (`-').
35
36       Here is a summary of the supported options:
37
38       -m, --model=id
39              Select radio model number. See model list (use 'rigctl -l').
40              NB:  rigswr  (or  third  party software) will use rig model 1901
41              when using rpc.rigd.
42
43       -r, --rig-file=device
44              Use device as the file name of the port the radio is  connected.
45              Often a serial port, but could be a USB to serial adapter.  Typ‐
46              ically /dev/ttyS0, /dev/ttyS1, /dev/ttyUSB0, etc.
47
48       -s, --serial-speed=baud
49              Set serial speed to baud rate. Uses maximum  serial  speed  from
50              rig backend capabilities as the default.
51
52       -c, --civaddr=id
53              Use  id  as  the  CI-V address to communicate with the rig. Only
54              useful for Icom rigs.
55              NB: the id is in decimal notation, unless  prefixed  by  0x,  in
56              which case it is hexadecimal.
57
58       -p, --ptt-file=device
59              Use  device  as the file name of the Push-To-Talk device using a
60              device file as described above.
61              This is only needed if the radio doesn't have  legacy  PTT  con‐
62              trol.
63
64       -p, --ptt-type=type
65              Use  type of Push-To-Talk device.  Supported types are RIG, DTR,
66              RTS, PARALLEL, NONE.
67              This is only needed if the radio doesn't have  legacy  PTT  con‐
68              trol.
69
70       -C, --set-conf=parm=val[,parm=val]*
71              Set config parameter.  e.g. stop_bits=2
72              Use -L option of rigctl for a list.
73
74       -v, --verbose
75              Set verbose mode, cumulative (see DIAGNOSTICS below).
76
77       -h, --help
78              Show summary of these options and exit.
79
80       -V, --version
81              Show version of rigswr and exit.
82
83       NOTE!  Some  options may not be implemented by a given backend and will
84       return an error.  This is most likely  to  occur  with  the  --set-conf
85       option.
86

EXAMPLE

88       rigswr -m 209 -r /dev/ttyS1 14000000 14290000 50000 > cswr
89
90       Scans frequencies between 14.000 MHz and 14.200 MHz with 50 kHz step on
91       a TS-850 and records VSWR measurements in file cswr.
92
93       After completion, cswr file contains the following lines:
94         14000000 1.50
95         14050000 1.31
96         14100000 1.22
97         14150000 1.07
98         14200000 1.07
99
100       Result could then be plotted with gnuplot:
101              gnuplot
102              set data style linespoints
103              set grid
104              plot "cswr"
105

DIAGNOSTICS

107       The -v, --version 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 informa‐
112       tion  to  the email address below.  For example, TRACE output shows all
113       of the values sent to and received from the radio which is very  useful
114       for  radio  backend  library  development  and  may be requested by the
115       developers.
116

EXIT STATUS

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

BUGS

125       Depending on keyer/QSK setup, transmissions in CW mode may not be modu‐
126       lated thus possibly giving a wrong result. Please report this situation
127       if it happens.
128

REPORTING BUGS

130       Report bugs to <hamlib-developer@lists.sourceforge.net>.
131       We are already aware of the bug in the previous section :-)
132

AUTHORS

134       Written by Thierry Leconte, Stephane Fillod, and the Hamlib Group
135       <http://www.hamlib.org>.
136

COPYRIGHT

138       Copyright © 2004-2009 Thierry Leconte, Stephane Fillod, and the  Hamlib
139       Group.
140       This is free software; see the source for copying conditions.  There is
141       NO warranty; not even for MERCHANTABILITY or FITNESS FOR  A  PARTICULAR
142       PURPOSE.
143