1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
|
/**
@mainpage
<h1>Introduction</h1>
This library supports the <a class="el" href="https://www.nuand.com">Nuand bladeRF</a>
USB 3.0 Software Defined Radio (SDR). It is intended to support developers looking to:
<ul>
<li>
Build both generic SDR software and domain-specific applications atop of the bladeRF.
</li>
<li>
Evaluate and experiment with the hardware, using routines that provide
low-level access to device settings and registers.
</li>
</ul>
The libbladeRF source code is hosted on our <a class="el" href="https://github.com/Nuand/bladeRF">GitHub project page</a>,
and the latest release of this documentation may be found <a class="el" href="https://www.nuand.com/libbladeRF-doc">here</a>.
A few avenues for support are available, including the <a class="el" href="https://www.nuand.com/forums">Nuand forums</a>,
the \#bladeRF IRC channel on <a class="el" href="https://freenode.net">Freenode</a>, or
<a class="el" href="#" onclick="location.href='mai'+'lto:'+'bla'+'de'+'RF@'+'Nu'+'and'+'.c'+'om'; return false;">email</a>.
The forums are generally preferred over email because they allow a publicly
accessible knowledge base of common questions and answers to be developed.
Bugs, both in libbladeRF and this documentation, may be reported on the
<a class="el" href="https://www.github.com/Nuand/bladeRF/issues">GitHub issue tracker</a>
<hr>
<h1>The libbladeRF API</h1>
libbladeRF provides the ability to:
<ul>
<li>
Query and connect to bladeRF devices connected to a system
</li>
<li>
Configure device properties, such as:
<ul>
<li>Frequency tuning</li>
<li>Hardware Low Pass Filter (LPF) bandwidth</li>
<li>Sample rate</li>
<li>Gain stages</li>
<li>Expansion board settings</li>
<li>SMB clock port mode (for MIMO applications)</li>
<li>Synchronization trigger signals</li>
</ul>
</li>
<li>
Read device attributes, including:
<ul>
<li>Serial number and calibration values</li>
<li>Firmware and FPGA version numbers</li>
</ul>
</li>
<li>
Steam sample data through either a simple synchronous interface, or a
callback-based asynchronous interface.
</li>
<li>
Access and manipulate low-level parameters and device registers.
</li>
<li>
Load FPGA images
</li>
<li>
Update FX3 firmware
</li>
<li>
Recover from FX3 bootloader mode
</li>
</ul>
The <a class="el" href="modules.html">API Sections</a> page presents a complete list of of the libbladeRF API sections,
including the aforementioned items.
The following pages provide examples and more detailed usage information:
<ul>
<li>
<a class="el" href="boilerplate.html">Device configuration boilerplate</a>
</li>
<li>
<a class="el" href="tuning.html">Frequency tuning</a>
</li>
<li>
RX and TX via the Synchronous Interface
</li>
<ul>
<li>
<a class="el" href="sync_no_meta.html">Basic usage without metadata</a>
</li>
<li>
<a class="el" href="sync_rx_meta.html">RX with metadata</a>
</li>
<li>
<a class="el" href="sync_tx_meta_bursts.html">TX with metadata</a>
</li>
</ul>
<li>
<a class="el" href="envvars.html">Environment variables</a>
</li>
<li>
<a class="el" href="configfile.html">Configuration file</a>
</li>
</ul>
*/
|