GNU Radio's HOWTO Package
fcd_control.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_FCD_CONTROL_H
22 #define INCLUDED_FCD_CONTROL_H
23 
24 #include <fcdproplus/api.h>
25 #include <gnuradio/block.h>
26 
27 namespace gr {
28  namespace fcdproplus {
29 
30  /*!
31  * \brief Funcube Dongle control block.
32  * \ingroup fcd_blk
33  *
34  * \details
35  * This class provides a Funcube Dongle control block by wrapping
36  * th USB HID control interface of
37  * the Funcube Dongle into one convenient source block.
38  *
39  * The Funcube Dongle needs to have firmware 18f or later for the
40  * control interface to work properly. As of early 2011, FCDs
41  * still come with firmware 18b. You can use qthid 2.2 (not 3) to
42  * upgrade the firmware: http://qthid.sf.net
43  */
44  class FCDPROPLUS_API fcd_control : virtual public gr::block
45  {
46  public:
47 
48  typedef boost::shared_ptr<fcd_control> sptr;
49  static sptr make();
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 
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  /*! \brief Set LNA gain.
72  * \param gain The new gain in dB.
73  *
74  * Set the LNA gain in the FCD. Valid range is -5 to
75  * 30. Although the LNA gain in the FCD takes enumerated values
76  * corresponding to 2.5 dB steps, you can can call this method
77  * with any float value and it will be rounded to the nearest
78  * valid value.
79  *
80  * By default the LNA gain is set to 20 dB and this is a good value for
81  * most cases. In noisy areas you may try to reduce the gain.
82  */
83  virtual void set_lna_gain(float gain) = 0;
84 
85  /*! \brief Set mixer gain.
86  * \param gain The new gain in dB.
87  *
88  * Set the mixer gain in the FCD. Valid values are +4 and +12 dB.
89  *
90  * By default the mixer gain is set to +12 dB and this is a good
91  * value for most cases. In noisy areas you may try to reduce
92  * the gain.
93  */
94  virtual void set_mixer_gain(float gain) = 0;
95 
96  /*! \brief Set new frequency correction.
97  * \param ppm The new frequency correction in parts per million
98  *
99  * Version 1.1 FCDs (S/N 810 or later) need a correction of -12
100  * ppm. Earlier FCDs need roughly -120 ppm (default for
101  * gr-fcd).
102  *
103  * Ref: http://www.funcubedongle.com/?p=617
104  */
105  virtual void set_freq_corr(int ppm) = 0;
106 
107  /*! \brief Set DC offset correction.
108  * \param _dci DC correction for I component (-1.0 to 1.0)
109  * \param _dcq DC correction for Q component (-1.0 to 1.0)
110  *
111  * Set DC offset correction in the device. Default is 0.0.
112  */
113  virtual void set_dc_corr(double _dci, double _dcq) = 0;
114 
115  /*! \brief Set IQ phase and gain balance.
116  * \param _gain The gain correction (-1.0 to 1.0)
117  * \param _phase The phase correction (-1.0 to 1.0)
118  *
119  * Set IQ phase and gain balance in the device. The default values
120  * are 0.0 for phase and 1.0 for gain.
121  */
122  virtual void set_iq_corr(double _gain, double _phase) = 0;
123  };
124 
125  } /* namespace fcd */
126 } /* namespace gr */
127 
128 #endif /* INCLUDED_FCD_CONTROL_H */
boost::shared_ptr< fcd_control > sptr
Definition: fcd_control.h:48
#define FCDPROPLUS_API
Definition: api.h:30
Funcube Dongle control block.
Definition: fcd_control.h:44
Definition: fcd.h:29