From cd092fc65421a1494abde9da5c8dbe5b9eed0eb8 Mon Sep 17 00:00:00 2001 From: Daniele Forsi IU5HKX Date: Sun, 20 Apr 2025 19:16:56 +0200 Subject: [PATCH] Fix list of parameters for get_func/set_func Fixes: OVF_STATUS was spelled wrong, SYNC was missing, SLICE is not available. Uses the list returned by \get_func ? sorted alphabetically to be more user friendly and to easily spot any missing item in future. --- doc/man1/rigctl.1 | 135 ++++++++++++++++++++++++++++--------------- doc/man1/rigctld.1 | 5 +- include/hamlib/rig.h | 2 +- 3 files changed, 92 insertions(+), 50 deletions(-) diff --git a/doc/man1/rigctl.1 b/doc/man1/rigctl.1 index 3e28d2785..b5897f2f1 100644 --- a/doc/man1/rigctl.1 +++ b/doc/man1/rigctl.1 @@ -855,65 +855,104 @@ Set and .RI \(aq "Func Status" \(aq. .IP -Func is a token: \(oqFAGC\(cq, \(oqNB\(cq, \(oqCOMP\(cq, \(oqVOX\(cq, -\(oqTONE\(cq, \(oqTSQL\(cq, \(oqSBKIN\(cq, \(oqFBKIN\(cq, \(oqANF\(cq, -\(oqNR\(cq, \(oqAIP\(cq, \(oqAPF\(cq, \(oqMON\(cq, \(oqMN\(cq, \(oqRF\(cq, -\(oqARO\(cq, \(oqLOCK\(cq, \(oqMUTE\(cq, \(oqVSC\(cq, \(oqREV\(cq, -\(oqSQL\(cq, \(oqABM\(cq, \(oqBC\(cq, \(oqMBC\(cq, \(oqRIT\(cq, \(oqAFC\(cq, -\(oqSATMODE\(cq, \(oqSCOPE\(cq, \(oqRESUME\(cq, \(oqTBURST\(cq, \(oqTUNER\(cq, -\(oqXIT\(cq, \(oqNB2\(cq, \(oqDSQL\(cq, \(oqAFLT\(cq, \(oqANL\(cq, \(oqBC2\(cq, -\(oqDUAL_WATCH\(cq, \(oqDIVERSITY\(cq, \(oqCSQL\(cq, \(oqSCEN\(cq, -\(oqTRANSCEIVE\(cq, \(oqSPECTRUM\(cq, \(oqSPECTRUM_HOLD\(cq, \(oqSEND_MORSE\(cq, -\(oqSEND_VOICE_MEM\(cq, \(oqOVF_STATUS\(cq. +Func is a token: +\(oqABM\(cq, +\(oqAFC\(cq, +\(oqAFLT\(cq, +\(oqAIP\(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. - 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 - BC -- Beat Canceller - MBC -- Manual Beat Canceller - RIT -- Receiver Incremental Tuning 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 + 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 - DUAL_WATCH -- Dual Watch / Sub Receiver + 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 - SLICE -- Rig slice selection -- Flex - TRANSCEIVE -- Send radio state changes automatically ON/OFF - SPECTRUM -- Spectrum scope data output ON/OFF - SPECTRUM_HOLD -- Pause spectrum scope updates ON/OFF + SCOPE -- Simple bandscope ON/OFF SEND_MORSE -- Send specified characters using CW 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 Func Status is a non null value for \(lqactivate\(rq or \(lqde-activate\(rq diff --git a/doc/man1/rigctld.1 b/doc/man1/rigctld.1 index 6f834a8c1..93916d9cd 100644 --- a/doc/man1/rigctld.1 +++ b/doc/man1/rigctld.1 @@ -867,7 +867,10 @@ Func is a token: \(oqFAGC\(cq, \(oqNB\(cq, \(oqCOMP\(cq, \(oqVOX\(cq, \(oqARO\(cq, \(oqLOCK\(cq, \(oqMUTE\(cq, \(oqVSC\(cq, \(oqREV\(cq, \(oqSQL\(cq, \(oqABM\(cq, \(oqBC\(cq, \(oqMBC\(cq, \(oqRIT\(cq, \(oqAFC\(cq, \(oqSATMODE\(cq, \(oqSCOPE\(cq, \(oqRESUME\(cq, \(oqTBURST\(cq, \(oqTUNER\(cq, -\(oqXIT\(cq. +\(oqXIT\(cq, \(oqNB2\(cq, \(oqDSQL\(cq, \(oqAFLT\(cq, \(oqANL\(cq, \(oqBC2\(cq, +\(oqDUAL_WATCH\(cq, \(oqDIVERSITY\(cq, \(oqCSQL\(cq, \(oqSCEN\(cq, +\(oqTRANSCEIVE\(cq, \(oqSPECTRUM\(cq, \(oqSPECTRUM_HOLD\(cq, \(oqSEND_MORSE\(cq, +\(oqSEND_VOICE_MEM\(cq, \(oqOVF_STATUS\(cq, \(oqSYNC\(cq. .IP Func Status is a non null value for \(lqactivate\(rq or \(lqde-activate\(rq otherwise, much as TRUE/FALSE definitions in the C language (true is non-zero diff --git a/include/hamlib/rig.h b/include/hamlib/rig.h index ea6bd8db0..b0c790011 100644 --- a/include/hamlib/rig.h +++ b/include/hamlib/rig.h @@ -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_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_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_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 */