GNU Radio 3.5.3.2 C++ API
fcd_source_c.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2011-2012 Free Software Foundation, Inc.
4  *
5  * GNU Radio is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 3, or (at your option)
8  * any later version.
9  *
10  * GNU Radio is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with GNU Radio; see the file COPYING. If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street,
18  * Boston, MA 02110-1301, USA.
19  */
20 
21 #ifndef INCLUDED_FCD_SOURCE_C_H
22 #define INCLUDED_FCD_SOURCE_C_H
23 
24 #include <fcd_api.h>
25 #include <gr_hier_block2.h>
26 
27 class fcd_source_c;
28 
30 
31 /*!
32  * \brief Return a shared_ptr to a new instance of fcd_source_c.
33  *
34  * This is effectively the public constructor. To avoid accidental use
35  * of raw pointers, fcd_source_c's constructor is private.
36  * fcd_make_source_c is the public interface for creating new instances.
37  */
38 FCD_API fcd_source_c_sptr fcd_make_source_c(const std::string device_name = "");
39 
40 /*! \brief Funcube Dongle source block.
41  *
42  * This class provides a Funcube Dongle soure block by wrapping the
43  * USB audio interface and the USB HID control interface of the Funcube
44  * Dongle into one convenient source block.
45  *
46  * The Funcube Dongle needs to have firmware 18f or later for the control
47  * interface to work properly. As of early 2011, FCDs still come with firmware
48  * 18b. You can use qthid 2.2 (not 3) to upgrade the firmware: http://qthid.sf.net
49  */
50 class FCD_API fcd_source_c : virtual public gr_hier_block2
51 {
52 public:
53  /*! \brief Set frequency with Hz resolution.
54  * \param freq The frequency in Hz
55  *
56  * Set the frequency of the Funcube Dongle with 1 Hz resolution applying
57  * the frequency correction set by set_freq_corr().
58  *
59  * \see set_freq_khz()
60  */
61  virtual void set_freq(int freq) = 0;
62 
63  /*! \brief Set frequency with Hz resolution.
64  * \param freq The frequency in Hz
65  *
66  * This is a convenience function that uses float parameter in order to allow
67  * using engineering notation in GRC.
68  *
69  * \see set_freq_khz()
70  */
71  virtual void set_freq(float freq) = 0;
72 
73  /*! \brief Set frequency with kHz resolution.
74  * \param freq The frequency in kHz
75  *
76  * Sets the frequency of the Funcube Dongle with 1 kHz resolution
77  * applying the frequency correction set by set_freq_corr().
78  *
79  * \see set_freq()
80  */
81  virtual void set_freq_khz(int freq) = 0;
82 
83  /*! \brief Set LNA gain.
84  * \param gain The new gain in dB.
85  *
86  * Set the LNA gain in the FCD. Valid range is -5 to 30. Although
87  * the LNA gain in the FCD takes enumerated values corresponding to
88  * 2.5 dB steps, you can can call this method with any float value
89  * and it will be rounded to the nearest valid value.
90  *
91  * By default the LNA gain is set to 20 dB and this is a good value for
92  * most cases. In noisy areas you may try to reduce the gain.
93  */
94  virtual void set_lna_gain(float gain) = 0;
95 
96  /*! \brief Set mixer gain.
97  * \param gain The new gain in dB.
98  *
99  * Set the mixer gain in the FCD. Valid values are +4 and +12 dB.
100  *
101  * By default the mixer gain is set to +12 dB and this is a good value for
102  * most cases. In noisy areas you may try to reduce the gain.
103  */
104  virtual void set_mixer_gain(float gain) = 0;
105 
106  /*! \brief Set new frequency correction.
107  * \param ppm The new frequency correction in parts per million
108  *
109  * Version 1.1 FCDs (S/N 810 or later) need a correction of -12 ppm.
110  * Earlier FCDs need roughly -120 ppm (default for gr-fcd).
111  *
112  * Ref: http://www.funcubedongle.com/?p=617
113  */
114  virtual void set_freq_corr(int ppm) = 0;
115 
116  /*! \brief Set DC offset correction.
117  * \param _dci DC correction for I component (-1.0 to 1.0)
118  * \param _dcq DC correction for Q component (-1.0 to 1.0)
119  *
120  * Set DC offset correction in the device. Default is 0.0.
121  */
122  virtual void set_dc_corr(double _dci, double _dcq) = 0;
123 
124  /*! \brief Set IQ phase and gain balance.
125  * \param _gain The gain correction (-1.0 to 1.0)
126  * \param _phase The phase correction (-1.0 to 1.0)
127  *
128  * Set IQ phase and gain balance in the device. The default values
129  * are 0.0 for phase and 1.0 for gain.
130  */
131  virtual void set_iq_corr(double _gain, double _phase) = 0;
132 };
133 
134 #endif /* INCLUDED_FCD_SOURCE_C_H */