Add Win32 port usage to man pages.

Hamlib-1.2.14
Nate Bargmann 2011-06-21 13:42:43 -05:00
rodzic b2b4d312f8
commit dfc6db399b
4 zmienionych plików z 195 dodań i 172 usunięć

Wyświetl plik

@ -2,7 +2,7 @@
.\" First parameter, NAME, should be all caps .\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1) .\" 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. .\" Please adjust this date whenever revising the manpage.
.\" .\"
.\" Some roff macros, for reference: .\" 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 .B \-r, --rig-file=device
Use \fIdevice\fP as the file name of the port the radio is connected. 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 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 .sp
Default is \fB/dev/rig\fP (may be a symbolic link to the actual device). Default is \fB/dev/rig\fP (may be a symbolic link to the actual device).
.TP .TP
@ -89,11 +90,12 @@ NB: the \fIid\fP is in decimal notation, unless prefixed by
\fI0x\fP, in which case it is hexadecimal. \fI0x\fP, in which case it is hexadecimal.
.TP .TP
.B \-t, --send-cmd-term=char .B \-t, --send-cmd-term=char
Change the termination \fIchar\fP for text protocol when using the \fIsend_cmd\fP Change the termination \fIchar\fP for text protocol when using the
command. The default value is <CR> (0x0d). Non ASCII printable characters can be \fIsend_cmd\fP command. The default value is <CR> (0x0d). Non ASCII printable
specified as an ASCII number, in hexadecimal format, prepended with 0x. You may characters can be specified as an ASCII number, in hexadecimal format,
pass an empty string for no termination char. The string '-1' tells rigctl to prepended with 0x. You may pass an empty string for no termination char. The
switch to binary protocol. See the \fIsend_cmd\fP command for further explanation. string '-1' tells rigctl to switch to binary protocol. See the \fIsend_cmd\fP
command for further explanation.
.sp .sp
For example, to specify a command terminator for Kenwood style text commands For example, to specify a command terminator for Kenwood style text commands
pass "-t ';'" to rigctl. See EXAMPLES below. 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 line, as the options do. They may be typed in when in interactive mode
or provided as argument(s) in command line interface mode. or provided as argument(s) in command line interface mode.
.PP .PP
Since most of the \fBHamlib\fP operations have a \fIset\fP and a \fIget\fP method, Since most of the \fBHamlib\fP operations have a \fIset\fP and a \fIget\fP
an upper case letter will be used for \fIset\fP method whereas the 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 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 also has a long name; in interactive mode, prepend a backslash to enter a long
command name. command name.
.sp .sp
Example: Use "\\dump_caps" to see what this radio can do. Example: Use "\\dump_caps" to see what this radio can do.
.PP .PP
Please note that the backend for the radio to be controlled, Please note that the backend for the radio to be controlled, or the radio
or the radio itself may not support some commands. In that case, itself may not support some commands. In that case, the operation will fail
the operation will fail with a \fBHamlib\fP error message. with a \fBHamlib\fP error message.
.PP .PP
Here is a summary of the supported commands (In the case of "set" commands the 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" 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 .B x, get_split_mode
Get 'TX Mode' and 'TX Passband'. Get 'TX Mode' and 'TX Passband'.
.sp .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 .TP
.B S, set_split_vfo 'Split' 'TX VFO' .B S, set_split_vfo 'Split' 'TX VFO'
Set 'Split' mode, '0' or '1', and 'TX VFO' from \fIset_vfo\fP above. 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 .B u, get_func
Get 'Func' 'Func Status'. Get 'Func' 'Func Status'.
.sp .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 .TP
.B L, set_level 'Level' 'Level Value' .B L, set_level 'Level' 'Level Value'
Set 'Level' and 'Level Value'. Set 'Level' and 'Level Value'.
.sp .sp
Level is one of: PREAMP, ATT, VOX, AF, RF, SQL, IF, APF, NR, PBT_IN, PBT_OUT, CWPITCH, Level is one of: PREAMP, ATT, VOX, AF, RF, SQL, IF, APF, NR, PBT_IN, PBT_OUT,
RFPOWER, MICGAIN, KEYSPD, NOTCHF, COMP, AGC (0:OFF, 1:SUPERFAST, 2:FAST, 3:SLOW, 4:USER, CWPITCH, RFPOWER, MICGAIN, KEYSPD, NOTCHF, COMP, AGC (0:OFF, 1:SUPERFAST,
5:MEDIUM, 6:AUTO), BKINDL, BAL, METER, VOXGAIN, ANTIVOX. 2:FAST, 3:SLOW, 4:USER, 5:MEDIUM, 6:AUTO), BKINDL, BAL, METER, VOXGAIN,
SLOPE_LOW, SLOPE_HIGH, RAWSTR, SWR, ALC, STRENGTH. ANTIVOX, SLOPE_LOW, SLOPE_HIGH, RAWSTR, SWR, ALC, STRENGTH.
.sp .sp
The Level Value can be a float or an integer. The Level Value can be a float or an integer.
.TP .TP
.B l, get_level .B l, get_level
Get 'Level' 'Level Value'. Get 'Level' 'Level Value'.
.sp .sp
Returns Level as a string from \fIset_level\fP above and Level value as a float or Returns Level as a string from \fIset_level\fP above and Level value as a float
integer. or integer.
.TP .TP
.B P, set_parm 'Parm' 'Parm Value' .B P, set_parm 'Parm' 'Parm Value'
Set 'Parm' 'Parm Value' Set 'Parm' 'Parm Value'
@ -329,8 +333,8 @@ Get 'Memory#' channel number.
.B G, vfo_op 'Mem/VFO Op' .B G, vfo_op 'Mem/VFO Op'
Perform 'Mem/VFO Op'. Perform 'Mem/VFO Op'.
.sp .sp
Mem VFO operation is one of: CPY, XCHG, FROM_VFO, TO_VFO, MCL, UP, DOWN, BAND_UP, Mem VFO operation is one of: CPY, XCHG, FROM_VFO, TO_VFO, MCL, UP, DOWN,
BAND_DOWN, LEFT, RIGHT, TUNE, TOGGLE. BAND_UP, BAND_DOWN, LEFT, RIGHT, TUNE, TOGGLE.
.TP .TP
.B g, scan 'Scan Fct' 'Scan Channel' .B g, scan 'Scan Fct' 'Scan Channel'
Perform 'Scan Fct' 'Scan Channel'. Perform 'Scan Fct' 'Scan Channel'.
@ -358,10 +362,10 @@ Get 'Antenna' number (0, 1, 2, ..).
.B *, reset 'Reset' .B *, reset 'Reset'
Perform rig 'Reset'. Perform rig 'Reset'.
.sp .sp
0 = None, 1 = Software reset, 2 = VFO reset, 4 = Memory Clear reset, 8 = Master reset. 0 = None, 1 = Software reset, 2 = VFO reset, 4 = Memory Clear reset, 8 = Master
Since these values are defined as a bitmask in rig.h, it should be possible to AND reset. Since these values are defined as a bitmask in rig.h, it should be
these values together to do multiple resets at once, if the backend supports it or possible to AND these values together to do multiple resets at once, if the
supports a reset action via rig control at all. backend supports it or supports a reset action via rig control at all.
.TP .TP
.B b, send_morse 'Morse' .B b, send_morse 'Morse'
Send 'Morse' symbols. Send 'Morse' symbols.
@ -385,9 +389,10 @@ Get misc information about the rig (no VFO in 'VFO mode' or value is passed).
.TP .TP
.B 1, dump_caps .B 1, dump_caps
Not a real rig remote command, it just dumps capabilities, i.e. what the 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 backend knows about this model, and what it can do.
in a consistent format so it can be read into a hash, dictionary, etc. Bug .sp
reports requested. TODO: Ensure this is in a consistent format so it can be read into a hash,
dictionary, etc. Bug reports requested.
.sp .sp
\fBN.B.\fP: This command will produce many lines of output so be very careful \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 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. rig commands and responses when developing a backend.
.sp .sp
For binary protocols enter values as \\0xAA\\0xBB. Expect a 'Reply' from the 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 rig which will likely be a binary block or an ASCII string depending on the
protocol (see your radio's computer control documentation). rig's protocol (see your radio's computer control documentation).
.sp .sp
The command terminator, set by the \fIsend-cmd-term\fP option above, will terminate The command terminator, set by the \fIsend-cmd-term\fP option above, will
each command string sent to the radio. This character should not be a part of terminate each command string sent to the radio. This character should not be
the input string. a part of the input string.
.SH EXAMPLES .SH EXAMPLES
Start \fBrigctl\fP for a Yaesu FT-920 using a USB to serial adapter in Start \fBrigctl\fP for a Yaesu FT-920 using a USB to serial adapter in
interactive mode: interactive mode:
.sp .sp
$ rigctl -m 114 -r /dev/ttyUSB1 $ rigctl -m 114 -r /dev/ttyUSB1
.sp .sp
Start \fBrigctl\fP for a Yaesu FT-920 using COM1 while generating TRACE output Start \fBrigctl\fP for a Yaesu FT-920 using COM1 on Win32 while generating
to \fBstderr\fP: TRACE output to \fBstderr\fP:
.sp .sp
$ rigctl -m 114 -r /dev/ttyS0 -vvvvv $ rigctl -m 114 -r COM1 -vvvvv
.sp .sp
Start \fBrigctl\fP for a Yaesu FT-920 using a USB to serial adapter while Start \fBrigctl\fP for a Yaesu FT-920 using a USB to serial adapter while
setting baud rate and stop bits: setting baud rate and stop bits:

Wyświetl plik

@ -2,7 +2,7 @@
.\" First parameter, NAME, should be all caps .\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1) .\" 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. .\" Please adjust this date whenever revising the manpage.
.\" .\"
.\" Some roff macros, for reference: .\" Some roff macros, for reference:
@ -21,13 +21,13 @@ rigctld \- Hamlib TCP rig control daemon
.B rigctld .B rigctld
[\fIOPTION\fR]... [\fIOPTION\fR]...
.SH DESCRIPTION .SH DESCRIPTION
The \fBrigctld\fP program is a NEW \fBHamlib\fP rig control daemon ready for testing The \fBrigctld\fP program is a NEW \fBHamlib\fP rig control daemon ready for
that handles client requests via TCP sockets. This allows multiple user programs to testing that handles client requests via TCP sockets. This allows multiple
share one radio (this needs testing). Multiple radios can be controlled user programs to share one radio (this needs testing). Multiple radios can be
on different TCP ports by use of multiple \fBrigctld\fP processes. The syntax of the controlled on different TCP ports by use of multiple \fBrigctld\fP processes.
commands are the same as \fBrigctl\fP. It is hoped that \fBrigctld\fP will be The syntax of the commands are the same as \fBrigctl\fP. It is hoped that
especially useful for client authors using languages such as Perl, Python, PHP, \fBrigctld\fP will be especially useful for client authors using languages
and others. such as Perl, Python, PHP, and others.
.PP .PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and .\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invoke bold face and italics, .\" \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 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. 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 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. is zero when successful, otherwise is a regative number indicating the error
Each line is terminated with a newline '\\n' character. This protocol is primarily code. Each line is terminated with a newline '\\n' character. This protocol
for use by the \fINET rigctl\fP (rig model 2)backend. is primarily for use by the \fINET rigctl\fP (rig model 2)backend.
.PP .PP
A separate \fBExtended Response\fP protocol extends the above A separate \fBExtended Response\fP protocol extends the above behavior by
behavior by echoing the received command string as a header, any returned values echoing the received command string as a header, any returned values as a key:
as a key: value pair, and the "RPTR x" string as the end of response marker which 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 includes the \fBHamlib\fP success or failure value. See the \fIPROTOCOL\fP
section for details. Consider using this protocol for clients that will interact section for details. Consider using this protocol for clients that will
with \fBrigctld\fP directly through a TCP socket. interact with \fBrigctld\fP directly through a TCP socket.
.PP .PP
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
While a lot of backend libraries lack complete rig support, the basic functions libraries lack complete rig support, the basic functions are usually well
are usually well supported. The API may change without publicized notice, supported. The API may change without publicized notice, while an advancement
while an advancement of the minor version (e.g. 1.1.x to 1.2.x) indicates such of the minor version (e.g. 1.1.x to 1.2.x) indicates such a change.
a change.
.PP .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
\fIREPORTING BUGS\fP section. Patches and code enhancements are also welcome. \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 .B \-r, --rig-file=device
Use \fIdevice\fP as the file name of the port the radio is connected. 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. 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 .TP
.B \-p, --ptt-file=device .B \-p, --ptt-file=device
Use \fIdevice\fP as the file name of the Push-To-Talk device using a Use \fIdevice\fP as the file name of the Push-To-Talk device using a
@ -130,9 +130,9 @@ below.
.B \-e, --end-marker .B \-e, --end-marker
Use END marker in rigctld protocol. Use END marker in rigctld protocol.
.sp .sp
\fBN.B.\fP: This option should be considered obsolete. Please consider using the Extended \fBN.B.\fP: This option should be considered obsolete. Please consider using
Response protocol instead (see \fIPROTOCOL\fP below). This option will be removed the Extended Response protocol instead (see \fIPROTOCOL\fP below). This option
in a future Hamlib release. will be removed in a future Hamlib release.
.TP .TP
.B \-v, --verbose .B \-v, --verbose
Set verbose mode, cumulative (see \fIDIAGNOSTICS\fP below). 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 return an error. This is most likely to occur with the \fI\-\-set-conf\fP
and \fI\-\-show-conf\fP options. and \fI\-\-show-conf\fP options.
.PP .PP
Please note that the backend for the radio to be controlled, Please note that the backend for the radio to be controlled, or the radio
or the radio itself may not support some commands. In that case, itself may not support some commands. In that case, the operation will fail
the operation will fail with a \fBHamlib\fP error code. with a \fBHamlib\fP error code.
.SH COMMANDS .SH COMMANDS
Commands can be sent over the TCP socket either as a single char, or as a 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 long command name plus the value(s) space separated on one '\\n' terminated
line. See \fIPROTOCOL\fP. line. See \fIPROTOCOL\fP.
.PP .PP
Since most of the \fBHamlib\fP operations have a \fIset\fP and a \fIget\fP method, Since most of the \fBHamlib\fP operations have a \fIset\fP and a \fIget\fP
an upper case letter will be used for \fIset\fP methods whereas the 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 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. also has a long name; prepend a backslash to send a long command name.
.PP .PP
@ -283,7 +283,8 @@ backend default.
.B x, get_split_mode .B x, get_split_mode
Get 'TX Mode' and 'TX Passband'. Get 'TX Mode' and 'TX Passband'.
.sp .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 .TP
.B S, set_split_vfo 'Split' 'TX VFO' .B S, set_split_vfo 'Split' 'TX VFO'
Set 'Split' mode, '0' or '1', and 'TX VFO' from \fIset_vfo\fP above. 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 .B u, get_func
Get 'Func' 'Func Status'. Get 'Func' 'Func Status'.
.sp .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 .TP
.B L, set_level 'Level' 'Level Value' .B L, set_level 'Level' 'Level Value'
Set 'Level' and 'Level Value'. Set 'Level' and 'Level Value'.
.sp .sp
Level is one of: PREAMP, ATT, VOX, AF, RF, SQL, IF, APF, NR, PBT_IN, PBT_OUT, CWPITCH, Level is one of: PREAMP, ATT, VOX, AF, RF, SQL, IF, APF, NR, PBT_IN, PBT_OUT,
RFPOWER, MICGAIN, KEYSPD, NOTCHF, COMP, AGC, BKINDL, BAL, METER, VOXGAIN, ANTIVOX. CWPITCH, RFPOWER, MICGAIN, KEYSPD, NOTCHF, COMP, AGC, BKINDL, BAL, METER,
SLOPE_LOW, SLOPE_HIGH, RAWSTR, SQLSTAT, SWR, ALC, STRENGTH. VOXGAIN, ANTIVOX, SLOPE_LOW, SLOPE_HIGH, RAWSTR, SQLSTAT, SWR, ALC, STRENGTH.
.sp .sp
The Level Value can be a float or an integer. The Level Value can be a float or an integer.
.TP .TP
.B l, get_level .B l, get_level
Get 'Level' 'Level Value'. Get 'Level' 'Level Value'.
.sp .sp
Returns Level as a string from \fIset_level\fP above and Level value as a float or Returns Level as a string from \fIset_level\fP above and Level value as a float
integer. or integer.
.TP .TP
.B P, set_parm 'Parm' 'Parm Value' .B P, set_parm 'Parm' 'Parm Value'
Set 'Parm' 'Parm Value' Set 'Parm' 'Parm Value'
@ -350,8 +352,8 @@ Get 'Memory#' channel number.
.B G, vfo_op 'Mem/VFO Op' .B G, vfo_op 'Mem/VFO Op'
Perform 'Mem/VFO Op'. Perform 'Mem/VFO Op'.
.sp .sp
Mem VFO operation is one of: CPY, XCHG, FROM_VFO, TO_VFO, MCL, UP, DOWN, BAND_UP, Mem VFO operation is one of: CPY, XCHG, FROM_VFO, TO_VFO, MCL, UP, DOWN,
BAND_DOWN, LEFT, RIGHT, TUNE, TOGGLE. BAND_UP, BAND_DOWN, LEFT, RIGHT, TUNE, TOGGLE.
.TP .TP
.B g, scan 'Scan Fct' 'Scan Channel' .B g, scan 'Scan Fct' 'Scan Channel'
Perform 'Scan Fct' 'Scan Channel'. Perform 'Scan Fct' 'Scan Channel'.
@ -379,10 +381,10 @@ Get 'Antenna' number (0, 1, 2, ..).
.B *, reset 'Reset' .B *, reset 'Reset'
Perform rig 'Reset'. Perform rig 'Reset'.
.sp .sp
0 = None, 1 = Software reset, 2 = VFO reset, 4 = Memory Clear reset, 8 = Master reset. 0 = None, 1 = Software reset, 2 = VFO reset, 4 = Memory Clear reset, 8 = Master
Since these values are defined as a bitmask in rig.h, it should be possible to AND reset. Since these values are defined as a bitmask in rig.h, it should be
these values together to do multiple resets at once, if the backend supports it or possible to AND these values together to do multiple resets at once, if the
supports a reset action via rig control at all. backend supports it or supports a reset action via rig control at all.
.TP .TP
.B b, send_morse 'Morse' .B b, send_morse 'Morse'
Send 'Morse' symbols. Send 'Morse' symbols.
@ -478,11 +480,11 @@ print $socket "f\\n";
Most \fIget\fP functions return one to three values. A notable exception is 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. the \fI\\dump_caps\fP function which returns many lines of key:value pairs.
.PP .PP
This protocol is primarily used by the \fINET rigctl\fP (rigctl model 2) backend This protocol is primarily used by the \fINET rigctl\fP (rigctl model 2)
which allows applications already written for Hamlib's C API to take advantage of backend which allows applications already written for Hamlib's C API to take
\fBrigctld\fP without the need of rewriting application code. An application's advantage of \fBrigctld\fP without the need of rewriting application code. An
user can select rig model 2 ("NET rigctl") and then set rig_pathname to application's user can select rig model 2 ("NET rigctl") and then set
"localhost:4532" or other network host:port. rig_pathname to "localhost:4532" or other network host:port.
.PP .PP
\fBExtended Response Protocol\fP \fBExtended Response Protocol\fP
.PP .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 the numeric return value of the Hamlib backend function that was called by the
command. command.
.PP .PP
3. Any records consisting of data values returned by the rig backend are prepended 3. Any records consisting of data values returned by the rig backend are
by a string immediately followed by a colon then a space and then the value prepended by a string immediately followed by a colon then a space and then the
terminated by the response separator. e.g. "Frequency: 14250000\\n" when the value terminated by the response separator. e.g. "Frequency: 14250000\\n" when
command was prepended by '+'. the command was prepended by '+'.
.PP .PP
4. All commands received will be acknowledged by \fBrigctld\fP with lines from 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 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 .br
RPRT 0 RPRT 0
.PP .PP
In this case the long command name and values are returned on the first line and In this case the long command name and values are returned on the first line
the second line contains the end of block marker and the numeric rig backend and the second line contains the end of block marker and the numeric rig
return value indicating success. backend return value indicating success.
.PP .PP
An example response to a \fI\\get_mode\fP query: An example response to a \fI\\get_mode\fP query:
.sp .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 Such a format will allow reading a response as a single event using a prefered
response separator. Other punctuation characters have not been tested! response separator. Other punctuation characters have not been tested!
.PP .PP
The following commands have been tested with the Extended Response protocol and the The following commands have been tested with the Extended Response protocol and
included \fBtestctld.pl\fP script: the included \fBtestctld.pl\fP script:
.br .br
\fI\\set_freq\fP \fI\\get_freq\fP \fI\\set_split_freq\fP \fI\\get_split_freq\fP \fI\\set_freq\fP \fI\\get_freq\fP \fI\\set_split_freq\fP \fI\\get_split_freq\fP
.br .br
@ -614,6 +616,10 @@ setting baud rate and stop bits, and backgrounding:
.PP .PP
$ rigctld -m 114 -r /dev/ttyUSB1 -s 4800 -C stop_bits=2 & $ rigctld -m 114 -r /dev/ttyUSB1 -s 4800 -C stop_bits=2 &
.PP .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 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: 14.266 MHz with a 1 second read timeout using the default protocol:
.PP .PP
@ -651,7 +657,7 @@ Written by Stephane Fillod, Nate Bargmann, and the Hamlib Group
.SH COPYRIGHT .SH COPYRIGHT
Copyright \(co 2000-2010 Stephane Fillod Copyright \(co 2000-2010 Stephane Fillod
.br .br
Copyright \(co 2010 Nate Bargmann Copyright \(co 2011 Nate Bargmann
.br .br
Copyright \(co 2000-2010 the Hamlib Group. Copyright \(co 2000-2010 the Hamlib Group.
.PP .PP

Wyświetl plik

@ -2,7 +2,7 @@
.\" First parameter, NAME, should be all caps .\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1) .\" 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. .\" Please adjust this date whenever revising the manpage.
.\" .\"
.\" Some roff macros, for reference: .\" Some roff macros, for reference:
@ -26,15 +26,15 @@ Control antenna rotators.
interactive mode if none are provided on the command line. interactive mode if none are provided on the command line.
.PP .PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and .\" 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. .\" 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 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 while an advancement of the minor version (e.g. 1.1.x to 1.2.x) indicates such
a change. a change.
.PP .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. REPORTING BUGS section. Patches and code enhancements are also welcome.
.SH OPTIONS .SH OPTIONS
This program follows the usual GNU command line syntax, with long 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 .B \-m, --model=id
Select rotator model number. See model list (use 'rotctl -l'). Select rotator model number. See model list (use 'rotctl -l').
.sp .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). when using \fBrpc.rotd\fP or rig model 2 for NET rotctl (rotctld).
.TP .TP
.B \-r, --rot-file=device .B \-r, --rot-file=device
Use \fIdevice\fP as the file name of the port the rotator is connected. 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. 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 .sp
Default is \fB/dev/rotator\fP (may be a symbolic link to the actual device). Default is \fB/dev/rotator\fP (may be a symbolic link to the actual device).
.TP .TP
.B \-s, --serial-speed=baud .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. backend capabilites as default.
.TP .TP
.B \-t, --send-cmd-term=char .B \-t, --send-cmd-term=char
Change the termination \fIchar\fP for text protocol when using the \fIsend_cmd\fP command. Change the termination \fIchar\fP for text protocol when using the
The default value is <CR>. Non ASCII printable characters can be specified as an \fIsend_cmd\fP command. The default value is <CR>. Non ASCII printable
ASCII number, in hexadecimal format, prepended with 0x. You may pass an empty string characters can be specified as an ASCII number, in hexadecimal format,
for no termination char. The string -1 tells rotctl to switch to binary protocol. prepended with 0x. You may pass an empty string for no termination char. The
See the \fIsend_cmd\fP command for further explanation. string -1 tells rotctl to switch to binary protocol. See the \fIsend_cmd\fP
command for further explanation.
.TP .TP
.B \-L, --show-conf .B \-L, --show-conf
List all config parameters for the rotor defined with -m above. 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. Show version of \fBrotctl\fP and exit.
.PP .PP
\fBN.B.\fP Some options may not be implemented by a given backend and will \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. and \fI\-\-show-conf\fP options.
.PP .PP
Please note that the backend for the rotator to be controlled, 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 the options do. They may be typed in when in interactive mode
or provided as argument(s) in command line interface mode. or provided as argument(s) in command line interface mode.
.PP .PP
Since most of the \fBHamlib\fP operations have a \fIset\fP and a \fIget\fP method, Since most of the \fBHamlib\fP operations have a \fIset\fP and a \fIget\fP
an upper case letter will be used for \fIset\fP method whereas the 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 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 also has a long name; in interactive mode, prepend a backslash to enter a long
command name. command name.
.sp .sp
Example: Use "\\get_info" to see the rotor's info. Example: Use "\\get_info" to see the rotor's info.
.PP .PP
Please note that the backend for the rotator to be controlled, Please note that the backend for the rotator to be controlled,
or the rotator itself may not support some commands. In that case, or the rotator itself may not support some commands. In that case,
the operation will fail with a \fBHamlib\fP error message. the operation will fail with a \fBHamlib\fP error message.
.PP .PP
A summary of commands is included below (In the case of "set" commands the 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" quoted string is replaced by the value in the description. In the case of
commands the quoted string is the key name of the value returned.): "get" commands the quoted string is the key name of the value returned.):
.TP .TP
.B P, set_pos 'Azimuth' 'Elevation' .B P, set_pos 'Azimuth' 'Elevation'
Set position: Azimuth and Elevation as double precision floating point values. Set position: Azimuth and Elevation as double precision floating point values.
.TP .TP
.B p, get_pos .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 .TP
.B M, move 'Direction' 'Speed' .B M, move 'Direction' 'Speed'
Move the rotator in a specific direction at the given rate. 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' .B w, send_cmd 'Cmd'
Send raw command string to the rotator. Send raw command string to the rotator.
.br .br
<CR> (or send-cmd-term, see \fI-t\fP option) is appended automatically at the end <CR> (or send-cmd-term, see \fI-t\fP option) is appended automatically at the
of the command for text protocols. end of the command for text protocols. For binary protocols, enter values
For binary protocols, enter values as \\0xAA\\0xBB as \\0xAA\\0xBB
.PP .PP
\fBLocator Commands\fP \fBLocator Commands\fP
.PP .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 controlled by 'Loc Len' which should be an even numbered integer value between
2 and 12. 2 and 12.
.sp .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 .TP
.B l, loc2lonlat 'Locator' .B l, loc2lonlat 'Locator'
Returns 'Longitude' and 'Latitude' in decimal degrees at the approximate 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' .B D, dms2dec 'Degrees' 'Minutes' 'Seconds' 'S/W'
Returns 'Dec Degrees', a signed floating point value. Returns 'Dec Degrees', a signed floating point value.
.sp .sp
Degrees and Minutes are Degrees and Minutes are integer values and Seconds is a floating point value.
integer values and Seconds is a floating point value. S/W is a flag with '1' S/W is a flag with '1' indicating South latitude or West longitude and '0'
indicating South latitude or West longitude and '0' North or East (the flag is North or East (the flag is needed as computers don't recognize a signed zero
needed as computers don't recognize a signed zero even though only the Degrees even though only the Degrees value only is typically signed in DMS notation).
value only is typically signed in DMS notation).
.TP .TP
.B d, dec2dms 'Dec Degrees' .B d, dec2dms 'Dec Degrees'
Returns 'Degrees' 'Minutes' 'Seconds' 'S/W'. Returns 'Degrees' 'Minutes' 'Seconds' 'S/W'.
@ -202,11 +205,10 @@ Values are as in dms2dec above.
.B E, dmmm2dec 'Degrees' 'Dec Minutes' 'S/W' .B E, dmmm2dec 'Degrees' 'Dec Minutes' 'S/W'
Returns 'Dec Degrees', a signed floating point value. Returns 'Dec Degrees', a signed floating point value.
.sp .sp
Degrees is an integer Degrees is an integer value and Minutes is a floating point value. S/W is a
value and Minutes is a floating point value. S/W is a flag with '1' flag with '1' indicating South latitude or West longitude and '0' North or
indicating South latitude or West longitude and '0' North or East (the flag is East (the flag is needed as computers don't recognize a signed zero even
needed as computers don't recognize a signed zero even though only the Degrees though only the Degrees value only is typically signed in DMS notation).
value only is typically signed in DMS notation).
.TP .TP
.B e, dec2dmmm 'Dec Deg' .B e, dec2dmmm 'Dec Deg'
Returns 'Degrees' 'Minutes' 'S/W'. Returns 'Degrees' 'Minutes' 'S/W'.
@ -228,10 +230,14 @@ Returns 'Long Path km'.
.sp .sp
Both are floating point values. Both are floating point values.
.SH EXAMPLES .SH EXAMPLES
Start \fBrotctl\fP for RotorEZ using COM1: Start \fBrotctl\fP for RotorEZ using the first serial port on Linux:
.sp .sp
$ rotctl -m 401 -r /dev/ttyS0 $ rotctl -m 401 -r /dev/ttyS0
.sp .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: Start \fBrotctl\fP using \fBrpc.rotd\fP and querying the position:
.sp .sp
$ rotctl -m 101 -r localhost \\get_pos $ rotctl -m 101 -r localhost \\get_pos
@ -242,8 +248,8 @@ local host and specifying the TCP port:
$ rotctl -m 2 -r localhost:4533 $ rotctl -m 2 -r localhost:4533
.SH DIAGNOSTICS .SH DIAGNOSTICS
The \fB-v\fP, \fB--version\fP option allows different levels of 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, 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. -vvv for WARN, -vvvv for VERBOSE, or -vvvvv for TRACE.
.PP .PP
A given verbose level is useful for providing needed debugging information to 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 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 .PP
We are already aware of the bug in the previous section :-) We are already aware of the bug in the previous section :-)
.SH AUTHOR .SH AUTHOR
Written by Stephane Fillod, Nate Bargmann, and the Hamlib Group Written by Stephane Fillod, Nate Bargmann, and the Hamlib Group
.PP .PP
<http://www.hamlib.org>. <http://www.hamlib.org>.
.SH COPYRIGHT .SH COPYRIGHT
Copyright \(co 2000-2010 Stephane Fillod Copyright \(co 2000-2010 Stephane Fillod
.br .br
Copyright \(co 2010 Nate Bargmann Copyright \(co 2011 Nate Bargmann
.br .br
Copyright \(co 2000-2010 the Hamlib Group Copyright \(co 2000-2010 the Hamlib Group
.PP .PP

Wyświetl plik

@ -2,7 +2,7 @@
.\" First parameter, NAME, should be all caps .\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1) .\" 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. .\" Please adjust this date whenever revising the manpage.
.\" .\"
.\" Some roff macros, for reference: .\" Some roff macros, for reference:
@ -21,13 +21,13 @@ rotctld \- Hamlib TCP rotator control daemon
.B rotctld .B rotctld
[\fIOPTION\fR]... [\fIOPTION\fR]...
.SH DESCRIPTION .SH DESCRIPTION
The \fBrotctld\fP program is an NEW \fBHamlib\fP rotator control daemon ready for The \fBrotctld\fP program is an NEW \fBHamlib\fP rotator control daemon ready
testing that handles client requests via TCP sockets. This allows multiple user for testing that handles client requests via TCP sockets. This allows multiple
programs to share one rotator (this needs testing). Multiple rotators can be user programs to share one rotator (this needs testing). Multiple rotators can
controlled on different TCP ports by use of multiple \fBrotctld\fP processes. The be controlled on different TCP ports by use of multiple \fBrotctld\fP processes.
syntax of the commands are the same as \fBrotctl\fP. It is hoped that \fBrotctld\fP The syntax of the commands are the same as \fBrotctl\fP. It is hoped that
will be especially useful for client authors using languages such as Perl, Python, \fBrotctld\fP will be especially useful for client authors using languages such
PHP, and others. as Perl, Python, PHP, and others.
.PP .PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and .\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invoke bold face and italics, .\" \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 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. 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 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. is zero when successful, otherwise is a regative number indicating the error
Each line is terminated with a newline '\\n' character. This protocol is primarily code. Each line is terminated with a newline '\\n' character. This protocol
for use by the \fINET rotctl\fP (rot model 2) backend. is primarily for use by the \fINET rotctl\fP (rot model 2) backend.
.PP .PP
A separate \fBExtended Response\fP protocol extends the above A separate \fBExtended Response\fP protocol extends the above
behavior by echoing the received command string as a header, any returned values 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 as a key: value pair, and the "RPTR x" string as the end of response marker
includes the \fBHamlib\fP success or failure value. See the \fIPROTOCOL\fP which includes the \fBHamlib\fP success or failure value. See the
section for details. Consider using this protocol for clients that will interact \fIPROTOCOL\fP section for details. Consider using this protocol for clients
with \fBrotctld\fP directly through a TCP socket. that will interact with \fBrotctld\fP directly through a TCP socket.
.PP .PP
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 rotator support, the basic functions While a lot of backend libraries lack complete rotator support, the basic
are usually well supported. The API may change without publicized notice, functions are usually well supported. The API may change without publicized
while an advancement of the minor version (e.g. 1.1.x to 1.2.x) indicates such notice, while an advancement of the minor version (e.g. 1.1.x to 1.2.x)
a change. indicates such a change.
.PP .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. 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 .B \-r, --rot-file=device
Use \fIdevice\fP as the file name of the port the rotator is connected. 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. 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 .sp
Default is \fB/dev/rotator\fP (may be a symbolic link to the actual device). Default is \fB/dev/rotator\fP (may be a symbolic link to the actual device).
.TP .TP
@ -103,9 +104,9 @@ Dump capabilities for the radio defined with -m above and exit.
.B \-e, --end-marker .B \-e, --end-marker
Use END marker in rotctld protocol. Use END marker in rotctld protocol.
.sp .sp
N.B.: This option should be considered obsolete. Please consider using the Extended N.B.: This option should be considered obsolete. Please consider using the
Response protocol instead (see \fIPROTOCOL\fP below). This option will be removed Extended Response protocol instead (see \fIPROTOCOL\fP below). This option
in a future Hamlib release. will be removed in a future Hamlib release.
.TP .TP
.B \-v, --verbose .B \-v, --verbose
Set verbose mode, cumulative (see DIAGNOSTICS below). 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 long command name plus the value(s) space separated on one '\\n' terminated
line. See \fIPROTOCOL\fP. line. See \fIPROTOCOL\fP.
.PP .PP
Since most of the \fBHamlib\fP operations have a \fIset\fP and a \fIget\fP method, Since most of the \fBHamlib\fP operations have a \fIset\fP and a \fIget\fP
an upper case letter will be used for \fIset\fP methods whereas the 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 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. also has a long name; prepend a backslash to send a long command name.
.PP .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 controlled by 'Loc Len' which should be an even numbered integer value between
2 and 12. 2 and 12.
.sp .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 .TP
.B l, loc2lonlat 'Locator' .B l, loc2lonlat 'Locator'
Returns 'Longitude' and 'Latitude' in decimal degrees at the approximate 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. the \fI\\dump_caps\fP function which returns many lines of key:value pairs.
.PP .PP
This protocol is primarily used by the \fINET rotctl\fP (rotctl model 2) backend 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 which allows applications already written for Hamlib's C API to take advantage
\fBrotctld\fP without the need of rewriting application code. An application's of \fBrotctld\fP without the need of rewriting application code. An
user can select rotor model 2 ("NET rotctl") and then set rot_pathname to application's user can select rotor model 2 ("NET rotctl") and then set
"localhost:4533" or other network host:port. rot_pathname to "localhost:4533" or other network host:port.
.PP .PP
\fBExtended Response Protocol\fP \fBExtended Response Protocol\fP
.PP .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 followed by the value(s) (if any) received from the client terminated by the
specified response separator as the first record of the response. specified response separator as the first record of the response.
.PP .PP
2. The last record of each block is the string "RPTR \fIx\fP\\n" where \fIx\fP is 2. The last record of each block is the string "RPTR \fIx\fP\\n" where \fIx\fP
the numeric return value of the Hamlib backend function that was called by the is the numeric return value of the Hamlib backend function that was called by
command. the command.
.PP .PP
3. Any records consisting of data values returned by the rotor backend are 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 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 value terminated by the response separator. e.g. "Azimuth: 90.000000\\n" when
command was prepended by '+'. the command was prepended by '+'.
.PP .PP
4. All commands received will be acknowledged by \fBrotctld\fP with records from 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 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 Such a format will allow reading a response as a single event using a prefered
response separator. Other punctuation characters have not been tested! response separator. Other punctuation characters have not been tested!
.PP .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. Extended Response protocol and the included \fBtestrotctld.pl\fP script.
.PP .PP
.SH EXAMPLES .SH EXAMPLES
@ -403,6 +405,10 @@ USB-to-serial adapter and backgrounding:
.sp .sp
$ rotctld -m 401 -r /dev/ttyUSB1 & $ rotctld -m 401 -r /dev/ttyUSB1 &
.sp .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 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: 135.0 degrees azimuth and 30.0 degrees elevation with a 1 second read timeout:
.sp .sp
@ -444,7 +450,7 @@ Written by Stephane Fillod, Nate Bargmann, and the Hamlib Group
.SH COPYRIGHT .SH COPYRIGHT
Copyright \(co 2000-2009 Stephane Fillod Copyright \(co 2000-2009 Stephane Fillod
.br .br
Copyright \(co 2010 Nate Bargmann Copyright \(co 2011 Nate Bargmann
.br .br
Copyright \(co 2000-2009 the Hamlib Group. Copyright \(co 2000-2009 the Hamlib Group.
.PP .PP