GNU Radio's OsmoSDR Package
bladerf_source_c Class Reference

#include <bladerf_source_c.h>

Inheritance diagram for bladerf_source_c:

Public Member Functions

bool start ()
 
bool stop ()
 
int work (int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
 
size_t get_num_channels (void)
 
osmosdr::meta_range_t get_sample_rates (void)
 
double set_sample_rate (double rate)
 
double get_sample_rate (void)
 
osmosdr::freq_range_t get_freq_range (size_t chan=0)
 
double set_center_freq (double freq, size_t chan=0)
 
double get_center_freq (size_t chan=0)
 
double set_freq_corr (double ppm, size_t chan=0)
 
double get_freq_corr (size_t chan=0)
 
std::vector< std::string > get_gain_names (size_t chan=0)
 
osmosdr::gain_range_t get_gain_range (size_t chan=0)
 
osmosdr::gain_range_t get_gain_range (const std::string &name, size_t chan=0)
 
bool set_gain_mode (bool automatic, size_t chan=0)
 
bool get_gain_mode (size_t chan=0)
 
double set_gain (double gain, size_t chan=0)
 
double set_gain (double gain, const std::string &name, size_t chan=0)
 
double get_gain (size_t chan=0)
 
double get_gain (const std::string &name, size_t chan=0)
 
double set_bb_gain (double gain, size_t chan=0)
 
std::vector< std::string > get_antennas (size_t chan=0)
 
std::string set_antenna (const std::string &antenna, size_t chan=0)
 
std::string get_antenna (size_t chan=0)
 
void set_dc_offset_mode (int mode, size_t chan=0)
 
void set_dc_offset (const std::complex< double > &offset, size_t chan=0)
 
void set_iq_balance_mode (int mode, size_t chan=0)
 
void set_iq_balance (const std::complex< double > &balance, size_t chan=0)
 
double set_bandwidth (double bandwidth, size_t chan=0)
 
double get_bandwidth (size_t chan=0)
 
osmosdr::freq_range_t get_bandwidth_range (size_t chan=0)
 
- Public Member Functions inherited from source_iface
virtual bool seek (long seek_point, int whence, size_t chan=0)
 seek file to seek_point relative to whence More...
 
virtual double set_if_gain (double gain, size_t chan=0)
 

Static Public Member Functions

static std::vector< std::string > get_devices ()
 

Friends

bladerf_source_c_sptr make_bladerf_source_c (const std::string &args)
 Return a shared_ptr to a new instance of bladerf_source_c. More...
 

Additional Inherited Members

- Protected Member Functions inherited from bladerf_common
void init (dict_t &dict, bladerf_module module)
 
bool start (bladerf_module module)
 
bool stop (bladerf_module module)
 
double set_sample_rate (bladerf_module module, double rate)
 
double get_sample_rate (bladerf_module module)
 
int set_dc_offset (bladerf_module module, const std::complex< double > &offset, size_t chan)
 
int set_iq_balance (bladerf_module module, const std::complex< double > &balance, size_t chan)
 
osmosdr::freq_range_t freq_range ()
 
osmosdr::meta_range_t sample_rates ()
 
osmosdr::freq_range_t filter_bandwidths ()
 
 bladerf_common ()
 
virtual ~bladerf_common ()
 
- Static Protected Member Functions inherited from bladerf_common
static std::vector< std::string > devices ()
 
- Protected Attributes inherited from bladerf_common
bladerf_sptr _dev
 
size_t _num_buffers
 
size_t _samples_per_buffer
 
size_t _num_transfers
 
unsigned int _stream_timeout_ms
 
int16_t * _conv_buf
 
int _conv_buf_size
 
osmosdr::gain_range_t _vga1_range
 
osmosdr::gain_range_t _vga2_range
 
std::string _pfx
 
bool _xb_200_attached
 
- Static Protected Attributes inherited from bladerf_common
static const int16_t DCOFF_SCALE = 2048
 
static const int16_t GAIN_SCALE = 4096
 
static const int16_t PHASE_SCALE = 4096
 

Member Function Documentation

std::string bladerf_source_c::get_antenna ( size_t  chan = 0)
virtual

Get the actual underlying radio hardware antenna setting.

Parameters
chanthe channel index 0 to N-1
Returns
the actual antenna's name

Implements source_iface.

std::vector< std::string > bladerf_source_c::get_antennas ( size_t  chan = 0)
virtual

Get the available antennas of the underlying radio hardware.

Parameters
chanthe channel index 0 to N-1
Returns
a vector of strings containing the names of available antennas

Implements source_iface.

double bladerf_source_c::get_bandwidth ( size_t  chan = 0)
virtual

Get the actual bandpass filter setting on the radio frontend.

Parameters
chanthe channel index 0 to N-1
Returns
the actual filter bandwidth in Hz

Reimplemented from source_iface.

osmosdr::freq_range_t bladerf_source_c::get_bandwidth_range ( size_t  chan = 0)
virtual

Get the possible bandpass filter settings on the radio frontend.

Parameters
chanthe channel index 0 to N-1
Returns
a range of bandwidths in Hz

Reimplemented from source_iface.

double bladerf_source_c::get_center_freq ( size_t  chan = 0)
virtual

Get the center frequency the underlying radio hardware is tuned to. This is the actual frequency and may differ from the frequency set.

Parameters
chanthe channel index 0 to N-1
Returns
the frequency in Hz

Implements source_iface.

static std::vector< std::string > bladerf_source_c::get_devices ( )
static
double bladerf_source_c::get_freq_corr ( size_t  chan = 0)
virtual

Get the frequency correction value.

Parameters
chanthe channel index 0 to N-1
Returns
correction value in parts per million

Implements source_iface.

osmosdr::freq_range_t bladerf_source_c::get_freq_range ( size_t  chan = 0)
virtual

Get the tunable frequency range for the underlying radio hardware.

Parameters
chanthe channel index 0 to N-1
Returns
the frequency range in Hz

Implements source_iface.

double bladerf_source_c::get_gain ( size_t  chan = 0)
virtual

Get the actual gain setting of the underlying radio hardware.

Parameters
chanthe channel index 0 to N-1
Returns
the actual gain in dB

Implements source_iface.

double bladerf_source_c::get_gain ( const std::string &  name,
size_t  chan = 0 
)
virtual

Get the actual gain setting of a named stage.

Parameters
namethe name of the gain stage
chanthe channel index 0 to N-1
Returns
the actual gain in dB

Implements source_iface.

bool bladerf_source_c::get_gain_mode ( size_t  chan = 0)
virtual

Get the gain mode selected for the underlying radio hardware.

Parameters
chanthe channel index 0 to N-1
Returns
the actual gain mode (true means automatic gain mode)

Reimplemented from source_iface.

std::vector<std::string> bladerf_source_c::get_gain_names ( size_t  chan = 0)
virtual

Get the gain stage names of the underlying radio hardware.

Parameters
chanthe channel index 0 to N-1
Returns
a vector of strings containing the names of gain stages

Implements source_iface.

osmosdr::gain_range_t bladerf_source_c::get_gain_range ( size_t  chan = 0)
virtual

Get the settable overall gain range for the underlying radio hardware.

Parameters
chanthe channel index 0 to N-1
Returns
the gain range in dB

Implements source_iface.

osmosdr::gain_range_t bladerf_source_c::get_gain_range ( const std::string &  name,
size_t  chan = 0 
)
virtual

Get the settable gain range for a specific gain stage.

Parameters
namethe name of the gain stage
chanthe channel index 0 to N-1
Returns
the gain range in dB

Implements source_iface.

size_t bladerf_source_c::get_num_channels ( void  )
virtual

Get the number of channels the underlying radio hardware offers.

Returns
the number of available channels

Implements source_iface.

double bladerf_source_c::get_sample_rate ( void  )
virtual

Get the sample rate for the underlying radio hardware. This is the actual sample rate and may differ from the rate set.

Returns
the actual rate in Sps

Implements source_iface.

osmosdr::meta_range_t bladerf_source_c::get_sample_rates ( void  )
virtual

Get the possible sample rates for the underlying radio hardware.

Returns
a range of rates in Sps

Implements source_iface.

std::string bladerf_source_c::set_antenna ( const std::string &  antenna,
size_t  chan = 0 
)
virtual

Select the active antenna of the underlying radio hardware.

Parameters
chanthe channel index 0 to N-1
Returns
the actual antenna's name

Implements source_iface.

double bladerf_source_c::set_bandwidth ( double  bandwidth,
size_t  chan = 0 
)
virtual

Set the bandpass filter on the radio frontend.

Parameters
bandwidththe filter bandwidth in Hz, set to 0 for automatic selection
chanthe channel index 0 to N-1
Returns
the actual filter bandwidth in Hz

Reimplemented from source_iface.

double bladerf_source_c::set_bb_gain ( double  gain,
size_t  chan = 0 
)
virtual

Set the BB gain for the underlying radio hardware. This function will automatically distribute the desired gain value over available BB gain stages in an appropriate way and return the actual value.

Parameters
gainthe gain in dB
chanthe channel index 0 to N-1
Returns
the actual gain in dB

Reimplemented from source_iface.

double bladerf_source_c::set_center_freq ( double  freq,
size_t  chan = 0 
)
virtual

Tune the underlying radio hardware to the desired center frequency. This also will select the appropriate RF bandpass.

Parameters
freqthe desired frequency in Hz
chanthe channel index 0 to N-1
Returns
the actual frequency in Hz

Implements source_iface.

void bladerf_source_c::set_dc_offset ( const std::complex< double > &  offset,
size_t  chan = 0 
)
virtual

Set a constant DC offset value. The value is complex to control both I and Q. Only set this when automatic correction is disabled.

Parameters
offsetthe dc offset (1.0 is full-scale)
chanthe channel index 0 to N-1

Reimplemented from source_iface.

void bladerf_source_c::set_dc_offset_mode ( int  mode,
size_t  chan = 0 
)
virtual

Set the RX frontend DC correction mode. The automatic correction subtracts out the long-run average.

When disabled, the averaging option operation is reset. Once in Manual mode, the average value will be held constant until the user re-enables the automatic correction or overrides the value by manually setting the offset.

Parameters
modedc offset correction mode: 0 = Off, 1 = Manual, 2 = Automatic
chanthe channel index 0 to N-1

Reimplemented from source_iface.

double bladerf_source_c::set_freq_corr ( double  ppm,
size_t  chan = 0 
)
virtual

Set the frequency correction value in parts per million.

Parameters
ppmthe desired correction value in parts per million
chanthe channel index 0 to N-1
Returns
correction value in parts per million

Implements source_iface.

double bladerf_source_c::set_gain ( double  gain,
size_t  chan = 0 
)
virtual

Set the gain for the underlying radio hardware. This function will automatically distribute the desired gain value over available gain stages in an appropriate way and return the actual value.

Parameters
gainthe gain in dB
chanthe channel index 0 to N-1
Returns
the actual gain in dB

Implements source_iface.

double bladerf_source_c::set_gain ( double  gain,
const std::string &  name,
size_t  chan = 0 
)
virtual

Set the named gain on the underlying radio hardware.

Parameters
gainthe gain in dB
namethe name of the gain stage
chanthe channel index 0 to N-1
Returns
the actual gain in dB

Implements source_iface.

bool bladerf_source_c::set_gain_mode ( bool  automatic,
size_t  chan = 0 
)
virtual

Set the gain mode for the underlying radio hardware. This might be supported only for certain hardware types.

Parameters
automaticthe gain mode (true means automatic gain mode)
chanthe channel index 0 to N-1
Returns
the actual gain mode

Reimplemented from source_iface.

void bladerf_source_c::set_iq_balance ( const std::complex< double > &  balance,
size_t  chan = 0 
)
virtual

Set the RX frontend IQ balance correction. Use this to adjust the magnitude and phase of I and Q.

Parameters
balancethe complex correction value
chanthe channel index 0 to N-1

Reimplemented from source_iface.

void bladerf_source_c::set_iq_balance_mode ( int  mode,
size_t  chan = 0 
)
virtual

Set the RX frontend IQ balance mode.

Parameters
modeiq balance correction mode: 0 = Off, 1 = Manual, 2 = Automatic
chanthe channel index 0 to N-1

Reimplemented from source_iface.

double bladerf_source_c::set_sample_rate ( double  rate)
virtual

Set the sample rate for the underlying radio hardware. This also will select the appropriate IF bandpass, if applicable.

Parameters
ratea new rate in Sps

Implements source_iface.

bool bladerf_source_c::start ( )
bool bladerf_source_c::stop ( )
int bladerf_source_c::work ( int  noutput_items,
gr_vector_const_void_star &  input_items,
gr_vector_void_star &  output_items 
)

Friends And Related Function Documentation

bladerf_source_c_sptr make_bladerf_source_c ( const std::string &  args)
friend

Return a shared_ptr to a new instance of bladerf_source_c.

To avoid accidental use of raw pointers, bladerf_source_c's constructor is private. bladerf_make_source_c is the public interface for creating new instances.


The documentation for this class was generated from the following file: