<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>GNU Radio's FCDPROPLUS Package: fcdproplus.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(initResizable); /* @license-end */</script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">GNU Radio's FCDPROPLUS Package </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(function(){initNavTree('fcdproplus_8h_source.html','');}); /* @license-end */ </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <div class="title">fcdproplus.h</div> </div> </div><!--header--> <div class="contents"> <a href="fcdproplus_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* -*- c++ -*- */</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/* </span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2013 Volker Schroer, DL1KSV</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * </span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This is free software; you can redistribute it and/or modify</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * it under the terms of the GNU General Public License as published by</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * any later version.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * </span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * This software is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * GNU General Public License for more details.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * </span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * You should have received a copy of the GNU General Public License</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * along with this software; see the file COPYING. If not, write to</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * Boston, MA 02110-1301, USA.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> */</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#ifndef INCLUDED_FCDPROPLUS_FCDPROPLUS_H</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define INCLUDED_FCDPROPLUS_FCDPROPLUS_H</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <<a class="code" href="api_8h.html">fcdproplus/api.h</a>></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <gnuradio/hier_block2.h></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="namespacegr.html"> 30</a></span> <span class="keyword">namespace </span><a class="code" href="namespacegr.html">gr</a> {</div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="namespacegr_1_1fcdproplus.html"> 31</a></span>  <span class="keyword">namespace </span><a class="code" href="classgr_1_1fcdproplus_1_1fcdproplus.html">fcdproplus</a> {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"></span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> /*!</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * \brief Funcube Pro+ Dongle source block.</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> *</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * This class provides a soure block for the Funcube Pro+ Dongle by wrapping the</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * alsa audio interface and the USB control interface of the Funcube Dongle</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * into one convenient source block.</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * The hadware audio device is autodetected by the card name. If more than one Pro+ are</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * connected it takes the first card.</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * The block was tested with firmware version 20.3</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> *</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * \ingroup fcdproplus</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> *</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> */</span></div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classgr_1_1fcdproplus_1_1fcdproplus.html"> 46</a></span>  <span class="keyword">class </span><a class="code" href="api_8h.html#a608f363ae3e1fb703891a502559410f7">FCDPROPLUS_API</a> <a class="code" href="classgr_1_1fcdproplus_1_1fcdproplus.html">fcdproplus</a> : <span class="keyword">virtual</span> <span class="keyword">public</span> hier_block2</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  {</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classgr_1_1fcdproplus_1_1fcdproplus.html#aecfbd15d08a9500223ac75bee3a493c4"> 49</a></span>  <span class="keyword">typedef</span> boost::shared_ptr<fcdproplus> <a class="code" href="classgr_1_1fcdproplus_1_1fcdproplus.html#aecfbd15d08a9500223ac75bee3a493c4">sptr</a>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"></span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> /*!</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * \brief Return a shared_ptr to a new instance of fcdproplus::fcdproplus.</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> *</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * To avoid accidental use of raw pointers, fcdproplus::fcdproplus's</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * constructor is in a private implementation</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * class. fcdproplus::fcdproplus::make is the public interface for</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * creating new instances.</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> */</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">static</span> <a class="code" href="classgr_1_1fcdproplus_1_1fcdproplus.html#aecfbd15d08a9500223ac75bee3a493c4">sptr</a> make(<span class="keyword">const</span> std::string device_name = <span class="stringliteral">""</span>,<span class="keywordtype">int</span> unit =1 );</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"></span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> /*! \brief Set frequency with resolution defined by unit.</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * \param freq The frequency in unit Hz</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> *</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * Sets the frequency of the Funcube Dongle with Hz or Khz resolution</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * depending on the unit paramater ( 1: Hz , 1000 Khz )</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * applying the frequency correction set by set_freq_corr().</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> *</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> */</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> set_freq(<span class="keywordtype">float</span> freq) = 0;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"></span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> /*! \brief Switches the LNA on/off.</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * \param gain lna on/off.</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> *</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> */</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> set_lna(<span class="keywordtype">int</span> gain) = 0;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"></span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> /*! \brief Switches mixer gain onf/off.</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * \param gain true means on.</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> *</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> */</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> set_mixer_gain(<span class="keywordtype">int</span> gain) = 0;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"></span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> /*! \brief Set new frequency correction.</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> * \param ppm The new frequency correction in parts per million</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> *</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * Funcube recommends 0 for the Pro+.</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> *</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * Ref: http://www.funcubedongle.com/MyImages/FCD2ManualV4.pdf</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> */</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> set_freq_corr(<span class="keywordtype">int</span> ppm) = 0;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"></span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> /*! \brief Set If gain.</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> * \param gain The If gain value between 0 and 59 db</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> *</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> */</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> set_if_gain(<span class="keywordtype">int</span> gain)=0;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  };</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  } <span class="comment">// namespace fcdproplus</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> } <span class="comment">// namespace gr</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_FCDPROPLUS_FCDPROPLUS_H */</span><span class="preprocessor"></span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="ttc" id="api_8h_html"><div class="ttname"><a href="api_8h.html">api.h</a></div></div> <div class="ttc" id="classgr_1_1fcdproplus_1_1fcdproplus_html_aecfbd15d08a9500223ac75bee3a493c4"><div class="ttname"><a href="classgr_1_1fcdproplus_1_1fcdproplus.html#aecfbd15d08a9500223ac75bee3a493c4">gr::fcdproplus::fcdproplus::sptr</a></div><div class="ttdeci">boost::shared_ptr< fcdproplus > sptr</div><div class="ttdef"><b>Definition:</b> fcdproplus.h:49</div></div> <div class="ttc" id="api_8h_html_a608f363ae3e1fb703891a502559410f7"><div class="ttname"><a href="api_8h.html#a608f363ae3e1fb703891a502559410f7">FCDPROPLUS_API</a></div><div class="ttdeci">#define FCDPROPLUS_API</div><div class="ttdef"><b>Definition:</b> api.h:30</div></div> <div class="ttc" id="classgr_1_1fcdproplus_1_1fcdproplus_html"><div class="ttname"><a href="classgr_1_1fcdproplus_1_1fcdproplus.html">gr::fcdproplus::fcdproplus</a></div><div class="ttdoc">Funcube Pro+ Dongle source block.</div><div class="ttdef"><b>Definition:</b> fcdproplus.h:46</div></div> <div class="ttc" id="namespacegr_html"><div class="ttname"><a href="namespacegr.html">gr</a></div><div class="ttdef"><b>Definition:</b> fcdproplus.h:30</div></div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_4d1ec785944306c2f5bab8e3f01d39b2.html">fcdproplus</a></li><li class="navelem"><a class="el" href="fcdproplus_8h.html">fcdproplus.h</a></li> <li class="footer">Generated on Sat Jan 19 2019 17:47:07 for GNU Radio's FCDPROPLUS Package by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li> </ul> </div> </body> </html>