GNU Radio 3.6.5.1 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  * \details
35  * This is effectively the public constructor. To avoid accidental use
36  * of raw pointers, fcd_source_c's constructor is private.
37  * fcd_make_source_c is the public interface for creating new instances.
38  */
39 FCD_API fcd_source_c_sptr fcd_make_source_c(const std::string device_name = "");
40 
41 /*!
42  * \brief Funcube Dongle source block.
43  * \ingroup fcd_blk
44  *
45  * \details
46  * This class provides a Funcube Dongle soure block by wrapping the
47  * USB audio interface and the USB HID control interface of the Funcube
48  * Dongle into one convenient source block.
49  *
50  * The Funcube Dongle needs to have firmware 18f or later for the control
51  * interface to work properly. As of early 2011, FCDs still come with firmware
52  * 18b. You can use qthid 2.2 (not 3) to upgrade the firmware: http://qthid.sf.net
53  */
54 class FCD_API fcd_source_c : virtual public gr_hier_block2
55 {
56 public:
57  /*! \brief Set frequency with Hz resolution.
58  * \param freq The frequency in Hz
59  *
60  * Set the frequency of the Funcube Dongle with 1 Hz resolution applying
61  * the frequency correction set by set_freq_corr().
62  *
63  * \see set_freq_khz()
64  */
65  virtual void set_freq(int freq) = 0;
66 
67  /*! \brief Set frequency with Hz resolution.
68  * \param freq The frequency in Hz
69  *
70  * This is a convenience function that uses float parameter in order to allow
71  * using engineering notation in GRC.
72  *
73  * \see set_freq_khz()
74  */
75  virtual void set_freq(float freq) = 0;
76 
77  /*! \brief Set frequency with kHz resolution.
78  * \param freq The frequency in kHz
79  *
80  * Sets the frequency of the Funcube Dongle with 1 kHz resolution
81  * applying the frequency correction set by set_freq_corr().
82  *
83  * \see set_freq()
84  */
85  virtual void set_freq_khz(int freq) = 0;
86 
87  /*! \brief Set LNA gain.
88  * \param gain The new gain in dB.
89  *
90  * Set the LNA gain in the FCD. Valid range is -5 to 30. Although
91  * the LNA gain in the FCD takes enumerated values corresponding to
92  * 2.5 dB steps, you can can call this method with any float value
93  * and it will be rounded to the nearest valid value.
94  *
95  * By default the LNA gain is set to 20 dB and this is a good value for
96  * most cases. In noisy areas you may try to reduce the gain.
97  */
98  virtual void set_lna_gain(float gain) = 0;
99 
100  /*! \brief Set mixer gain.
101  * \param gain The new gain in dB.
102  *
103  * Set the mixer gain in the FCD. Valid values are +4 and +12 dB.
104  *
105  * By default the mixer gain is set to +12 dB and this is a good value for
106  * most cases. In noisy areas you may try to reduce the gain.
107  */
108  virtual void set_mixer_gain(float gain) = 0;
109 
110  /*! \brief Set new frequency correction.
111  * \param ppm The new frequency correction in parts per million
112  *
113  * Version 1.1 FCDs (S/N 810 or later) need a correction of -12 ppm.
114  * Earlier FCDs need roughly -120 ppm (default for gr-fcd).
115  *
116  * Ref: http://www.funcubedongle.com/?p=617
117  */
118  virtual void set_freq_corr(int ppm) = 0;
119 
120  /*! \brief Set DC offset correction.
121  * \param _dci DC correction for I component (-1.0 to 1.0)
122  * \param _dcq DC correction for Q component (-1.0 to 1.0)
123  *
124  * Set DC offset correction in the device. Default is 0.0.
125  */
126  virtual void set_dc_corr(double _dci, double _dcq) = 0;
127 
128  /*! \brief Set IQ phase and gain balance.
129  * \param _gain The gain correction (-1.0 to 1.0)
130  * \param _phase The phase correction (-1.0 to 1.0)
131  *
132  * Set IQ phase and gain balance in the device. The default values
133  * are 0.0 for phase and 1.0 for gain.
134  */
135  virtual void set_iq_corr(double _gain, double _phase) = 0;
136 };
137 
138 #endif /* INCLUDED_FCD_SOURCE_C_H */