diff options
Diffstat (limited to 'gr-fcd/include/fcd/fcd_source_c.h')
| -rw-r--r-- | gr-fcd/include/fcd/fcd_source_c.h | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/gr-fcd/include/fcd/fcd_source_c.h b/gr-fcd/include/fcd/fcd_source_c.h index 988925c2e..19c589023 100644 --- a/gr-fcd/include/fcd/fcd_source_c.h +++ b/gr-fcd/include/fcd/fcd_source_c.h @@ -1,17 +1,17 @@ /* -*- c++ -*- */ /* * Copyright 2011-2012 Free Software Foundation, Inc. - * + * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. - * + * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. - * + * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, @@ -38,11 +38,11 @@ typedef boost::shared_ptr<fcd_source_c> fcd_source_c_sptr; FCD_API fcd_source_c_sptr fcd_make_source_c(const std::string device_name = ""); /*! \brief Funcube Dongle source block. - * + * * This class provides a Funcube Dongle soure block by wrapping the * USB audio interface and the USB HID control interface of the Funcube * Dongle into one convenient source block. - * + * * The Funcube Dongle needs to have firmware 18f or later for the control * interface to work properly. As of early 2011, FCDs still come with firmware * 18b. You can use qthid 2.2 (not 3) to upgrade the firmware: http://qthid.sf.net @@ -52,42 +52,42 @@ class FCD_API fcd_source_c : virtual public gr_hier_block2 public: /*! \brief Set frequency with Hz resolution. * \param freq The frequency in Hz - * + * * Set the frequency of the Funcube Dongle with 1 Hz resolution applying * the frequency correction set by set_freq_corr(). - * + * * \see set_freq_khz() */ virtual void set_freq(int freq) = 0; /*! \brief Set frequency with Hz resolution. * \param freq The frequency in Hz - * + * * This is a convenience function that uses float parameter in order to allow * using engineering notation in GRC. - * + * * \see set_freq_khz() */ virtual void set_freq(float freq) = 0; - + /*! \brief Set frequency with kHz resolution. * \param freq The frequency in kHz - * + * * Sets the frequency of the Funcube Dongle with 1 kHz resolution * applying the frequency correction set by set_freq_corr(). - * + * * \see set_freq() */ virtual void set_freq_khz(int freq) = 0; - + /*! \brief Set LNA gain. * \param gain The new gain in dB. - * + * * Set the LNA gain in the FCD. Valid range is -5 to 30. Although * the LNA gain in the FCD takes enumerated values corresponding to * 2.5 dB steps, you can can call this method with any float value * and it will be rounded to the nearest valid value. - * + * * By default the LNA gain is set to 20 dB and this is a good value for * most cases. In noisy areas you may try to reduce the gain. */ @@ -105,26 +105,26 @@ public: /*! \brief Set new frequency correction. * \param ppm The new frequency correction in parts per million - * + * * Version 1.1 FCDs (S/N 810 or later) need a correction of -12 ppm. * Earlier FCDs need roughly -120 ppm (default for gr-fcd). - * + * * Ref: http://www.funcubedongle.com/?p=617 */ virtual void set_freq_corr(int ppm) = 0; - + /*! \brief Set DC offset correction. * \param _dci DC correction for I component (-1.0 to 1.0) * \param _dcq DC correction for Q component (-1.0 to 1.0) - * + * * Set DC offset correction in the device. Default is 0.0. */ virtual void set_dc_corr(double _dci, double _dcq) = 0; - + /*! \brief Set IQ phase and gain balance. * \param _gain The gain correction (-1.0 to 1.0) * \param _phase The phase correction (-1.0 to 1.0) - * + * * Set IQ phase and gain balance in the device. The default values * are 0.0 for phase and 1.0 for gain. */ |