--- name: "rigctl" section: "1" platform: "linux" package: "hamlib" version: "4.7.2-2" release: "Arch Linux 2026-11-01" platforms: ["linux"] url: "https://new.carta.tech/rigctl" --- # rigctl(1) control radio transceivers and receivers ## NAME rigctl - control radio transceivers and receivers ## SYNOPSIS **rigctl** \[**-hiIlLnouV**\] \[**-m** *id*\] \[**-r** *device*\] \[**-p** *device*\] \[**-d** *device*\] \[**-P** *type*\] \[**-D** *type*\] \[**-s** *baud*\] \[**-c** *id*\] \[**-t** *char*\] \[**-C** *parm=val*\] -Y \[**-v**\[**-Z**\]\] \[**command**\|**-**\] ## DESCRIPTION Control radio transceivers and receivers. **rigctl** accepts **commands** from the command line as well as in interactive mode if none are provided on the command line. 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. Please report bugs and provide feedback at the e-mail address given in the **BUGS** section below. Patches and code enhancements sent to the same address are welcome. ## 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 (‘-’) require an ‘=’ between the option and any argument. Here is a summary of the supported options: - **-m**, **--model**=***id*** Select radio model number. Defaults to dummy rig. - See model list (use “rigctl -l”). - **Note**: **rigctl** (or third party software using the C API) will use radio model 2 for **NET rigctl** (communicating with **rigctld**). - **-r**, **--rig-file**=***device*** Use *device* as the file name of the port connected to the radio. - 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. - Can be a network address:port, e.g. *127.0.0.1:12345* - The special string “uh-rig” may be given to enable micro-ham device support. - **-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’, ‘CM108’, ‘GPIO’, ‘GPION’, ‘NONE’, overriding PTT type defined in the rig's backend. - Some side effects of this command are that when type is set to DTR, read PTT state comes from the **Hamlib** frontend, not read from the radio. When set to NONE, PTT state cannot be read or set even if rig backend supports reading/setting PTT status from the rig. - **-D**, **--dcd-type**=***type*** Use *type* of Data Carrier Detect device. - Supported types are ‘RIG’ (CAT command), ‘DSR’, ‘CTS’, ‘CD’, ‘PARALLEL’, ‘CM108’, ‘GPIO’, ‘GPION’, ‘NONE’. - **-s**, **--serial-speed**=***baud*** Set serial speed to *baud* rate. - Uses maximum serial speed from radio 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 and some Ten-Tec rigs. - **Note**: The *id* is in decimal notation, unless prefixed by *0x*, in which case it is hexadecimal. - **-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 **rigctl** to switch to binary protocol. See the **send\_cmd** command for further explanation. - For example, to specify a command terminator for Kenwood style text commands pass “-t ';'” to rigctl. See **EXAMPLE** below. - **-L**, **--show-conf** List all config parameters for the radio defined with **-m** above. - **-C**, **--set-conf**=***parm=val***\[***,parm=val***\] Set configuration parameter(s). Some common ones are: ``` async:True enables asynchronous data transfer for backends that support it. This allows use of transceive and spectrum data. auto_power_on:True enables compatible rigs to be powered up on open auto_power_off:True enables compatible rigs to be powered down on close auto_disable_screensaver:True enables compatible rigs to have their screen saver disabled on open dcd_type:Data Carrier Detect (or squelch) interface type override dcd_pathname:Path name to the device file of the Data Carrier Detect (or squelch) disable_yaesu_bandselect:True disables the automatic band select on band change for Yaesu rigs dtr_state:ON turns on DTR, OFF turns it off, Unset disables it freq_skip:!=0 skips setting freq on TX_VFO when in RX and on RX_VFO when in TX -- for use with gpredict and rigs that do not have TARGETABLE_VFO lo_freq:Frequency to add to the VFO frequency for use with a transverter post_write_delay:Delay in ms between each command sent out ptt_share:True enables ptt port to be shared with other apps ptt_type:Push-To-Talk interface type override ptt_pathname:Path name to the device file of the Push-To-Talk ptt_bitnum:Push-To-Talk GPIO bit number retry:Max number of retry rts_state:ON turns on DTR, OFF turns it off, Unset disables it twiddle_timeout:For satellite ops when VFOB is twiddled will pause VFOB commands until timeout twiddle_rit:Suppress get_freq on VFOB for RIT tuning satellites timeout:Timeout in ms write_delay:Delay in ms between each byte sent out tuner_control_pathname:Path name to a script/program to control a tuner with 1 argument of 0/1 for Tuner Off/On ``` - Use the **-L** option above for a list of configuration parameters for a given model number. - **-u**, **--dump-caps** Dump capabilities for the radio defined with **-m** above and exit. - **-l**, **--list** List all 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)](/more/1.md) or [**less**(1)](/less/1.md), e.g. “rigctl -l \| more”. - **-o**, **--vfo** Enable vfo mode. - An extra VFO argument will be required in front of each appropriate command (except **set\_vfo**). Otherwise, ‘currVFO’ is used when this option is not set and an extra VFO argument is not used. - **-n**, **--no-restore-ai** On exit **rigctl** restores the state of auto information (AI) on the controlled rig. - If this is not desired, for example if you are using **rigctl** to turn AI mode on or off, pass this option. - **-i**, **--read-history** Read previously saved command and argument history from a file (default *$HOME/.rigctl\_history*) for the current session. - Available when **rigctl** is built with Readline support (see READLINE below). - **Note**: To read a history file stored in another directory, set the **RIGCTL\_HIST\_DIR** environment variable, e.g. “RIGCTL\_HIST\_DIR=~/tmp rigctl -i”. When RIGCTL\_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/.rigctl\_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 **rigctl** is built with Readline support (see **READLINE** below). - **Note**: To write a history file in another directory, set the **RIGCTL\_HIST\_DIR** environment variable, e.g. “RIGCTL\_HIST\_DIR=~/tmp rigctl -IRq. When RIGCTL\_HIST\_DIR is not set, the value of **HOME** is used. - **-v**, **--verbose** Set verbose mode, cumulative (see **DIAGNOSTICS** below). - **-Y**,**--ignore-err** Ignores rig open errors - **-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 **rigctl** and exit. - **-!**, **--cookie** Sets the cookie to be used for remote access security - **-#**, **--skip\_init** Skips most startup initialization. - **-** Stop option processing and read commands from standard input. - See **Standard Input** below. **Note**: Some options may not be implemented by a given backend and will return an error. This is most likely to occur with the **--set-conf** and **--show-conf** options. Please note that the backend for the radio to be controlled, or the radio itself may not support some commands. In that case, the operation will fail with a **Hamlib** error code. ## 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: ``` M LSB 2400 ``` Since most of the **Hamlib** operations have a **set** and a **get** method, a single upper case letter will be used for **set** methods whereas the corresponding single lower case letter refers to the **get** method. Each operation also has a long name; in interactive mode, prepend a backslash, ‘\\’, to enter a long command name all lower case. Example: Use “\\dump\_caps” to see what capabilities this radio and backend support. - **Note**: The backend for the radio to be controlled, or the radio itself may not support some commands. In that case, the operation will fail with a **Hamlib** error message. ### Standard Input As an alternative to the **READLINE** interactive command entry or a single command for each run, **rigctl** features a special option where a single dash (‘-’) may be used to read commands from standard input (**stdin**). Commands must be separated by whitespace similar to the commands given on the command line. Comments may be added using the ‘#’ character, all text up until the end of the current line including the ‘#’ character is ignored. A simple example (typed text is in bold): ``` $ cat <<.EOF. >cmds.txt > # File of commands > v f m # query rig > V VFOB F 14200000 M CW 500 # set rig > v f m # query rig > .EOF. $ rigctl -m1 - 0 is 1-based antenna# (‘1’, ‘2’, ‘3’, ...). - Option returned depends on rig. For Icom it is likely the RX only flag. - **b**, **send\_morse** '***Morse***' Send '*Morse*' symbols. For Yaesu rigs use memory# (1-5 for most rigs) or up to 50 char message (which will use memory#1) Example from command line: ``` rigctl -m 3073 -r /dev/ttyUSB0 b "CQ CQ DE ME" ``` Yaesu example to send message#1: ``` rigctl -m 1035 -r /dev/ttyUSB0 b 1 ``` - **0xbb**, **stop\_morse** Stop sending the current morse code. - **0xbc**, **wait\_morse** Wait for morse to finish -- only works on full break-in. - **0x94**, **send\_voice\_mem** '***Msgnum***' Have rig transmit internal message '*Msgnum*' - **0xab**, **stop\_voice\_mem** Stop transmission of internal message - **0x8b**, **get\_dcd** Get '*DCD*' (squelch) status: ‘0’ (Closed) or ‘1’ (Open). - **0x8d**, **set\_twiddle** '***Timeout***' Set the twiddle '*Timeout*' in seconds. - **0x8e**, **get\_twiddle** Get the twiddle '*Timeout*' in seconds. - **R**, **set\_rptr\_shift** '***Rptr Shift***' Set '*Rptr Shift*'. - Rptr Shift is one of: ‘+’, ‘-’, or something else for ‘None’. - **r**, **get\_rptr\_shift** Get '*Rptr Shift*'. - Returns ‘+’, ‘-’, or ‘None’. - **O**, **set\_rptr\_offs** '***Rptr Offset***' Set '*Rptr Offset*', in Hz. - **o**, **get\_rptr\_offs** Get '*Rptr Offset*', in Hz. - **C**, **set\_ctcss\_tone** '***CTCSS Tone***' Set '*CTCSS Tone*', in tenths of Hz. - **c**, **get\_ctcss\_tone** Get '*CTCSS Tone*', in tenths of Hz. - **D**, **set\_dcs\_code** '***DCS Code***' Set '*DCS Code*'. - **d**, **get\_dcs\_code** Get '*DCS Code*'. - **0x90**, **set\_ctcss\_sql** '***CTCSS Sql***' Set '*CTCSS Sql*' tone, in tenths of Hz. - **0x91**, **get\_ctcss\_sql** Get '*CTCSS Sql*' tone, in tenths of Hz. - **0x92**, **set\_dcs\_sql** '***DCS Sql***' Set '*DCS Sql*' code. - **0x93**, **get\_dcs\_sql** Get '*DCS Sql*' code. - **0x95**, **set\_cache** '***Timeout***' Set cache timeout in ms. - **0x96**, **get\_cache** Get cache timeout in ms. - **0x97**, **uplink** '***Uplink***' Set the uplink VFO to '*Uplink*' (1=Sub, 2=Main). - **N**, **set\_ts** '***Tuning Step***' Set '*Tuning Step*', in Hz. - **n**, **get\_ts** Get '*Tuning Step*', in Hz. - **U**, **set\_func** '***Func***' '***Func Status***' Set '*Func*' and '*Func Status*'. - Func is a token: ‘ABM’, ‘AFC’, ‘AFLT’, ‘AIP’, ‘ANF’, ‘ANL’, ‘APF’, ‘ARO’, ‘BC2’, ‘BC’, ‘COMP’, ‘CSQL’, ‘DIVERSITY’, ‘DSQL’, ‘DUAL\_WATCH’, ‘FAGC’, ‘FBKIN’, ‘LOCK’, ‘MBC’, ‘MN’, ‘MON’, ‘MUTE’, ‘NB2’, ‘NB’, ‘NR’, ‘OVF\_STATUS’, ‘RESUME’, ‘REV’, ‘RF’, ‘RIT’, ‘SATMODE’, ‘SBKIN’, ‘SCEN’, ‘SCOPE’, ‘SEND\_MORSE’, ‘SEND\_VOICE\_MEM’, ‘SPECTRUM’, ‘SPECTRUM\_HOLD’, ‘SQL’, ‘SYNC’, ‘TBURST’, ‘TONE’, ‘TRANSCEIVE’, ‘TSQL’, ‘TUNER’, ‘VOX’, ‘VSC’, ‘XIT’. ABM -- Auto Band Mode\ AFC -- Auto Frequency Control ON/OFF\ AFLT -- AF Filter setting\ AIP -- RF pre-amp (AIP on Kenwood, IPO on Yaesu, etc.)\ ANF -- Automatic Notch Filter (DSP)\ ANL -- Noise limiter setting\ APF -- Audio Peak Filter\ ARO -- Auto Repeater Offset\ BC -- Beat Canceller\ BC2 -- 2nd Beat Cancel\ COMP -- Speech Compression\ CSQL -- DCS Squelch setting\ DIVERSITY -- Diversity receive\ DSQL -- Digital modes squelch\ DUAL\_WATCH -- Dual Watch / Sub Receiver\ FAGC -- Fast AGC\ FBKIN -- Full Break-in (CW mode)\ LOCK -- Lock\ MBC -- Manual Beat Canceller\ MN -- Manual Notch\ MON -- Monitor transmitted signal\ MUTE -- Mute\ NB -- Noise Blanker\ NB2 -- 2nd Noise Blanker\ NR -- Noise Reduction (DSP)\ OVF\_STATUS -- Read overflow status 0=Off, 1=On\ RESUME -- Scan auto-resume\ REV -- Reverse transmit and receive frequencies\ RF -- RTTY Filter\ RIT -- Receiver Incremental Tuning\ SATMODE -- Satellite mode ON/OFF\ SBKIN -- Semi Break-in (CW mode)\ SCEN -- scrambler/encryption\ SCOPE -- Simple bandscope ON/OFF\ SEND\_MORSE -- Send specified characters using CW\ SEND\_VOICE\_MEM -- Transmit in SSB message stored in memory\ SPECTRUM -- Spectrum scope data output ON/OFF\ SPECTRUM\_HOLD -- Pause spectrum scope updates ON/OFF\ SQL -- Turn Squelch Monitor on/off\ SYNC -- Synchronize VFOs\ TBURST -- 1750 Hz tone burst\ TONE -- CTCSS Tone TX\ TRANSCEIVE -- Send radio state changes automatically ON/OFF\ TSQL -- CTCSS Activate/De-activate RX\ TUNER -- Enable automatic tuner\ VOX -- Voice Operated Relay\ VSC -- Voice Scan Control\ XIT -- Transmitter Incremental Tuning - Func Status is a non null value for “activate” or “de-activate” otherwise, much as TRUE/FALSE definitions in the C language (true is non-zero and false is zero, ‘0’). - **Note**: Passing a ‘?’ (query) as the first argument instead of a Func token will return a space separated list of radio backend supported set function tokens. Use this to determine the supported functions of a given radio backend. - **u**, **get\_func** '***Func***' Get '*Func Status*'. - Returns Func Status as a non null value for the Func token given as in **set\_func** above. - **Note**: Passing a ‘?’ (query) as the first argument instead of a Func token will return a space separated list of radio backend supported get function tokens. Use this to determine the supported functions of a given radio backend. - **L**, **set\_level** '***Level***' '***Level Value***' Set '*Level*' and '*Level Value*'. - Level is a token: ‘AF’, ‘AGC’, ‘AGC\_TIME’, ‘ALC’, ‘ANTIVOX’, ‘APF’, ‘ATT’, ‘BAL’, ‘BAND\_SELECT’, ‘BKINDL’, ‘BKIN\_DLYMS’, ‘COMP’, ‘COMP\_METER’, ‘CWPITCH’, ‘ID\_METER’, ‘IF’, ‘KEYSPD’, ‘METER’, ‘MGC’, ‘MGF’, ‘MGL’, ‘MICGAIN’, ‘MONITOR\_GAIN’, ‘NB’, ‘NOTCHF’, ‘NOTCHF\_RAW’, ‘NR’, ‘PBT\_IN’, ‘PBT\_OUT’, ‘PREAMP’, ‘RAWSTR’, ‘RF’, ‘RFPOWER’, ‘RFPOWER\_METER’, ‘RFPOWER\_METER\_WATTS’, ‘SLOPE\_HIGH’, ‘SLOPE\_LOW’, ‘SPECTRUM\_ATT’, ‘SPECTRUM\_AVG’, ‘SPECTRUM\_EDGE\_HIGH’, ‘SPECTRUM\_EDGE\_LOW’, ‘SPECTRUM\_MODE’, ‘SPECTRUM\_REF’, ‘SPECTRUM\_SPAN’, ‘SPECTRUM\_SPEED’, ‘SQL’, ‘STRENGTH’, ‘SWR’, ‘TEMP\_METER’, ‘USB\_AF’, ‘USB\_AF\_INPUT’, ‘VD\_METER’, ‘VOXDELAY’, ‘VOXGAIN’. - The Level Value can be a float or an integer value. For the AGC token the value is one of ‘0’ = OFF, ‘1’ = SUPERFAST, ‘2’ = FAST, ‘3’ = SLOW, ‘4’ = USER, ‘5’ = MEDIUM, ‘6’ = AUTO. Note that not all values work on all rigs. To list usable values do ``` rigctl -m MODEL_ID -u | grep "AGC levels" ``` or for Windows ``` rigctl -m MODEL_ID -u | find "AGC levels" ``` - Level units ``` 0.0-1.0 where 0=0% and 1.0=100% (except for BAL where 50% is center) AF, ALC, ANTIVOX, BAL, COMP, MICGAIN, MONITOR_GAIN, NOTCHF_RAW, NR, RF, RFPOWER, RFPOWER_METER, USB_AF, VOXGAIN Amps ID_METER(A) dB NL, COMP_METER, PREAMP, ATT, SLOPE_LOW, SLOPE_HIGH, SPECTRUM_REF, SPECTRUM_ATT, STRENGTH Degrees(temperature) TEMP_METER(C) Hz CWPITCH, IF, NOTCHF, PBT_IN, PBT_OUT, SPECTRUM_EDGE_LOW, SPECTRUM_EDGE_HIGH, SPECTRUM_SPAN Seconds VOXDELAY(ds), BKINDL(ms), BKIN_DLYMS(ms) Raw info from rig RAWSTR, BANDSELECT (subject to change -- index right now but may convert to band name) SWR SWR Volts VD_METER Lookup - if level shows 0/0/0 then it's probably a lookup value METER RIG_METER_XXXX 1=SWR, 2=COMP, 4=ALC, 8=IC, 16=DB, 32=PO, 64=VDD, 128=Temp AGC 0=None, 1=SuperFast, 2=Fast, 3=Slow, 4=User, 5=Medium, 6=Auto Note: Not all AGC values may be available -- see AGC Level in dumpcaps (e.g. rigctl -m 1035 -u | grep AGC) SPECTRUM_MODE 0=None, 1=Center, 2=Fixed, 3=Center Scroll, 4=Fixed Scroll SPECTRUM_AVG rig specific METER -- SWR,COMP,ALC,IC/ID,DB,PO,VDD,TEMP or can use the numbers above in Lookup l METER returns the meter number=name Watts RFPOWER_METER_WATTS WPM KEYSPD ``` - **Note**: Passing a ‘?’ (query) as the first argument instead of a Level token will return a space separated list of radio backend supported set level tokens. Use this to determine the supported levels of a given radio backend. - **l**, **get\_level** '***Level***' Get '*Level Value*'. - Returns Level Value as a float or integer for the Level token given as in **set\_level** above. - **Note**: Passing a ‘?’ (query) as the first argument instead of a Level token will return a space separated list of radio backend supported get level tokens. Use this to determine the supported levels of a given radio backend. - **P**, **set\_parm** '***Parm***' '***Parm Value***' Set '*Parm*' and '*Parm Value*'. - Parm is a token: ‘AFIF’, ‘AFIF\_ACC’, ‘AFIF\_LAN’, ‘AFIF\_WLAN’, ‘ANN’, ‘APO’, ‘BACKLIGHT’, ‘BANDSELECT’, ‘BAT’, ‘BEEP’, ‘KEYERTYPE’, ‘KEYLIGHT’, ‘SCREENSAVER’, ‘TIME’. - **Note**: Passing a ‘?’ (query) as the first argument instead of a Parm token will return a space separated list of radio backend supported set parameter tokens. Use this to determine the supported parameters of a given radio backend. - ANN -- "Announce" level, see ann\_t\ APO -- Auto power off, int in minute\ BACKLIGHT -- LCD light, float \[0.0 ... 1.0\]\ BEEP -- Beep on keypressed, int (0,1)\ TIME -- hh:mm:ss, int in seconds from 00:00:00\ BAT -- battery level, float \[0.0 ... 1.0\]\ KEYLIGHT -- Button backlight, on/off\ SCREENSAVER -- rig specific timeouts\ AFIF -- 0=AF audio, 1=IF audio -- see IC-7300/9700/705\ BANDSELECT -- band name, e.g. BAND160M, BAND80M.... a ? instead of band will show band possibilities\ KEYERTYPE -- Icom keyer type 0,1,2 or STRAIGHT,BUG,PADDLE - **p**, **get\_parm** '***Parm***' Get '*Parm Value*'. - Returns Parm Value as a float or integer for the Parm token given as in **set\_parm** above. - **Note**: Passing a ‘?’ (query) as the first argument instead of a Parm token will return a space separated list of radio backend supported get parameter tokens. Use this to determine the supported parameters of a given radio backend. - **B**, **set\_bank** '***Bank***' Set '*Bank*'. - Sets the current memory bank number. - **E**, **set\_mem** '***Memory#***' Set '*Memory#*' channel number. - **e**, **get\_mem** Get '*Memory#*' channel number. - **G**, **vfo\_op** '***Mem/VFO Op***' Perform a '*Mem/VFO Op*'. - Mem/VFO Operation is a token: ‘CPY’, ‘XCHG’, ‘FROM\_VFO’, ‘TO\_VFO’, ‘MCL’, ‘UP’, ‘DOWN’, ‘BAND\_UP’, ‘BAND\_DOWN’, ‘LEFT’, ‘RIGHT’, ‘TUNE’, ‘TOGGLE’. - **Note**: Passing a ‘?’ (query) as the first argument instead of a Mem/VFO Op token will return a space separated list of radio backend supported Set Mem/VFO Op tokens. Use this to determine the supported Mem/VFO Ops of a given radio backend. - **g**, **scan** '***Scan Function***' '***Scan Channel***' Perform a '*Scan Function*' on a '*Scan Option*'. - Scan Function is a token: ‘DELTA’, ‘MEM’, ‘PLT’, ‘PRIO’, ‘PROG’, ‘SLCT’, ‘STOP’, ‘VFO’. - Scan Option is an integer. - Scan Option for Yaesu rigs 0=STOP, 1=UP, 2=DOWN. - Scan Option for Icom rigs is a channel number to program with G otherwise not used. - Scan Option for Kenwood rigs is not used. - **Note**: Passing a ‘?’ (query) as the first argument instead of a Scan Fct token will return a space separated list of radio backend supported Scan Function tokens. Use this to determine the supported Scan Functions of a given radio backend. - **H**, **set\_channel** '***Channel***' Set memory '*Channel*' data. - Sets memory channel information - **h**, **get\_channel** '***Channel***' **'***readonly***'** Get channel memory. - If readonly!=0 then only channel data is returned and rig remains on the current channel. If readonly=0 then rig will be set to the channel requested. - **A**, **set\_trn** '***Transceive***' Set '*Transceive*' mode. - Transceive is a token: ‘OFF’, ‘RIG’, ‘POLL’. - Transceive is a mechanism for radios to report events without a specific call for information. - **Note**: Passing a ‘?’ (query) as the first argument instead of a Transceive token will return a space separated list of radio backend supported Transceive mode tokens. Use this to determine the supported Transceive modes of a given radio backend. - **a**, **get\_trn** Get '*Transceive*' mode. - Transceive mode (reporting event) as in **set\_trn** above. - **\***, **reset** '***Reset***' Perform rig '*Reset*'. - Reset is a value: ‘0’ = None, ‘1’ = Software reset, ‘2’ = VFO reset, ‘4’ = Memory Clear reset, ‘8’ = Master reset. - Since these values are defined as a bitmask in *include/hamlib/rig.h*, it should be possible to OR these values together to do multiple resets at once, if the backend supports it or supports a reset action via rig control at all. - **0x87**, **set\_powerstat** '***Power Status***' Set '*Power Status*'. - Power Status is a value: ‘0’ = Power Off, ‘1’ = Power On, ‘2’ = Power Standby (enter standby), ‘4’ = Power Operate (leave standby). - **0x88**, **get\_powerstat** Get '*Power Status*' as in **set\_powerstat** above. - **0x89**, **send\_dtmf** '***Digits***' Set DTMF '*Digits*'. - **0x8a**, **recv\_dtmf** Get DTMF '*Digits*'. - **0xac**, **set\_conf** '***Token***' '***Value***' Set '*Token*' to '*Value*'. - **0xad**, **get\_conf** '***Token***' Get value of '*Token*'. - **\_**, **get\_info** Get misc information about the rig. - **0xf5**, **get\_rig\_info** Get misc information about the rig vfo status and other info. - **0xf1**, **halt** When issued inside **rigctl** it quits it; when issued by another client it quits **rigctld** instead. - **0xf3**, **get\_vfo\_info** '***VFO***' Get misc information about a specific vfo. - **0xf4**, **get\_vfo\_list** Get the names of the available VFOs. - **0xf6**, **get\_modes** Get all supported bandwidths for all modes. - **0xf7**, **get\_mode\_bandwidths** '***Mode***' Get bandwidths of '*Mode*'. See also **get\_modes.** - **dump\_state** Return certain state information about the radio backend. - **1**, **dump\_caps** Not a real rig remote command, it just dumps capabilities, i.e. what the backend knows about this model, and what it can do. - TODO: Ensure this is in a consistent format so it can be read into a hash, dictionary, etc. Bug reports requested. - **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 over 5kB of text output. - VFO parameter is not used in 'VFO mode'. - **2**, **power2mW** '***Power \[0.0..1.0\]***' '***Frequency***' '***Mode***' Returns '*Power mW*'. - Converts a Power value in a range of *0.0*...*1.0* to the real transmit power in milli-Watts (integer). - '*Frequency*' and '*Mode*' also need to be provided as output power may vary according to these values. - VFO parameter is not used in VFO mode. - **3**, **dump\_conf** Not a real rig remote command, it just dumps the current configuration with allowed ranges of values. - **4**, **mW2power** '***Power mW***' '***Frequency***' '***Mode***' Returns '*Power \[0.0..1.0\]*'. - Converts the real transmit power in milli-Watts (integer) to a Power value in a range of *0.0 ... 1.0*. - '*Frequency*' and '*Mode*' also need to be provided as output power may vary according to these values. - VFO parameter is not used in VFO mode. - **w**, **send\_cmd** '***Cmd***' Send a raw command string to the radio. - This is useful for testing and troubleshooting radio commands and responses when developing a backend. - For binary protocols enter values as \\0xAA\\0xBB. Expect a '*Reply*' from the radio which will likely be a binary block or an ASCII string depending on the radio's protocol (see your radio's computer control documentation). If you are testing a protocol like SmartSDR where there are spaces in the commands use quote, e.g. w "C0\|set slice 0 tx=1" - The command terminator, set by the **send-cmd-term** option above, will terminate each command string sent to the radio. This character should not be a part of the input string. - **W**, **send\_cmd\_rx** '***Cmd*'** ***nbytes\_or\_terminator\_char*** Send a raw command string to the radio and expect nbytes returned or the terminator char (e.g. ;). - This is useful for testing and troubleshooting radio commands and responses when developing a backend. If the # of bytes requested is \<= the number actually returned no timeout will occur. If a char is provided it will be used to terminate reading the string so ';' is popular for Kenwood/Yaesu commands for example. - The command argument can have no spaces in it. For binary protocols enter values as \\0xAA\\0xBB. Expect a '*Reply*' from the radio which will likely be a binary block or an ASCII string depending on the radio's protocol (see your radio's computer control documentation). - The command terminator, set by the **send-cmd-term** option above, will terminate each command string sent to the radio. This character should not be a part of the input string. - **set\_clock** '***DateTime***' Set '*DateTime*' - Sets rig clock -- note that some rigs do not handle seconds or milliseconds. If you try to set sec/msec and rig does not support it you will get a debug warning message. Format is ISO8601. Formats accepted allow for 2-digit or 4-digit time zone ``` YYYY-MM-DDTHH:MM:SS.SSS+ZZ (where +ZZ is either -/+ UTC offset HH) YYYY-MM-DDTHH:MM:SS.SSS+ZZZZ (where +ZZZZ is either -/+ UTC offset HHMM) YYYY-MM-DDTHH:MM:SS+ZZ YYYY-MM-DDTHH:MM:SS+ZZZZ YYYY-MM-DDTHH:MM+ZZ YYYY-MM-DDTHH:MM+ZZZZ YYYY-MM-DD (sets date only) local (sets both clocks to local time) utc (sets both clocks to utc time) ``` Note: Icom rigs expect you to set local time and the hours off to UTC. So...4PM EST example would be 2021-12-01T16:00:00-0500 But...if you want to display GMT you must set the clock for GMT with zero UTC offset. Hopefully Icom will allow displaying either clock in the future Note: Kenwood rigs only allow setting local clock, and then only if not autoset by NTP. Trying to set clock when NTP is in use will set the offset, but not the time - and no error status will be returned. Time displayed on the auxiliary clock is solely determined by UTC and the aux offset. - **get\_clock** Get '*RigTime*' - Gets rig clock -- note that some rigs do not handle seconds or milliseconds. Format is ISO8601 YYYY-MM-DDTHH:MM:SS.sss+ZZ where +ZZ is either -/+ UTC offset - **chk\_vfo** Get '*Status*' - Returns Status as 1 if vfo option is on and 0 if vfo option is off. This command reflects the -o switch for **rigctl** and **rigctld** and can be dynamically changed by **set\_vfo\_opt.** - **set\_vfo\_opt** '***Status***' Set '*Status*' - Set vfo option Status 1=on or 0=off This is the same as using the -o switch for **rigctl** and **rigctld.** This can be dynamically changed while running. - **set\_separator** '***SeparatorChar***' Set '*SeparatorChar*' - Change rigctld response to use a special char instead of newline (recommend #). Handy for node-red's tcprequest node. This can be dynamically changed while running. - **get\_separator** Get '*SeparatorChar*' - Shows the current SeparatorChar. - **pause** '***Seconds***' Pause for the given whole (integer) number of '*Seconds*' before sending the next command to the radio. - **password** '***Password***' Sends password to rigctld when rigctld has been secured with -A. Must use the 32-char shared secret from rigctld. (NOT IMPLEMENTED) - **set\_lock\_mode** '***Locked***' Turns mode lock on(1) or off(0) (only when using rigctld). Turning on will prevent all clients from changing the rig mode. For example this is useful when running CW Skimmer in FM mode on an IC-7300. Clicking spots in a spotting program will not change the VFOA mode when lock is on. So "set\_lock\_mode 1" when CW Skimmer is started and "set\_lock\_mode 0" when CW Skimmer is stopped. - **get\_lock\_mode** Returns current lock mode status 1=On, 2=Off (only useful when using rigctld) - **send\_raw** '***Terminator***' '***String***' Can send ASCII string or 0xnn values or xnn values -- there can be no spaces in the command string. Possible terminator values are CR, LF, ;, ICOM, 1-100 (bytes to read), or 0 meaning no reply and -1 meaning unknown (will timeout on read). Examples (note that a ; must be escaped in Unix/Linux or enclosed in single or double quotes): - For Windows & Unix/Linux we have a new colon-separated format for hex digits ``` send_raw icom 0xFE:0xFE:0x94:0x03:0xFD Note: colon-separated does not have to be escaped on Unix/Linux send_raw -1 0xFE:0xFE:0x94:0x03:0xFD send_raw 14 0xFE:0xFE:0x94:0x03:0xFD Note that ASCII commands still require escaping the semicolon on Unix/Linux send_raw \; FA\;MD\; ``` For Windows: ``` send_raw ; FA;MD; send_raw icom 0xFE;0xFE;0x94;0x03;0xFD send_raw -1 0xFE;0xFE;0x94;0x03;0xFD send_raw 14 0xFE;0xFE;0x94;0x03;0xFD ``` For Unix/Linux ``` send_raw icom 0xFE;0xFE;0x94;0x03;0xFD send_raw \; FA\;MD\; send_raw -1 0xFE;0xFE;0x94;0x03;0xFD send_raw 14 0xFE;0xFE;0x94;0x03;0xFD ``` - **client\_version** '***String***' Client can send its version to **rigctld** and get feedback on compatibility, deprecation, and alternatives - **hamlib\_version** Returns Hamlib version with ISO8601 date/time - **test** Performs test routines. Under development. - **set\_gpio** '***GPIO#***' '***0/1***' Sets GPIO1, GPIO2, GPIO3, GPIO4 on the GPIO ptt port Can also use 1,2,3,4 - **get\_gpio** '***GPIO#***' Reads GPIO1, GPIO2, GPIO3, GPIO4 on the GPIO ptt port Can also use 1,2,3,4 - **skip\_init** Skips rig initialization -- useful when executing commands with rigctl to speed up things ## READLINE If **Readline** library development files are found at configure time, **rigctl** will be conditionally built with Readline support for command and argument entry. Readline command key bindings are at their defaults as described in the Readline manual ⟨https://tiswww.cwru.edu/php/chet/readline/rluserman.html⟩. **rigctl** sets the name “rigctl” which can be used in Conditional Init Constructs in the Readline Init File (*$HOME/.inputrc* by default) for custom keybindings unique to **rigctl**. Command history is available with Readline support as described in the Readline History manual ⟨https://tiswww.case.edu/php/chet/readline/history.html#SEC1⟩. 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. Normally session history is not saved, however, use of either of the **-i**/**--read-history** or **-I**/**--save-history** options when starting **rigctl** will cause any previously saved history to be read in and/or the current and any previous session history (assuming the **-i** and **-I** options are given together) will be written out when **rigctl** 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. History is stored in *$HOME/.rigctl\_history* by default although the destination directory may be changed by setting the **RIGCTL\_HIST\_DIR** environment variable. When RIGCTL\_HIST\_DIR is unset, the value of the **HOME** environment variable is used instead. Only the destination directory may be changed at this time. If Readline support is not found at configure time the original internal command handler is used. Readline is not used for **rigctl** commands entered on the command line regardless if Readline support is built in or not. **Note**: Readline support is not included in the MS Windows 32 or 64 bit binary builds supplied by the Hamlib Project. Running **rigctl** on the MS Windows platform in the ‘cmd’ shell does give session command line history, however, it is not saved to disk between sessions. ## DIAGNOSTICS The **-v**, **--verbose** option allows different levels of diagnostics to be output to **stderr** and correspond to -v for **BUG**, -vv for **ERR**, -vvv for **WARN**, -vvvv for **VERBOSE**, or -vvvvv for **TRACE**. 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 radio which is very useful for radio backend library development and may be requested by the developers. ## EXIT STATUS **rigctl** exits with: - **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 Start **rigctl** for a Yaesu FT-920 using a USB to serial adapter on Linux in interactive mode: ``` $ rigctl -m 1014 -r /dev/ttyUSB1 ``` Start **rigctl** for a Yaesu FT-920 using COM1 on MS Windows while generating TRACE output to *stderr*: ``` > rigctl -m 1014 -r COM1 -vvvvv ``` Start **rigctl** for a Yaesu FT-920 using a USB to serial adapter while setting baud rate and stop bits: ``` $ rigctl -m 1014 -r /dev/ttyUSB1 -s 4800 -C stop_bits=2 ``` Start **rigctl** for an Elecraft K3 using a USB to serial adapter while specifying a command terminator for the **w** command: ``` $ rigctl -m 2029 -r /dev/ttyUSB0 -t';' ``` Connect to a running **rigctld** with radio model 2 (“NET rigctl”) on the local host and specifying the TCP port, setting frequency and mode: ``` $ rigctl -m 2 -r localhost:4532 F 7253500 M LSB 0 ``` ## BUGS **set\_chan** has no entry method as of yet, hence left unimplemented. This almost empty section... Report bugs to: - ``` Hamlib Developer mailing list ⟨hamlib\-developer@lists.sourceforge.net⟩ ``` ## 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. Copyright © 2000-2011 Stephane Fillod\ Copyright © 2000-2018 the Hamlib Group (various contributors)\ Copyright © 2010-2020 Nate Bargmann 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. ## SEE ALSO [**less**(1)](/less/1.md), [**more**(1)](/more/1.md), [**rigctld**(1)](/rigctld/1.md), [**hamlib**(7)](/hamlib/7.md) ## COLOPHON Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot archives are available via hamlib.org ⟨http://www.hamlib.org⟩.