diff options
| author | Tom Rondeau <tom@trondeau.com> | 2014-07-14 15:10:19 -0400 |
|---|---|---|
| committer | Tom Rondeau <tom@trondeau.com> | 2014-07-14 15:10:19 -0400 |
| commit | 1fb307d852a5e5ca156a2f85a8a9e87f4c0820af (patch) | |
| tree | bdf32806637bf6373a13d32d9cbd1324c121f702 /gr-uhd/include/gnuradio/uhd/usrp_source.h | |
| parent | d83f0377a7c1e3e3af33d24a6cad5eeb4b7e8ba0 (diff) | |
| parent | 12523cdb3218be85565c3c3bcb49d113e6bac518 (diff) | |
Merge remote-tracking branch 'mbant/uhd/msg_format' into qt_the_things
Diffstat (limited to 'gr-uhd/include/gnuradio/uhd/usrp_source.h')
| -rw-r--r-- | gr-uhd/include/gnuradio/uhd/usrp_source.h | 42 |
1 files changed, 12 insertions, 30 deletions
diff --git a/gr-uhd/include/gnuradio/uhd/usrp_source.h b/gr-uhd/include/gnuradio/uhd/usrp_source.h index 2e165cf771..75e8f8b844 100644 --- a/gr-uhd/include/gnuradio/uhd/usrp_source.h +++ b/gr-uhd/include/gnuradio/uhd/usrp_source.h @@ -27,6 +27,7 @@ #include <gnuradio/sync_block.h> #include <uhd/usrp/multi_usrp.hpp> +// TODO In 3.8, UHD 3.4 will be required and we can remove all these ifdefs #ifndef INCLUDED_UHD_STREAM_HPP namespace uhd { struct GR_UHD_API stream_args_t @@ -60,41 +61,18 @@ namespace gr { typedef boost::shared_ptr<usrp_source> sptr; /*! - * \brief Make a new USRP source block. + * \brief DEPRECATED Make a new USRP source block using the deprecated io_type_t. * \ingroup uhd_blk * - * The USRP source block receives samples and writes to a stream. - * The source block also provides API calls for receiver settings. - * - * RX Stream tagging: - * - * The following tag keys will be produced by the work function: - * - pmt::string_to_symbol("rx_time") - * - pmt::string_to_symbol("rx_rate") - * - pmt::string_to_symbol("rx_freq") - * - * The timstamp tag value is a pmt tuple of the following: - * (uint64 seconds, and double fractional seconds). - * A timestamp tag is produced at start() and after overflows. - * - * The sample rate and center frequency tags are doubles, - * representing the sample rate in Sps and frequency in Hz. - * These tags are produced upon the user changing parameters. - * - * See the UHD manual for more detailed documentation: - * http://code.ettus.com/redmine/ettus/projects/uhd/wiki - * - * \param device_addr the address to identify the hardware - * \param io_type the desired output data type - * \param num_channels number of stream from the device - * \return a new USRP source block object + * This function will be removed in the future. Please use the other make function, + * gr::uhd::make(const ::uhd::device_addr_t, const ::uhd::stream_args_t, const std::string). */ static sptr make(const ::uhd::device_addr_t &device_addr, const ::uhd::io_type_t &io_type, size_t num_channels); /*! - * \brief Make a new USRP source block. + * \brief Make a new USRP source block (usually a radio receiver). * * The USRP source block receives samples and writes to a stream. * The source block also provides API calls for receiver settings. @@ -104,12 +82,16 @@ namespace gr { * The following tag keys will be produced by the work function: * - pmt::string_to_symbol("rx_time") * - * The timstamp tag value is a pmt tuple of the following: + * The timestamp tag value is a pmt tuple of the following: * (uint64 seconds, and double fractional seconds). * A timestamp tag is produced at start() and after overflows. * - * See the UHD manual for more detailed documentation: - * http://code.ettus.com/redmine/ettus/projects/uhd/wiki + * \section uhd_rx_command_iface Command interface + * + * This block has a message port, which consumes UHD PMT commands. + * For a description of the command syntax, see Section \ref uhd_command_syntax. + * + * For a more general description of the gr-uhd components, see \ref page_uhd. * * \param device_addr the address to identify the hardware * \param stream_args the IO format and channel specification |