#include <gnuradio/uhd/usrp_sink.h>
Public Types | |
typedef boost::shared_ptr < usrp_sink > | sptr |
![]() | |
enum | { WORK_CALLED_PRODUCE = -2, WORK_DONE = -1 } |
Magic return values from general_work. More... | |
enum | tag_propagation_policy_t { TPP_DONT = 0, TPP_ALL_TO_ALL = 1, TPP_ONE_TO_ONE = 2 } |
Public Member Functions | |
virtual void | set_start_time (const ::uhd::time_spec_t &time)=0 |
virtual ::uhd::dict < std::string, std::string > | get_usrp_info (size_t chan=0)=0 |
virtual void | set_dc_offset (const std::complex< double > &offset, size_t chan=0)=0 |
virtual void | set_iq_balance (const std::complex< double > &correction, size_t chan=0)=0 |
![]() | |
virtual void | set_subdev_spec (const std::string &spec, size_t mboard=0)=0 |
virtual std::string | get_subdev_spec (size_t mboard=0)=0 |
virtual size_t | get_num_mboards ()=0 |
virtual void | set_samp_rate (double rate)=0 |
virtual double | get_samp_rate (void)=0 |
virtual ::uhd::meta_range_t | get_samp_rates (void)=0 |
virtual ::uhd::tune_result_t | set_center_freq (const ::uhd::tune_request_t tune_request, size_t chan=0)=0 |
::uhd::tune_result_t | set_center_freq (double freq, size_t chan=0) |
virtual double | get_center_freq (size_t chan=0)=0 |
virtual ::uhd::freq_range_t | get_freq_range (size_t chan=0)=0 |
virtual void | set_gain (double gain, size_t chan=0)=0 |
virtual void | set_gain (double gain, const std::string &name, size_t chan=0)=0 |
virtual void | set_normalized_gain (double norm_gain, size_t chan=0)=0 |
virtual double | get_gain (size_t chan=0)=0 |
virtual double | get_gain (const std::string &name, size_t chan=0)=0 |
virtual double | get_normalized_gain (size_t chan=0)=0 |
virtual std::vector< std::string > | get_gain_names (size_t chan=0)=0 |
virtual ::uhd::gain_range_t | get_gain_range (size_t chan=0)=0 |
virtual ::uhd::gain_range_t | get_gain_range (const std::string &name, size_t chan=0)=0 |
virtual void | set_antenna (const std::string &ant, size_t chan=0)=0 |
virtual std::string | get_antenna (size_t chan=0)=0 |
virtual std::vector< std::string > | get_antennas (size_t chan=0)=0 |
virtual void | set_bandwidth (double bandwidth, size_t chan=0)=0 |
virtual double | get_bandwidth (size_t chan=0)=0 |
virtual ::uhd::freq_range_t | get_bandwidth_range (size_t chan=0)=0 |
virtual ::uhd::sensor_value_t | get_sensor (const std::string &name, size_t chan=0)=0 |
virtual std::vector< std::string > | get_sensor_names (size_t chan=0)=0 |
::uhd::sensor_value_t | get_dboard_sensor (const std::string &name, size_t chan=0) |
DEPRECATED use get_sensor. More... | |
std::vector< std::string > | get_dboard_sensor_names (size_t chan=0) |
DEPRECATED use get_sensor_names. More... | |
virtual ::uhd::sensor_value_t | get_mboard_sensor (const std::string &name, size_t mboard=0)=0 |
virtual std::vector< std::string > | get_mboard_sensor_names (size_t mboard=0)=0 |
virtual std::string | get_time_source (const size_t mboard)=0 |
virtual std::vector< std::string > | get_time_sources (const size_t mboard)=0 |
virtual void | set_clock_source (const std::string &source, const size_t mboard=0)=0 |
virtual std::string | get_clock_source (const size_t mboard)=0 |
virtual std::vector< std::string > | get_clock_sources (const size_t mboard)=0 |
virtual double | get_clock_rate (size_t mboard=0)=0 |
virtual void | set_clock_rate (double rate, size_t mboard=0)=0 |
virtual ::uhd::time_spec_t | get_time_now (size_t mboard=0)=0 |
virtual ::uhd::time_spec_t | get_time_last_pps (size_t mboard=0)=0 |
virtual void | set_time_now (const ::uhd::time_spec_t &time_spec, size_t mboard=0)=0 |
virtual void | set_time_next_pps (const ::uhd::time_spec_t &time_spec)=0 |
virtual void | set_time_unknown_pps (const ::uhd::time_spec_t &time_spec)=0 |
virtual void | set_command_time (const ::uhd::time_spec_t &time_spec, size_t mboard=0)=0 |
virtual void | clear_command_time (size_t mboard=0)=0 |
virtual ::uhd::usrp::dboard_iface::sptr | get_dboard_iface (size_t chan=0)=0 |
virtual ::uhd::usrp::multi_usrp::sptr | get_device (void)=0 |
virtual void | set_user_register (const uint8_t addr, const uint32_t data, size_t mboard=0)=0 |
virtual void | set_clock_config (const ::uhd::clock_config_t &clock_config, size_t mboard=0)=0 |
virtual void | set_time_source (const std::string &source, const size_t mboard=0)=0 |
virtual void | set_stream_args (const ::uhd::stream_args_t &stream_args)=0 |
virtual std::vector< std::string > | get_gpio_banks (const size_t mboard)=0 |
virtual void | set_gpio_attr (const std::string &bank, const std::string &attr, const boost::uint32_t value, const boost::uint32_t mask=0xffffffff, const size_t mboard=0)=0 |
virtual boost::uint32_t | get_gpio_attr (const std::string &bank, const std::string &attr, const size_t mboard=0)=0 |
![]() | |
virtual int | work (int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)=0 |
just like gr::block::general_work, only this arranges to call consume_each for you More... | |
void | forecast (int noutput_items, gr_vector_int &ninput_items_required) |
Estimate input requirements given output request. More... | |
int | general_work (int noutput_items, gr_vector_int &ninput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items) |
compute output items from input items More... | |
int | fixed_rate_ninput_to_noutput (int ninput) |
Given ninput samples, return number of output samples that will be produced. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this. More... | |
int | fixed_rate_noutput_to_ninput (int noutput) |
Given noutput samples, return number of input samples required to produce noutput. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this. More... | |
![]() | |
virtual | ~block () |
unsigned | history () const |
void | set_history (unsigned history) |
void | declare_sample_delay (int which, unsigned delay) |
void | declare_sample_delay (unsigned delay) |
unsigned | sample_delay (int which) const |
bool | fixed_rate () const |
Return true if this block has a fixed input to output rate. More... | |
virtual bool | start () |
Called to enable drivers, etc for i/o devices. More... | |
virtual bool | stop () |
Called to disable drivers, etc for i/o devices. More... | |
void | set_output_multiple (int multiple) |
Constrain the noutput_items argument passed to forecast and general_work. More... | |
int | output_multiple () const |
bool | output_multiple_set () const |
void | set_alignment (int multiple) |
Constrains buffers to work on a set item alignment (for SIMD) More... | |
int | alignment () const |
void | set_unaligned (int na) |
int | unaligned () const |
void | set_is_unaligned (bool u) |
bool | is_unaligned () const |
void | consume (int which_input, int how_many_items) |
Tell the scheduler how_many_items of input stream which_input were consumed. This function should be called at the end of work() or general_work(), after all processing is finished. More... | |
void | consume_each (int how_many_items) |
Tell the scheduler how_many_items were consumed on each input stream. More... | |
void | produce (int which_output, int how_many_items) |
Tell the scheduler how_many_items were produced on output stream which_output . More... | |
void | set_relative_rate (double relative_rate) |
Set the approximate output rate / input rate. More... | |
double | relative_rate () const |
return the approximate output rate / input rate More... | |
uint64_t | nitems_read (unsigned int which_input) |
Return the number of items read on input stream which_input. More... | |
uint64_t | nitems_written (unsigned int which_output) |
Return the number of items written on output stream which_output. More... | |
tag_propagation_policy_t | tag_propagation_policy () |
Asks for the policy used by the scheduler to moved tags downstream. More... | |
void | set_tag_propagation_policy (tag_propagation_policy_t p) |
Set the policy by the scheduler to determine how tags are moved downstream. More... | |
int | min_noutput_items () const |
Return the minimum number of output items this block can produce during a call to work. More... | |
void | set_min_noutput_items (int m) |
Set the minimum number of output items this block can produce during a call to work. More... | |
int | max_noutput_items () |
Return the maximum number of output items this block will handle during a call to work. More... | |
void | set_max_noutput_items (int m) |
Set the maximum number of output items this block will handle during a call to work. More... | |
void | unset_max_noutput_items () |
Clear the switch for using the max_noutput_items value of this block. More... | |
bool | is_set_max_noutput_items () |
Ask the block if the flag is or is not set to use the internal value of max_noutput_items during a call to work. More... | |
void | expand_minmax_buffer (int port) |
long | max_output_buffer (size_t i) |
Returns max buffer size on output port i . More... | |
void | set_max_output_buffer (long max_output_buffer) |
Request limit on max buffer size on all output ports. More... | |
void | set_max_output_buffer (int port, long max_output_buffer) |
Request limit on max buffer size on output port port . More... | |
long | min_output_buffer (size_t i) |
Returns min buffer size on output port i . More... | |
void | set_min_output_buffer (long min_output_buffer) |
Request limit on the mininum buffer size on all output ports. More... | |
void | set_min_output_buffer (int port, long min_output_buffer) |
Request limit on min buffer size on output port port . More... | |
float | pc_noutput_items () |
Gets instantaneous noutput_items performance counter. More... | |
float | pc_noutput_items_avg () |
Gets average noutput_items performance counter. More... | |
float | pc_noutput_items_var () |
Gets variance of noutput_items performance counter. More... | |
float | pc_nproduced () |
Gets instantaneous num items produced performance counter. More... | |
float | pc_nproduced_avg () |
Gets average num items produced performance counter. More... | |
float | pc_nproduced_var () |
Gets variance of num items produced performance counter. More... | |
float | pc_input_buffers_full (int which) |
Gets instantaneous fullness of which input buffer. More... | |
float | pc_input_buffers_full_avg (int which) |
Gets average fullness of which input buffer. More... | |
float | pc_input_buffers_full_var (int which) |
Gets variance of fullness of which input buffer. More... | |
std::vector< float > | pc_input_buffers_full () |
Gets instantaneous fullness of all input buffers. More... | |
std::vector< float > | pc_input_buffers_full_avg () |
Gets average fullness of all input buffers. More... | |
std::vector< float > | pc_input_buffers_full_var () |
Gets variance of fullness of all input buffers. More... | |
float | pc_output_buffers_full (int which) |
Gets instantaneous fullness of which input buffer. More... | |
float | pc_output_buffers_full_avg (int which) |
Gets average fullness of which input buffer. More... | |
float | pc_output_buffers_full_var (int which) |
Gets variance of fullness of which input buffer. More... | |
std::vector< float > | pc_output_buffers_full () |
Gets instantaneous fullness of all output buffers. More... | |
std::vector< float > | pc_output_buffers_full_avg () |
Gets average fullness of all output buffers. More... | |
std::vector< float > | pc_output_buffers_full_var () |
Gets variance of fullness of all output buffers. More... | |
float | pc_work_time () |
Gets instantaneous clock cycles spent in work. More... | |
float | pc_work_time_avg () |
Gets average clock cycles spent in work. More... | |
float | pc_work_time_var () |
Gets average clock cycles spent in work. More... | |
float | pc_work_time_total () |
Gets total clock cycles spent in work. More... | |
float | pc_throughput_avg () |
Gets average throughput. More... | |
void | reset_perf_counters () |
Resets the performance counters. More... | |
void | setup_pc_rpc () |
Sets up export of perf. counters to ControlPort. Only called by the scheduler. More... | |
bool | is_pc_rpc_set () |
Checks if this block is already exporting perf. counters to ControlPort. More... | |
void | no_pc_rpc () |
If the block calls this in its constructor, it's perf. counters will not be exported. More... | |
void | set_processor_affinity (const std::vector< int > &mask) |
Set the thread's affinity to processor core n . More... | |
void | unset_processor_affinity () |
Remove processor affinity to a specific core. More... | |
std::vector< int > | processor_affinity () |
Get the current processor affinity. More... | |
int | active_thread_priority () |
Get the current thread priority in use. More... | |
int | thread_priority () |
Get the current thread priority stored. More... | |
int | set_thread_priority (int priority) |
Set the current thread priority. More... | |
bool | update_rate () const |
void | system_handler (pmt::pmt_t msg) |
the system message handler More... | |
bool | finished () |
returns true when execution has completed due to a message connection More... | |
block_detail_sptr | detail () const |
void | set_detail (block_detail_sptr detail) |
void | notify_msg_neighbors () |
Tell msg neighbors we are finished. More... | |
void | clear_finished () |
Make sure we dont think we are finished. More... | |
![]() | |
pmt::pmt_t | message_subscribers (pmt::pmt_t port) |
virtual | ~basic_block () |
long | unique_id () const |
long | symbolic_id () const |
std::string | name () const |
std::string | symbol_name () const |
gr::io_signature::sptr | input_signature () const |
gr::io_signature::sptr | output_signature () const |
basic_block_sptr | to_basic_block () |
bool | alias_set () |
std::string | alias () |
pmt::pmt_t | alias_pmt () |
void | set_block_alias (std::string name) |
void | message_port_register_in (pmt::pmt_t port_id) |
void | message_port_register_out (pmt::pmt_t port_id) |
void | message_port_pub (pmt::pmt_t port_id, pmt::pmt_t msg) |
void | message_port_sub (pmt::pmt_t port_id, pmt::pmt_t target) |
void | message_port_unsub (pmt::pmt_t port_id, pmt::pmt_t target) |
virtual bool | message_port_is_hier (pmt::pmt_t port_id) |
virtual bool | message_port_is_hier_in (pmt::pmt_t port_id) |
virtual bool | message_port_is_hier_out (pmt::pmt_t port_id) |
pmt::pmt_t | message_ports_in () |
Get input message port names. More... | |
pmt::pmt_t | message_ports_out () |
Get output message port names. More... | |
void | _post (pmt::pmt_t which_port, pmt::pmt_t msg) |
bool | empty_p (pmt::pmt_t which_port) |
is the queue empty? More... | |
bool | empty_p () |
bool | empty_handled_p (pmt::pmt_t which_port) |
are all msg ports with handlers empty? More... | |
bool | empty_handled_p () |
size_t | nmsgs (pmt::pmt_t which_port) |
How many messages in the queue? More... | |
void | insert_tail (pmt::pmt_t which_port, pmt::pmt_t msg) |
pmt::pmt_t | delete_head_nowait (pmt::pmt_t which_port) |
pmt::pmt_t | delete_head_blocking (pmt::pmt_t which_port, unsigned int millisec=0) |
msg_queue_t::iterator | get_iterator (pmt::pmt_t which_port) |
void | erase_msg (pmt::pmt_t which_port, msg_queue_t::iterator it) |
virtual bool | has_msg_port (pmt::pmt_t which_port) |
const msg_queue_map_t & | get_msg_map (void) const |
virtual void | setup_rpc () |
Set up the RPC registered variables. More... | |
bool | is_rpc_set () |
Ask if this block has been registered to the RPC. More... | |
void | rpc_set () |
When the block is registered with the RPC, set this. More... | |
virtual bool | check_topology (int ninputs, int noutputs) |
Confirm that ninputs and noutputs is an acceptable combination. More... | |
template<typename T > | |
void | set_msg_handler (pmt::pmt_t which_port, T msg_handler) |
Set the callback that is fired when messages are available. More... | |
![]() | |
msg_accepter () | |
~msg_accepter () | |
void | post (pmt::pmt_t which_port, pmt::pmt_t msg) |
send msg to msg_accepter on port which_port More... | |
Static Public Member Functions | |
static sptr | make (const ::uhd::device_addr_t &device_addr, const ::uhd::io_type_t &io_type, size_t num_channels) |
DEPRECATED Make a new USRP sink block using the deprecated io_type_t.This function will be removed in the future. Please use the other make function, gr::uhd::usrp_sink::make(const ::uhd::device_addr_t, const ::uhd::stream_args_t, const std::string). More... | |
static sptr | make (const ::uhd::device_addr_t &device_addr, const ::uhd::stream_args_t &stream_args, const std::string &tsb_tag_name="") |
Additional Inherited Members | |
![]() | |
enum | vcolor { WHITE, GREY, BLACK } |
![]() | |
usrp_block () | |
usrp_block (const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature) | |
![]() | |
sync_block (void) | |
sync_block (const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature) | |
![]() | |
block (void) | |
block (const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature) | |
void | set_fixed_rate (bool fixed_rate) |
void | add_item_tag (unsigned int which_output, uint64_t abs_offset, const pmt::pmt_t &key, const pmt::pmt_t &value, const pmt::pmt_t &srcid=pmt::PMT_F) |
Adds a new tag onto the given output buffer. More... | |
void | add_item_tag (unsigned int which_output, const tag_t &tag) |
Adds a new tag onto the given output buffer. More... | |
void | remove_item_tag (unsigned int which_input, uint64_t abs_offset, const pmt::pmt_t &key, const pmt::pmt_t &value, const pmt::pmt_t &srcid=pmt::PMT_F) |
DEPRECATED. Will be removed in 3.8. More... | |
void | remove_item_tag (unsigned int which_input, const tag_t &tag) |
DEPRECATED. Will be removed in 3.8. More... | |
void | get_tags_in_range (std::vector< tag_t > &v, unsigned int which_input, uint64_t abs_start, uint64_t abs_end) |
Given a [start,end), returns a vector of all tags in the range. More... | |
void | get_tags_in_range (std::vector< tag_t > &v, unsigned int which_input, uint64_t abs_start, uint64_t abs_end, const pmt::pmt_t &key) |
Given a [start,end), returns a vector of all tags in the range with a given key. More... | |
void | get_tags_in_window (std::vector< tag_t > &v, unsigned int which_input, uint64_t rel_start, uint64_t rel_end) |
Gets all tags within the relative window of the current call to work. More... | |
void | get_tags_in_window (std::vector< tag_t > &v, unsigned int which_input, uint64_t rel_start, uint64_t rel_end, const pmt::pmt_t &key) |
Operates like gr::block::get_tags_in_window with the ability to only return tags with the specified key . More... | |
void | enable_update_rate (bool en) |
![]() | |
basic_block (void) | |
basic_block (const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature) | |
Protected constructor prevents instantiation by non-derived classes. More... | |
void | set_input_signature (gr::io_signature::sptr iosig) |
may only be called during constructor More... | |
void | set_output_signature (gr::io_signature::sptr iosig) |
may only be called during constructor More... | |
void | set_color (vcolor color) |
Allow the flowgraph to set for sorting and partitioning. More... | |
vcolor | color () const |
virtual bool | has_msg_handler (pmt::pmt_t which_port) |
Tests if there is a handler attached to port which_port . More... | |
virtual void | dispatch_msg (pmt::pmt_t which_port, pmt::pmt_t msg) |
![]() | |
std::vector< long > | d_max_output_buffer |
std::vector< long > | d_min_output_buffer |
gr::thread::mutex | d_setlock |
gr::logger_ptr | d_logger |
gr::logger_ptr | d_debug_logger |
![]() | |
std::string | d_name |
gr::io_signature::sptr | d_input_signature |
gr::io_signature::sptr | d_output_signature |
long | d_unique_id |
long | d_symbolic_id |
std::string | d_symbol_name |
std::string | d_symbol_alias |
vcolor | d_color |
bool | d_rpc_set |
msg_queue_map_t | msg_queue |
std::vector< boost::any > | d_rpc_vars |
pmt::pmt_t | d_message_subscribers |
USRP Sink – Radio Transmitter
The USRP sink block reads a stream and transmits the samples. The sink block also provides API calls for transmitter settings. See also gr::uhd::usrp_block for more public API calls.
The following tag keys will be consumed by the work function:
Any other tag will be ignored.
There are multiple ways to do bursty transmission without triggering underruns:
The sob and eob (start and end of burst) tag values are pmt booleans. When present, burst tags should be set to true (pmt::PMT_T).
If tsb_tag_name
is not an empty string, all "tx_sob" and "tx_eob" tags will be ignored, and the input is assumed to a tagged stream.
If sob/eob tags or length tags are used, this block understands that the data is bursty, and will configure the USRP to make sure there's no underruns after transmitting the final sample of a burst.
The timestamp tag value is a PMT tuple of the following: (uint64 seconds, double fractional seconds).
The tx_freq tag has to be a double or a pair of form (channel, frequency), with frequency being a double and channel being an integer. This tag will trigger a tune command to the USRP to the given frequency, if possible. Note that oscillators need some time to stabilize after this! Don't expect clean data to be sent immediately after this command. If channel is omitted, and only a double is given, it will set this frequency to all channels.
The command tag can carry a PMT command. See the following section.
There are two ways of passing commands to this block:
In both cases, the payload of the command is a PMT command, as described in Section Command Syntax.
For a more general description of the gr-uhd components, see UHD Interface.
typedef boost::shared_ptr<usrp_sink> gr::uhd::usrp_sink::sptr |
|
pure virtual |
Returns identifying information about this USRP's configuration. Returns motherboard ID, name, and serial. Returns daughterboard TX ID, subdev name and spec, serial, and antenna.
chan | channel index 0 to N-1 |
|
static |
device_addr | the address to identify the hardware |
stream_args | the IO format and channel specification |
tsb_tag_name | the name of the tag identifying tagged stream length |
|
pure virtual |
Set a constant DC offset value. The value is complex to control both I and Q.
offset | the dc offset (1.0 is full-scale) |
chan | the channel index 0 to N-1 |
|
pure virtual |
Set the RX frontend IQ imbalance correction. Use this to adjust the magnitude and phase of I and Q.
correction | the complex correction (1.0 is full-scale) |
chan | the channel index 0 to N-1 |
|
pure virtual |
Set the start time for outgoing samples. To control when samples are transmitted, set this value before starting the flow graph. The value is cleared after each run. When not specified, the start time will be:
time | the absolute time for transmission to begin |