2001-12-28 20:34:30 +00:00
|
|
|
.\" Hey, EMACS: -*- nroff -*-
|
|
|
|
.\" First parameter, NAME, should be all caps
|
|
|
|
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
|
|
|
|
.\" other parameters are allowed: see man(7), man(1)
|
2009-01-04 14:49:17 +00:00
|
|
|
.TH ROTCTL "1" "January 4, 2009" "Hamlib" "Rotator Control Program"
|
2001-12-28 20:34:30 +00:00
|
|
|
.\" Please adjust this date whenever revising the manpage.
|
|
|
|
.\"
|
|
|
|
.\" Some roff macros, for reference:
|
|
|
|
.\" .nh disable hyphenation
|
|
|
|
.\" .hy enable hyphenation
|
|
|
|
.\" .ad l left justify
|
|
|
|
.\" .ad b justify to both left and right margins
|
|
|
|
.\" .nf disable filling
|
|
|
|
.\" .fi enable filling
|
|
|
|
.\" .br insert line break
|
|
|
|
.\" .sp <n> insert n+1 empty lines
|
|
|
|
.\" for manpage-specific macros, see man(7)
|
|
|
|
.SH NAME
|
|
|
|
rotctl \- control antenna rotators
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.B rotctl
|
|
|
|
[\fIOPTION\fR]... [\fICOMMAND\fR]...
|
|
|
|
.SH DESCRIPTION
|
|
|
|
Control antenna rotators.
|
2007-02-24 20:24:34 +00:00
|
|
|
\fBrotctl\fP accepts \fIcommands\fP from the command line as well as in
|
|
|
|
interactive mode if none are provided on the command line.
|
2001-12-28 20:34:30 +00:00
|
|
|
.PP
|
|
|
|
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
|
|
|
|
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
|
|
|
|
.\" respectively.
|
2007-02-24 20:24:34 +00:00
|
|
|
Keep in mind that \fBHamlib\fP is BETA level software.
|
|
|
|
While a lot of backend libraries lack complete rig support, the basic functions
|
|
|
|
are usually well supported. The API may change without publicized notice,
|
|
|
|
while an advancement of the minor version (e.g. 1.1.x to 1.2.x) indicates such
|
|
|
|
a change.
|
|
|
|
.PP
|
|
|
|
Please report bugs and provide feedback at the e-mail address given in the
|
|
|
|
REPORTING BUGS section. Patches and code enhancements are also welcome.
|
2001-12-28 20:34:30 +00:00
|
|
|
.SH OPTIONS
|
2003-02-27 03:47:47 +00:00
|
|
|
This program follows the usual GNU command line syntax, with long
|
2001-12-28 20:34:30 +00:00
|
|
|
options starting with two dashes (`-').
|
2007-02-24 20:24:34 +00:00
|
|
|
|
|
|
|
Here is s summary of the supported options:
|
2001-12-28 20:34:30 +00:00
|
|
|
.TP
|
2007-02-24 20:24:34 +00:00
|
|
|
.B \-m, --model=id
|
|
|
|
Select rotator model number. See model list (use 'rotctl -l').
|
2001-12-28 20:34:30 +00:00
|
|
|
.TP
|
|
|
|
.B \-r, --rot-file=device
|
2007-02-24 20:24:34 +00:00
|
|
|
Use \fIdevice\fP as the file name of the port the rotator is connected.
|
|
|
|
Often a serial port, but could be a USB to serial adapter. Typically
|
|
|
|
/dev/ttyS0, /dev/ttyS1, /dev/ttyUSB0, etc.
|
|
|
|
.br
|
|
|
|
Default is \fB/dev/rotator\fP (may be a symbolic link to the actual device).
|
2001-12-28 20:34:30 +00:00
|
|
|
.TP
|
|
|
|
.B \-s, --serial-speed=baud
|
2007-02-24 20:24:34 +00:00
|
|
|
Set serial speed to \fIbaud\fP rate. Uses maximum serial speed from rotator
|
2003-02-27 03:47:47 +00:00
|
|
|
backend capabilites as default.
|
2001-12-28 20:34:30 +00:00
|
|
|
.TP
|
2009-01-04 14:49:17 +00:00
|
|
|
.B \-t, --send-cmd-term=char
|
|
|
|
Change the termination \fIchar\fP for text protocol when using the \fIsend_cmd\fP command.
|
|
|
|
The default value is <CR>. Non ASCII printable characters can be specified as an
|
|
|
|
ASCII number, in hexadecimal format, prepended with 0x. You may pass an empty string
|
|
|
|
for no termination char. The string -1 tells rotctl to switch to binary protocol.
|
|
|
|
See the \fIsend_cmd\fP command for further explanation.
|
|
|
|
.TP
|
2007-02-24 20:24:34 +00:00
|
|
|
.B \-L, --show-conf
|
|
|
|
List all config parameters for the rotor defined with -m above.
|
2001-12-28 20:34:30 +00:00
|
|
|
.TP
|
2007-02-24 20:24:34 +00:00
|
|
|
.B \-C, --set-conf=parm=val[,parm=val]*
|
|
|
|
Set config parameter. e.g. stop_bits=2
|
|
|
|
.br
|
|
|
|
Use -L option for a list.
|
2001-12-28 20:34:30 +00:00
|
|
|
.TP
|
2007-02-24 20:24:34 +00:00
|
|
|
.B \-l, --list
|
|
|
|
List all model numbers defined in \fBHamlib\fP and exit.
|
2001-12-28 20:34:30 +00:00
|
|
|
.TP
|
2007-02-24 20:24:34 +00:00
|
|
|
.B \-v, --verbose
|
|
|
|
Set verbose mode, cumulative (see DIAGNOSTICS below).
|
2001-12-28 20:34:30 +00:00
|
|
|
.TP
|
2007-02-24 20:24:34 +00:00
|
|
|
.B \-h, --help
|
|
|
|
Show summary of these options and exit.
|
2001-12-28 20:34:30 +00:00
|
|
|
.TP
|
|
|
|
.B \-V, \-\-version
|
2007-02-24 20:24:34 +00:00
|
|
|
Show version of \fBrotctl\fP and exit.
|
2003-02-27 03:47:47 +00:00
|
|
|
.PP
|
|
|
|
\fBNOTE!\fP Some options may not be implemented by a given backend and will
|
|
|
|
return an error. This is most likely to occur with the \fI\-\-set-conf\fP
|
|
|
|
and \fI\-\-show-conf\fP options.
|
2001-12-28 20:34:30 +00:00
|
|
|
.SH COMMANDS
|
|
|
|
Commands can be entered either as a single char, or as a long command name.
|
|
|
|
Basically, the commands do not take a dash in front of them, as
|
2007-02-24 20:24:34 +00:00
|
|
|
the options do. They may be typed in when in interactive mode
|
|
|
|
or provided as argument(s) in command line interface mode.
|
|
|
|
.PP
|
|
|
|
Since most of the \fBHamlib\fP operations have a \fIset\fP and a \fIget\fP method,
|
|
|
|
an upper case letter will be used for \fIset\fP method whereas the
|
|
|
|
corresponding lower case letter refers to the \fIget\fP method. In
|
|
|
|
interactive mode, prepend a backslash to enter a long command name.
|
|
|
|
.br
|
|
|
|
Example: Use "\\get_info" to see the rotor's info.
|
2001-12-28 20:34:30 +00:00
|
|
|
.PP
|
|
|
|
Please note that the backend for the rotator to be controlled,
|
|
|
|
or the rotator itself may not support some commands. In that case,
|
2007-02-24 20:24:34 +00:00
|
|
|
the operation will fail with a \fBHamlib\fP error message.
|
2001-12-28 20:34:30 +00:00
|
|
|
.PP
|
|
|
|
A summary of commands is included below.
|
|
|
|
.TP
|
|
|
|
.B P, set_pos
|
|
|
|
Set position: azimuth and elevation.
|
|
|
|
.TP
|
|
|
|
.B p, get_pos
|
|
|
|
Get position: azimuth and elevation.
|
|
|
|
.TP
|
|
|
|
.B K, park
|
|
|
|
Park the antenna.
|
|
|
|
.TP
|
|
|
|
.B S, stop
|
|
|
|
Stop the rotator.
|
|
|
|
.TP
|
|
|
|
.B R, reset
|
|
|
|
Reset the rotator.
|
2002-01-14 07:00:55 +00:00
|
|
|
.TP
|
2002-01-16 17:08:31 +00:00
|
|
|
.B M, move
|
2006-02-26 19:30:49 +00:00
|
|
|
Move the rotator in a specific direction.
|
2002-01-16 17:08:31 +00:00
|
|
|
.TP
|
2003-02-27 03:47:47 +00:00
|
|
|
.B C, set_conf
|
|
|
|
Set a configuration parameter. It is safe to give "Token" a value of '0'
|
|
|
|
(zero). "Value" may be a string up to 20 characters.
|
2007-02-24 20:24:34 +00:00
|
|
|
.br
|
|
|
|
See -L output
|
2003-02-27 03:47:47 +00:00
|
|
|
.TP
|
2002-01-14 07:00:55 +00:00
|
|
|
.B _, get_info
|
|
|
|
Get misc information on the rotator.
|
2009-01-04 14:49:17 +00:00
|
|
|
.TP
|
|
|
|
.B w, send_cmd
|
|
|
|
Send raw command string to the rotator.
|
|
|
|
.br
|
|
|
|
<CR> (or send-cmd-term, see \fI-t\fP option) is appended automatically at the end
|
|
|
|
of the command for text protocols.
|
|
|
|
For binary protocols, enter values as \\0xAA\\0xBB
|
|
|
|
|
2007-02-24 20:24:34 +00:00
|
|
|
.SH EXAMPLES
|
|
|
|
Start \fBrotctl\fP for RotorEZ using COM1:
|
2001-12-28 20:34:30 +00:00
|
|
|
|
2007-02-24 20:24:34 +00:00
|
|
|
$ rotctl -m 401 -r /dev/ttyS0
|
2001-12-28 20:34:30 +00:00
|
|
|
|
2007-02-24 20:24:34 +00:00
|
|
|
Start \fBrotctl\fP using \fBrpc.rotd\fP:
|
|
|
|
|
|
|
|
$ rotctl -m 101
|
|
|
|
.SH DIAGNOSTICS
|
|
|
|
The \fB-v\fP, \fB--version\fP option allows different levels of diagnostics
|
|
|
|
to be output to \fBstderr\fP and correspond to -v for BUG, -vv for ERR,
|
|
|
|
-vvv for WARN, -vvvv for VERBOSE, or -vvvvv for TRACE.
|
|
|
|
|
|
|
|
A given verbose level is useful for providing needed debugging information to
|
|
|
|
the email address below. For example, TRACE output shows all of the values
|
|
|
|
sent to and received from the radio which is very useful for radio backend
|
|
|
|
library development and may be requested by the developers.
|
|
|
|
.SH EXIT STATUS
|
|
|
|
\fBrotctl\fP exits with:
|
|
|
|
.br
|
|
|
|
0 if all operations completed normally;
|
|
|
|
.br
|
|
|
|
1 if there was an invalid command line option or argument;
|
|
|
|
.br
|
|
|
|
2 if an error was returned by \fBHamlib\fP.
|
2001-12-28 20:34:30 +00:00
|
|
|
.SH BUGS
|
|
|
|
.PP
|
2007-02-24 20:24:34 +00:00
|
|
|
This suspiciously empty section...
|
2001-12-28 20:34:30 +00:00
|
|
|
.SH REPORTING BUGS
|
2007-02-24 20:24:34 +00:00
|
|
|
Report bugs to <hamlib-developer@lists.sourceforge.net>.
|
|
|
|
.br
|
|
|
|
We are already aware of the bug in the previous section :-)
|
|
|
|
.SH AUTHOR
|
|
|
|
Written by Stephane Fillod and the Hamlib Group
|
2001-12-28 20:34:30 +00:00
|
|
|
.br
|
2007-02-24 20:24:34 +00:00
|
|
|
<http://www.hamlib.org>.
|
2001-12-28 20:34:30 +00:00
|
|
|
.SH COPYRIGHT
|
2009-01-04 14:49:17 +00:00
|
|
|
Copyright \(co 2000-2009 Stephane Fillod and the Hamlib Group.
|
2001-12-28 20:34:30 +00:00
|
|
|
.br
|
|
|
|
This is free software; see the source for copying conditions.
|
|
|
|
There is NO warranty; not even for MERCHANTABILITY
|
|
|
|
or FITNESS FOR A PARTICULAR PURPOSE.
|
|
|
|
.SH SEE ALSO
|
2007-02-24 20:24:34 +00:00
|
|
|
.BR hamlib (3),
|
|
|
|
.BR rpc.rotd (8)
|
2001-12-28 20:34:30 +00:00
|
|
|
|