Merge pull request #1707 from dforsi/fix/manpage

Fix/manpage
pull/1710/head
Nate Bargmann 2025-04-21 17:22:59 -05:00 zatwierdzone przez GitHub
commit 8f641b2b6a
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: B5690EEEBB952194
6 zmienionych plików z 360 dodań i 131 usunięć

Wyświetl plik

@ -497,12 +497,6 @@ the value terminated by the response separator. e.g. \(lqFrequency:
data values must be returned to the client. data values must be returned to the client.
. .
.PP .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 An example response to a
.B set_frequency .B set_frequency
command sent from the shell prompt (note the prepended \(oq+\(cq): command sent from the shell prompt (note the prepended \(oq+\(cq):

Wyświetl plik

@ -384,9 +384,9 @@ Since most of the
.B Hamlib .B Hamlib
operations have a operations have a
.BR set " and a " get .BR set " and a " get
method, a single upper case letter will often be used for a method, a single upper case letter will be used for
.B set .B set
method whereas the corresponding single lower case letter refers to the methods whereas the corresponding single lower case letter refers to the
.B get .B get
method. Each operation also has a long name; in interactive mode, prepend a method. Each operation also has a long name; in interactive mode, prepend a
backslash, \(oq\\\(cq, to enter a long command name all lower case. backslash, \(oq\\\(cq, to enter a long command name all lower case.
@ -528,7 +528,8 @@ Set
.RI \(aq VFO \(aq. .RI \(aq VFO \(aq.
.IP .IP
VFO is a token: \(oqVFOA\(cq, \(oqVFOB\(cq, \(oqVFOC\(cq, \(oqcurrVFO\(cq, VFO is a token: \(oqVFOA\(cq, \(oqVFOB\(cq, \(oqVFOC\(cq, \(oqcurrVFO\(cq,
\(oqVFO\(cq, \(oqMEM\(cq, \(oqMain\(cq, \(oqSub\(cq, \(oqTX\(cq, \(oqRX\(cq. \(oqVFO\(cq, \(oqMEM\(cq, \(oqMain\(cq, \(oqSub\(cq, \(oqTX\(cq, \(oqRX\(cq,
\(oqMainA\(cq, \(oqMainB\(cq, \(oqMainC\(cq, \(oqSubA\(cq, \(oqSubB\(cq \(oqSubC\(cq.
.IP .IP
In VFO mode (see In VFO mode (see
.B \-\-vfo .B \-\-vfo
@ -726,8 +727,6 @@ Get
A value of 0 for Antenna will return the current TX antenna A value of 0 for Antenna will return the current TX antenna
.IP .IP
> 0 is 1-based antenna# (\(oq1\(cq, \(oq2\(cq, \(oq3\(cq, ...). > 0 is 1-based antenna# (\(oq1\(cq, \(oq2\(cq, \(oq3\(cq, ...).
.IP .IP
Option returned depends on rig. For Icom it is likely the RX only flag. Option returned depends on rig. For Icom it is likely the RX only flag.
. .
@ -735,10 +734,15 @@ Option returned depends on rig. For Icom it is likely the RX only flag.
.BR b ", " send_morse " \(aq" \fIMorse\fP \(aq .BR b ", " send_morse " \(aq" \fIMorse\fP \(aq
Send Send
.RI \(aq Morse \(aq .RI \(aq Morse \(aq
symbols. For Yaesu rigs use memory#1-5 or up to 50 char msg 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:
.EX .EX
Example from command line: rigctl -m 3073 -r /dev/ttyUSB0 b "CQ CQ DE ME" 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 .EE
Yaesu example to send message#1:
.EX
rigctl -m 1035 -r /dev/ttyUSB0 b 1
.EE .EE
. .
.TP .TP
@ -747,7 +751,7 @@ Stop sending the current morse code.
. .
.TP .TP
.BR 0xbc ", " wait_morse " .BR 0xbc ", " wait_morse "
Wait for morse to finish -- only works on full break-in Wait for morse to finish -- only works on full break-in.
. .
.TP .TP
.BR 0x94 ", " send_voice_mem " \(aq" \fIMsgnum\fP \(aq .BR 0x94 ", " send_voice_mem " \(aq" \fIMsgnum\fP \(aq
@ -852,65 +856,104 @@ Set
and and
.RI \(aq "Func Status" \(aq. .RI \(aq "Func Status" \(aq.
.IP .IP
Func is a token: \(oqFAGC\(cq, \(oqNB\(cq, \(oqCOMP\(cq, \(oqVOX\(cq, Func is a token:
\(oqTONE\(cq, \(oqTSQL\(cq, \(oqSBKIN\(cq, \(oqFBKIN\(cq, \(oqANF\(cq, \(oqABM\(cq,
\(oqNR\(cq, \(oqAIP\(cq, \(oqAPF\(cq, \(oqMON\(cq, \(oqMN\(cq, \(oqRF\(cq, \(oqAFC\(cq,
\(oqARO\(cq, \(oqLOCK\(cq, \(oqMUTE\(cq, \(oqVSC\(cq, \(oqREV\(cq, \(oqAFLT\(cq,
\(oqSQL\(cq, \(oqABM\(cq, \(oqBC\(cq, \(oqMBC\(cq, \(oqRIT\(cq, \(oqAFC\(cq, \(oqAIP\(cq,
\(oqSATMODE\(cq, \(oqSCOPE\(cq, \(oqRESUME\(cq, \(oqTBURST\(cq, \(oqTUNER\(cq, \(oqANF\(cq,
\(oqXIT\(cq, \(oqNB2\(cq, \(oqDSQL\(cq, \(oqAFLT\(cq, \(oqANL\(cq, \(oqBC2\(cq, \(oqANL\(cq,
\(oqDUAL_WATCH\(cq, \(oqDIVERSITY\(cq, \(oqCSQL\(cq, \(oqSCEN\(cq, \(oqAPF\(cq,
\(oqTRANSCEIVE\(cq, \(oqSPECTRUM\(cq, \(oqSPECTRUM_HOLD\(cq, \(oqSEND_MORSE\(cq, \(oqARO\(cq,
\(oqSEND_VOICE_MEM\(cq, \(oqOVF_STATUS\(cq. \(oqBC2\(cq,
\(oqBC\(cq,
\(oqCOMP\(cq,
\(oqCSQL\(cq,
\(oqDIVERSITY\(cq,
\(oqDSQL\(cq,
\(oqDUAL_WATCH\(cq,
\(oqFAGC\(cq,
\(oqFBKIN\(cq,
\(oqLOCK\(cq,
\(oqMBC\(cq,
\(oqMN\(cq,
\(oqMON\(cq,
\(oqMUTE\(cq,
\(oqNB2\(cq,
\(oqNB\(cq,
\(oqNR\(cq,
\(oqOVF_STATUS\(cq,
\(oqRESUME\(cq,
\(oqREV\(cq,
\(oqRF\(cq,
\(oqRIT\(cq,
\(oqSATMODE\(cq,
\(oqSBKIN\(cq,
\(oqSCEN\(cq,
\(oqSCOPE\(cq,
\(oqSEND_MORSE\(cq,
\(oqSEND_VOICE_MEM\(cq,
\(oqSPECTRUM\(cq,
\(oqSPECTRUM_HOLD\(cq,
\(oqSQL\(cq,
\(oqSYNC\(cq,
\(oqTBURST\(cq,
\(oqTONE\(cq,
\(oqTRANSCEIVE\(cq,
\(oqTSQL\(cq,
\(oqTUNER\(cq,
\(oqVOX\(cq,
\(oqVSC\(cq,
\(oqXIT\(cq.
FAGC -- Fast AGC
NB -- Noise Blanker
COMP -- Speech Compression
VOX -- Voice Operated Relay
TONE -- CTCSS Tone TX
TSQL -- CTCSS Activate/De-activate RX
SBKIN -- Semi Break-in (CW mode)
FBKIN -- Full Break-in (CW mode)
ANF -- Automatic Notch Filter (DSP)
NR -- Noise Reduction (DSP)
AIP -- RF pre-amp (AIP on Kenwood, IPO on Yaesu, etc.)
APF -- Audio Peak Filter
MON -- Monitor transmitted signal
MN -- Manual Notch
RF -- RTTY Filter
ARO -- Auto Repeater Offset
LOCK -- Lock
MUTE -- Mute
VSC -- Voice Scan Control
REV -- Reverse transmit and receive frequencies
SQL -- Turn Squelch Monitor on/off
ABM -- Auto Band Mode ABM -- Auto Band Mode
BC -- Beat Canceller
MBC -- Manual Beat Canceller
RIT -- Receiver Incremental Tuning
AFC -- Auto Frequency Control ON/OFF AFC -- Auto Frequency Control ON/OFF
SATMODE -- Satellite mode ON/OFF
SCOPE -- Simple bandscope ON/OFF
RESUME -- Scan auto-resume
TBURST -- 1750 Hz tone burst
TUNER -- Enable automatic tuner
XIT -- Transmitter Incremental Tuning
NB2 -- 2nd Noise Blanker
CSQL -- DCS Squelch setting
AFLT -- AF Filter setting AFLT -- AF Filter setting
AIP -- RF pre-amp (AIP on Kenwood, IPO on Yaesu, etc.)
ANF -- Automatic Notch Filter (DSP)
ANL -- Noise limiter setting ANL -- Noise limiter setting
APF -- Audio Peak Filter
ARO -- Auto Repeater Offset
BC -- Beat Canceller
BC2 -- 2nd Beat Cancel BC2 -- 2nd Beat Cancel
DUAL_WATCH -- Dual Watch / Sub Receiver COMP -- Speech Compression
CSQL -- DCS Squelch setting
DIVERSITY -- Diversity receive DIVERSITY -- Diversity receive
DSQL -- Digital modes squelch 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 SCEN -- scrambler/encryption
SLICE -- Rig slice selection -- Flex SCOPE -- Simple bandscope ON/OFF
TRANSCEIVE -- Send radio state changes automatically ON/OFF
SPECTRUM -- Spectrum scope data output ON/OFF
SPECTRUM_HOLD -- Pause spectrum scope updates ON/OFF
SEND_MORSE -- Send specified characters using CW SEND_MORSE -- Send specified characters using CW
SEND_VOICE_MEM -- Transmit in SSB message stored in memory SEND_VOICE_MEM -- Transmit in SSB message stored in memory
OVF -- Read overflow status 0=Off, 1=On 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
.IP .IP
Func Status is a non null value for \(lqactivate\(rq or \(lqde-activate\(rq Func Status is a non null value for \(lqactivate\(rq or \(lqde-activate\(rq
@ -943,17 +986,61 @@ Set
and and
.RI \(aq "Level Value" \(aq. .RI \(aq "Level Value" \(aq.
.IP .IP
Level is a token: \(oqPREAMP\(cq, \(oqATT\(cq, \(oqVOXDELAY\(cq, \(oqAF\(cq, Level is a token:
\(oqRF\(cq, \(oqSQL\(cq, \(oqIF\(cq, \(oqAPF\(cq, \(oqNR\(cq, \(oqPBT_IN\(cq, \(oqAF\(cq,
\(oqPBT_OUT\(cq, \(oqCWPITCH\(cq, \(oqRFPOWER\(cq, \(oqMICGAIN\(cq, \(oqAGC\(cq,
\(oqKEYSPD\(cq, \(oqNOTCHF\(cq, \(oqCOMP\(cq, \(oqAGC\(cq, \(oqBKINDL\(cq, \(oqAGC_TIME\(cq,
\(oqBAL\(cq, \(oqMETER\(cq, \(oqVOXGAIN\(cq, \(oqANTIVOX\(cq, \(oqALC\(cq,
\(oqSLOPE_LOW\(cq, \(oqSLOPE_HIGH\(cq, \(oqBKIN_DLYMS\(cq, \(oqRAWSTR\(cq, \(oqSWR\(cq, \(oqANTIVOX\(cq,
\(oqALC\(cq, \(oqSTRENGTH\(cq, \(oqRFPOWER_METER\(cq, \(oqCOMPMETER\(cq, \(oqVD_METER\(cq, \(oqID_METER\(cq, \(oqAPF\(cq,
\(oqNOTCHF_RAW\(cq, \(oqMONITOR_GAIN\(cq, \(oqNQ\(cq, \(oqRFPOWER_METER_WATTS\(cq, \(oqSPECTRUM_MODE\(cq, \(oqATT\(cq,
\(oqSPECTRUM_SPAN\(cq, \(oqSPECTRUM_EDGE_LOW\(cq, \(oqSPECTRUM_EDGE_HIGH\(cq, \(oqSPECTRUM_SPEED\(cq, \(oqBAL\(cq,
\(oqSPECTRUM_REF\(cq, \(oqSPECTRUM_AVG\(cq, \(oqSPECTRUM_ATT\(cq, \(oqTEMP_METER\(cq, \(oqBANDSELECT\(cq, \(oqBAND_SELECT\(cq,
\(oqUSB_AF\(cq. \(oqBKINDL\(cq,
\(oqBKIN_DLYMS\(cq,
\(oqCOMP\(cq,
\(oqCOMP_METER\(cq,
\(oqCWPITCH\(cq,
\(oqID_METER\(cq,
\(oqIF\(cq,
\(oqKEYSPD\(cq,
\(oqMETER\(cq,
\(oqMGC\(cq,
\(oqMGF\(cq,
\(oqMGL\(cq,
\(oqMICGAIN\(cq,
\(oqMONITOR_GAIN\(cq,
\(oqNB\(cq,
\(oqNOTCHF\(cq,
\(oqNOTCHF_RAW\(cq,
\(oqNR\(cq,
\(oqPBT_IN\(cq,
\(oqPBT_OUT\(cq,
\(oqPREAMP\(cq,
\(oqRAWSTR\(cq,
\(oqRF\(cq,
\(oqRFPOWER\(cq,
\(oqRFPOWER_METER\(cq,
\(oqRFPOWER_METER_WATTS\(cq,
\(oqSLOPE_HIGH\(cq,
\(oqSLOPE_LOW\(cq,
\(oqSPECTRUM_ATT\(cq,
\(oqSPECTRUM_AVG\(cq,
\(oqSPECTRUM_EDGE_HIGH\(cq,
\(oqSPECTRUM_EDGE_LOW\(cq,
\(oqSPECTRUM_MODE\(cq,
\(oqSPECTRUM_REF\(cq,
\(oqSPECTRUM_SPAN\(cq,
\(oqSPECTRUM_SPEED\(cq,
\(oqSQL\(cq,
\(oqSTRENGTH\(cq,
\(oqSWR\(cq,
\(oqTEMP_METER\(cq,
\(oqUSB_AF\(cq,
\(oqUSB_AF_INPUT\(cq,
\(oqVD_METER\(cq,
\(oqVOXDELAY\(cq,
\(oqVOXGAIN\(cq.
.IP .IP
The Level Value can be a float or an integer value. For the AGC token the The Level Value can be a float or an integer value. For the AGC token the
value is one of \(oq0\(cq = OFF, \(oq1\(cq = SUPERFAST, \(oq2\(cq = FAST, value is one of \(oq0\(cq = OFF, \(oq1\(cq = SUPERFAST, \(oq2\(cq = FAST,
@ -1035,8 +1122,21 @@ Set
and and
.RI \(aq "Parm Value" \(aq. .RI \(aq "Parm Value" \(aq.
.IP .IP
Parm is a token: \(oqANN\(cq, \(oqAPO\(cq, \(oqBACKLIGHT\(cq, \(oqBEEP\(cq, Parm is a token:
\(oqTIME\(cq, \(oqBAT\(cq, \(oqKEYLIGHT\(cq, \(oqSCREENSAVER\(cq, \(oqAFIF\(cq, \(oqBANDSELECT\(cq, \(oqKEYERTYPE\(cq. \(oqAFIF\(cq,
\(oqAFIF_ACC\(cq,
\(oqAFIF_LAN\(cq,
\(oqAFIF_WLAN\(cq,
\(oqANN\(cq,
\(oqAPO\(cq,
\(oqBACKLIGHT\(cq,
\(oqBANDSELECT\(cq,
\(oqBAT\(cq,
\(oqBEEP\(cq,
\(oqKEYERTYPE\(cq,
\(oqKEYLIGHT\(cq,
\(oqSCREENSAVER\(cq,
\(oqTIME\(cq.
.IP .IP
.BR Note : .BR Note :
Passing a \(oq?\(cq (query) as the first argument instead of a Parm token will Passing a \(oq?\(cq (query) as the first argument instead of a Parm token will
@ -1318,9 +1418,9 @@ Set
.IP .IP
Sets rig clock -- note that some rigs do not handle seconds or milliseconds. 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. If you try to set sec/msec and rig does not support it you will get a debug warning message.
Format is ISO8601, Format is ISO8601.
.EX
Formats accepted allow for 2-digit or 4-digit time zone Formats accepted allow for 2-digit or 4-digit time zone
.EX
YYYY-MM-DDTHH:MM:SS.SSS+ZZ (where +ZZ is either -/+ UTC offset HH) 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.SSS+ZZZZ (where +ZZZZ is either -/+ UTC offset HHMM)
YYYY-MM-DDTHH:MM:SS+ZZ YYYY-MM-DDTHH:MM:SS+ZZ
@ -1330,6 +1430,7 @@ YYYY-MM-DDTHH:MM+ZZZZ
YYYY-MM-DD (sets date only) YYYY-MM-DD (sets date only)
local (sets both clocks to local time) local (sets both clocks to local time)
utc (sets both clocks to utc time) utc (sets both clocks to utc time)
.EE
Note: Icom rigs expect you to set local time and the hours off to UTC. 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 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. But...if you want to display GMT you must set the clock for GMT with zero UTC offset.
@ -1339,9 +1440,6 @@ Note: Kenwood rigs only allow setting local clock, and then only if not autoset
Trying to set clock when NTP is in use will set the offset, but not the time - Trying to set clock when NTP is in use will set the offset, but not the time -
and no error status will be returned. and no error status will be returned.
Time displayed on the auxiliary clock is solely determined by UTC and the aux offset. Time displayed on the auxiliary clock is solely determined by UTC and the aux offset.
.EE
.
.TP .TP
.BR get_clock .BR get_clock
Get Get
@ -1393,6 +1491,7 @@ before sending the next command to the radio.
.TP .TP
.BR password " \(aq" \fIPassword\fP \(aq .BR password " \(aq" \fIPassword\fP \(aq
Sends password to rigctld when rigctld has been secured with -A. Must use the 32-char shared secret from rigctld. Sends password to rigctld when rigctld has been secured with -A. Must use the 32-char shared secret from rigctld.
(NOT IMPLEMENTED)
. .
.TP .TP
.BR set_lock_mode " \(aq" \fILocked\fP \(aq .BR set_lock_mode " \(aq" \fILocked\fP \(aq
@ -1435,10 +1534,12 @@ For Unix/Linux
. .
.TP .TP
.BR client_version " \(aq" \fIString\fP "\(aq .BR client_version " \(aq" \fIString\fP "\(aq
Client can send its version to rigctld and get feedback on compatibility, deprecation, and alternatives Client can send its version to
.B rigctld
and get feedback on compatibility, deprecation, and alternatives
.TP .TP
.BR hamlib_version .BR hamlib_version
Returns hamlib version with ISO8601 date/time Returns Hamlib version with ISO8601 date/time
. .
.TP .TP
.BR test .BR test

Wyświetl plik

@ -88,7 +88,7 @@ directly through a TCP socket.
. .
.PP .PP
Keep in mind that Hamlib is BETA level software. While a lot of backend Keep in mind that Hamlib is BETA level software. While a lot of backend
libraries lack complete rotator support, the basic functions are usually well libraries lack complete rig support, the basic functions are usually well
supported. supported.
. .
.PP .PP
@ -110,7 +110,7 @@ Here is a summary of the supported options:
. .
.TP .TP
.BR \-m ", " \-\-model = \fIid\fP .BR \-m ", " \-\-model = \fIid\fP
Select radio model number. Defaults to dummy device. Select radio model number. Defaults to dummy rig.
.IP .IP
See model list (use \(lqrigctld -l\(rq). See model list (use \(lqrigctld -l\(rq).
.IP .IP
@ -136,7 +136,6 @@ etc. on Linux,
etc. on MS Windows. The BSD flavors and Mac OS/X have their own designations. etc. on MS Windows. The BSD flavors and Mac OS/X have their own designations.
See your system's documentation. See your system's documentation.
.IP .IP
.IP
Can be a network address:port, e.g. Can be a network address:port, e.g.
.IR 127.0.0.1:12345 .IR 127.0.0.1:12345
.IP .IP
@ -164,7 +163,7 @@ Use
of Push-To-Talk device. of Push-To-Talk device.
.IP .IP
Supported types are \(oqRIG\(cq (CAT command), \(oqDTR\(cq, \(oqRTS\(cq, Supported types are \(oqRIG\(cq (CAT command), \(oqDTR\(cq, \(oqRTS\(cq,
\(oqPARALLEL\(cq, \(oqNONE\(cq, overriding PTT type defined in the rig's \(oqPARALLEL\(cq, \(oqCM108\(cq, \(oqGPIO\(cq, \(oqGPION\(cq, \(oqNONE\(cq, overriding PTT type defined in the rig's
backend. backend.
.IP .IP
Some side effects of this command are that when type is set to DTR, read Some side effects of this command are that when type is set to DTR, read
@ -180,7 +179,7 @@ Use
of Data Carrier Detect device. of Data Carrier Detect device.
.IP .IP
Supported types are \(oqRIG\(cq (CAT command), \(oqDSR\(cq, \(oqCTS\(cq, Supported types are \(oqRIG\(cq (CAT command), \(oqDSR\(cq, \(oqCTS\(cq,
\(oqCD\(cq, \(oqPARALLEL\(cq, \(oqNONE\(cq. \(oqCD\(cq, \(oqPARALLEL\(cq, \(oqCM108\(cq, \(oqGPIO\(cq, \(oqGPION\(cq, \(oqNONE\(cq.
. .
.TP .TP
.BR \-s ", " \-\-serial\-speed = \fIbaud\fP .BR \-s ", " \-\-serial\-speed = \fIbaud\fP
@ -381,6 +380,10 @@ Should only be needed when controlling software should be "paused"
so you can move the VFO. Continuous movement extends the timeout. so you can move the VFO. Continuous movement extends the timeout.
. .
.TP .TP
.BR \-w ", " \-\-twiddle_rit = \fIseconds\fP
Suppress VFOB getfreq so RIT can be twiddled.
.
.TP
.BR \-x ", " \-\-uplink = \fIoption\fP .BR \-x ", " \-\-uplink = \fIoption\fP
1=Sub, 2=Main 1=Sub, 2=Main
.IP .IP
@ -401,6 +404,7 @@ option as it generates no output on its own.
Sets password on Sets password on
.B rigctld .B rigctld
which requires hamlib to use rig_set_password and rigctl to use \\password to access rigctld. A 32-char shared secret will be displayed to be used on the client side. which requires hamlib to use rig_set_password and rigctl to use \\password to access rigctld. A 32-char shared secret will be displayed to be used on the client side.
(NOT IMPLEMENTED)
. .
.TP .TP
.BR \-R ", " \-\-rigctld\-idle .BR \-R ", " \-\-rigctld\-idle
@ -518,6 +522,7 @@ Mode is a token: \(oqUSB\(cq, \(oqLSB\(cq, \(oqCW\(cq, \(oqCWR\(cq,
\(oqDSB\(cq. \(oqDSB\(cq.
.IP .IP
Passband is in Hz as an integer, -1 for no change, or \(oq0\(cq for the radio backend default. Passband is in Hz as an integer, -1 for no change, or \(oq0\(cq for the radio backend default.
IC7300 can use 1,2,3 to select which filter to use
.IP .IP
.BR Note : .BR Note :
Passing a \(oq?\(cq (query) as the first argument instead of a Mode token will Passing a \(oq?\(cq (query) as the first argument instead of a Mode token will
@ -709,21 +714,23 @@ Returns TX Mode as a token and TX Passband in Hz as in
above. above.
. .
.TP .TP
.BR Y ", " set_ant " \(aq" \fIAntenna\fP \(aq .BR Y ", " set_ant " \(aq" \fIAntenna\fP "\(aq \(aq" \fIOption\fP \(aq
Set Set
.RI \(aq Antenna \(aq .RI \(aq Antenna \(aq
number (\(oq0\(cq, \(oq1\(cq, \(oq2\(cq, ...). and
.RI \(aq Option \(aq.
.IP .IP
Number is 1-based antenna# (\(oq1\(cq, \(oq2\(cq, \(oq3\(cq, ...).
.IP .IP
Option depends on rig. For Icom it probably sets the Tx & Rx antennas as in the IC-7851. See your manual for rig specific option values. Most rigs don't care about the option. Option depends on rig. For Icom it probably sets the Tx & Rx antennas as in the IC-7851. See your manual for rig specific option values. Most rigs don't care about the option.
.IP .IP
For the IC-7851 (and perhaps others) it means this: For the IC-7851, FTDX3000 (and perhaps others) it means this:
.IP .IP
.in +4n .in +4n
.EX .EX
1 = TX/RX = ANT1 1 = TX/RX = ANT1 FTDX3000=ANT1/ANT3
2 = TX/RX = ANT2 2 = TX/RX = ANT2 FTDX3000=ANT2/ANT3
3 = TX/RX = ANT3 3 = TX/RX = ANT3 FTDX3000=ANT3
4 = TX/RX = ANT1/ANT4 4 = TX/RX = ANT1/ANT4
5 = TX/RX = ANT2/ANT4 5 = TX/RX = ANT2/ANT4
6 = TX/RX = ANT3/ANT4 6 = TX/RX = ANT3/ANT4
@ -731,19 +738,29 @@ For the IC-7851 (and perhaps others) it means this:
.in .in
. .
.TP .TP
.BR y ", " get_ant .BR y ", " get_ant " \(aq" \fIAntenna\fP \(aq
Get Get
.RI \(aq Antenna \(aq .RI \(aq Antenna \(aq
number (\(oq0\(cq, \(oq1\(cq, \(oq2\(cq, ...). .IP
A value of 0 for Antenna will return the current TX antenna
.IP
> 0 is 1-based antenna# (\(oq1\(cq, \(oq2\(cq, \(oq3\(cq, ...).
.IP
Option returned depends on rig. For Icom it is likely the RX only flag.
. .
.TP .TP
.BR b ", " send_morse " \(aq" \fIMorse\fP \(aq .BR b ", " send_morse " \(aq" \fIMorse\fP \(aq
Send Send
.RI \(aq Morse \(aq .RI \(aq Morse \(aq
symbols. For Yaesu rigs use memory# (1-5 for most rigs) or up to 50 char message (which will use memory#1) symbols. For Yaesu rigs use memory# (1-5 for most rigs) or up to 50 char message (which will use memory#1)
Example from rigctld socket:
.EX .EX
Example from rigctld socket: b CQ CQ DE ME b CQ CQ DE ME
Yaesu example to send message#1 frm rigctld socket: b 1 .EE
Yaesu example to send message#1 from rigctld socket:
.EX
b 1
.EE .EE
. .
.TP .TP
@ -857,12 +874,54 @@ Set
and and
.RI \(aq "Func Status" \(aq. .RI \(aq "Func Status" \(aq.
.IP .IP
Func is a token: \(oqFAGC\(cq, \(oqNB\(cq, \(oqCOMP\(cq, \(oqVOX\(cq, Func is a token:
\(oqTONE\(cq, \(oqTSQL\(cq, \(oqSBKIN\(cq, \(oqFBKIN\(cq, \(oqANF\(cq, \(oqABM\(cq,
\(oqNR\(cq, \(oqAIP\(cq, \(oqAPF\(cq, \(oqMON\(cq, \(oqMN\(cq, \(oqRF\(cq, \(oqAFC\(cq,
\(oqARO\(cq, \(oqLOCK\(cq, \(oqMUTE\(cq, \(oqVSC\(cq, \(oqREV\(cq, \(oqAFLT\(cq,
\(oqSQL\(cq, \(oqABM\(cq, \(oqBC\(cq, \(oqMBC\(cq, \(oqRIT\(cq, \(oqAFC\(cq, \(oqAIP\(cq,
\(oqSATMODE\(cq, \(oqSCOPE\(cq, \(oqRESUME\(cq, \(oqTBURST\(cq, \(oqTUNER\(cq, \(oqANF\(cq,
\(oqANL\(cq,
\(oqAPF\(cq,
\(oqARO\(cq,
\(oqBC2\(cq,
\(oqBC\(cq,
\(oqCOMP\(cq,
\(oqCSQL\(cq,
\(oqDIVERSITY\(cq,
\(oqDSQL\(cq,
\(oqDUAL_WATCH\(cq,
\(oqFAGC\(cq,
\(oqFBKIN\(cq,
\(oqLOCK\(cq,
\(oqMBC\(cq,
\(oqMN\(cq,
\(oqMON\(cq,
\(oqMUTE\(cq,
\(oqNB2\(cq,
\(oqNB\(cq,
\(oqNR\(cq,
\(oqOVF_STATUS\(cq,
\(oqRESUME\(cq,
\(oqREV\(cq,
\(oqRF\(cq,
\(oqRIT\(cq,
\(oqSATMODE\(cq,
\(oqSBKIN\(cq,
\(oqSCEN\(cq,
\(oqSCOPE\(cq,
\(oqSEND_MORSE\(cq,
\(oqSEND_VOICE_MEM\(cq,
\(oqSPECTRUM\(cq,
\(oqSPECTRUM_HOLD\(cq,
\(oqSQL\(cq,
\(oqSYNC\(cq,
\(oqTBURST\(cq,
\(oqTONE\(cq,
\(oqTRANSCEIVE\(cq,
\(oqTSQL\(cq,
\(oqTUNER\(cq,
\(oqVOX\(cq,
\(oqVSC\(cq,
\(oqXIT\(cq. \(oqXIT\(cq.
.IP .IP
Func Status is a non null value for \(lqactivate\(rq or \(lqde-activate\(rq Func Status is a non null value for \(lqactivate\(rq or \(lqde-activate\(rq
@ -895,17 +954,61 @@ Set
and and
.RI \(aq "Level Value" \(aq. .RI \(aq "Level Value" \(aq.
.IP .IP
Level is a token: \(oqPREAMP\(cq, \(oqATT\(cq, \(oqVOXDELAY\(cq, \(oqAF\(cq, Level is a token:
\(oqRF\(cq, \(oqSQL\(cq, \(oqIF\(cq, \(oqAPF\(cq, \(oqNR\(cq, \(oqPBT_IN\(cq, \(oqAF\(cq,
\(oqPBT_OUT\(cq, \(oqCWPITCH\(cq, \(oqRFPOWER\(cq, \(oqMICGAIN\(cq, \(oqAGC\(cq,
\(oqKEYSPD\(cq, \(oqNOTCHF\(cq, \(oqCOMP\(cq, \(oqAGC\(cq, \(oqBKINDL\(cq, \(oqAGC_TIME\(cq,
\(oqBAL\(cq, \(oqMETER\(cq, \(oqVOXGAIN\(cq, \(oqANTIVOX\(cq, \(oqALC\(cq,
\(oqSLOPE_LOW\(cq, \(oqSLOPE_HIGH\(cq, \(oqBKIN_DLYMS\(cq, \(oqRAWSTR\(cq, \(oqSWR\(cq, \(oqANTIVOX\(cq,
\(oqALC\(cq, \(oqSTRENGTH\(cq, \(oqRFPOWER_METER\(cq, \(oqCOMPMETER\(cq, \(oqVD_METER\(cq, \(oqID_METER\(cq, \(oqAPF\(cq,
\(oqNOTCHF_RAW\(cq, \(oqMONITOR_GAIN\(cq, \(oqNQ\(cq, \(oqRFPOWER_METER_WATTS\(cq, \(oqSPECTRUM_MODE\(cq, \(oqATT\(cq,
\(oqSPECTRUM_SPAN\(cq, \(oqSPECTRUM_EDGE_LOW\(cq, \(oqSPECTRUM_EDGE_HIGH\(cq, \(oqSPECTRUM_SPEED\(cq, \(oqBAL\(cq,
\(oqSPECTRUM_REF\(cq, \(oqSPECTRUM_AVG\(cq, \(oqSPECTRUM_ATT\(cq, \(oqTEMP_METER\(cq, \(oqBAND_SELECT\(cq, \(oqBAND_SELECT\(cq,
\(oqUSB_AF\(cq. \(oqBKINDL\(cq,
\(oqBKIN_DLYMS\(cq,
\(oqCOMP\(cq,
\(oqCOMP_METER\(cq,
\(oqCWPITCH\(cq,
\(oqID_METER\(cq,
\(oqIF\(cq,
\(oqKEYSPD\(cq,
\(oqMETER\(cq,
\(oqMGC\(cq,
\(oqMGF\(cq,
\(oqMGL\(cq,
\(oqMICGAIN\(cq,
\(oqMONITOR_GAIN\(cq,
\(oqNB\(cq,
\(oqNOTCHF\(cq,
\(oqNOTCHF_RAW\(cq,
\(oqNR\(cq,
\(oqPBT_IN\(cq,
\(oqPBT_OUT\(cq,
\(oqPREAMP\(cq,
\(oqRAWSTR\(cq,
\(oqRF\(cq,
\(oqRFPOWER\(cq,
\(oqRFPOWER_METER\(cq,
\(oqRFPOWER_METER_WATTS\(cq,
\(oqSLOPE_HIGH\(cq,
\(oqSLOPE_LOW\(cq,
\(oqSPECTRUM_ATT\(cq,
\(oqSPECTRUM_AVG\(cq,
\(oqSPECTRUM_EDGE_HIGH\(cq,
\(oqSPECTRUM_EDGE_LOW\(cq,
\(oqSPECTRUM_MODE\(cq,
\(oqSPECTRUM_REF\(cq,
\(oqSPECTRUM_SPAN\(cq,
\(oqSPECTRUM_SPEED\(cq,
\(oqSQL\(cq,
\(oqSTRENGTH\(cq,
\(oqSWR\(cq,
\(oqTEMP_METER\(cq,
\(oqUSB_AF\(cq,
\(oqUSB_AF_INPUT\(cq,
\(oqVD_METER\(cq,
\(oqVOXDELAY\(cq,
\(oqVOXGAIN\(cq.
.IP .IP
The Level Value can be a float or an integer value. For the AGC token the The Level Value can be a float or an integer value. For the AGC token the
value is one of \(oq0\(cq = OFF, \(oq1\(cq = SUPERFAST, \(oq2\(cq = FAST, value is one of \(oq0\(cq = OFF, \(oq1\(cq = SUPERFAST, \(oq2\(cq = FAST,
@ -938,8 +1041,21 @@ Set
and and
.RI \(aq "Parm Value" \(aq. .RI \(aq "Parm Value" \(aq.
.IP .IP
Parm is a token: \(oqANN\(cq, \(oqAPO\(cq, \(oqBACKLIGHT\(cq, \(oqBEEP\(cq, Parm is a token:
\(oqTIME\(cq, \(oqBAT\(cq, \(oqKEYLIGHT\(cq, \(oqBANDSELECT\(cq, \(oqKEYERTYPE\(cq. \(oqAFIF\(cq,
\(oqAFIF_ACC\(cq,
\(oqAFIF_LAN\(cq,
\(oqAFIF_WLAN\(cq,
\(oqANN\(cq,
\(oqAPO\(cq,
\(oqBACKLIGHT\(cq,
\(oqBANDSELECT\(cq,
\(oqBAT\(cq,
\(oqBEEP\(cq,
\(oqKEYERTYPE\(cq,
\(oqKEYLIGHT\(cq,
\(oqSCREENSAVER\(cq,
\(oqTIME\(cq.
.IP .IP
.BR Note : .BR Note :
Passing a \(oq?\(cq (query) as the first argument instead of a Parm token will Passing a \(oq?\(cq (query) as the first argument instead of a Parm token will
@ -1074,7 +1190,8 @@ Set
.RI \(aq "Power Status" \(aq. .RI \(aq "Power Status" \(aq.
.IP .IP
Power Status is a value: \(oq0\(cq = Power Off, \(oq1\(cq = Power On, 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 .TP
.BR 0x88 ", " get_powerstat .BR 0x88 ", " get_powerstat
@ -1099,11 +1216,11 @@ Get DTMF
Get misc information about the rig. Get misc information about the rig.
. .
.TP .TP
.BR 0xf5 ", " get_rig_info " .BR 0xf5 ", " get_rig_info
Get misc information about the rig vfos and other info. Get misc information about the rig vfo status and other info.
. .
.TP .TP
.BR 0xf3 ", " get_vfo_info " \(aq" "\fIVFO\fP" \(aq .BR 0xf3 ", " get_vfo_info " \(aq" \fIVFO\fP \(aq
Get misc information about a specific vfo. Get misc information about a specific vfo.
. .
.TP .TP
@ -1162,15 +1279,29 @@ Set
.RI \(aq DateTime \(aq .RI \(aq DateTime \(aq
.IP .IP
Sets rig clock -- note that some rigs do not handle seconds or milliseconds. Sets rig clock -- note that some rigs do not handle seconds or milliseconds.
If you try to set that you will get a debug warning message. If you try to set sec/msec and rig does not support it you will get a debug warning message.
Format is ISO8601. Format is ISO8601.
Formats accepted allow for 2-digit or 4-digit time zone
.EX .EX
Formats accepted YYYY-MM-DDTHH:MM:SS.SSS+ZZ (where +ZZ is either -/+ UTC offset HH)
YYYY-MM-DDTHH:MM:SS.sss+ZZ (where +ZZ is either -/+ UTC offset) 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+ZZ
YYYY-MM-DDTHH:MM:SS+ZZZZ
YYYY-MM-DDTHH:MM+ZZ YYYY-MM-DDTHH:MM+ZZ
YYYY-MM-DDTHH:MM+ZZZZ
YYYY-MM-DD (sets date only) YYYY-MM-DD (sets date only)
local (sets both clocks to local time)
utc (sets both clocks to utc time)
.EE .EE
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.
. .
.TP .TP
.BR get_clock .BR get_clock

Wyświetl plik

@ -274,6 +274,8 @@ to communicate with a radio connected to Flrig:
. .
.PP .PP
.in +4n .in +4n
.EX
Flrig -><- rigctlcom -> COM9 <- virt_port_pipe -> COM10 <- N1MM
.EE .EE
.in .in
. .

Wyświetl plik

@ -1296,7 +1296,7 @@ typedef uint64_t setting_t;
#define RIG_FUNC_SPECTRUM_HOLD CONSTANT_64BIT_FLAG (44) /*!< \c SPECTRUM_HOLD -- Pause spectrum scope updates ON/OFF */ #define RIG_FUNC_SPECTRUM_HOLD CONSTANT_64BIT_FLAG (44) /*!< \c SPECTRUM_HOLD -- Pause spectrum scope updates ON/OFF */
#define RIG_FUNC_SEND_MORSE CONSTANT_64BIT_FLAG (45) /*!< \c SEND_MORSE -- Send specified characters using CW */ #define RIG_FUNC_SEND_MORSE CONSTANT_64BIT_FLAG (45) /*!< \c SEND_MORSE -- Send specified characters using CW */
#define RIG_FUNC_SEND_VOICE_MEM CONSTANT_64BIT_FLAG (46) /*!< \c SEND_VOICE_MEM -- Transmit in SSB message stored in memory */ #define RIG_FUNC_SEND_VOICE_MEM CONSTANT_64BIT_FLAG (46) /*!< \c SEND_VOICE_MEM -- Transmit in SSB message stored in memory */
#define RIG_FUNC_OVF_STATUS CONSTANT_64BIT_FLAG (47) /*!< \c OVF -- Read overflow status 0=Off, 1=On */ #define RIG_FUNC_OVF_STATUS CONSTANT_64BIT_FLAG (47) /*!< \c OVF_STATUS -- Read overflow status 0=Off, 1=On */
#define RIG_FUNC_SYNC CONSTANT_64BIT_FLAG (48) /*!< \c Synchronize VFOS -- FTDX101D/MP for now SY command */ #define RIG_FUNC_SYNC CONSTANT_64BIT_FLAG (48) /*!< \c Synchronize VFOS -- FTDX101D/MP for now SY command */
#define RIG_FUNC_BIT49 CONSTANT_64BIT_FLAG (49) /*!< \c available for future RIG_FUNC items */ #define RIG_FUNC_BIT49 CONSTANT_64BIT_FLAG (49) /*!< \c available for future RIG_FUNC items */
#define RIG_FUNC_BIT50 CONSTANT_64BIT_FLAG (50) /*!< \c available for future RIG_FUNC items */ #define RIG_FUNC_BIT50 CONSTANT_64BIT_FLAG (50) /*!< \c available for future RIG_FUNC items */

Wyświetl plik

@ -81,7 +81,7 @@
* keep up to date SHORT_OPTIONS, usage()'s output and man page. thanks. * keep up to date SHORT_OPTIONS, usage()'s output and man page. thanks.
* TODO: add an option to read from a file * TODO: add an option to read from a file
*/ */
#define SHORT_OPTIONS "m:r:p:d:P:D:s:S:c:T:t:C:W:w:x:z:lLuovhVZMRA:n:" #define SHORT_OPTIONS "m:r:p:d:P:D:s:S:c:T:t:C:W:w:x:z:lLuovhVZRA:b"
static struct option long_options[] = static struct option long_options[] =
{ {
{"model", 1, 0, 'm'}, {"model", 1, 0, 'm'},
@ -1525,12 +1525,13 @@ void usage(void)
" -u, --dump-caps dump capabilities and exit\n" " -u, --dump-caps dump capabilities and exit\n"
" -o, --vfo do not default to VFO_CURR, require extra vfo arg\n" " -o, --vfo do not default to VFO_CURR, require extra vfo arg\n"
" -v, --verbose set verbose mode, cumulative (-v to -vvvvv)\n" " -v, --verbose set verbose mode, cumulative (-v to -vvvvv)\n"
" -W, --twiddle_timeout timeout after detecting vfo manual change\n" " -W, --twiddle_timeout=SECONDS timeout after detecting vfo manual change\n"
" -w, --twiddle_rit suppress VFOB getfreq so RIT can be twiddled\n" " -w, --twiddle_rit=SECONDS suppress VFOB getfreq so RIT can be twiddled\n"
" -x, --uplink set uplink get_freq ignore, 1=Sub, 2=Main\n" " -x, --uplink set uplink get_freq ignore, 1=Sub, 2=Main\n"
" -Z, --debug-time-stamps enable time stamps for debug messages\n" " -Z, --debug-time-stamps enable time stamps for debug messages\n"
" -A, --password set password for rigctld access\n" " -A, --password=PASSWORD set password for rigctld access (NOT IMPLEMENTED)\n"
" -R, --rigctld-idle make rigctld close the rig when no clients are connected\n" " -R, --rigctld-idle make rigctld close the rig when no clients are connected\n"
" -b, --bind-all make rigctld bind to first network device available\n"
" -h, --help display this help and exit\n" " -h, --help display this help and exit\n"
" -V, --version output version information and exit\n\n", " -V, --version output version information and exit\n\n",
portno); portno);