rotctl(1)

1ROTCTL(1)                   Rotator Control Program                  ROTCTL(1)
2
3
4

NAME

6       rotctl - control antenna rotators
7

SYNOPSIS

9       rotctl [OPTION]... [COMMAND]...
10

DESCRIPTION

12       Control  antenna  rotators.   rotctl  accepts commands from the command
13       line as well as in interactive mode if none are provided on the command
14       line.
15
16       Keep  in mind that Hamlib is BETA level software.  While a lot of back‐
17       end libraries lack complete rig support, the basic functions  are  usu‐
18       ally  well  supported.   The  API may change without publicized notice,
19       while an advancement of the minor version (e.g. 1.1.x to  1.2.x)  indi‐
20       cates such a change.
21
22       Please  report bugs and provide feedback at the e-mail address given in
23       the REPORTING BUGS section.  Patches and  code  enhancements  are  also
24       welcome.
25

OPTIONS

27       This  program  follows  the  usual  GNU  command line syntax, with long
28       options starting with two dashes (`-').
29
30       Here is s summary of the supported options:
31
32       -m, --model=id
33              Select rotator model number. See model list (use 'rotctl -l').
34
35       -r, --rot-file=device
36              Use device as the file name of the  port  the  rotator  is  con‐
37              nected.   Often  a  serial  port,  but  could be a USB to serial
38              adapter.  Typically /dev/ttyS0, /dev/ttyS1, /dev/ttyUSB0, etc.
39              Default is /dev/rotator (may be a symbolic link  to  the  actual
40              device).
41
42       -s, --serial-speed=baud
43              Set  serial  speed  to baud rate. Uses maximum serial speed from
44              rotator backend capabilites as default.
45
46       -L, --show-conf
47              List all config parameters for the rotor defined with -m above.
48
49       -C, --set-conf=parm=val[,parm=val]*
50              Set config parameter.  e.g. stop_bits=2
51              Use -L option for a list.
52
53       -l, --list
54              List all model numbers defined in Hamlib and exit.
55
56       -v, --verbose
57              Set verbose mode, cumulative (see DIAGNOSTICS below).
58
59       -h, --help
60              Show summary of these options and exit.
61
62       -V, --version
63              Show version of rotctl and exit.
64
65       NOTE! Some options may not be implemented by a given backend  and  will
66       return  an error.  This is most likely to occur with the --set-conf and
67       --show-conf options.
68

COMMANDS

70       Commands can be entered either as a single char, or as a  long  command
71       name.   Basically, the commands do not take a dash in front of them, as
72       the options do. They may be typed in when in interactive mode  or  pro‐
73       vided as argument(s) in command line interface mode.
74
75       Since  most  of  the  Hamlib operations have a set and a get method, an
76       upper case letter will be used for set method whereas the corresponding
77       lower  case  letter  refers  to  the  get  method. In interactive mode,
78       prepend a backslash to enter a long command name.
79       Example: Use "\get_info" to see the rotor's info.
80
81       Please note that the backend for the rotator to be controlled,  or  the
82       rotator  itself may not support some commands. In that case, the opera‐
83       tion will fail with a Hamlib error message.
84
85       A summary of commands is included below.
86
87       P, set_pos
88              Set position: azimuth and elevation.
89
90       p, get_pos
91              Get position: azimuth and elevation.
92
93       K, park
94              Park the antenna.
95
96       S, stop
97              Stop the rotator.
98
99       R, reset
100              Reset the rotator.
101
102       M, move
103              Move the rotator in a specific direction.
104
105       C, set_conf
106              Set a configuration parameter.  It is safe  to  give  "Token"  a
107              value  of  '0' (zero).  "Value" may be a string up to 20 charac‐
108              ters.
109              See -L output
110
111       _, get_info
112              Get misc information on the rotator.
113

EXAMPLES

115       Start rotctl for RotorEZ using COM1:
116
117       $ rotctl -m 401 -r /dev/ttyS0
118
119       Start rotctl using rpc.rotd:
120
121       $ rotctl -m 101
122

DIAGNOSTICS

124       The -v, --version option allows different levels of diagnostics  to  be
125       output  to  stderr  and correspond to -v for BUG, -vv for ERR, -vvv for
126       WARN, -vvvv for VERBOSE, or -vvvvv for TRACE.
127
128       A given verbose level is useful for providing needed debugging informa‐
129       tion  to  the email address below.  For example, TRACE output shows all
130       of the values sent to and received from the radio which is very  useful
131       for  radio  backend  library  development  and  may be requested by the
132       developers.
133

EXIT STATUS

135       rotctl exits with:
136       0 if all operations completed normally;
137       1 if there was an invalid command line option or argument;
138       2 if an error was returned by Hamlib.
139

BUGS

141       This suspiciously empty section...
142

REPORTING BUGS

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

AUTHOR

148       Written by Stephane Fillod and the Hamlib Group
149       <http://www.hamlib.org>.
150

COPYRIGHT

152       Copyright © 2000-2007 Stephane Fillod and the Hamlib Group.
153       This is free software; see the source for copying conditions.  There is
154       NO  warranty;  not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
155       PURPOSE.
156