rigctld (8) Linux Manual Page

rigctld – Hamlib TCP rig control daemon

Synopsis

rigctld [OPTION]…

Description

The rigctld program is a NEW Hamlib rig control daemon ready for testing that handles client requests via TCP sockets. This allows multiple user programs to share one radio (this needs testing), except on Win32 where pthreads are not available. Multiple radios can be controlled on different TCP ports by use of multiple rigctld processes. The syntax of the commands are the same as rigctl. It is hoped that rigctld will be especially useful for client authors using languages such as Perl, Python, PHP, and others.

rigctld communicates to a client through a TCP socket using text commands shared with rigctl. The protocol is simple; commands are sent to rigctld on one line and rigctld responds to "get" commands with the requested values, one per line, when successful, otherwise, it responds with one line "RPRT x", where x is a negative number indicating the error code. Commands that do not return values respond with the line "RPRT x", where x is zero when successful, otherwise is a regative number indicating the error code. Each line is terminated with a newline ‘
’ character. This protocol is primarily for use by the NET rigctl (rig model 2)backend.

A separate 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 "RPRT x" string as the end of response marker which includes the Hamlib success or failure value. See the PROTOCOL section for details. Consider using this protocol for clients that will interact with rigctld directly through a TCP socket.

Keep in mind that Hamlib is BETA level software. While a lot of backend libraries lack complete rig support, the basic functions are usually well supported. The API may change without publicized notice, while an advancement of the minor version (e.g. 1.1.x to 1.2.x) indicates such a change.

Please report bugs and provide feedback at the e-mail address given in the REPORTING BUGS section. Patches and code enhancements are also welcome.

Options

This program follows the usual GNU command line syntax, with long options starting with two dashes (‘-‘).

Here is a summary of the supported options:

-m, –model=id

Select radio model number. See the -l, –list option below.

-r, –rig-file=device

Use device as the file name of the port the radio is connected. Often a serial port, but could be a USB to serial adapter or USB port device. Typically /dev/ttyS0, /dev/ttyS1, /dev/ttyUSB0, etc. on Linux or COM1, COM2, etc. on Win32.

-p, –ptt-file=device

Use device as the file name of the Push-To-Talk device using a device file as described above.

-d, –dcd-file=device

Use device as the file name of the Data Carrier Detect device using a device file as described above.

-P, –ptt-type=type

Use type of Push-To-Talk device. Supported types are RIG (CAT command), DTR, RTS, PARALLEL, NONE.

-D, –dcd-type=type

Use type of Data Carrier Detect device. Supported types are RIG (CAT command), DSR, CTS, CD, PARALLEL, NONE.

-s, –serial-speed=baud

Set serial speed to baud rate. Uses maximum serial speed from rig backend capabilities (set by -m above) as the default.

-c, –civaddr=id

Use id as the CI-V address to communicate with the rig. Only useful for Icom rigs.

N.B.: The id is in decimal notation, unless prefixed by 0x for a hexadecimal value.

-T, –listen-addr=IPADDR

Use IPADDR as the listening IP address. The default is ANY.

N.B.: This option seems mandatory on Win32, eg: -T 127.0.0.1

-t, –port=number

Use number as the TCP listening port. The default is 4532.

N.B.: As rotctld‘s default port is 4533, it is advisable to use even numbered ports for rigctld, e.g. 4532, 4534, 4536, etc.

N.B.: This option seems mandatory on Win32, eg: -t 4532

-L, –show-conf

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

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

Set config parameter. e.g. –set-conf=stop_bits=2

Use -L option for a list.

-l, –list

List all model numbers defined in Hamlib and exit. As of 1.2.15.1 the list is sorted by model number.

N.B. 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’ or ‘less’, e.g. ‘rigctld -l | more’.

-u, –dump-caps

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

-o, –vfo

Set vfo mode, requiring an extra VFO argument in front of each appropriate command (except \set_vfo!). Otherwise, ‘currVFO’ is assumed when this option is not set and an extra VFO argument is not used. See