pull/1261/head
Mike Black W9MDB 2023-03-20 23:08:38 -05:00
commit 0f0bbeb612
11 zmienionych plików z 50 dodań i 47 usunięć

Wyświetl plik

@ -163,7 +163,7 @@ enum rig_errcode_e {
RIG_EDOM, /*!< 17 Argument out of domain of func */
RIG_EDEPRECATED,/*!< 18 Function deprecated */
RIG_ESECURITY, /*!< 19 Security error */
RIG_EPOWER, /*!, 20 Rig not powered on */
RIG_EPOWER, /*!< 20 Rig not powered on */
RIG_EEND // MUST BE LAST ITEM IN LAST
};
/**
@ -340,8 +340,8 @@ enum agc_level_e {
RIG_AGC_MEDIUM,
RIG_AGC_AUTO,
RIG_AGC_LONG,
RIG_AGC_ON, /*< Turns AGC ON -- Kenwood -- restores last level set */
RIG_AGC_NONE /*< Rig does not have CAT AGC control */
RIG_AGC_ON, /*!< Turns AGC ON -- Kenwood -- restores last level set */
RIG_AGC_NONE /*!< Rig does not have CAT AGC control */
};
@ -2074,7 +2074,6 @@ struct rig_caps {
* \brief Enumeration of all rig_ functions
*
*/
//! @cond Doxygen_Suppress
// all functions enumerated for rig_get_function_ptr
enum rig_function_e {
RIG_FUNCTION_INIT,
@ -2171,14 +2170,12 @@ enum rig_function_e {
* \brief Function to return pointer to rig_* function
*
*/
//! @cond Doxygen_Suppress
extern HAMLIB_EXPORT (void *) rig_get_function_ptr(rig_model_t rig_model, enum rig_function_e rig_function);
/**
* \brief Enumeration of rig->caps values
*
*/
//! @cond Doxygen_Suppress
// values enumerated for rig->caps values
enum rig_caps_int_e {
RIG_CAPS_TARGETABLE_VFO,
@ -2199,14 +2196,12 @@ enum rig_caps_cptr_e {
* \brief Function to return int value from rig->caps
* Does not support > 32-bit rig_caps values
*/
//! @cond Doxygen_Suppress
extern HAMLIB_EXPORT (long long) rig_get_caps_int(rig_model_t rig_model, enum rig_caps_int_e rig_caps);
/**
* \brief Function to return char pointer value from rig->caps
*
*/
//! @cond Doxygen_Suppress
extern HAMLIB_EXPORT (const char *) rig_get_caps_cptr(rig_model_t rig_model, enum rig_caps_cptr_e rig_caps);
struct hamlib_async_pipe;
@ -2368,7 +2363,7 @@ typedef hamlib_port_t port_t;
#define HAMLIB_ELAPSED_SET 1
#define HAMLIB_ELAPSED_INVALIDATE 2
#define HAMLIB_CACHE_ALWAYS (-1) /*< value to set cache timeout to always use cache */
#define HAMLIB_CACHE_ALWAYS (-1) /*!< value to set cache timeout to always use cache */
typedef enum {
HAMLIB_CACHE_ALL, // to set all cache timeouts at once
@ -2584,16 +2579,16 @@ struct rig_state {
/********* DO NOT ADD or CHANGE anything (or than to rename) ABOVE THIS LINE *********/
/********* ENSURE ANY NEW ITEMS ARE ADDED AFTER HERE *********/
/* flags instructing the rig_get routines to use cached values when asyncio is in use */
int use_cached_freq; /*<! flag instructing rig_get_freq to use cached values when asyncio is in use */
int use_cached_mode; /*<! flag instructing rig_get_mode to use cached values when asyncio is in use */
int use_cached_ptt; /*<! flag instructing rig_get_ptt to use cached values when asyncio is in use */
int depth; /*<! a depth counter to use for debug indentation and such */
int lock_mode; /*<! flag that prevents mode changes if ~= 0 -- see set/get_lock_mode */
powerstat_t powerstat; /*<! power status */
char *tuner_control_pathname; /*<! Path to external tuner control program that get 0/1 (Off/On) argument */
char client_version[32]; /*<! Allow client to report version for compatility checks/capability */
freq_t offset_vfoa; /*<! Offset to apply to VFOA/Main set_freq */
freq_t offset_vfob; /*<! Offset to apply to VFOB/Sub set_freq */
int use_cached_freq; /*!< flag instructing rig_get_freq to use cached values when asyncio is in use */
int use_cached_mode; /*!< flag instructing rig_get_mode to use cached values when asyncio is in use */
int use_cached_ptt; /*!< flag instructing rig_get_ptt to use cached values when asyncio is in use */
int depth; /*!< a depth counter to use for debug indentation and such */
int lock_mode; /*!< flag that prevents mode changes if ~= 0 -- see set/get_lock_mode */
powerstat_t powerstat; /*!< power status */
char *tuner_control_pathname; /*!< Path to external tuner control program that get 0/1 (Off/On) argument */
char client_version[32]; /*!<! Allow client to report version for compatility checks/capability */
freq_t offset_vfoa; /*!< Offset to apply to VFOA/Main set_freq */
freq_t offset_vfob; /*!< Offset to apply to VFOB/Sub set_freq */
};
//! @cond Doxygen_Suppress

Wyświetl plik

@ -637,9 +637,17 @@
#define ROT_MODEL_ANDROIDSENSOR ROT_MAKE_MODEL(ROT_ANDROIDSENSOR, 1)
/**
* \brief A macro that returns the model number of the GRBLTRK backend.
* \brief A macro that returns the model number of the ROT_MODEL_GRBLTRK_SER backend.
*
* \def ROT_MODEL_GRBLTRK
* \def ROT_MODEL_GRBLTRK_SER
*
* The GRBLTRK backend can be used with rotators that support the GRBL
* protocol.
*/
/**
* \brief A macro that returns the model number of the ROT_MODEL_GRBLTRK_NET backend.
*
* \def ROT_MODEL_GRBLTRK_NET
*
* The GRBLTRK backend can be used with rotators that support the GRBL
* protocol.
@ -658,7 +666,7 @@
*
* The FLIR backend can be used with FLIR and DirectedPercepition
* rotators using the PTU protocol (e.g. PTU-D48). Currently only
* the serial interaface is supported and no ethernet.
* the serial interface is supported and no ethernet.
*/
//! @cond Doxygen_Suppress
#define ROT_FLIR 25
@ -669,7 +677,7 @@
/**
* \brief A macro that returns the model number of the APEX backend.
*
* \def ROT_MODEL_APEX
* \def ROT_MODEL_APEX_SHARED_LOOP
*
* The APEX backend can be used with APEX * rotators.
*/

Wyświetl plik

@ -7790,7 +7790,7 @@ int icom_set_dcs_code(RIG *rig, vfo_t vfo, tone_t code)
RETURNFUNC(-RIG_EINVAL);
}
/* DCS Polarity ignored, by setting code_len to 3 it's foretval to 0 (= Tx:norm, Rx:norm). */
/* DCS Polarity ignored, by setting code_len to 3 it's forced to 0 (= Tx:norm, Rx:norm). */
code_len = 3;
to_bcd_be(codebuf, code, code_len * 2);

Wyświetl plik

@ -2762,7 +2762,7 @@ int k4_get_ptt(RIG *rig, vfo_t vfo, ptt_t *ptt)
// The K4 has a problem in Fake It mode where the FA command is ignored
// We will use it's special TQ command to try and ensure PTT is really off
// We will use its special TQ command to try and ensure PTT is really off
int k4_set_ptt(RIG *rig, vfo_t vfo, ptt_t ptt)
{
char pttbuf[6];
@ -2808,7 +2808,7 @@ int k4_set_ptt(RIG *rig, vfo_t vfo, ptt_t ptt)
return RIG_OK;
}
// K3S band memory needs some time to do it's thing after freq change
// K3S band memory needs some time to do its thing after freq change
// K3 probably does too
// But what about the K4?
int k3_set_freq(RIG *rig, vfo_t vfo, freq_t freq)

Wyświetl plik

@ -460,7 +460,7 @@ tt550_trx_open(RIG *rig)
priv = (struct tt550_priv_data *) rig->state.priv;
/*
* Reset the radio and start it's program running
* Reset the radio and start its program running
* We'll try twice to reset before giving up
*/
if (tt550_reset(rig, RIG_RESET_SOFT) != RIG_OK)

Wyświetl plik

@ -293,7 +293,7 @@ const char *uniden_digital_get_info(RIG *rig)
* STS command returns 3 lines including system, truck, freq info
*
* XXX indicates the BCD996T returns some non-printable ascii chars
* within it's comma separated fields. See pg 30-32 of BCD996T_Protocol.pdf.
* within its comma separated fields. See pg 30-32 of BCD996T_Protocol.pdf.
* These chars cause abnomalies on stdout! */
/* FIXME: Strip or replace non-printable chars return from STS command!

Wyświetl plik

@ -1169,7 +1169,7 @@ int newcat_set_freq(RIG *rig, vfo_t vfo, freq_t freq)
__func__, rigerror(err));
}
hl_usleep(500 * 1000); // wait for BS to do it's thing and swap back
hl_usleep(500 * 1000); // wait for BS to do its thing and swap back
if (newcat_valid_command(rig, "VS"))
{
@ -1193,7 +1193,7 @@ int newcat_set_freq(RIG *rig, vfo_t vfo, freq_t freq)
__func__, rigerror(err));
}
hl_usleep(500 * 1000); // wait for BS to do it's thing
hl_usleep(500 * 1000); // wait for BS to do its thing
}
@ -10964,7 +10964,7 @@ int newcat_set_cmd(RIG *rig)
if (strncmp(priv->cmd_str, "BS", 2) == 0)
{
// the BS command needs time to do it's thing
// the BS command needs time to do its thing
hl_usleep(500 * 1000);
priv->cache_start.tv_sec = 0; // invalidate the cache
}

Wyświetl plik

@ -178,8 +178,6 @@ void HAMLIB_API rig_set_debug_time_stamp(int flag)
rig_debug_time_stamp = flag;
}
//! @endcond
/**
* \brief Print debugging messages through `stderr` by default.

Wyświetl plik

@ -1334,7 +1334,7 @@ static const struct
/**
* \brief Convert enum RIG_AGC_... to alpha string
* \param mode RIG_AGC_...
* \param level RIG_AGC_...
* \return alpha string
*/
const char *HAMLIB_API rig_stragclevel(enum agc_level_e level)
@ -1828,6 +1828,8 @@ void HAMLIB_API rig_no_restore_ai()
no_restore_ai = -1;
}
//! @endcond
//! @cond Doxygen_Suppress
double HAMLIB_API elapsed_ms(struct timespec *start, int option)
@ -1882,6 +1884,8 @@ double HAMLIB_API elapsed_ms(struct timespec *start, int option)
return elapsed_msec;
}
//! @endcond
int HAMLIB_API rig_get_cache_timeout_ms(RIG *rig, hamlib_cache_t selection)
{

Wyświetl plik

@ -480,7 +480,7 @@ static int rig_check_rig_caps()
}
/**
* \brief allocate a new RIG handle
* \brief Allocate a new #RIG handle.
* \param rig_model The rig model for this new handle
*
* Allocates a new RIG handle and initializes the associated data
@ -1645,13 +1645,11 @@ int HAMLIB_API rig_set_twiddle(RIG *rig, int seconds)
/**
* \brief For GPredict to avoid reading frequency on uplink VFO
* \param rig The rig handle
* \param seconds 1=Ignore Sub, 2=Ignore Main
* \param val 1=Ignore Sub, 2=Ignore Main
*
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
* \sa rig_set_uplink()
*/
int HAMLIB_API rig_set_uplink(RIG *rig, int val)
{
@ -3070,7 +3068,7 @@ int HAMLIB_API rig_set_ptt(RIG *rig, vfo_t vfo, ptt_t ptt)
}
#if 0
hl_usleep(50 * 1000); // give PTT a chance to do it's thing
hl_usleep(50 * 1000); // give PTT a chance to do its thing
// don't use the cached value and check to see if it worked
elapsed_ms(&rig->state.cache.time_ptt, HAMLIB_ELAPSED_INVALIDATE);
@ -4948,7 +4946,7 @@ int HAMLIB_API rig_get_split_freq_mode(RIG *rig,
/**
* \brief set the split mode
* \param rig The rig handle
* \param vfo The target VFO
* \param rx_vfo The receive VFO
* \param split The split mode to set to
* \param tx_vfo The transmit VFO
*
@ -6015,7 +6013,7 @@ int HAMLIB_API rig_mW2power(RIG *rig,
*
* Returns the best frequency resolution of the rig, for a given \a mode.
*
* \return the frequency resolution in Hertz if the operation h
* \return the frequency resolution in Hertz if the operation
* has been successful, otherwise a negative value if an error occurred.
*
*/
@ -6054,7 +6052,7 @@ shortfreq_t HAMLIB_API rig_get_resolution(RIG *rig, rmode_t mode)
* See #RIG_POWER_ON, #RIG_POWER_OFF and #RIG_POWER_STANDBY defines
* for the \a status.
*
* \return RIG_OK if the operation has been successful, ortherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -7066,7 +7064,7 @@ static unsigned long gen_crc(unsigned char *p, size_t n)
* \brief get freq/mode/width for requested VFO
* \param rig The rig handle
*
* returns a string for all known VFOs plus rig split status and satellite mode status
* \returns a string for all known VFOs plus rig split status and satellite mode status
*/
int HAMLIB_API rig_get_rig_info(RIG *rig, char *response, int max_response_len)
{
@ -7238,8 +7236,8 @@ int HAMLIB_API rig_get_vfo_info(RIG *rig, vfo_t vfo, freq_t *freq,
/**
* \brief get list of available vfos
* \param rig The rig handle
* \param char* char buffer[SPRINTF_MAX_SIZE] to hold result
* \param len max length of char buffer
* \param buf char buffer to hold result
* \param buflen max length of char buffer
*
* Retrieves all usable vfo entries for the rig
*

Wyświetl plik

@ -480,7 +480,7 @@ int HAMLIB_API rig_get_ctcss_sql(RIG *rig, vfo_t vfo, tone_t *tone)
*
* Sets the current Digitally-Coded *Squelch* code.
*
* \return returns RIG_OK if the operation has been successful, ortherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is set
* appropriately).
*
@ -542,7 +542,7 @@ int HAMLIB_API rig_set_dcs_sql(RIG *rig, vfo_t vfo, tone_t code)
*
* Retrieves the current Digitally-Coded *Squelch* code.
*
* \return RIG_OK if the operation has been successful, ortherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*