GNU Radio 3.7.1 C++ API
source_c.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2011-2013 Free Software Foundation, Inc.
00004  *
00005  * GNU Radio is free software; you can redistribute it and/or modify
00006  * it under the terms of the GNU General Public License as published by
00007  * the Free Software Foundation; either version 3, or (at your option)
00008  * any later version.
00009  *
00010  * GNU Radio is distributed in the hope that it will be useful,
00011  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00012  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00013  * GNU General Public License for more details.
00014  *
00015  * You should have received a copy of the GNU General Public License
00016  * along with GNU Radio; see the file COPYING.  If not, write to
00017  * the Free Software Foundation, Inc., 51 Franklin Street,
00018  * Boston, MA 02110-1301, USA.
00019  */
00020 
00021 #ifndef INCLUDED_FCD_SOURCE_C_H
00022 #define INCLUDED_FCD_SOURCE_C_H
00023 
00024 #include <gnuradio/fcd/api.h>
00025 #include <gnuradio/hier_block2.h>
00026 
00027 namespace gr {
00028   namespace fcd {
00029 
00030     /*!
00031      * \brief Funcube Dongle source block.
00032      * \ingroup fcd_blk
00033      *
00034      * \details
00035      * This class provides a Funcube Dongle soure block by wrapping
00036      * the USB audio interface and the USB HID control interface of
00037      * the Funcube Dongle into one convenient source block.
00038      *
00039      * The Funcube Dongle needs to have firmware 18f or later for the
00040      * control interface to work properly. As of early 2011, FCDs
00041      * still come with firmware 18b. You can use qthid 2.2 (not 3) to
00042      * upgrade the firmware: http://qthid.sf.net
00043      */
00044     class FCD_API source_c : virtual public gr::hier_block2
00045     {
00046     public:
00047       // gr::fcd::source_c::sptr
00048       typedef boost::shared_ptr<source_c> sptr;
00049 
00050       /*!
00051        * \brief Return a shared_ptr to a new instance of fcd_source_c.
00052        *
00053        * \details
00054        * This is effectively the public constructor. To avoid accidental
00055        * use of raw pointers, fcd_source_c's constructor is private.
00056        * fcd_make_source_c is the public interface for creating new
00057        * instances.
00058        */
00059       static sptr make(const std::string device_name = "");
00060 
00061       /*! \brief Set frequency with Hz resolution.
00062        *  \param freq The frequency in Hz
00063        *
00064        * Set the frequency of the Funcube Dongle with 1 Hz resolution applying
00065        * the frequency correction set by set_freq_corr().
00066        *
00067        * \see set_freq_khz()
00068        */
00069       virtual void set_freq(int freq) = 0;
00070 
00071       /*! \brief Set frequency with Hz resolution.
00072        *  \param freq The frequency in Hz
00073        *
00074        * This is a convenience function that uses float parameter in
00075        * order to allow using engineering notation in GRC.
00076        *
00077        * \see set_freq_khz()
00078        */
00079       virtual void set_freq(float freq) = 0;
00080 
00081       /*! \brief Set frequency with kHz resolution.
00082        *  \param freq The frequency in kHz
00083        *
00084        * Sets the frequency of the Funcube Dongle with 1 kHz
00085        * resolution applying the frequency correction set by
00086        * set_freq_corr().
00087        *
00088        * \see set_freq()
00089        */
00090       virtual void set_freq_khz(int freq) = 0;
00091 
00092       /*! \brief Set LNA gain.
00093        *  \param gain The new gain in dB.
00094        *
00095        * Set the LNA gain in the FCD. Valid range is -5 to
00096        * 30. Although the LNA gain in the FCD takes enumerated values
00097        * corresponding to 2.5 dB steps, you can can call this method
00098        * with any float value and it will be rounded to the nearest
00099        * valid value.
00100        *
00101        * By default the LNA gain is set to 20 dB and this is a good value for
00102        * most cases. In noisy areas you may try to reduce the gain.
00103        */
00104       virtual void set_lna_gain(float gain) = 0;
00105 
00106       /*! \brief Set mixer gain.
00107        *  \param gain The new gain in dB.
00108        *
00109        * Set the mixer gain in the FCD. Valid values are +4 and +12 dB.
00110        *
00111        * By default the mixer gain is set to +12 dB and this is a good
00112        * value for most cases. In noisy areas you may try to reduce
00113        * the gain.
00114        */
00115       virtual void set_mixer_gain(float gain) = 0;
00116 
00117       /*! \brief Set new frequency correction.
00118        *  \param ppm The new frequency correction in parts per million
00119        *
00120        * Version 1.1 FCDs (S/N 810 or later) need a correction of -12
00121        * ppm.  Earlier FCDs need roughly -120 ppm (default for
00122        * gr-fcd).
00123        *
00124        * Ref: http://www.funcubedongle.com/?p=617
00125        */
00126       virtual void set_freq_corr(int ppm) = 0;
00127 
00128       /*! \brief Set DC offset correction.
00129        *  \param _dci DC correction for I component (-1.0 to 1.0)
00130        *  \param _dcq DC correction for Q component (-1.0 to 1.0)
00131        *
00132        * Set DC offset correction in the device. Default is 0.0.
00133        */
00134       virtual void set_dc_corr(double _dci, double _dcq) = 0;
00135 
00136       /*! \brief Set IQ phase and gain balance.
00137        *  \param _gain The gain correction (-1.0 to 1.0)
00138        *  \param _phase The phase correction (-1.0 to 1.0)
00139        *
00140        * Set IQ phase and gain balance in the device. The default values
00141        * are 0.0 for phase and 1.0 for gain.
00142        */
00143       virtual void set_iq_corr(double _gain, double _phase) = 0;
00144     };
00145 
00146   } /* namespace fcd */
00147 } /* namespace gr */
00148 
00149 #endif /* INCLUDED_FCD_SOURCE_C_H */