kopia lustrzana https://github.com/Hamlib/Hamlib
Add Win32 port usage to man pages.
Nate Bargmann
rodzic
b2b4d312f8
commit
dfc6db399b
|
|
@ -2,7 +2,7 @@
|
|||
.\" 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)
|
||||
.TH RIGCTL "1" "April 14, 2010" "Hamlib" "Radio Control Program"
|
||||
.TH RIGCTL "1" "June 21, 2011" "Hamlib" "Radio Control Program"
|
||||
.\" Please adjust this date whenever revising the manpage.
|
||||
.\"
|
||||
.\" Some roff macros, for reference:
|
||||
|
|
@ -51,7 +51,8 @@ when using \fBrpc.rigd\fP or rig model 2 for NET rigctl (rigctld).
|
|||
.B \-r, --rig-file=device
|
||||
Use \fIdevice\fP as the file name of the port the radio is connected.
|
||||
Often a serial port, but could be a USB to serial adapter. Typically
|
||||
/dev/ttyS0, /dev/ttyS1, /dev/ttyUSB0, etc.
|
||||
/dev/ttyS0, /dev/ttyS1, /dev/ttyUSB0, etc. on Linux or COM1, COM2, etc.
|
||||
on Win32.
|
||||
.sp
|
||||
Default is \fB/dev/rig\fP (may be a symbolic link to the actual device).
|
||||
.TP
|
||||
|
|
@ -89,11 +90,12 @@ NB: the \fIid\fP is in decimal notation, unless prefixed by
|
|||
\fI0x\fP, in which case it is hexadecimal.
|
||||
.TP
|
||||
.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> (0x0d). 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 rigctl to
|
||||
switch to binary protocol. See the \fIsend_cmd\fP command for further explanation.
|
||||
Change the termination \fIchar\fP for text protocol when using the
|
||||
\fIsend_cmd\fP command. The default value is <CR> (0x0d). 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 rigctl to switch to binary protocol. See the \fIsend_cmd\fP
|
||||
command for further explanation.
|
||||
.sp
|
||||
For example, to specify a command terminator for Kenwood style text commands
|
||||
pass "-t ';'" to rigctl. See EXAMPLES below.
|
||||
|
|
@ -138,17 +140,17 @@ Basically, the commands do not take a dash in front of them on the command
|
|||
line, as 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
|
||||
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. Each operation
|
||||
also has a long name; in interactive mode, prepend a backslash to enter a long
|
||||
command name.
|
||||
.sp
|
||||
Example: Use "\\dump_caps" to see what this radio can do.
|
||||
.PP
|
||||
Please note that the backend for the radio to be controlled,
|
||||
or the radio itself may not support some commands. In that case,
|
||||
the operation will fail with a \fBHamlib\fP error message.
|
||||
Please note that the backend for the radio to be controlled, or the radio
|
||||
itself may not support some commands. In that case, the operation will fail
|
||||
with a \fBHamlib\fP error message.
|
||||
.PP
|
||||
Here is a summary of the supported commands (In the case of "set" commands the
|
||||
quoted string is replaced by the value in the description. In the case of "get"
|
||||
|
|
@ -261,7 +263,8 @@ backend default.
|
|||
.B x, get_split_mode
|
||||
Get 'TX Mode' and 'TX Passband'.
|
||||
.sp
|
||||
Returns TX mode as a string from \fIset_split_mode\fP above and TX passband in Hz.
|
||||
Returns TX mode as a string from \fIset_split_mode\fP above and TX passband in
|
||||
Hz.
|
||||
.TP
|
||||
.B S, set_split_vfo 'Split' 'TX VFO'
|
||||
Set 'Split' mode, '0' or '1', and 'TX VFO' from \fIset_vfo\fP above.
|
||||
|
|
@ -288,23 +291,24 @@ otherwise, much as TRUE/FALSE definitions in C language.
|
|||
.B u, get_func
|
||||
Get 'Func' 'Func Status'.
|
||||
.sp
|
||||
Returns Func as a string from \fIset_func\fP above and Func status as a non null value.
|
||||
Returns Func as a string from \fIset_func\fP above and Func status as a non
|
||||
null value.
|
||||
.TP
|
||||
.B L, set_level 'Level' 'Level Value'
|
||||
Set 'Level' and 'Level Value'.
|
||||
.sp
|
||||
Level is one of: PREAMP, ATT, VOX, AF, RF, SQL, IF, APF, NR, PBT_IN, PBT_OUT, CWPITCH,
|
||||
RFPOWER, MICGAIN, KEYSPD, NOTCHF, COMP, AGC (0:OFF, 1:SUPERFAST, 2:FAST, 3:SLOW, 4:USER,
|
||||
5:MEDIUM, 6:AUTO), BKINDL, BAL, METER, VOXGAIN, ANTIVOX.
|
||||
SLOPE_LOW, SLOPE_HIGH, RAWSTR, SWR, ALC, STRENGTH.
|
||||
Level is one of: PREAMP, ATT, VOX, AF, RF, SQL, IF, APF, NR, PBT_IN, PBT_OUT,
|
||||
CWPITCH, RFPOWER, MICGAIN, KEYSPD, NOTCHF, COMP, AGC (0:OFF, 1:SUPERFAST,
|
||||
2:FAST, 3:SLOW, 4:USER, 5:MEDIUM, 6:AUTO), BKINDL, BAL, METER, VOXGAIN,
|
||||
ANTIVOX, SLOPE_LOW, SLOPE_HIGH, RAWSTR, SWR, ALC, STRENGTH.
|
||||
.sp
|
||||
The Level Value can be a float or an integer.
|
||||
.TP
|
||||
.B l, get_level
|
||||
Get 'Level' 'Level Value'.
|
||||
.sp
|
||||
Returns Level as a string from \fIset_level\fP above and Level value as a float or
|
||||
integer.
|
||||
Returns Level as a string from \fIset_level\fP above and Level value as a float
|
||||
or integer.
|
||||
.TP
|
||||
.B P, set_parm 'Parm' 'Parm Value'
|
||||
Set 'Parm' 'Parm Value'
|
||||
|
|
@ -329,8 +333,8 @@ Get 'Memory#' channel number.
|
|||
.B G, vfo_op 'Mem/VFO Op'
|
||||
Perform 'Mem/VFO Op'.
|
||||
.sp
|
||||
Mem VFO operation is one of: CPY, XCHG, FROM_VFO, TO_VFO, MCL, UP, DOWN, BAND_UP,
|
||||
BAND_DOWN, LEFT, RIGHT, TUNE, TOGGLE.
|
||||
Mem VFO operation is one of: CPY, XCHG, FROM_VFO, TO_VFO, MCL, UP, DOWN,
|
||||
BAND_UP, BAND_DOWN, LEFT, RIGHT, TUNE, TOGGLE.
|
||||
.TP
|
||||
.B g, scan 'Scan Fct' 'Scan Channel'
|
||||
Perform 'Scan Fct' 'Scan Channel'.
|
||||
|
|
@ -358,10 +362,10 @@ Get 'Antenna' number (0, 1, 2, ..).
|
|||
.B *, reset 'Reset'
|
||||
Perform rig 'Reset'.
|
||||
.sp
|
||||
0 = None, 1 = Software reset, 2 = VFO reset, 4 = Memory Clear reset, 8 = Master reset.
|
||||
Since these values are defined as a bitmask in rig.h, it should be possible to AND
|
||||
these values together to do multiple resets at once, if the backend supports it or
|
||||
supports a reset action via rig control at all.
|
||||
0 = None, 1 = Software reset, 2 = VFO reset, 4 = Memory Clear reset, 8 = Master
|
||||
reset. Since these values are defined as a bitmask in rig.h, it should be
|
||||
possible to AND these values together to do multiple resets at once, if the
|
||||
backend supports it or supports a reset action via rig control at all.
|
||||
.TP
|
||||
.B b, send_morse 'Morse'
|
||||
Send 'Morse' symbols.
|
||||
|
|
@ -385,9 +389,10 @@ Get misc information about the rig (no VFO in 'VFO mode' or value is passed).
|
|||
.TP
|
||||
.B 1, dump_caps
|
||||
Not a real rig remote command, it just dumps capabilities, i.e. what the
|
||||
backend knows about this model, and what it can do. TODO: Ensure this is
|
||||
in a consistent format so it can be read into a hash, dictionary, etc. Bug
|
||||
reports requested.
|
||||
backend knows about this model, and what it can do.
|
||||
.sp
|
||||
TODO: Ensure this is in a consistent format so it can be read into a hash,
|
||||
dictionary, etc. Bug reports requested.
|
||||
.sp
|
||||
\fBN.B.\fP: This command will produce many lines of output so be very careful
|
||||
if using a fixed length array! For example, running this command against the
|
||||
|
|
@ -418,22 +423,22 @@ Send raw command string to rig. This is useful for testing and troubleshooting
|
|||
rig commands and responses when developing a backend.
|
||||
.sp
|
||||
For binary protocols enter values as \\0xAA\\0xBB. Expect a 'Reply' from the
|
||||
rig which will likely be a binary block or an ASCII string depending on the rig's
|
||||
protocol (see your radio's computer control documentation).
|
||||
rig which will likely be a binary block or an ASCII string depending on the
|
||||
rig's protocol (see your radio's computer control documentation).
|
||||
.sp
|
||||
The command terminator, set by the \fIsend-cmd-term\fP option above, will terminate
|
||||
each command string sent to the radio. This character should not be a part of
|
||||
the input string.
|
||||
The command terminator, set by the \fIsend-cmd-term\fP option above, will
|
||||
terminate each command string sent to the radio. This character should not be
|
||||
a part of the input string.
|
||||
.SH EXAMPLES
|
||||
Start \fBrigctl\fP for a Yaesu FT-920 using a USB to serial adapter in
|
||||
interactive mode:
|
||||
.sp
|
||||
$ rigctl -m 114 -r /dev/ttyUSB1
|
||||
.sp
|
||||
Start \fBrigctl\fP for a Yaesu FT-920 using COM1 while generating TRACE output
|
||||
to \fBstderr\fP:
|
||||
Start \fBrigctl\fP for a Yaesu FT-920 using COM1 on Win32 while generating
|
||||
TRACE output to \fBstderr\fP:
|
||||
.sp
|
||||
$ rigctl -m 114 -r /dev/ttyS0 -vvvvv
|
||||
$ rigctl -m 114 -r COM1 -vvvvv
|
||||
.sp
|
||||
Start \fBrigctl\fP for a Yaesu FT-920 using a USB to serial adapter while
|
||||
setting baud rate and stop bits:
|
||||
|
|
|
|||
122
tests/rigctld.8
122
tests/rigctld.8
|
|
@ -2,7 +2,7 @@
|
|||
.\" 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)
|
||||
.TH RIGCTLD "8" "March 1, 2010" "Hamlib" "Rig Control Daemon"
|
||||
.TH RIGCTLD "8" "June 21, 2011" "Hamlib" "Rig Control Daemon"
|
||||
.\" Please adjust this date whenever revising the manpage.
|
||||
.\"
|
||||
.\" Some roff macros, for reference:
|
||||
|
|
@ -21,13 +21,13 @@ rigctld \- Hamlib TCP rig control daemon
|
|||
.B rigctld
|
||||
[\fIOPTION\fR]...
|
||||
.SH DESCRIPTION
|
||||
The \fBrigctld\fP program is a NEW \fBHamlib\fP rig control daemon ready for testing
|
||||
that handles client requests via TCP sockets. This allows multiple user programs to
|
||||
share one radio (this needs testing). Multiple radios can be controlled
|
||||
on different TCP ports by use of multiple \fBrigctld\fP processes. The syntax of the
|
||||
commands are the same as \fBrigctl\fP. It is hoped that \fBrigctld\fP will be
|
||||
especially useful for client authors using languages such as Perl, Python, PHP,
|
||||
and others.
|
||||
The \fBrigctld\fP program is a NEW \fBHamlib\fP rig control daemon ready for
|
||||
testing that handles client requests via TCP sockets. This allows multiple
|
||||
user programs to share one radio (this needs testing). Multiple radios can be
|
||||
controlled on different TCP ports by use of multiple \fBrigctld\fP processes.
|
||||
The syntax of the commands are the same as \fBrigctl\fP. It is hoped that
|
||||
\fBrigctld\fP will be especially useful for client authors using languages
|
||||
such as Perl, Python, PHP, and others.
|
||||
.PP
|
||||
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
|
||||
.\" \fI<whatever>\fP escape sequences to invoke bold face and italics,
|
||||
|
|
@ -38,22 +38,21 @@ to \fBrigctld\fP on one line and \fBrigctld\fP responds to "get" commands with
|
|||
the requested values, one per line, when successful, otherwise, it responds
|
||||
with one line "RPTR x", where x is a negative number indicating the error code.
|
||||
Commands that do not return values respond with the line "RPTR x", where x
|
||||
is zero when successful, otherwise is a regative number indicating the error code.
|
||||
Each line is terminated with a newline '\\n' character. This protocol is primarily
|
||||
for use by the \fINET rigctl\fP (rig model 2)backend.
|
||||
is zero when successful, otherwise is a regative number indicating the error
|
||||
code. Each line is terminated with a newline '\\n' character. This protocol
|
||||
is primarily for use by the \fINET rigctl\fP (rig model 2)backend.
|
||||
.PP
|
||||
A separate \fBExtended Response\fP protocol extends the above
|
||||
behavior by echoing the received command string as a header, any returned values
|
||||
as a key: value pair, and the "RPTR x" string as the end of response marker which
|
||||
A separate \fBExtended Response\fP protocol extends the above behavior by
|
||||
echoing the received command string as a header, any returned values as a key:
|
||||
value pair, and the "RPTR x" string as the end of response marker which
|
||||
includes the \fBHamlib\fP success or failure value. See the \fIPROTOCOL\fP
|
||||
section for details. Consider using this protocol for clients that will interact
|
||||
with \fBrigctld\fP directly through a TCP socket.
|
||||
section for details. Consider using this protocol for clients that will
|
||||
interact with \fBrigctld\fP directly through a TCP socket.
|
||||
.PP
|
||||
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.
|
||||
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
|
||||
\fIREPORTING BUGS\fP section. Patches and code enhancements are also welcome.
|
||||
|
|
@ -69,7 +68,8 @@ Select radio model number. See the -l, --list option below.
|
|||
.B \-r, --rig-file=device
|
||||
Use \fIdevice\fP as the file name of the port the radio is connected.
|
||||
Often a serial port, but could be a USB to serial adapter or USB port device.
|
||||
Typically /dev/ttyS0, /dev/ttyS1, /dev/ttyUSB0, etc.
|
||||
Typically /dev/ttyS0, /dev/ttyS1, /dev/ttyUSB0, etc. on Linux or COM1, COM2,
|
||||
etc. on Win32.
|
||||
.TP
|
||||
.B \-p, --ptt-file=device
|
||||
Use \fIdevice\fP as the file name of the Push-To-Talk device using a
|
||||
|
|
@ -130,9 +130,9 @@ below.
|
|||
.B \-e, --end-marker
|
||||
Use END marker in rigctld protocol.
|
||||
.sp
|
||||
\fBN.B.\fP: This option should be considered obsolete. Please consider using the Extended
|
||||
Response protocol instead (see \fIPROTOCOL\fP below). This option will be removed
|
||||
in a future Hamlib release.
|
||||
\fBN.B.\fP: This option should be considered obsolete. Please consider using
|
||||
the Extended Response protocol instead (see \fIPROTOCOL\fP below). This option
|
||||
will be removed in a future Hamlib release.
|
||||
.TP
|
||||
.B \-v, --verbose
|
||||
Set verbose mode, cumulative (see \fIDIAGNOSTICS\fP below).
|
||||
|
|
@ -147,16 +147,16 @@ Show the version of \fBrigctld\fP and exit.
|
|||
return an error. This is most likely to occur with the \fI\-\-set-conf\fP
|
||||
and \fI\-\-show-conf\fP options.
|
||||
.PP
|
||||
Please note that the backend for the radio to be controlled,
|
||||
or the radio itself may not support some commands. In that case,
|
||||
the operation will fail with a \fBHamlib\fP error code.
|
||||
Please note that the backend for the radio to be controlled, or the radio
|
||||
itself may not support some commands. In that case, the operation will fail
|
||||
with a \fBHamlib\fP error code.
|
||||
.SH COMMANDS
|
||||
Commands can be sent over the TCP socket either as a single char, or as a
|
||||
long command name plus the value(s) space separated on one '\\n' terminated
|
||||
line. See \fIPROTOCOL\fP.
|
||||
.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 methods whereas the
|
||||
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 methods whereas the
|
||||
corresponding lower case letter refers to the \fIget\fP method. Each operation
|
||||
also has a long name; prepend a backslash to send a long command name.
|
||||
.PP
|
||||
|
|
@ -283,7 +283,8 @@ backend default.
|
|||
.B x, get_split_mode
|
||||
Get 'TX Mode' and 'TX Passband'.
|
||||
.sp
|
||||
Returns TX mode as a string from \fIset_split_mode\fP above and TX passband in Hz.
|
||||
Returns TX mode as a string from \fIset_split_mode\fP above and TX passband in
|
||||
Hz.
|
||||
.TP
|
||||
.B S, set_split_vfo 'Split' 'TX VFO'
|
||||
Set 'Split' mode, '0' or '1', and 'TX VFO' from \fIset_vfo\fP above.
|
||||
|
|
@ -310,22 +311,23 @@ otherwise, much as TRUE/FALSE definitions in C language.
|
|||
.B u, get_func
|
||||
Get 'Func' 'Func Status'.
|
||||
.sp
|
||||
Returns Func as a string from \fIset_func\fP above and Func status as a non null value.
|
||||
Returns Func as a string from \fIset_func\fP above and Func status as a non
|
||||
null value.
|
||||
.TP
|
||||
.B L, set_level 'Level' 'Level Value'
|
||||
Set 'Level' and 'Level Value'.
|
||||
.sp
|
||||
Level is one of: PREAMP, ATT, VOX, AF, RF, SQL, IF, APF, NR, PBT_IN, PBT_OUT, CWPITCH,
|
||||
RFPOWER, MICGAIN, KEYSPD, NOTCHF, COMP, AGC, BKINDL, BAL, METER, VOXGAIN, ANTIVOX.
|
||||
SLOPE_LOW, SLOPE_HIGH, RAWSTR, SQLSTAT, SWR, ALC, STRENGTH.
|
||||
Level is one of: PREAMP, ATT, VOX, AF, RF, SQL, IF, APF, NR, PBT_IN, PBT_OUT,
|
||||
CWPITCH, RFPOWER, MICGAIN, KEYSPD, NOTCHF, COMP, AGC, BKINDL, BAL, METER,
|
||||
VOXGAIN, ANTIVOX, SLOPE_LOW, SLOPE_HIGH, RAWSTR, SQLSTAT, SWR, ALC, STRENGTH.
|
||||
.sp
|
||||
The Level Value can be a float or an integer.
|
||||
.TP
|
||||
.B l, get_level
|
||||
Get 'Level' 'Level Value'.
|
||||
.sp
|
||||
Returns Level as a string from \fIset_level\fP above and Level value as a float or
|
||||
integer.
|
||||
Returns Level as a string from \fIset_level\fP above and Level value as a float
|
||||
or integer.
|
||||
.TP
|
||||
.B P, set_parm 'Parm' 'Parm Value'
|
||||
Set 'Parm' 'Parm Value'
|
||||
|
|
@ -350,8 +352,8 @@ Get 'Memory#' channel number.
|
|||
.B G, vfo_op 'Mem/VFO Op'
|
||||
Perform 'Mem/VFO Op'.
|
||||
.sp
|
||||
Mem VFO operation is one of: CPY, XCHG, FROM_VFO, TO_VFO, MCL, UP, DOWN, BAND_UP,
|
||||
BAND_DOWN, LEFT, RIGHT, TUNE, TOGGLE.
|
||||
Mem VFO operation is one of: CPY, XCHG, FROM_VFO, TO_VFO, MCL, UP, DOWN,
|
||||
BAND_UP, BAND_DOWN, LEFT, RIGHT, TUNE, TOGGLE.
|
||||
.TP
|
||||
.B g, scan 'Scan Fct' 'Scan Channel'
|
||||
Perform 'Scan Fct' 'Scan Channel'.
|
||||
|
|
@ -379,10 +381,10 @@ Get 'Antenna' number (0, 1, 2, ..).
|
|||
.B *, reset 'Reset'
|
||||
Perform rig 'Reset'.
|
||||
.sp
|
||||
0 = None, 1 = Software reset, 2 = VFO reset, 4 = Memory Clear reset, 8 = Master reset.
|
||||
Since these values are defined as a bitmask in rig.h, it should be possible to AND
|
||||
these values together to do multiple resets at once, if the backend supports it or
|
||||
supports a reset action via rig control at all.
|
||||
0 = None, 1 = Software reset, 2 = VFO reset, 4 = Memory Clear reset, 8 = Master
|
||||
reset. Since these values are defined as a bitmask in rig.h, it should be
|
||||
possible to AND these values together to do multiple resets at once, if the
|
||||
backend supports it or supports a reset action via rig control at all.
|
||||
.TP
|
||||
.B b, send_morse 'Morse'
|
||||
Send 'Morse' symbols.
|
||||
|
|
@ -478,11 +480,11 @@ print $socket "f\\n";
|
|||
Most \fIget\fP functions return one to three values. A notable exception is
|
||||
the \fI\\dump_caps\fP function which returns many lines of key:value pairs.
|
||||
.PP
|
||||
This protocol is primarily used by the \fINET rigctl\fP (rigctl model 2) backend
|
||||
which allows applications already written for Hamlib's C API to take advantage of
|
||||
\fBrigctld\fP without the need of rewriting application code. An application's
|
||||
user can select rig model 2 ("NET rigctl") and then set rig_pathname to
|
||||
"localhost:4532" or other network host:port.
|
||||
This protocol is primarily used by the \fINET rigctl\fP (rigctl model 2)
|
||||
backend which allows applications already written for Hamlib's C API to take
|
||||
advantage of \fBrigctld\fP without the need of rewriting application code. An
|
||||
application's user can select rig model 2 ("NET rigctl") and then set
|
||||
rig_pathname to "localhost:4532" or other network host:port.
|
||||
.PP
|
||||
\fBExtended Response Protocol\fP
|
||||
.PP
|
||||
|
|
@ -499,10 +501,10 @@ specified response separator as the record line of the response.
|
|||
the numeric return value of the Hamlib backend function that was called by the
|
||||
command.
|
||||
.PP
|
||||
3. Any records consisting of data values returned by the rig backend are prepended
|
||||
by a string immediately followed by a colon then a space and then the value
|
||||
terminated by the response separator. e.g. "Frequency: 14250000\\n" when the
|
||||
command was prepended by '+'.
|
||||
3. Any records consisting of data values returned by the rig backend are
|
||||
prepended by a string immediately followed by a colon then a space and then the
|
||||
value terminated by the response separator. e.g. "Frequency: 14250000\\n" when
|
||||
the command was prepended by '+'.
|
||||
.PP
|
||||
4. All commands received will be acknowledged by \fBrigctld\fP with lines from
|
||||
rules 1 and 2. Lines from rule 3 are only returned when data values must be
|
||||
|
|
@ -516,9 +518,9 @@ set_mode: USB 2400
|
|||
.br
|
||||
RPRT 0
|
||||
.PP
|
||||
In this case the long command name and values are returned on the first line and
|
||||
the second line contains the end of block marker and the numeric rig backend
|
||||
return value indicating success.
|
||||
In this case the long command name and values are returned on the first line
|
||||
and the second line contains the end of block marker and the numeric rig
|
||||
backend return value indicating success.
|
||||
.PP
|
||||
An example response to a \fI\\get_mode\fP query:
|
||||
.sp
|
||||
|
|
@ -585,8 +587,8 @@ set_mode: USB 2400|RPRT 0
|
|||
Such a format will allow reading a response as a single event using a prefered
|
||||
response separator. Other punctuation characters have not been tested!
|
||||
.PP
|
||||
The following commands have been tested with the Extended Response protocol and the
|
||||
included \fBtestctld.pl\fP script:
|
||||
The following commands have been tested with the Extended Response protocol and
|
||||
the included \fBtestctld.pl\fP script:
|
||||
.br
|
||||
\fI\\set_freq\fP \fI\\get_freq\fP \fI\\set_split_freq\fP \fI\\get_split_freq\fP
|
||||
.br
|
||||
|
|
@ -614,6 +616,10 @@ setting baud rate and stop bits, and backgrounding:
|
|||
.PP
|
||||
$ rigctld -m 114 -r /dev/ttyUSB1 -s 4800 -C stop_bits=2 &
|
||||
.PP
|
||||
Start \fBrigctld\fP for an Elecraft K3 using COM2 on Win32:
|
||||
.sp
|
||||
$ rigctld -m 229 -r COM2
|
||||
.sp
|
||||
Connect to the already running \fBrigctld\fP, and set current frequency to
|
||||
14.266 MHz with a 1 second read timeout using the default protocol:
|
||||
.PP
|
||||
|
|
@ -651,7 +657,7 @@ Written by Stephane Fillod, Nate Bargmann, and the Hamlib Group
|
|||
.SH COPYRIGHT
|
||||
Copyright \(co 2000-2010 Stephane Fillod
|
||||
.br
|
||||
Copyright \(co 2010 Nate Bargmann
|
||||
Copyright \(co 2011 Nate Bargmann
|
||||
.br
|
||||
Copyright \(co 2000-2010 the Hamlib Group.
|
||||
.PP
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
.\" 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)
|
||||
.TH ROTCTL "1" "April 25, 2010" "Hamlib" "Rotator Control Program"
|
||||
.TH ROTCTL "1" "June 21, 2011" "Hamlib" "Rotator Control Program"
|
||||
.\" Please adjust this date whenever revising the manpage.
|
||||
.\"
|
||||
.\" Some roff macros, for reference:
|
||||
|
|
@ -26,15 +26,15 @@ Control antenna rotators.
|
|||
interactive mode if none are provided on the command line.
|
||||
.PP
|
||||
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
|
||||
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
|
||||
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
|
||||
.\" respectively.
|
||||
Keep in mind that \fBHamlib\fP is BETA level software.
|
||||
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,
|
||||
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
|
||||
Please report bugs and provide feedback at the e-mail address given in the
|
||||
REPORTING BUGS section. Patches and code enhancements are also welcome.
|
||||
.SH OPTIONS
|
||||
This program follows the usual GNU command line syntax, with long
|
||||
|
|
@ -45,26 +45,28 @@ Here is s summary of the supported options:
|
|||
.B \-m, --model=id
|
||||
Select rotator model number. See model list (use 'rotctl -l').
|
||||
.sp
|
||||
NB: \fBrotctl\fP (or third party software) will use rig model 1901
|
||||
NB: \fBrotctl\fP (or third party software) will use rig model 1901
|
||||
when using \fBrpc.rotd\fP or rig model 2 for NET rotctl (rotctld).
|
||||
.TP
|
||||
.B \-r, --rot-file=device
|
||||
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 or USB port device.
|
||||
Typically /dev/ttyS0, /dev/ttyS1, /dev/ttyUSB0, etc.
|
||||
Typically /dev/ttyS0, /dev/ttyS1, /dev/ttyUSB0, etc. on Linux or COM1, COM2,
|
||||
etc. on Win32.
|
||||
.sp
|
||||
Default is \fB/dev/rotator\fP (may be a symbolic link to the actual device).
|
||||
.TP
|
||||
.B \-s, --serial-speed=baud
|
||||
Set serial speed to \fIbaud\fP rate. Uses maximum serial speed from rotator
|
||||
Set serial speed to \fIbaud\fP rate. Uses maximum serial speed from rotator
|
||||
backend capabilites as default.
|
||||
.TP
|
||||
.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.
|
||||
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
|
||||
.B \-L, --show-conf
|
||||
List all config parameters for the rotor defined with -m above.
|
||||
|
|
@ -90,7 +92,7 @@ Show summary of these options and exit.
|
|||
Show version of \fBrotctl\fP and exit.
|
||||
.PP
|
||||
\fBN.B.\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
|
||||
return an error. This is most likely to occur with the \fI\-\-set-conf\fP
|
||||
and \fI\-\-show-conf\fP options.
|
||||
.PP
|
||||
Please note that the backend for the rotator to be controlled,
|
||||
|
|
@ -102,27 +104,28 @@ Basically, the commands do not take a dash in front of them, as
|
|||
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
|
||||
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. Each operation
|
||||
also has a long name; in interactive mode, prepend a backslash to enter a long
|
||||
command name.
|
||||
.sp
|
||||
Example: Use "\\get_info" to see the rotor's info.
|
||||
.PP
|
||||
Please note that the backend for the rotator to be controlled,
|
||||
or the rotator itself may not support some commands. In that case,
|
||||
Please note 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 \fBHamlib\fP error message.
|
||||
.PP
|
||||
A summary of commands is included below (In the case of "set" commands the
|
||||
quoted string is replaced by the value in the description. In the case of "get"
|
||||
commands the quoted string is the key name of the value returned.):
|
||||
quoted string is replaced by the value in the description. In the case of
|
||||
"get" commands the quoted string is the key name of the value returned.):
|
||||
.TP
|
||||
.B P, set_pos 'Azimuth' 'Elevation'
|
||||
Set position: Azimuth and Elevation as double precision floating point values.
|
||||
.TP
|
||||
.B p, get_pos
|
||||
Get position: 'Azimuth' and 'Elevation' as double precision floating point values.
|
||||
Get position: 'Azimuth' and 'Elevation' as double precision floating point
|
||||
values.
|
||||
.TP
|
||||
.B M, move 'Direction' 'Speed'
|
||||
Move the rotator in a specific direction at the given rate.
|
||||
|
|
@ -157,9 +160,9 @@ At the moment returns 'Model Name'.
|
|||
.B w, send_cmd '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
|
||||
<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
|
||||
.PP
|
||||
\fBLocator Commands\fP
|
||||
.PP
|
||||
|
|
@ -173,7 +176,8 @@ Both are floating point values. The precision of the returned square is
|
|||
controlled by 'Loc Len' which should be an even numbered integer value between
|
||||
2 and 12.
|
||||
.sp
|
||||
For example, "+L -170.000000 -85.000000 12\\n" returns "Locator: AA55AA00AA00\\n".
|
||||
For example, "+L -170.000000 -85.000000 12\\n" returns
|
||||
"Locator: AA55AA00AA00\\n".
|
||||
.TP
|
||||
.B l, loc2lonlat 'Locator'
|
||||
Returns 'Longitude' and 'Latitude' in decimal degrees at the approximate
|
||||
|
|
@ -188,11 +192,10 @@ For example, "+l AA55AA00AA00\\n" returns "Longitude: -169.999983\\nLatitude:
|
|||
.B D, dms2dec 'Degrees' 'Minutes' 'Seconds' 'S/W'
|
||||
Returns 'Dec Degrees', a signed floating point value.
|
||||
.sp
|
||||
Degrees and Minutes are
|
||||
integer values and Seconds is a floating point value. S/W is a flag with '1'
|
||||
indicating South latitude or West longitude and '0' North or East (the flag is
|
||||
needed as computers don't recognize a signed zero even though only the Degrees
|
||||
value only is typically signed in DMS notation).
|
||||
Degrees and Minutes are integer values and Seconds is a floating point value.
|
||||
S/W is a flag with '1' indicating South latitude or West longitude and '0'
|
||||
North or East (the flag is needed as computers don't recognize a signed zero
|
||||
even though only the Degrees value only is typically signed in DMS notation).
|
||||
.TP
|
||||
.B d, dec2dms 'Dec Degrees'
|
||||
Returns 'Degrees' 'Minutes' 'Seconds' 'S/W'.
|
||||
|
|
@ -202,11 +205,10 @@ Values are as in dms2dec above.
|
|||
.B E, dmmm2dec 'Degrees' 'Dec Minutes' 'S/W'
|
||||
Returns 'Dec Degrees', a signed floating point value.
|
||||
.sp
|
||||
Degrees is an integer
|
||||
value and Minutes is a floating point value. S/W is a flag with '1'
|
||||
indicating South latitude or West longitude and '0' North or East (the flag is
|
||||
needed as computers don't recognize a signed zero even though only the Degrees
|
||||
value only is typically signed in DMS notation).
|
||||
Degrees is an integer value and Minutes is a floating point value. S/W is a
|
||||
flag with '1' indicating South latitude or West longitude and '0' North or
|
||||
East (the flag is needed as computers don't recognize a signed zero even
|
||||
though only the Degrees value only is typically signed in DMS notation).
|
||||
.TP
|
||||
.B e, dec2dmmm 'Dec Deg'
|
||||
Returns 'Degrees' 'Minutes' 'S/W'.
|
||||
|
|
@ -228,10 +230,14 @@ Returns 'Long Path km'.
|
|||
.sp
|
||||
Both are floating point values.
|
||||
.SH EXAMPLES
|
||||
Start \fBrotctl\fP for RotorEZ using COM1:
|
||||
Start \fBrotctl\fP for RotorEZ using the first serial port on Linux:
|
||||
.sp
|
||||
$ rotctl -m 401 -r /dev/ttyS0
|
||||
.sp
|
||||
Start \fBrotctl\fP for RotorEZ using COM2 on Win32:
|
||||
.sp
|
||||
$ rotctl -m 401 -r COM2
|
||||
.sp
|
||||
Start \fBrotctl\fP using \fBrpc.rotd\fP and querying the position:
|
||||
.sp
|
||||
$ rotctl -m 101 -r localhost \\get_pos
|
||||
|
|
@ -242,8 +248,8 @@ local host and specifying the TCP port:
|
|||
$ rotctl -m 2 -r localhost:4533
|
||||
.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.
|
||||
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.
|
||||
.PP
|
||||
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
|
||||
|
|
@ -265,13 +271,13 @@ Report bugs to <hamlib-developer@lists.sourceforge.net>.
|
|||
.PP
|
||||
We are already aware of the bug in the previous section :-)
|
||||
.SH AUTHOR
|
||||
Written by Stephane Fillod, Nate Bargmann, and the Hamlib Group
|
||||
Written by Stephane Fillod, Nate Bargmann, and the Hamlib Group
|
||||
.PP
|
||||
<http://www.hamlib.org>.
|
||||
.SH COPYRIGHT
|
||||
Copyright \(co 2000-2010 Stephane Fillod
|
||||
.br
|
||||
Copyright \(co 2010 Nate Bargmann
|
||||
Copyright \(co 2011 Nate Bargmann
|
||||
.br
|
||||
Copyright \(co 2000-2010 the Hamlib Group
|
||||
.PP
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
.\" 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)
|
||||
.TH ROTCTLD "8" "March 1, 2010" "Hamlib" "Rotator Control Daemon"
|
||||
.TH ROTCTLD "8" "June 21, 2011" "Hamlib" "Rotator Control Daemon"
|
||||
.\" Please adjust this date whenever revising the manpage.
|
||||
.\"
|
||||
.\" Some roff macros, for reference:
|
||||
|
|
@ -21,13 +21,13 @@ rotctld \- Hamlib TCP rotator control daemon
|
|||
.B rotctld
|
||||
[\fIOPTION\fR]...
|
||||
.SH DESCRIPTION
|
||||
The \fBrotctld\fP program is an NEW \fBHamlib\fP rotator control daemon ready for
|
||||
testing that handles client requests via TCP sockets. This allows multiple user
|
||||
programs to share one rotator (this needs testing). Multiple rotators can be
|
||||
controlled on different TCP ports by use of multiple \fBrotctld\fP processes. The
|
||||
syntax of the commands are the same as \fBrotctl\fP. It is hoped that \fBrotctld\fP
|
||||
will be especially useful for client authors using languages such as Perl, Python,
|
||||
PHP, and others.
|
||||
The \fBrotctld\fP program is an NEW \fBHamlib\fP rotator control daemon ready
|
||||
for testing that handles client requests via TCP sockets. This allows multiple
|
||||
user programs to share one rotator (this needs testing). Multiple rotators can
|
||||
be controlled on different TCP ports by use of multiple \fBrotctld\fP processes.
|
||||
The syntax of the commands are the same as \fBrotctl\fP. It is hoped that
|
||||
\fBrotctld\fP will be especially useful for client authors using languages such
|
||||
as Perl, Python, PHP, and others.
|
||||
.PP
|
||||
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
|
||||
.\" \fI<whatever>\fP escape sequences to invoke bold face and italics,
|
||||
|
|
@ -38,22 +38,22 @@ to \fBrotctld\fP on one line and \fBrotctld\fP responds to "get" commands with
|
|||
the requested values, one per line, when successful, otherwise, it responds
|
||||
with one line "RPTR x", where x is a negative number indicating the error code.
|
||||
Commands that do not return values respond with the line "RPTR x", where x
|
||||
is zero when successful, otherwise is a regative number indicating the error code.
|
||||
Each line is terminated with a newline '\\n' character. This protocol is primarily
|
||||
for use by the \fINET rotctl\fP (rot model 2) backend.
|
||||
is zero when successful, otherwise is a regative number indicating the error
|
||||
code. Each line is terminated with a newline '\\n' character. This protocol
|
||||
is primarily for use by the \fINET rotctl\fP (rot model 2) backend.
|
||||
.PP
|
||||
A separate \fBExtended Response\fP protocol extends the above
|
||||
behavior by echoing the received command string as a header, any returned values
|
||||
as a key: value pair, and the "RPTR x" string as the end of response marker which
|
||||
includes the \fBHamlib\fP success or failure value. See the \fIPROTOCOL\fP
|
||||
section for details. Consider using this protocol for clients that will interact
|
||||
with \fBrotctld\fP directly through a TCP socket.
|
||||
as a key: value pair, and the "RPTR x" string as the end of response marker
|
||||
which includes the \fBHamlib\fP success or failure value. See the
|
||||
\fIPROTOCOL\fP section for details. Consider using this protocol for clients
|
||||
that will interact with \fBrotctld\fP directly through a TCP socket.
|
||||
.PP
|
||||
Keep in mind that \fBHamlib\fP is BETA level software.
|
||||
While a lot of backend libraries lack complete rotator 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.
|
||||
While a lot of backend libraries lack complete rotator 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.
|
||||
|
|
@ -69,7 +69,8 @@ Select rotator model number. See -l, "list" option below.
|
|||
.B \-r, --rot-file=device
|
||||
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 or USB port device.
|
||||
Typically /dev/ttyS0, /dev/ttyS1, /dev/ttyUSB0, etc.
|
||||
Typically /dev/ttyS0, /dev/ttyS1, /dev/ttyUSB0, etc. on Linux or COM1, COM2,
|
||||
etc. on Win32.
|
||||
.sp
|
||||
Default is \fB/dev/rotator\fP (may be a symbolic link to the actual device).
|
||||
.TP
|
||||
|
|
@ -103,9 +104,9 @@ Dump capabilities for the radio defined with -m above and exit.
|
|||
.B \-e, --end-marker
|
||||
Use END marker in rotctld protocol.
|
||||
.sp
|
||||
N.B.: This option should be considered obsolete. Please consider using the Extended
|
||||
Response protocol instead (see \fIPROTOCOL\fP below). This option will be removed
|
||||
in a future Hamlib release.
|
||||
N.B.: This option should be considered obsolete. Please consider using the
|
||||
Extended Response protocol instead (see \fIPROTOCOL\fP below). This option
|
||||
will be removed in a future Hamlib release.
|
||||
.TP
|
||||
.B \-v, --verbose
|
||||
Set verbose mode, cumulative (see DIAGNOSTICS below).
|
||||
|
|
@ -128,8 +129,8 @@ Commands can be sent over the TCP socket either as a single char, or as a
|
|||
long command name plus the value(s) space separated on one '\\n' terminated
|
||||
line. See \fIPROTOCOL\fP.
|
||||
.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 methods whereas the
|
||||
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 methods whereas the
|
||||
corresponding lower case letter refers to the \fIget\fP method. Each operation
|
||||
also has a long name; prepend a backslash to send a long command name.
|
||||
.PP
|
||||
|
|
@ -201,7 +202,8 @@ Both are floating point values. The precision of the returned square is
|
|||
controlled by 'Loc Len' which should be an even numbered integer value between
|
||||
2 and 12.
|
||||
.sp
|
||||
For example, "+L -170.000000 -85.000000 12\\n" returns "Locator: AA55AA00AA00\\n".
|
||||
For example, "+L -170.000000 -85.000000 12\\n" returns
|
||||
"Locator: AA55AA00AA00\\n".
|
||||
.TP
|
||||
.B l, loc2lonlat 'Locator'
|
||||
Returns 'Longitude' and 'Latitude' in decimal degrees at the approximate
|
||||
|
|
@ -289,10 +291,10 @@ Most \fIget\fP functions return one to three values. A notable exception is
|
|||
the \fI\\dump_caps\fP function which returns many lines of key:value pairs.
|
||||
.PP
|
||||
This protocol is primarily used by the \fINET rotctl\fP (rotctl model 2) backend
|
||||
which allows applications already written for Hamlib's C API to take advantage of
|
||||
\fBrotctld\fP without the need of rewriting application code. An application's
|
||||
user can select rotor model 2 ("NET rotctl") and then set rot_pathname to
|
||||
"localhost:4533" or other network host:port.
|
||||
which allows applications already written for Hamlib's C API to take advantage
|
||||
of \fBrotctld\fP without the need of rewriting application code. An
|
||||
application's user can select rotor model 2 ("NET rotctl") and then set
|
||||
rot_pathname to "localhost:4533" or other network host:port.
|
||||
.PP
|
||||
\fBExtended Response Protocol\fP
|
||||
.PP
|
||||
|
|
@ -304,14 +306,14 @@ strings returned by \fBrotctld\fP and adds a rule for the command syntax.
|
|||
followed by the value(s) (if any) received from the client terminated by the
|
||||
specified response separator as the first record of the response.
|
||||
.PP
|
||||
2. The last record of each block is the string "RPTR \fIx\fP\\n" where \fIx\fP is
|
||||
the numeric return value of the Hamlib backend function that was called by the
|
||||
command.
|
||||
2. The last record of each block is the string "RPTR \fIx\fP\\n" where \fIx\fP
|
||||
is the numeric return value of the Hamlib backend function that was called by
|
||||
the command.
|
||||
.PP
|
||||
3. Any records consisting of data values returned by the rotor backend are
|
||||
prepended by a string immediately followed by a colon then a space and then the
|
||||
value terminated by the response separator. e.g. "Azimuth: 90.000000\\n" when the
|
||||
command was prepended by '+'.
|
||||
value terminated by the response separator. e.g. "Azimuth: 90.000000\\n" when
|
||||
the command was prepended by '+'.
|
||||
.PP
|
||||
4. All commands received will be acknowledged by \fBrotctld\fP with records from
|
||||
rules 1 and 2. Records from rule 3 are only returned when data values must be
|
||||
|
|
@ -394,7 +396,7 @@ set_pos: 135 22.5|RPRT 0
|
|||
Such a format will allow reading a response as a single event using a prefered
|
||||
response separator. Other punctuation characters have not been tested!
|
||||
.PP
|
||||
All commands with the exception of \fI\\set_conf\fP have been tested with the
|
||||
All commands with the exception of \fI\\set_conf\fP have been tested with the
|
||||
Extended Response protocol and the included \fBtestrotctld.pl\fP script.
|
||||
.PP
|
||||
.SH EXAMPLES
|
||||
|
|
@ -403,6 +405,10 @@ USB-to-serial adapter and backgrounding:
|
|||
.sp
|
||||
$ rotctld -m 401 -r /dev/ttyUSB1 &
|
||||
.sp
|
||||
Start \fBrotctld\fP for RotorEZ using COM2 on Win32:
|
||||
.sp
|
||||
$ rotctl -m 401 -r COM2
|
||||
.sp
|
||||
Connect to the already running \fBrotctld\fP, and set position to
|
||||
135.0 degrees azimuth and 30.0 degrees elevation with a 1 second read timeout:
|
||||
.sp
|
||||
|
|
@ -444,7 +450,7 @@ Written by Stephane Fillod, Nate Bargmann, and the Hamlib Group
|
|||
.SH COPYRIGHT
|
||||
Copyright \(co 2000-2009 Stephane Fillod
|
||||
.br
|
||||
Copyright \(co 2010 Nate Bargmann
|
||||
Copyright \(co 2011 Nate Bargmann
|
||||
.br
|
||||
Copyright \(co 2000-2009 the Hamlib Group.
|
||||
.PP
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue