diff options
Diffstat (limited to 'gr-uhd/doc/uhd.dox')
| -rw-r--r-- | gr-uhd/doc/uhd.dox | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/gr-uhd/doc/uhd.dox b/gr-uhd/doc/uhd.dox new file mode 100644 index 000000000..f08fe2f06 --- /dev/null +++ b/gr-uhd/doc/uhd.dox @@ -0,0 +1,35 @@ +/*! \page page_uhd UHD Interface + +\section Introduction +This is the GNU Radio UHD package. It is the interface to the UHD +library to connect to and send and receive data between the Ettus +Research, LLC product line. To use the UHD blocks, the Python +namespaces is in gnuradio.uhd, which would be normally imported +as: + +\code + from gnuradio import uhd +\endcode + +The relevant blocks are listed in the \ref uhd_blk group. + +A quick listing of the details can be found in Python after importing +by using: + +\code + help(uhd) +\endcode + + +\section External Documentation + +Ettus Research keeps the comprehensive documentation to the underlying UHD driver, which can be found: + + http://files.ettus.com/uhd_docs/manual/html/ + +The UHD Doxygen page is located: + + http://files.ettus.com/uhd_docs/doxygen/html/index.html + + +*/ |