GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
source_c.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_SOURCE_C_H
22#define INCLUDED_FCD_SOURCE_C_H
23
24#include <gnuradio/fcd/api.h>
26
27namespace gr {
28namespace fcd {
29
30/*!
31 * \brief Funcube Dongle source block.
32 * \ingroup fcd_blk
33 *
34 * \details
35 * This class provides a Funcube Dongle source block by wrapping
36 * the USB audio interface and the 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 */
44class FCD_API source_c : virtual public gr::hier_block2
45{
46public:
47 // gr::fcd::source_c::sptr
48 typedef boost::shared_ptr<source_c> sptr;
49
50 /*!
51 * \brief Return a shared_ptr to a new instance of fcd_source_c.
52 *
53 * \details
54 * This is effectively the public constructor. To avoid accidental
55 * use of raw pointers, fcd_source_c's constructor is private.
56 * fcd_make_source_c is the public interface for creating new
57 * instances.
58 */
59 static sptr make(const std::string device_name = "");
60
61 /*! \brief Set frequency with Hz resolution.
62 * \param freq The frequency in Hz
63 *
64 * Set the frequency of the Funcube Dongle with 1 Hz resolution applying
65 * the frequency correction set by set_freq_corr().
66 *
67 * \see set_freq_khz()
68 */
69 virtual void set_freq(int freq) = 0;
70
71 /*! \brief Set frequency with Hz resolution.
72 * \param freq The frequency in Hz
73 *
74 * This is a convenience function that uses float parameter in
75 * order to allow using engineering notation in GRC.
76 *
77 * \see set_freq_khz()
78 */
79 virtual void set_freq(float freq) = 0;
80
81 /*! \brief Set frequency with kHz resolution.
82 * \param freq The frequency in kHz
83 *
84 * Sets the frequency of the Funcube Dongle with 1 kHz
85 * resolution applying the frequency correction set by
86 * set_freq_corr().
87 *
88 * \see set_freq()
89 */
90 virtual void set_freq_khz(int freq) = 0;
91
92 /*! \brief Set LNA gain.
93 * \param gain The new gain in dB.
94 *
95 * Set the LNA gain in the FCD. Valid range is -5 to
96 * 30. Although the LNA gain in the FCD takes enumerated values
97 * corresponding to 2.5 dB steps, you can can call this method
98 * with any float value and it will be rounded to the nearest
99 * valid value.
100 *
101 * By default the LNA gain is set to 20 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_lna_gain(float gain) = 0;
105
106 /*! \brief Set mixer gain.
107 * \param gain The new gain in dB.
108 *
109 * Set the mixer gain in the FCD. Valid values are +4 and +12 dB.
110 *
111 * By default the mixer gain is set to +12 dB and this is a good
112 * value for most cases. In noisy areas you may try to reduce
113 * the gain.
114 */
115 virtual void set_mixer_gain(float gain) = 0;
116
117 /*! \brief Set new frequency correction.
118 * \param ppm The new frequency correction in parts per million
119 *
120 * Version 1.1 FCDs (S/N 810 or later) need a correction of -12
121 * ppm. Earlier FCDs need roughly -120 ppm (default for
122 * gr-fcd).
123 *
124 * Ref: http://www.funcubedongle.com/?p=617
125 */
126 virtual void set_freq_corr(int ppm) = 0;
127
128 /*! \brief Set DC offset correction.
129 * \param _dci DC correction for I component (-1.0 to 1.0)
130 * \param _dcq DC correction for Q component (-1.0 to 1.0)
131 *
132 * Set DC offset correction in the device. Default is 0.0.
133 */
134 virtual void set_dc_corr(double _dci, double _dcq) = 0;
135
136 /*! \brief Set IQ phase and gain balance.
137 * \param _gain The gain correction (-1.0 to 1.0)
138 * \param _phase The phase correction (-1.0 to 1.0)
139 *
140 * Set IQ phase and gain balance in the device. The default values
141 * are 0.0 for phase and 1.0 for gain.
142 */
143 virtual void set_iq_corr(double _gain, double _phase) = 0;
144};
145
146} /* namespace fcd */
147} /* namespace gr */
148
149#endif /* INCLUDED_FCD_SOURCE_C_H */
Funcube Dongle source block.
Definition: source_c.h:45
static sptr make(const std::string device_name="")
Return a shared_ptr to a new instance of fcd_source_c.
virtual void set_mixer_gain(float gain)=0
Set mixer gain.
virtual void set_freq_khz(int freq)=0
Set frequency with kHz resolution.
virtual void set_iq_corr(double _gain, double _phase)=0
Set IQ phase and gain balance.
boost::shared_ptr< source_c > sptr
Definition: source_c.h:48
virtual void set_dc_corr(double _dci, double _dcq)=0
Set DC offset correction.
virtual void set_freq(float freq)=0
Set frequency with Hz resolution.
virtual void set_freq(int freq)=0
Set frequency with Hz resolution.
virtual void set_freq_corr(int ppm)=0
Set new frequency correction.
virtual void set_lna_gain(float gain)=0
Set LNA gain.
Hierarchical container class for gr::block's and gr::hier_block2's.
Definition: hier_block2.h:46
#define FCD_API
Definition: gr-fcd/include/gnuradio/fcd/api.h:30
Include this header to use the message passing features.
Definition: basic_block.h:45