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