.\" Hey, EMACS: -*- nroff -*- .\" .\" For layout and available macros, see man(7), man-pages(7), groff_man(7) .\" Please adjust the date whenever revising the manpage. .\" .\" Note: Please keep this page in sync with the source, rotctl.c .\" .TH ROTCTL "1" "2018-04-29" "Hamlib" "Hamlib Utilities" . . .SH NAME . rotctl \- control antenna rotators . . .SH SYNOPSIS . .SY rotctl .OP \-hiIlLuV .OP \-m id .OP \-r device .OP \-s baud .OP \-t char .OP \-C parm=val .RB [ \-v [ \-Z ]] .RB [ command | \- ] .YS . . .SH DESCRIPTION . Control antenna rotators. . .PP .B rotctl accepts .I commands from the command line as well as in interactive mode if none are provided on the command line. . .PP Keep in mind that Hamlib is BETA level software. While a lot of backend libraries lack complete rotator support, the basic functions are usually well supported. . .PP Please report bugs and provide feedback at the e-mail address given in the .B BUGS section below. Patches and code enhancements sent to the same address are welcome. . . .SH OPTIONS . This program follows the usual GNU command line syntax. Short options that take an argument may have the value follow immediately or be separated by a space. Long options starting with two dashes (\(oq\-\(cq) require an \(oq=\(cq between the option and any argument. . .PP Here is a summary of the supported options: . .TP .BR \-m ", " \-\-model = \fIid\fP Select rotator model number. .IP See model list (use \(lqrotctl -l\(rq). .IP .BR Note : .B rotctl (or third party software using the C API) will use rotator model 2 for .B NET rotctl (communicating with .BR rotctld ). . .TP .BR \-r ", " \-\-rot\-file = \fIdevice\fP Use .I device as the file name of the port connected to the rotator. .IP Often a serial port, but could be a USB to serial adapter. Typically .IR /dev/ttyS0 ", " /dev/ttyS1 ", " /dev/ttyUSB0 , etc. on Linux, .IR COM1 ", " COM2 , etc. on MS Windows. The BSD flavors and Mac OS/X have their own designations. See your system's documentation. . .TP .BR \-s ", " \-\-serial\-speed = \fIbaud\fP Set serial speed to .I baud rate. .IP Uses maximum serial speed from rotator backend capabilities as the default. . .TP .BR \-t ", " \-\-send\-cmd\-term = \fIchar\fP Change the termination .I char for text protocol when using the .B send_cmd command. .IP The default value is ASCII CR (\(oq0x0D\(cq). ASCII non-printing characters can be given as the ASCII number in hexadecimal format prepended with \(lq0x\(rq. You may pass an empty string for no termination char. The string \(lq\-1\(rq tells .B rotctl to switch to binary protocol. See the .B send_cmd command for further explanation. .IP .BR Note : The semicolon (\(oq;\(cq) is a common terminator for rotators that accept ASCII character strings. . .TP .BR \-L ", " \-\-show\-conf List all configuration parameters for the rotator defined with .B \-m above. . .TP .BR \-C ", " \-\-set\-conf = \fIparm=val\fP [ \fI,parm=val\fP ] Set rotator configuration parameter(s), e.g. .IR stop_bits=2 . .IP Use the .B -L option above for a list of configuration parameters for a given model number. . .TP .BR \-u ", " \-\-dump\-caps Dump capabilities for the rotator defined with .B -m above and exit. . .TP .BR \-l ", " \-\-list List all rotator model numbers defined in .B Hamlib and exit. .IP The list is sorted by model number. .IP .BR Note : In Linux the list can be scrolled back using .BR Shift-PageUp / Shift-PageDown , or using the scrollbars of a virtual terminal in X or the cmd window in Windows. The output can be piped to .BR more (1) or .BR less (1), e.g. \(lqrotctl -l | more\(rq. . .TP .BR \-i ", " \-\-read\-history Read previously saved command and argument history from a file (default .IR $HOME/.rotctl_history ) for the current session. .IP Available when .B rotctl is built with Readline support (see .B READLINE below). .IP .BR Note : To read a history file stored in another directory, set the .B ROTCTL_HIST_DIR environment variable, e.g. \(lqROTCTL_HIST_DIR=$HOME/tmp rotctl -i\(rq. When ROTCTL_HIST_DIR is not set, the value of .B HOME is used. . .TP .BR \-I ", " \-\-save\-history Write current session (and any previous session(s), if .B -i option is also given) command and argument history to a file (default .IR $HOME/.rotctl_history ) at the end of the current session. .IP Complete commands with arguments are saved as a single line to be recalled and used or edited. Available when .B rotctl is built with Readline support (see .B READLINE below). .IP .BR Note : To write a history file in another directory, set the .B ROTCTL_HIST_DIR environment variable, e.g. \(lqROTCTL_HIST_DIR=$HOME/tmp rotctl -I\(rq. When ROTCTL_HIST_DIR is not set, the value of .B HOME is used. . .TP .BR \-v ", " \-\-verbose Set verbose mode, cumulative (see .B DIAGNOSTICS below). . .TP .BR \-Z ", " \-\-debug\-time\-stamps Enable time stamps for the debug messages. .IP Use only in combination with the .B -v option as it generates no output on its own. . .TP .BR \-h ", " \-\-help Show a summary of these options and exit. . .TP .BR \-V ", " \-\-version Show version of .B rotctl and exit. . .TP .B \- Stop option processing and read commands from standard input. .IP See .B Standard Input below. . .PP .BR Note : Some options may not be implemented by a given backend and will return an error. This is most likely to occur with the .B \-\-set\-conf and .B \-\-show\-conf options. . .PP Be aware that the backend for the rotator to be controlled, or the rotator itself may not support some commands. In that case, the operation will fail with a .B Hamlib error code. . . .SH COMMANDS . Commands can be entered either as a single char, or as a long command name. The commands are not prefixed with a dash as the options are. They may be typed in when in interactive mode or provided as argument(s) in command line interface mode. In interactive mode commands and their arguments may be entered on a single line: . .sp .RS 0.5i .EX P 123 45 .EE .RE . .PP Since most of the .B Hamlib operations have a .BR set " and a " get method, an upper case letter will often be used for a .B set method whereas the corresponding lower case letter refers to the .B get method. Each operation also has a long name; in interactive mode, prepend a backslash, \(oq\\\(cq, to enter a long command name. . .PP Example: Use \(lq\\get_info\(rq in interactive mode to see the rotator's information. . .PP .BR Note : The backend for the rotator to be controlled, or the rotator itself may not support some commands. In that case, the operation will fail with a .B Hamlib error message. . . .SS Standard Input . As an alternative to the .B READLINE interactive command entry or a single command for each run, .B rotctl features a special option where a single dash (\(oq\-\(cq) may be used to read commands from standard input .RB ( stdin ). Commands must be separated by whitespace similar to the commands given on the command line. Comments may be added using the \(oq#\(cq character, all text up until the end of the current line including the \(oq#\(cq character is ignored. . .PP A simple example: . .sp .RS 0.5i .EX $ cat <<.EOF. >cmds.txt > # File of commands > set_pos 180.0 10.0 # rotate > pause 30 # wait for action to complete > get_pos # query rotator > .EOF. $ rotctl -m 1 -