mirror
/
Hamlib
kopia lustrzana https://github.com/Hamlib/Hamlib
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność

Merge branch 'master' of https://github.com/Hamlib/Hamlib

pull/544/head
Michael Black W9MDB 2021-02-08 12:55:24 -06:00
rodzic ad9d464822 cd77d8f22d
commit 31b28202ee
3 zmienionych plików z 77 dodań i 48 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

3
doc/hamlib.cfg.in
Wyświetl plik

@ -21,6 +21,9 @@ INPUT = @top_srcdir@/doc/index.doxygen \
@top_srcdir@/include/hamlib/ \ @top_srcdir@/include/hamlib/ \
@top_srcdir@/src/ @top_srcdir@/src/
EXCLUDE = @top_srcdir@/src/amp_conf.h \
@top_srcdir@/include/hamlib/ampclass.h
INCLUDE_PATH = @top_srcdir@/include INCLUDE_PATH = @top_srcdir@/include
EXAMPLE_PATH = @top_srcdir@/tests/testrig.c \ EXAMPLE_PATH = @top_srcdir@/tests/testrig.c \

74
src/amp_conf.c
Wyświetl plik

@ -109,7 +109,7 @@ static const struct confparams ampfrontend_serial_cfg_params[] =
{ RIG_CONF_END, NULL, } { RIG_CONF_END, NULL, }
}; };
//! @cond Doxygen_Suppress
/** /**
* \brief Set amplifier state info from alpha input * \brief Set amplifier state info from alpha input
* \param amp * \param amp
@ -295,8 +295,10 @@ int frontamp_set_conf(AMP *amp, token_t token, const char *val)
return RIG_OK; return RIG_OK;
} }
//! @endcond
//! @cond Doxygen_Suppress
/** /**
* \brief Get data from amplifier state in alpha form * \brief Get data from amplifier state in alpha form
* \param amp non-null * \param amp non-null
@ -430,6 +432,7 @@ int frontamp_get_conf(AMP *amp, token_t token, char *val)
return RIG_OK; return RIG_OK;
} }
//! @endcond
#ifdef XXREMOVEDXXC #ifdef XXREMOVEDXXC
@ -489,13 +492,20 @@ int HAMLIB_API amp_token_foreach(AMP *amp,
/** /**
* \brief lookup conf token by its name, return pointer to confparams struct. * \brief Query an amplifier configuration parameter token by its name.
* \param amp * \param amp The #AMP handle.
* \param name * \param name Configuration parameter token name (C string).
* \return confparams or NULL
* *
* lookup backend config table first, then fall back to frontend. * Use this function to get a pointer to the token in the #confparams
* TODO: should use Lex to speed it up, strcmp hurts! * structure. Searches the backend config params table first, then falls back
* to the frontend config params table.
*
* TODO: Should use Lex to speed it up, strcmp() hurts!
*
* \return A pointer to the token in the #confparams structure or NULL if #AMP
* is invalid or token not found (how can the caller know which occurred?).
*
* \sa amp_token_lookup()
*/ */
const struct confparams *HAMLIB_API amp_confparam_lookup(AMP *amp, const struct confparams *HAMLIB_API amp_confparam_lookup(AMP *amp,
const char *name) const char *name)
@ -545,10 +555,16 @@ const struct confparams *HAMLIB_API amp_confparam_lookup(AMP *amp,
/** /**
* \brief Simple lookup returning token id associated with name * \brief Search for the token ID associated with an amplifier configuration parameter token name.
* \param amp * \param amp The #AMP handle.
* \param name * \param name Configuration parameter token name (C string).
* \return token enum *
* Searches the backend and frontend configuration parameters tables for the
* token ID.
*
* \return The token ID value or RIG_CONF_END if the lookup failed.
*
* \sa amp_confparam_lookup()
*/ */
token_t HAMLIB_API amp_token_lookup(AMP *amp, const char *name) token_t HAMLIB_API amp_token_lookup(AMP *amp, const char *name)
{ {
@ -568,16 +584,19 @@ token_t HAMLIB_API amp_token_lookup(AMP *amp, const char *name)
/** /**
* \brief set a amplifier configuration parameter * \brief Set an amplifier configuration parameter.
* \param amp The amp handle * \param amp The #AMP handle.
* \param token The parameter * \param token The token of the parameter to set.
* \param val The value to set the parameter to * \param val The value to set the parameter to.
* *
* Sets a configuration parameter. * Sets an amplifier configuration parameter to \a val.
* *
* \return RIG_OK if the operation has been successful, otherwise * \return RIG_OK if the operation has been successful, otherwise a **negative
* a negative value if an error occurred (in which case, cause is * value** if an error occurred (in which case, cause is set appropriately).
* set appropriately). *
* \retval RIG_OK The parameter was set successfully.
* \retval RIG_EINVAL The #AMP handle or token was invalid.
* \retval RIG_ENAVAIL amp_caps#set_conf() capability is not available.
* *
* \sa amp_get_conf() * \sa amp_get_conf()
*/ */
@ -620,16 +639,19 @@ int HAMLIB_API amp_set_conf(AMP *amp, token_t token, const char *val)
/** /**
* \brief get the value of a configuration parameter * \brief Query the value of an amplifier configuration parameter.
* \param amp The amp handle * \param amp The #AMP handle.
* \param token The parameter * \param token The token of the parameter to query.
* \param val The location where to store the value of config \a token * \param val The location where to store the value of configuration \a token.
* *
* Retrieves the value of a configuration parameter associated with \a token. * Retrieves the value of a configuration parameter associated with \a token.
* *
* \return RIG_OK if the operation has been successful, otherwise * \return RIG_OK if the operation has been successful, otherwise a **negative
* a negative value if an error occurred (in which case, cause is * value** if an error occurred (in which case, cause is set appropriately).
* set appropriately). *
* \retval RIG_OK Querying the parameter was successful.
* \retval RIG_EINVAL The #AMP handle was invalid.
* \retval RIG_ENAVAIL amp_caps#get_conf() capability is not available.
* *
* \sa amp_set_conf() * \sa amp_set_conf()
*/ */

48
src/amp_settings.c
Wyświetl plik

@ -1,20 +1,7 @@
/**
* \addtogroup amplifier
* @{
*/
/**
* \file amp_settings.c
* \brief amplifiter func/level/parm interface
* \author Stephane Fillod
* \date 2000-2010
*
* Hamlib interface is a frontend implementing wrapper functions.
*/
/* /*
* Hamlib Interface - amplifier func/level/parm * Hamlib Interface - amplifier func/level/parm
* Copyright (c) 2000-2010 by Stephane Fillod * Copyright (c) 2000-2010 by Stephane Fillod
* Copyright (c) 2020 by Mikael Nousiainen
* *
* *
* This library is free software; you can redistribute it and/or * This library is free software; you can redistribute it and/or
@ -33,6 +20,23 @@
* *
*/ */
/**
* \addtogroup amplifier
* @{
*/
/**
* \file amp_settings.c
* \brief amplifiter func/level/parm interface
* \author Stephane Fillod
* \date 2000-2010
* \author Mikael Nousiainen
* \date 2020
*
* Hamlib interface is a frontend implementing wrapper functions.
*/
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H
# include "config.h" # include "config.h"
#endif #endif
@ -44,17 +48,17 @@
/** /**
* \brief check retrieval ability of level settings * \brief Check retrieval ability of level settings.
* \param amp The amp handle * \param amp The #AMP handle.
* \param level The level settings * \param level The level settings to check.
* *
* Checks if an amp is capable of *getting* a level setting. * Checks if an amplifier is capable of *getting* a level setting. Since the
* Since the \a level is an OR'ed bitwise argument, more than * \a level is an OR'ed bitwise argument, more than one level can be checked
* one level can be checked at the same time. * at the same time.
* *
* EXAMPLE: if (amp_has_get_level(my_amp, AMP_LVL_SWR)) disp_SWR(); * EXAMPLE: \code if (amp_has_get_level(my_amp, AMP_LVL_SWR)) disp_SWR();\endcode
* *
* \return a bit map of supported level settings that can be retrieved, * \return A bit map of supported level settings that can be retrieved,
* otherwise 0 if none supported. * otherwise 0 if none supported.
* *
* \sa amp_has_set_level(), amp_get_level() * \sa amp_has_set_level(), amp_get_level()