ampctl

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

-m, --model=id

Select amplifier model number.

See model list (use “ampctl -l”).

Note: ampctl (or third party software using the C API) will use amplifier model 2 for NET ampctl (communicating with ampctld).

-r, --amp-file=device

Use device as the file name of the port connected to the amplifier.

Often a serial port, but could be a USB to serial adapter. Typically /dev/ttyS0, /dev/ttyS1, /dev/ttyUSB0, etc. on Linux, COM1, COM2, etc. on MS Windows. The BSD flavors and Mac OS/X have their own designations. See your system's documentation.

-s, --serial-speed=baud

Set serial speed to baud rate.

Uses maximum serial speed from amplifier backend capabilities (set by -m above) as the default.

-t, --send-cmd-term=char

Change the termination char for text protocol when using the send_cmd command.

The default value is ASCII CR (‘0x0D’). ASCII non-printing characters can be given as the ASCII number in hexadecimal format prepended with “0x”. You may pass an empty string for no termination char. The string “-1” tells ampctl to switch to binary protocol.

For example, to specify a command terminator for Kenwood style text commands pass “-t ';'” to ampctl. See EXAMPLE below.

-L, --show-conf

List all config parameters for the amplifier defined with -m above.

-C, --set-conf=parm=val[,parm=val]

Set amplifier configuration parameter(s), e.g. stop_bits=2.

Use the -L option above for a list of configuration parameters for a given model number.

-u, --dump-caps

Dump capabilities for the amplifier defined with -m above and exit.

-l, --list

List all amplifier model numbers defined in Hamlib and exit.

The list is sorted by model number.

Note: In Linux the list can be scrolled back using 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 more(1) or less(1), e.g. “ampctl -l | more”.

-i, --read-history

Read previously saved command and argument history from a file (default $HOME/.ampctl_history) for the current session.

Available when ampctl is built with Readline support (see READLINE below).

Note: To read a history file stored in another directory, set the AMPCTL_HIST_DIR environment variable, e.g. “AMPCTL_HIST_DIR=~/tmp ampctl -i”. When AMPCTL_HIST_DIR is not set, the value of HOME is used.

-I, --save-history

Write current session (and previous session(s), if -i option is given) command and argument history to a file (default $HOME/.ampctl_history) at the end of the current session.

Complete commands with arguments are saved as a single line to be recalled and used or edited. Available when ampctl is built with Readline support (see READLINE below).

Note: To write a history file in another directory, set the AMPCTL_HIST_DIR environment variable, e.g. “AMPCTL_HIST_DIR=~/tmp ampctl -I)Rq. When AMPCTL_HIST_DIR is not set, the value of HOME is used.

-v, --verbose

Set verbose mode, cumulative (see DIAGNOSTICS below).

-Z, --debug-time-stamps

Enable time stamps for the debug messages.

Use only in combination with the -v option as it generates no output on its own.

-h, --help

Show a summary of these options and exit.

-V, --version

Show version of ampctl and exit.

-

Stop option processing and read commands from standard input.

See Standard Input below.

COMMANDS

F 14250000

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 Hamlib error message.

$ 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:

$

ampctl Commands

Q|q, exit ampctl

Exit ampctl in interactive mode.

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.

F, set_freq 'Frequency'

Set 'Frequency', in Hz.

Frequency may be a floating point or integer value.

f, get_freq

Get 'Frequency', in Hz.

Returns an integer value.

l, get_level 'Level'

Get 'Level Value'.

Returns Level Value as a float or integer for the Level token given.

Note: Passing a ‘?’ (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.

w, send_cmd 'Cmd'

Send a raw command string to the amplifier.

This is useful for testing and troubleshooting amplifier commands and responses when developing a backend.

For binary protocols enter values as \0xAA\0xBB. Expect a 'Reply' 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).

The command terminator, set by the 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.

dump_state

Return certain state information about the amplifier backend.

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.

TODO: Ensure this is in a consistent format so it can be read into a hash, dictionary, etc. Bug reports requested.

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.

_, get_info

Return information from the amplifier backend.

R, reset 'Reset'

Perform amplifier 'Reset'.

Reset is an integer value: ‘0’ = None, ‘1’ = Memory reset, ‘2’ = Fault reset, ‘3’ = Amplifier reset.

set_powerstat 'Power Status'

Set 'Power Status'.

Power Status is an integer value: ‘0’ = Power Off, ‘1’ = Power On, ‘2’ = Power Standby (enter standby), ‘4’ = Power Operate (leave standby).

get_powerstat

Get 'Power Status' as in set_powerstat above.

Y, set_ant 'Antenna' 'Option'

Set 'Antenna' and 'Option'.

Number is 1-based antenna# (‘1’, ‘2’, ‘3’, ...).

1 = A/1
2 = B/2
3 = C/3
    

READLINE

DIAGNOSTICS

EXIT STATUS

0

if all operations completed normally;

1

if there was an invalid command line option or argument;

2

if an error was returned by Hamlib.

EXAMPLES

$ ampctl -m 201 -r /dev/ttyUSB1

> ampctl -m 201 -r COM1 -vvvvv

$ ampctl -m 2 -r localhost:4531 F 7253500

BUGS

Hamlib Developer mailing list

COPYING

SEE ALSO

COLOPHON