pull/155/head
Michael Black 2019-12-11 07:47:24 -06:00
commit 011efe0452
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: 6599353EC683404D
13 zmienionych plików z 1523 dodań i 47 usunięć

Wyświetl plik

@ -1,6 +1,7 @@
EXTRA_DIST = hamlib.cfg index.doxygen hamlib.css footer.html
dist_man_MANS = man1/rigctl.1 man1/rigctld.1 man1/rigmem.1 man1/rigsmtr.1 \
dist_man_MANS = man1/ampctl.1 man1/ampctld.1 \
man1/rigctl.1 man1/rigctld.1 man1/rigmem.1 man1/rigsmtr.1 \
man1/rigswr.1 man1/rotctl.1 man1/rotctld.1 man1/rigctlcom.1 \
man7/hamlib.7 man7/hamlib-primer.7 man7/hamlib-utilities.7

665
doc/man1/ampctl.1 100644
Wyświetl plik

@ -0,0 +1,665 @@
.\" Hey, EMACS: -*- nroff -*-
.\"
.\" For layout and available macros, see man(7), man-pages(7), groff_man(7)
.\" Please adjust the date whenever revising the manpage.
.\"
.\" Note: Please keep this page in sync with the source, ampctl.c
.\"
.TH AMPCTL "1" "2019-12-10" "Hamlib" "Hamlib Utilities"
.
.
.SH NAME
.
ampctl \- control radio amplifiers
.
.SH SYNOPSIS
.
.
.SY ampctl
.OP \-hiIlLuV
.OP \-m id
.OP \-r device
.OP \-s baud
.OP \-t char
.OP \-C parm=val
.RB [ \-v [ \-Z ]]
.RB [ command | \- ]
.YS
.
.SH DESCRIPTION
Control radio amplifiers.
.B ampctl
accepts
.B commands
from the command line as well as in interactive mode if none are provided on
the command line.
.
.PP
Keep in mind that Hamlib is BETA level software. While a lot of backend
libraries lack complete amplifier support, the basic functions are usually
well supported.
.
.PP
Please report bugs and provide feedback at the e-mail address given in the
.B BUGS
section below. Patches and code enhancements sent to the same address are
welcome.
.
.
.SH OPTIONS
.
This program follows the usual GNU command line syntax. Short options that
take an argument may have the value follow immediately or be separated by a
space. Long options starting with two dashes (\(oq\-\(cq) require an
\(oq=\(cq between the option and any argument.
.
.PP
Here is a summary of the supported options:
.
.TP
.BR \-m ", " \-\-model = \fIid\fP
Select amplifier model number.
.IP
See model list (use \(lqampctl -l\(rq).
.IP
.BR Note :
.B ampctl
(or third party software using the C API) will use amplifier model 2 for
.B NET ampctl
(communicating with
.BR ampctld ).
.
.TP
.BR \-r ", " \-\-amp\-file = \fIdevice\fP
Use
.I device
as the file name of the port connected to the amplifier.
.IP
Often a serial port, but could be a USB to serial adapter. Typically
.IR /dev/ttyS0 ", " /dev/ttyS1 ", " /dev/ttyUSB0 ,
etc. on Linux,
.IR COM1 ", " COM2 ,
etc. on MS Windows. The BSD flavors and Mac OS/X have their own designations.
See your system's documentation.
.
.TP
.BR \-s ", " \-\-serial\-speed = \fIbaud\fP
Set serial speed to
.I baud
rate.
.IP
Uses maximum serial speed from amplifier backend capabilities (set by
.B -m
above) as the default.
.
.TP
.BR \-t ", " \-\-send\-cmd\-term = \fIchar\fP
Change the termination
.I char
for text protocol when using the
.B send_cmd
command.
.IP
The default value is ASCII CR (\(oq0x0D\(cq). ASCII non-printing characters
can be given as the ASCII number in hexadecimal format prepended with
\(lq0x\(rq. You may pass an empty string for no termination char. The string
\(lq\-1\(rq tells
.B ampctl
to switch to binary protocol.
.IP
For example, to specify a command terminator for Kenwood style text commands
pass \(lq-t ';'\(rq to ampctl. See
.B EXAMPLE
below.
.
.TP
.BR \-L ", " \-\-show\-conf
List all config parameters for the amplifier defined with
.B \-m
above.
.
.TP
.BR \-C ", " \-\-set\-conf = \fIparm=val\fP [ \fI,parm=val\fP ]
Set amplifier configuration parameter(s), e.g.
.IR stop_bits=2 .
.IP
Use the
.B -L
option above for a list of configuration parameters for a given model number.
.
.TP
.BR \-u ", " \-\-dump\-caps
Dump capabilities for the amplifier defined with
.B -m
above and exit.
.
.TP
.BR \-l ", " \-\-list
List all amplifier model numbers defined in
.B Hamlib
and exit.
.IP
The list is sorted by model number.
.IP
.BR Note :
In Linux the list can be scrolled back using
.BR Shift-PageUp / Shift-PageDown ,
or using the scrollbars of a virtual terminal in X or the cmd window in
Windows. The output can be piped to
.BR more (1)
or
.BR less (1),
e.g. \(lqampctl -l | more\(rq.
.
.TP
.BR \-i ", " \-\-read\-history
Read previously saved command and argument history from a file (default
.IR $HOME/.ampctl_history )
for the current session.
.IP
Available when
.B ampctl
is built with Readline support (see READLINE below).
.IP
.BR Note :
To read a history file stored in another directory, set the
.B AMPCTL_HIST_DIR
environment variable, e.g. \(lqAMPCTL_HIST_DIR=~/tmp ampctl -i\(rq. When
AMPCTL_HIST_DIR is not set, the value of
.B HOME
is used.
.
.TP
.BR \-I ", " \-\-save\-history
Write current session (and previous session(s), if
.B -i
option is given) command and argument history to a file (default
.IR $HOME/.ampctl_history )
at the end of the current session.
.IP
Complete commands with arguments are saved as a single line to be recalled and
used or edited. Available when
.B ampctl
is built with Readline support (see
.B READLINE
below).
.IP
.BR Note :
To write a history file in another directory, set the
.B AMPCTL_HIST_DIR
environment variable, e.g. \(lqAMPCTL_HIST_DIR=~/tmp ampctl -I\)Rq. When
AMPCTL_HIST_DIR is not set, the value of
.B HOME
is used.
.
.TP
.BR \-v ", " \-\-verbose
Set verbose mode, cumulative (see
.B DIAGNOSTICS
below).
.
.TP
.BR \-Z ", " \-\-debug\-time\-stamps
Enable time stamps for the debug messages.
.IP
Use only in combination with the
.B -v
option as it generates no output on its own.
.
.TP
.BR \-h ", " \-\-help
Show a summary of these options and exit.
.
.TP
.BR \-V ", " \-\-version
Show version of
.B ampctl
and exit.
.
.TP
.B \-
Stop option processing and read commands from standard input.
.IP
See
.B Standard Input
below.
.
.PP
.BR Note :
Some options may not be implemented by a given backend and will return an
error. This is most likely to occur with the
.B \-\-set\-conf
and
.B \-\-show\-conf
options.
.
.PP
Please note that the backend for the amplifier to be controlled, or the
amplifier itself may not support some commands. In that case, the operation
will fail with a
.B Hamlib
error code.
.
.
.SH COMMANDS
.
Commands can be entered either as a single char, or as a long command name.
The commands are not prefixed with a dash as the options are. They may be
typed in when in interactive mode or provided as argument(s) in command line
interface mode. In interactive mode commands and their arguments may be
entered on a single line:
.
.sp
.RS 0.5i
.EX
F 14250000
.EE
.RE
.
.PP
Since most of the
.B Hamlib
operations have a
.B set
and a
.B get
method, an upper case letter will often be used for a
.B set
method whereas the corresponding lower case letter refers to the
.B get
method. Each operation also has a long name; in interactive mode, prepend a
backslash, \(oq\\\(cq, to enter a long command name.
.
.PP
Example: Use \(lq\\dump_caps\(rq to see what capabilities this amplifier and
backend support.
.
.PP
.BR Note :
The backend for the amplifier to be controlled, or the amplifier itself may
not support some commands. In that case, the operation will fail with a
.B Hamlib
error message.
.
.
.PP
A simple example:
.
.sp
.RS 0.5i
.EX
$ cat <<.EOF. >cmds.txt
> # File of commands
> F 14250000
> f
> l PWRINPUT
> l PWRFORWARD
> l SWR
> \\dump_caps
> .EOF.
$ ampctl -m1 - <cmds.txt
Amplifier command: # File of commands
Amplifier command: F 14250000
Amplifier command: f
Frequency(Hz): 14250000
Amplifier command: l PWRINPUT
Level Value: 0
Amplifier command: l PWRFORWARD
Level Value: 1499
Amplifier command: l SWR
Level Value: 1.000000
Amplifier command: \\dump_caps
Caps dump for model: 1
Model name: Dummy
Mfg name: Hamlib
Backend version: 0.1
Backend copyright: LGPL
Backend status: Alpha
Amp type: Other
Port type: None
Write delay: 0mS, timeout 0mS, 0 retries
Post Write delay: 0mS
Has priv data: N
Get level: SWR NH PF PWRINPUT PWRFORWARD PWRREFLECTED PWRPEAK FAULT
Has Init: Y
Has Cleanup: Y
Has Open: Y
Has Close: Y
Can set Conf: N
Can get Conf: N
Can Reset: Y
Can get Info: Y
Overall backend warnings: 0
Amplifier command:
$
.EE
.RE
.
.
.SS ampctl Commands
.
A summary of commands is included below (In the case of
.B set
commands the quoted italicized string is replaced by the value in the
description. In the case of
.B get
commands the quoted italicized string is the key name of the value returned.):
.
.TP
.BR Q | q ", exit ampctl"
Exit ampctl in interactive mode.
.IP
When ampctl is controlling the amplifier directly, will close the amplifier
backend and port. When ampctl is connected to ampctld (amplifier model 2),
the TCP/IP connection to ampctld is closed and ampctld remains running,
available for another TCP/IP network connection.
.
.TP
.BR F ", " set_freq " \(aq" \fIFrequency\fP \(aq
Set
.RI \(aq Frequency \(aq,
in Hz.
.IP
Frequency may be a floating point or integer value.
.
.TP
.BR f ", " get_freq
Get
.RI \(aq Frequency \(aq,
in Hz.
.IP
Returns an integer value.
.
.TP
.BR l ", " get_level " \(aq" \fILevel\fP \(aq
Get
.RI \(aq "Level Value" \(aq.
.IP
Returns Level Value as a float or integer for the Level token given.
.IP
.BR Note :
Passing a \(oq?\(cq (query) as the first argument instead of a Level token
will return a space separated list of amplifier backend supported get level
tokens. Use this to determine the supported levels of a given amplifier
backend.
.
.TP
.BR w ", " send_cmd " \(aq" \fICmd\fP \(aq
Send a raw command string to the amplifier.
.IP
This is useful for testing and troubleshooting amplifier commands and
responses when developing a backend.
.IP
For binary protocols enter values as \\0xAA\\0xBB. Expect a
.RI \(aq Reply \(aq
from the amplifier which will likely be a binary block or an ASCII string
depending on the amplifier's protocol (see your amplifier's computer control
documentation).
.IP
The command terminator, set by the
.B send-cmd-term
option above, will terminate each command string sent to the amplifier. This
character should not be a part of the input string.
.
.TP
.B dump_state
Return certain state information about the amplifier backend.
.
.TP
.BR 1 ", " dump_caps
Not a real amplifier remote command, it just dumps capabilities, i.e. what the
backend knows about this model, and what it can do.
.IP
TODO: Ensure this is in a consistent format so it can be read into a hash,
dictionary, etc. Bug reports requested.
.IP
.BR Note :
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 Dummy
backend results in a number of lines of text output.
.
.TP
.BR _ ", " get_info
Return information from the amplifier backend.
.
.TP
.BR R ", " reset " \(aq" \fIReset\fP \(aq
Perform amplifier
.RI \(aq Reset \(aq.
.IP
Reset is an integer value: \(oq0\(cq = None, \(oq1\(cq = Memory reset,
\(oq2\(cq = Fault reset, \(oq3\(cq = Amplifier reset.
.
.TP
.BR set_powerstat " \(aq" "\fIPower Status\fP" \(aq
Set
.RI \(aq "Power Status" \(aq.
.IP
Power Status is an integer value: \(oq0\(cq = Power Off, \(oq1\(cq = Power On,
\(oq2\(cq = Power Standby (enter standby), \(oq4\(cq = Power Operate (leave
standby).
.
.TP
.B get_powerstat
Get
.RI \(aq "Power Status" \(aq
as in
.B set_powerstat
above.
.
.
.SH READLINE
.
If
.B Readline
library development files are found at configure time,
.B ampctl
will be conditonally built with Readline support for command and argument entry.
Readline command key bindings are at their defaults as described in the
.UR https://tiswww.cwru.edu/php/chet/readline/rluserman.html
Readline manual
.UE .
.B ampctl
sets the name \(lqampctl\(rq which can be used in Conditional Init Constructs
in the Readline Init File
.RI ( $HOME/.inputrc
by default) for custom keybindings unique to
.BR ampctl .
.
.PP
Command history is available with Readline support as described in the
.UR https://tiswww.case.edu/php/chet/readline/history.html#SEC1
Readline History manual
.UE .
Command and argument strings are stored as single lines even when arguments
are prompted for input individually. Commands and arguments are not validated
and are stored as typed with values separated by a single space.
.
.PP
Normally session history is not saved, however, use of either of the
.BR \-i / \-\-read\-history
or
.BR \-I / \-\-save\-history
options when starting
.B ampctl
will cause any previously saved history to be read in and/or the
current and any previous session history (assuming the
.BR -i " and " -I
options are given together) will be written out when
.B ampctl
is closed. Each option is mutually exclusive, i.e. either may be given
separately or in combination. This is useful to save a set of commands and
then read them later but not write the modified history for a consistent set
of test commands in interactive mode, for example.
.
.PP
History is stored in
.I $HOME/.ampctl_history
by default although the destination directory may be changed by setting the
.B AMPCTL_HIST_DIR
environment variable. When AMPCTL_HIST_DIR is unset, the value of the
.B HOME
environment variable is used instead. Only the destination directory may be
changed at this time.
.
.PP
If Readline support is not found at configure time the original internal
command handler is used. Readline is not used for
.B ampctl
commands entered on the command line regardless if Readline support is built
in or not.
.
.PP
.BR Note :
Readline support is not included in the MS Windows 32 or 64 bit binary builds
supplied by the Hamlib Project. Running
.B ampctl
on the MS Windows platform in the \(oqcmd\(cq shell does give session command
line history, however, it is not saved to disk between sessions.
.
.
.SH DIAGNOSTICS
.
The
.BR \-v ,
.B \-\-verbose
option allows different levels of diagnostics
to be output to
.B stderr
and correspond to \-v for
.BR BUG ,
\-vv for
.BR ERR ,
\-vvv for
.BR WARN ,
\-vvvv for
.BR VERBOSE ,
or \-vvvvv for
.BR 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
sent to and received from the amplifier which is very useful for amplifier
backend library development and may be requested by the developers.
.
.
.SH EXIT STATUS
.B ampctl
exits with:
.
.TP
.B 0
if all operations completed normally;
.
.TP
.B 1
if there was an invalid command line option or argument;
.
.TP
.B 2
if an error was returned by
.BR Hamlib .
.
.
.SH EXAMPLE
.
Start
.B ampctl
for am Elecraft KPA-1500 using a USB to serial adapter on Linux in interactive
mode:
.
.sp
.RS 0.5i
.EX
$ ampctl -m 201 -r /dev/ttyUSB1
.EE
.RE
.
.PP
Start
.B ampctl
for an Elecraft KPA-1500 using COM1 on MS Windows while generating TRACE
output to
.IR stderr :
.
.sp
.RS 0.5i
.EX
> ampctl -m 201 -r COM1 -vvvvv
.EE
.RE
.
.PP
Connect to a running
.B ampctld
with amplifier model 2 (\(lqNET ampctl\(rq) on the local host and specifying
the TCP port, setting frequency and mode:
.
.sp
.RS 0.5i
.EX
$ ampctl -m 2 -r localhost:4531 F 7253500
.EE
.RE
.
.
.SH BUGS
.
This almost empty section...
.PP
Report bugs to:
.IP
.nf
.MT hamlib\-developer@lists.sourceforge.net
Hamlib Developer mailing list
.ME
.fi
.
.
.SH COPYING
.
This file is part of Hamlib, a project to develop a library that simplifies
radio, rotator, and amplifier control functions for developers of software
primarily of interest to radio amateurs and those interested in radio
communications.
.
.PP
Copyright \(co 2000-2011 Stephane Fillod
.br
Copyright \(co 2000-2018 the Hamlib Group (various contributors)
.br
Copyright \(co 2010-2019 Nate Bargmann
.
.PP
This is free software; see the file COPYING for copying conditions. There is
NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.
.
.SH SEE ALSO
.
.BR less (1),
.BR more (1),
.BR ampctld (1),
.BR hamlib (7)
.
.
.SH COLOPHON
.
Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot
archives:
.IP
.UR http://www.hamlib.org
hamlib.org
.UE .

790
doc/man1/ampctld.1 100644
Wyświetl plik

@ -0,0 +1,790 @@
.\" Hey, EMACS: -*- nroff -*-
.\"
.\" For layout and available macros, see man(7), man-pages(7), groff_man(7)
.\" Please adjust the date whenever revising the manpage.
.\"
.\" Note: Please keep this page in sync with the source, ampctld.c
.\"
.TH AMPCTLD "1" "2019-12-10" "Hamlib" "Hamlib Utilities"
.
.
.SH NAME
.
ampctld \- TCP amplifier control daemon
.
.
.SH SYNOPSIS
.
.SY ampctld
.OP \-hlLuV
.OP \-m id
.OP \-r device
.OP \-s baud
.OP \-T IPADDR
.OP \-t number
.OP \-C parm=val
.RB [ \-v [ \-Z ]]
.YS
.
.
.SH DESCRIPTION
.
The
.B ampctld
program is an amplifier control daemon that handles client requests via TCP
sockets. This allows multiple user programs to share one amplifier (this
needs more development). Multiple amplifiers can be controlled on different
TCP ports by use of multiple
.B ampctld
processes. Note that multiple processes/ports are also necessary if some
clients use extended responses and/or vfo mode. So up to 4 processes/ports
may be needed for each combination of extended response/vfo mode. The syntax
of the commands are the same as
.BR ampctl (1).
It is hoped that
.B ampctld
will be especially useful for client authors using languages such as Perl,
Python, PHP, and others.
.
.PP
.B ampctld
communicates to a client through a TCP socket using text commands shared with
.BR ampctl .
The protocol is simple, commands are sent to
.B ampctld
on one line and
.B ampctld
responds to
.B get
commands with the requested values, one per line, when successful, otherwise,
it responds with one line \(lqRPRT x\(rq, where \(oqx\(cq is a negative number
indicating the error code. Commands that do not return values respond with
the line \(lqRPRT x\(rq, where \(oqx\(cq is \(oq0\(cq when successful,
otherwise is a regative number indicating the error code. Each line is
terminated with a newline \(oq\\n\(cq character. This protocol is primarily
for use by the
.B NET ampctl
(amplifier model 2) backend.
.
.PP
A separate
.B Extended Response Protocol
extends the above behavior by echoing the received command string as a header,
any returned values as a key: value pair, and the \(lqRPRT x\(rq string as the
end of response marker which includes the
.B Hamlib
success or failure value. See the
.B PROTOCOL
section for details. Consider using this protocol for clients that will
interact with
.B ampctld
directly through a TCP socket.
.
.PP
Keep in mind that Hamlib is BETA level software. While a lot of backend
libraries lack complete amplifier support, the basic functions are usually
well supported.
.
.PP
Please report bugs and provide feedback at the e-mail address given in the
.B BUGS
section below. Patches and code enhancements sent to the same address are
welcome.
.
.
.SH OPTIONS
.
This program follows the usual GNU command line syntax. Short options that
take an argument may have the value follow immediately or be separated by a
space. Long options starting with two dashes (\(oq\-\(cq) require an
\(oq=\(cq between the option and any argument.
.
.PP
Here is a summary of the supported options:
.
.TP
.BR \-m ", " \-\-model = \fIid\fP
Select amplifier model number.
.IP
See model list (use \(lqampctl -l\(rq).
.IP
.BR Note :
.B ampctl
(or third party software using the C API) will use amplifier model 2 for
.B NET ampctl
(communicating with
.BR ampctld ).
.
.TP
.BR \-r ", " \-\-amp\-file = \fIdevice\fP
Use
.I device
as the file name of the port connected to the amplifier.
.IP
Often a serial port, but could be a USB to serial adapter. Typically
.IR /dev/ttyS0 ", " /dev/ttyS1 ", " /dev/ttyUSB0 ,
etc. on Linux,
.IR COM1 ", " COM2 ,
etc. on MS Windows. The BSD flavors and Mac OS/X have their own designations.
See your system's documentation.
.
.TP
.BR \-s ", " \-\-serial\-speed = \fIbaud\fP
Set serial speed to
.I baud
rate.
.IP
Uses maximum serial speed from amplifier backend capabilities (set by
.B -m
above) as the default.
.
.TP
.BR \-t ", " \-\-port = \fInumber\fP
Use
.I number
as the TCP listening port.
.IP
The default is 4531.
.IP
.BR Note :
As
.BR rigctld 's
default port is 4532 and
.BR rotctld 's
default port is 4533, it is recommended to use DESCENDING odd numbered ports
for multiple
.BR ampctld
instances, e.g. 4529, 4527, 4525, etc.
.
.TP
.BR \-T ", " \-\-listen\-addr = \fIIPADDR\fP
Use
.I IPADDR
as the listening IP address.
.IP
The default is ANY.
.
.TP
.BR \-L ", " \-\-show\-conf
List all config parameters for the amplifier defined with
.B \-m
above.
.
.TP
.BR \-C ", " \-\-set\-conf = \fIparm=val\fP [ \fI,parm=val\fP ]
Set amplifier configuration parameter(s), e.g.
.IR stop_bits=2 .
.IP
Use the
.B -L
option above for a list of configuration parameters for a given model number.
.
.TP
.BR \-u ", " \-\-dump\-caps
Dump capabilities for the amplifier defined with
.B -m
above and exit.
.
.TP
.BR \-l ", " \-\-list
List all amplifier model numbers defined in
.B Hamlib
and exit.
.IP
The list is sorted by model number.
.IP
.BR Note :
In Linux the list can be scrolled back using
.BR Shift-PageUp / Shift-PageDown ,
or using the scrollbars of a virtual terminal in X or the cmd window in
Windows. The output can be piped to
.BR more (1)
or
.BR less (1),
e.g. \(lqampctl -l | more\(rq.
.
.TP
.BR \-v ", " \-\-verbose
Set verbose mode, cumulative (see
.B DIAGNOSTICS
below).
.
.TP
.BR \-Z ", " \-\-debug\-time\-stamps
Enable time stamps for the debug messages.
.IP
Use only in combination with the
.B -v
option as it generates no output on its own.
.
.TP
.BR \-h ", " \-\-help
Show a summary of these options and exit.
.
.TP
.BR \-V ", " \-\-version
Show version of
.B ampctl
and exit.
.
.PP
.BR Note :
Some options may not be implemented by a given backend and will return an
error. This is most likely to occur with the
.B \-\-set\-conf
and
.B \-\-show\-conf
options.
.
.PP
Please note that the backend for the amplifier to be controlled, or the
amplifier itself may not support some commands. In that case, the operation
will fail with a
.B Hamlib
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 \(oq\\n\(cq terminated
line. See
.BR PROTOCOL .
.
.PP
Since most of the
.B Hamlib
operations have a
.B set
and a
.B get
method, an upper case letter will be used for
.B set
methods whereas the corresponding lower case letter refers to the
.B get
method. Each operation also has a long name; prepend a backslash, \(oq\\\(cq,
to send a long command name.
.
.PP
Example (Perl): \(lqprint $socket "\\\\dump_caps\\n";\(rq to see what the
amplifier's backend can do
.RB ( Note :
In Perl and many other languages a \(oq\\\(cq will need to be escaped with a
preceding \(oq\\\(cq so that even though two backslash characters appear in
the code, only one will be passed to
.BR ampctld .
This is a possible bug, beware!).
.
.PP
.BR Note :
The backend for the amplifier to be controlled, or the amplifier itself may
not support some commands. In that case, the operation will fail with a
.B Hamlib
error message.
.
.PP
Here is a summary of the supported commands (In the case of
.B set
commands the quoted italicized string is replaced by the value in the
description. In the case of
.B get
commands the quoted italicized string is the key name of the value returned.):
.
.TP
.BR F ", " set_freq " \(aq" \fIFrequency\fP \(aq
Set
.RI \(aq Frequency \(aq,
in Hz.
.IP
Frequency may be a floating point or integer value.
.
.TP
.BR f ", " get_freq
Get
.RI \(aq Frequency \(aq,
in Hz.
.IP
Returns an integer value.
.
.TP
.BR l ", " get_level " \(aq" \fILevel\fP \(aq
Get
.RI \(aq "Level Value" \(aq.
.IP
Returns Level Value as a float or integer for the Level token given.
.IP
.BR Note :
Passing a \(oq?\(cq (query) as the first argument instead of a Level token
will return a space separated list of amplifier backend supported get level
tokens. Use this to determine the supported levels of a given amplifier
backend.
.
.TP
.B dump_state
Return certain state information about the amplifier backend.
.
.TP
.BR 1 ", " dump_caps
Not a real amplifier remote command, it just dumps capabilities, i.e. what the
backend knows about this model, and what it can do.
.IP
TODO: Ensure this is in a consistent format so it can be read into a hash,
dictionary, etc. Bug reports requested.
.IP
.BR Note :
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 Dummy
backend results in a number of lines of text output.
.
.TP
.BR _ ", " get_info
Return information from the amplifier backend.
.
.TP
.BR R ", " reset " \(aq" \fIReset\fP \(aq
Perform amplifier
.RI \(aq Reset \(aq.
.IP
Reset is an integer value: \(oq0\(cq = None, \(oq1\(cq = Memory reset,
\(oq2\(cq = Fault reset, \(oq3\(cq = Amplifier reset.
.
.TP
.BR set_powerstat " \(aq" "\fIPower Status\fP" \(aq
Set
.RI \(aq "Power Status" \(aq.
.IP
Power Status is an integer value: \(oq0\(cq = Power Off, \(oq1\(cq = Power On,
\(oq2\(cq = Power Standby (enter standby), \(oq4\(cq = Power Operate (leave
standby).
.
.TP
.B get_powerstat
Get
.RI \(aq "Power Status" \(aq
as in
.B set_powerstat
above.
.
.
.SH PROTOCOL
.
There are two protocols in use by
.BR ampctld ,
the
.B Default Protocol
and the
.BR "Extended Response Protocol" .
.
.PP
The
.B Default Protocol
is intended primarily for the communication between
.B Hamlib
library functions and
.B ampctld
(\(lqNET ampctl\(rq, available using amplifier model \(oq2\(cq).
.
.PP
The
.B Extended Response Protocol
is intended to be used with scripts or other programs interacting directly
with
.B ampctld
as consistent feedback is provided.
.
.
.SS Default Protocol
.
The
.B Default Protocol
is intentionally simple. Commands are entered on a single line with any
needed values. In practice, reliable results are obtained by terminating each
command string with a newline character, \(oq\\n\(cq.
.
.PP
Example set frequency and mode commands (Perl code):
.
.sp
.RS 0.5i
.EX
print $socket "F 14250000\\n";
.br
print $socket "\\\\set_powerstat 1\\n"; # escape leading '\\'
.EE
.RE
.
.PP
A one line response will be sent as a reply to
.B set
commands, \(lqRPRT \fIx\fP\\n\(rq where
.I x
is the Hamlib error code with \(oq0\(cq indicating success of the command.
.
.PP
Responses from
.B ampctld
.B get
commands are text values and match the same tokens used in the
.B set
commands. Each value is returned on its own line. On error the string \(lqRPRT
\fIx\fP\\n\(rq is returned where
.I x
is the Hamlib error code.
.
.PP
Example get frequency (Perl code):
.
.sp
.RS 0.5i
.EX
print $socket "f\\n";
.br
"14250000\\n"
.EE
.RE
.
.PP
Most
.B get
functions return one to three values. A notable exception is the
.B dump_caps
command which returns many lines of
\fBkey\fR:\fIvalue\fR
pairs.
.
.PP
This protocol is primarily used by the \(lqNET ampctl\(rq (ampctl model 2)
backend which allows applications already written for Hamlib's C API to take
advantage of
.B ampctld
without the need of rewriting application code. An application's user can
select amplifier model 2 (\(lqNET ampctl\(rq) and then set
.B amp_pathname
to \(lqlocalhost:4531\(rq or other network
.IR host : port
(set by the
.BR \-T / \-t
options, respectively, above).
.
.
.SS Extended Response Protocol
.
The Extended Response protocol adds several rules to the strings returned by
.B ampctld
and adds a rule for the command syntax.
.
.PP
1. The command received by
.B ampctld
is echoed with its long command name 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 \(lqRPRT \fIx\fP\\n\(rq where
.I x
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 amplifier 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. \(lqFrequency:
14250000\\n\(rq when the command was prepended by \(oq+\(cq.
.
.PP
4. All commands received will be acknowledged by
.B ampctld
with records from rules 1 and 2. Records from rule 3 are only returned when
data values must be returned to the client.
.
.PP
4. All commands received will be acknowledged by
.B ampctld
with records from rules 1 and 2. Records from rule 3 are only returned when
data values must be returned to the client.
.
.PP
An example response to a
.B set_frequency
command sent from the shell prompt (note the prepended \(oq+\(cq):
.
.sp
.RS 0.5i
.EX
$ echo "+F 14250000" | nc -w 1 localhost 4531
.br
set_freq: 14250000
.br
RPRT 0
.EE
.RE
.
.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 amplifier
backend return value indicating success.
.
.PP
An example response to a
.B get_freq
query:
.
.sp
.RS 0.5i
.EX
$ echo "+\\get_freq" | nc -w 1 localhost 4531
.br
get_freq:
.br
Frequency(Hz): 14250000
.br
RPRT 0
.EE
.RE
.
.IP
.BR Note :
The \(oq\\\(cq is still required for the long command name even with the ERP
character.
.
.PP
In this case, as no value is passed to
.BR ampctld ,
the first line consists only of the long command name. The final line shows
that the command was processed successfully by the amplifier backend.
.
.PP
Invoking the Extended Response Protocol requires prepending a command with a
punctuation character. As shown in the examples above, prepending a \(oq+\(cq
character to the command results in the responses being separated by a newline
character (\(oq\\n\(cq). Any other punctuation character recognized by the C
.BR ispunct ()
function except \(oq\\\(cq, \(oq?\(cq, or \(oq_\(cq will cause that character
to become the response separator and the entire response will be on one line.
.
.PP
Separator character summary:
.TP
.RB \(oq + \(cq
Each record of the response is appended with a newline (\(oq\\n\(cq).
.
.TP
.RB \(oq ; "\(cq, \(oq" | "\(cq, or, \(oq" , \(cq
Each record of the response is appended by the given character resulting in
entire response on one line.
.IP
These are common record separators for text representations of spreadsheet
data, etc.
.
.TP
.RB \(oq ? \(cq
Reserved for help in
.BR ampctl .
.
.TP
.RB \(oq _ \(cq
Reserved for
.B get_info
short command
.
.TP
.RB \(oq # \(cq
Reserved for comments when reading a command file script.
.IP
.BR Note :
Other punctuation characters have not been tested! Use at your own risk.
.
.PP
For example, invoking a
.B get_freq
query with a leading \(oq;\(cq returns:
.
.sp
.RS 0.5i
.EX
get_freq:;Frequency(Hz): 14250000;RPRT 0
.EE
.RE
.
.PP
Or, using the pipe character \(oq|\(cq returns:
.
.sp
.RS 0.5i
.EX
get_freq:|Frequency(Hz): 14250000|RPRT 0
.EE
.RE
.
.PP
And a
.B set_freq
command prepended with a \(oq|\(cq returns:
.
.sp
.RS 0.5i
.EX
set_freq: 14250000|RPRT 0
.EE
.RE
.
.PP
Such a format will allow reading a response as a single event using a preferred
response separator. Other punctuation characters have not been tested!
.
.SH DIAGNOSTICS
.
The
.BR \-v ,
.B \-\-verbose
option allows different levels of diagnostics
to be output to
.B stderr
and correspond to \-v for
.BR BUG ,
\-vv for
.BR ERR ,
\-vvv for
.BR WARN ,
\-vvvv for
.BR VERBOSE ,
or \-vvvvv for
.BR 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
sent to and received from the amplifier which is very useful for amplifier
backend library development and may be requested by the developers.
.
.
.SH EXAMPLE
.
Start
.B ampctld
for an Elecraft KPA-1500 using a USB-to-serial adapter and backgrounding:
.
.sp
.RS 0.5i
.EX
$ ampctld -m 201 -r /dev/ttyUSB1 &
.EE
.RE
.
.PP
Start
.B ampctld
for an Elecraft KPA-1500 using COM2 on MS Windows:
.
.sp
.RS 0.5i
.EX
$ ampctld -m 201 -r COM2
.EE
.RE
.
.PP
Connect to the already running
.B ampctld
and set the frequency to 14.266 MHz with a 1 second read timeout using the
default protocol from the shell prompt:
.
.sp
.RS 0.5i
.EX
$ echo "\\set_freq 14266000" | nc -w 1 localhost 4531
.EE
.RE
.
.PP
Connect to a running
.B ampctld
with
.B ampctl
on the local host:
.
.sp
.RS 0.5i
.EX
$ ampctl -m2
.EE
.RE
.
.
.SH SECURITY
.
No authentication whatsoever; DO NOT leave this TCP port open wide to the
Internet. Please ask if stronger security is needed or consider using a
Secure Shell
.RB ( ssh (1))
tunnel.
.
.PP
As
.B ampctld
does not need any greater permissions than
.BR ampctl ,
it is advisable to not start
.B ampctld
as \(lqroot\(rq or another system user account in order to limit any
vulnerability.
.
.
.SH BUGS
.
The daemon is not detaching and backgrounding itself.
.PP
No method to exit the daemon so the
.BR kill (1)
command must be used to terminate it.
.
.PP
Multiple clients using the daemon may experience contention with the connected
amplifier.
.
.PP
Report bugs to:
.IP
.nf
.MT hamlib\-developer@lists.sourceforge.net
Hamlib Developer mailing list
.ME
.fi
.
.
.SH COPYING
.
This file is part of Hamlib, a project to develop a library that simplifies
radio, rotator, and amplifier control functions for developers of software
primarily of interest to radio amateurs and those interested in radio
communications.
.
.PP
Copyright \(co 2000-2010 Stephane Fillod
.br
Copyright \(co 2000-2018 the Hamlib Group (various contributors)
.br
Copyright \(co 2011-2019 Nate Bargmann
.
.PP
This is free software; see the file COPYING for copying conditions. There is
NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.
.
.SH SEE ALSO
.
.BR kill (1),
.BR ampctl (1),
.BR ssh (1),
.BR hamlib (7)
.
.
.SH COLOPHON
.
Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot
archives:
.IP
.UR http://www.hamlib.org
hamlib.org
.UE .

Wyświetl plik

@ -5,7 +5,7 @@
.\"
.\" Note: Please keep this page in sync with the source, rigctl.c
.\"
.TH RIGCTL "1" "2018-04-29" "Hamlib" "Hamlib Utilities"
.TH RIGCTL "1" "2019-12-10" "Hamlib" "Hamlib Utilities"
.
.
.SH NAME
@ -236,7 +236,7 @@ If this is not desired, for example if you are using
to turn AI mode on or off, pass this option.
.
.TP
.B \-i ", " \-\-read\-history
.BR \-i ", " \-\-read\-history
Read previously saved command and argument history from a file (default
.IR $HOME/.rigctl_history )
for the current session.
@ -353,7 +353,8 @@ method. Each operation also has a long name; in interactive mode, prepend a
backslash, \(oq\\\(cq, to enter a long command name.
.
.PP
Example: Use \(lq\\dump_caps\(rq to see what this radio and backend support.
Example: Use \(lq\\dump_caps\(rq to see what capabilities this radio and
backend support.
.
.PP
.BR Note :
@ -414,7 +415,7 @@ $
.RE
.
.
.SS Radio Commands
.SS rigctl Commands
.
A summary of commands is included below (In the case of
.B set
@ -981,7 +982,8 @@ Set
.RI \(aq "Power Status" \(aq.
.IP
Power Status is a value: \(oq0\(cq = Power Off, \(oq1\(cq = Power On,
\(oq2\(cq = Power Standby.
\(oq2\(cq = Power Standby (enter standby), \(oq4\(cq = Power Operate (leave
standby).
.
.TP
.BR 0x88 ", " get_powerstat
@ -1006,6 +1008,10 @@ Get DTMF
Get misc information about the rig (no VFO in 'VFO mode' or value is passed).
.
.TP
.B dump_state
Return certain state information about the radio backend.
.
.TP
.BR 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.
@ -1297,15 +1303,16 @@ Hamlib Developer mailing list
.SH COPYING
.
This file is part of Hamlib, a project to develop a library that simplifies
radio and rotator control functions for developers of software primarily of
interest to radio amateurs and those interested in radio communications.
radio, rotator, and amplifier control functions for developers of software
primarily of interest to radio amateurs and those interested in radio
communications.
.
.PP
Copyright \(co 2000-2011 Stephane Fillod
.br
Copyright \(co 2000-2018 the Hamlib Group (various contributors)
.br
Copyright \(co 2010-2018 Nate Bargmann
Copyright \(co 2010-2019 Nate Bargmann
.
.PP
This is free software; see the file COPYING for copying conditions. There is

Wyświetl plik

@ -5,7 +5,7 @@
.\"
.\" Note: Please keep this page in sync with the source, rigctlcom.c
.\"
.TH RIGCTLCOM "1" "2019-01-20" "Hamlib" "Hamlib Utilities"
.TH RIGCTLCOM "1" "2019-12-10" "Hamlib" "Hamlib Utilities"
.
.
.SH NAME
@ -376,8 +376,9 @@ Hamlib Developer mailing list
.SH COPYING
.
This file is part of Hamlib, a project to develop a library that simplifies
radio and rotator control functions for developers of software primarily of
interest to radio amateurs and those interested in radio communications.
radio, rotator, and amplifier control functions for developers of software
primarily of interest to radio amateurs and those interested in radio
communications.
.
.PP
Copyright \(co 2000-2011 Stephane Fillod

Wyświetl plik

@ -5,7 +5,7 @@
.\"
.\" Note: Please keep this page in sync with the source, rigctld.c
.\"
.TH RIGCTLD "1" "2018-04-29" "Hamlib" "Hamlib Utilities"
.TH RIGCTLD "1" "2019-12-10" "Hamlib" "Hamlib Utilities"
.
.
.SH NAME
@ -41,7 +41,10 @@ sockets. This allows multiple user programs to share one radio (this needs
more development). Multiple radios can be controlled on different TCP ports
by use of multiple
.B rigctld
processes. Note that multiple processes/ports are also necessary if some clients use extended responses and/or vfo mode. So up to 4 processes/ports may be needed for each combination of extended response/vfo mode. The syntax of the commands are the same as
processes. Note that multiple processes/ports are also necessary if some
clients use extended responses and/or vfo mode. So up to 4 processes/ports
may be needed for each combination of extended response/vfo mode. The syntax
of the commands are the same as
.BR rigctl (1).
It is hoped that
.B rigctld
@ -56,13 +59,15 @@ The protocol is simple, commands are sent to
.B rigctld
on one line and
.B rigctld
responds to \(lqget\(rq commands with the requested values, one per line, when
successful, otherwise, it responds with one line \(lqRPRT x\(rq, where
\(oqx\(cq is a negative number indicating the error code. Commands that do
not return values respond with the line \(lqRPRT x\(rq, where \(oqx\(cq is
\(oq0\(cq when successful, otherwise is a regative number indicating the error
code. Each line is terminated with a newline \(oq\\n\(cq character. This
protocol is primarily for use by the
responds to
.B get
commands with the requested values, one per line, when successful, otherwise,
it responds with one line \(lqRPRT x\(rq, where \(oqx\(cq is a negative number
indicating the error code. Commands that do not return values respond with
the line \(lqRPRT x\(rq, where \(oqx\(cq is \(oq0\(cq when successful,
otherwise is a regative number indicating the error code. Each line is
terminated with a newline \(oq\\n\(cq character. This protocol is primarily
for use by the
.B NET rigctl
(radio model 2) backend.
.
@ -1167,6 +1172,7 @@ Passband: 2400
RPRT 0
.EE
.RE
.
.IP
.BR Note :
The \(oq\\\(cq is still required for the long command name even with the ERP
@ -1407,7 +1413,7 @@ command must be used to terminate it.
.
.PP
Multiple clients using the daemon may experience contention with the connected
rotator.
radio.
.
.PP
Report bugs to:
@ -1422,15 +1428,16 @@ Hamlib Developer mailing list
.SH COPYING
.
This file is part of Hamlib, a project to develop a library that simplifies
radio and rotator control functions for developers of software primarily of
interest to radio amateurs and those interested in radio communications.
radio, rotator, and amplifier control functions for developers of software
primarily of interest to radio amateurs and those interested in radio
communications.
.
.PP
Copyright \(co 2000-2010 Stephane Fillod
.br
Copyright \(co 2000-2018 the Hamlib Group (various contributors)
.br
Copyright \(co 2011-2018 Nate Bargmann
Copyright \(co 2011-2019 Nate Bargmann
.
.PP
This is free software; see the file COPYING for copying conditions. There is

Wyświetl plik

@ -5,7 +5,7 @@
.\"
.\" Note: Please keep this page in sync with the source, rigmem.c
.\"
.TH RIGMEM "1" "2018-04-29" "Hamlib" "Hamlib Utilities"
.TH RIGMEM "1" "2019-12-10" "Hamlib" "Hamlib Utilities"
.
.
.SH NAME
@ -261,13 +261,14 @@ Hamlib Developer mailing list
.SH COPYING
.
This file is part of Hamlib, a project to develop a library that simplifies
radio and rotator control functions for developers of software primarily of
interest to radio amateurs and those interested in radio communications.
radio, rotator, and amplifier control functions for developers of software
primarily of interest to radio amateurs and those interested in radio
communications.
.
.PP
Copyright \(co 2003-2011 Stephane Fillod
.br
Copyright \(co 2007,2018 Nate Bargmann
Copyright \(co 2007,2019 Nate Bargmann
.
.PP
This is free software; see the file COPYING for copying conditions. There is

Wyświetl plik

@ -5,7 +5,7 @@
.\"
.\" Note: Please keep this page in sync with the source, rigsmtr.c
.\"
.TH RIGSMTR "1" "2018-04-29" "Hamlib" "Hamlib Utilities"
.TH RIGSMTR "1" "2019-12-10" "Hamlib" "Hamlib Utilities"
.
.
.SH NAME
@ -330,13 +330,14 @@ Hamlib Developer mailing list
.SH COPYING
.
This file is part of Hamlib, a project to develop a library that simplifies
radio and rotator control functions for developers of software primarily of
interest to radio amateurs and those interested in radio communications.
radio, rotator, and amplifier control functions for developers of software
primarily of interest to radio amateurs and those interested in radio
communications.
.
.PP
Copyright \(co 2007-2009 Stephane Fillod
.br
Copyright \(co 2018 Nate Bargmann
Copyright \(co 2018,2019 Nate Bargmann
.PP
This is free software; see the file COPYING for copying conditions. There is
NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Wyświetl plik

@ -5,7 +5,7 @@
.\"
.\" Note: Please keep this page in sync with the source, rigswr.c
.\"
.TH RIGSWR "1" "2018-04-29" "Hamlib" "Hamlib Utilities"
.TH RIGSWR "1" "2019-12-10" "Hamlib" "Hamlib Utilities"
.
.
.SH NAME
@ -305,15 +305,16 @@ Hamlib Developer mailing list
.SH COPYING
.
This file is part of Hamlib, a project to develop a library that simplifies
radio and rotator control functions for developers of software primarily of
interest to radio amateurs and those interested in radio communications.
radio, rotator, and amplifier control functions for developers of software
primarily of interest to radio amateurs and those interested in radio
communications.
.
.PP
Copyright \(co 2004 Thierry Leconte
.br
Copyright \(co 2004-2011 Stephane Fillod
.br
Copyright \(co 2007,2018 Nate Bargmann
Copyright \(co 2007,2018,2019 Nate Bargmann
.PP
This is free software; see the file COPYING for copying conditions. There is
NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Wyświetl plik

@ -5,7 +5,7 @@
.\"
.\" Note: Please keep this page in sync with the source, rotctl.c
.\"
.TH ROTCTL "1" "2018-04-29" "Hamlib" "Hamlib Utilities"
.TH ROTCTL "1" "2019-12-10" "Hamlib" "Hamlib Utilities"
.
.
.SH NAME
@ -777,15 +777,16 @@ Hamlib Developer mailing list
.SH COPYING
.
This file is part of Hamlib, a project to develop a library that simplifies
radio and rotator control functions for developers of software primarily of
interest to radio amateurs and those interested in radio communications.
radio, rotator, and amplifier control functions for developers of software
primarily of interest to radio amateurs and those interested in radio
communications.
.
.PP
Copyright \(co 2001-2011 Stephane Fillod
.br
Copyright \(co 2002-2017 the Hamlib Group (various contributors)
.br
Copyright \(co 2003-2018 Nate Bargmann
Copyright \(co 2003-2019 Nate Bargmann
.
.PP
This is free software; see the file COPYING for copying conditions. There is

Wyświetl plik

@ -5,7 +5,7 @@
.\"
.\" Note: Please keep this page in sync with the source, rotctld.c
.\"
.TH ROTCTLD "1" "2018-04-29" "Hamlib" "Hamlib Utilities"
.TH ROTCTLD "1" "2019-12-10" "Hamlib" "Hamlib Utilities"
.
.
.SH NAME
@ -946,15 +946,16 @@ Hamlib Developer mailing list
.SH COPYING
.
This file is part of Hamlib, a project to develop a library that simplifies
radio and rotator control functions for developers of software primarily of
interest to radio amateurs and those interested in radio communications.
radio, rotator, and amplifier control functions for developers of software
primarily of interest to radio amateurs and those interested in radio
communications.
.
.PP
Copyright \(co 2000-2009 Stephane Fillod
.br
Copyright \(co 2000-2018 the Hamlib Group (various contributors)
.br
Copyright \(co 2011-2018 Nate Bargmann
Copyright \(co 2011-2019 Nate Bargmann
.
.PP
This is free software; see the file COPYING for copying conditions. There is

Wyświetl plik

@ -360,7 +360,7 @@ int HAMLIB_API amp_open(AMP *amp)
case RIG_PORT_NETWORK:
case RIG_PORT_UDP_NETWORK:
/* FIXME: default port */
status = network_open(&rs->ampport, 4533);
status = network_open(&rs->ampport, 4531);
if (status < 0)
{

Wyświetl plik

@ -106,7 +106,7 @@ static struct option long_options[] =
int interactive = 1; /* no cmd because of daemon */
int prompt = 0 ; /* Daemon mode for rigparse return string */
const char *portno = "4533";
const char *portno = "4531";
const char *src_addr = NULL; /* INADDR_ANY */
char send_cmd_term = '\r'; /* send_cmd termination char */