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

NAME

6       rigsmtr - measure S-Meter vs azimuth using Hamlib
7

SYNOPSIS

9       rigsmtr [-hvV] [-m id] [-r device] [-s baud] [-c id] [-C parm=val]
10               [-M id] [-R device] [-S baud] [-N parm=val] [time_step]
11

DESCRIPTION

13       rigsmtr uses Hamlib to control a radio to measure S-Meter value  versus
14       antenna azimuth.
15
16       It  rotates the antenna from minimum azimuth to maximum azimuth.  Every
17       second, or time_step if specified in seconds, it retrieves  the  signal
18       strength.  Azimuth in degrees and the corresponding S-Meter level in dB
19       relative to S9 are then printed on stdout.
20
21       To work correctly, rigsmtr needs a radio that could measure S-Meter and
22       a  Hamlib  backend  that  is able to retrieve it, connected to a Hamlib
23       supported rotator.
24
25       Keep in mind that Hamlib is BETA level software.  While a lot of  back‐
26       end libraries lack complete radio support, the basic functions are usu‐
27       ally well supported.
28
29       Please report bugs and provide feedback at the e-mail address given  in
30       the BUGS section below.  Patches and code enhancements sent to the same
31       address are welcome.
32

OPTIONS

34       This program follows the usual GNU command line syntax.  Short  options
35       that take an argument may have the value follow immediately or be sepa‐
36       rated by a space.  Long options starting with two dashes (‘-’)  require
37       an ‘=’ between the option and any argument.
38
39       Here is a summary of the supported options.
40
41       -m, --model=id
42              Select radio model number.
43
44              See model list (use “rigctl -l”).
45
46       -r, --rig-file=device
47              Use device as the file name of the port connected to the radio.
48
49              Often a serial port, but could be a USB to serial adapter.  Typ‐
50              ically /dev/ttyS0,  /dev/ttyS1,  /dev/ttyUSB0,  etc.  on  Linux,
51              COM1,  COM2,  etc.  on MS Windows.  The BSD flavors and Mac OS/X
52              have their own designations.  See your system's documentation.
53
54       -s, --serial-speed=baud
55              Set radio serial speed to baud rate.
56
57              Uses maximum serial speed from radio backend capabilities as the
58              default.
59
60       -c, --civaddr=id
61              Use id as the CI-V address to communicate with the radio.
62
63              Only useful for Icom and some Ten-Tec radios.
64
65              Note:  The  id is in decimal notation, unless prefixed by 0x, in
66              which case it is hexadecimal.
67
68       -C, --set-conf=parm=val[,parm=val]
69              Set radio configuration parameter(s),  e.g.  stop_bits=2.
70
71              Use the -L option of rigctl for a list of configuration  parame‐
72              ters for a given model number.
73
74       -M, --rot-model=id
75              Select rotator model number.
76
77              See model list (use “rotctl -l”).
78
79       -R, --rot-file=device
80              Use  device  as the file name of the port connected to the rota‐
81              tor.
82
83              Often a serial port, but could be a USB to serial adapter.  Typ‐
84              ically  /dev/ttyS0,  /dev/ttyS1,  /dev/ttyUSB0,  etc.  on Linux,
85              COM1, COM2, etc. on MS Windows.  The BSD flavors  and  Mac  OS/X
86              have their own designations.  See your system's documentation.
87
88       -S, --rot-serial-speed=baud
89              Set rotator serial speed to baud rate.
90
91              Uses  maximum  serial speed from rotator backend capabilities as
92              the default.
93
94       -N, --rot-set-conf=parm=val[,parm=val]
95              Set rotator configuration parameter(s),  e.g.  stop_bits=2.
96
97              Use the -L option of rotctl for a list of configuration  parame‐
98              ters for a given model number.
99
100       -v, --verbose
101              Set verbose mode, cumulative (see DIAGNOSTICS below).
102
103       -h, --help
104              Show a summary of these options and exit.
105
106       -V, --version
107              Show version of rigsmtr and exit.
108
109       Note:  Some  options may not be implemented by a given backend and will
110       return an error.  This is most likely to occur with the --set-conf  and
111       --rot-set-conf options.
112

DIAGNOSTICS

114       The  -v,  --verbose option allows different levels of diagnostics to be
115       output to stderr and correspond to -v for BUG, -vv for  ERR,  -vvv  for
116       WARN, -vvvv for VERBOSE, or -vvvvv for TRACE.
117
118       A given verbose level is useful for providing needed debugging informa‐
119       tion to the email address below.  For example, TRACE output  shows  all
120       of  the values sent to and received from the radio which is very useful
121       for radio backend library development  and  may  be  requested  by  the
122       developers.
123

EXIT STATUS

125       rigsmtr exits with:
126
127       0      if all operations completed normally;
128
129       1      if there was an invalid command line option or argument;
130
131       2      if an error was returned by Hamlib;
132
133       3      if the radio doesn't have the required capabilities.
134

EXAMPLE

136       Collect  S-Meter readings on a TS-850 while an EasycommII rotator makes
137       a full 360° rotation and record measurements in the file csmtr:
138
139            rigsmtr -m 209 -r /dev/ttyS1 -M 202 > csmtr
140
141       After completion the file csmtr contains lines such as:
142
143            0 -47
144            30 -40
145            60 -22
146            90 -3
147            120 10
148            150 1
149            180 -11
150            210 -24
151            240 -35
152            270 -42
153            300 -48
154            330 -51
155            360 -49
156
157       The results can be plotted with gnuplot(1):
158
159            gnuplot
160            set angles degrees
161            set polar
162            set grid polar 15.
163            unset border
164            unset param
165            set style data line
166            set rrange [-60:60]
167            set xrange [-60:60]
168            set yrange [-60:60]
169            plot csmtr
170

BUGS

172       Report bugs to:
173
174              Hamlib Developer mailing list
175              ⟨hamlib-developer@lists.sourceforge.net⟩
176

COPYING

178       This file is part of Hamlib, a project to develop a library  that  sim‐
179       plifies  radio and rotator control functions for developers of software
180       primarily of interest to radio amateurs and those interested  in  radio
181       communications.
182
183       Copyright © 2007-2009 Stephane Fillod
184       Copyright © 2018 Nate Bargmann
185
186       This  is  free  software;  see the file COPYING for copying conditions.
187       There is NO warranty; not even for MERCHANTABILITY  or  FITNESS  FOR  A
188       PARTICULAR PURPOSE.
189

SEE ALSO

191       gnuplot(1), rigctl(1), rotctl(1), hamlib(7)
192

COLOPHON

194       Links  to  the Hamlib Wiki, Git repository, release archives, and daily
195       snapshot archives:
196
197              hamlib.org ⟨http://www.hamlib.org⟩.
198
199
200
201Hamlib                            2018-04-29                        RIGSMTR(1)
Impressum