GNU Radio 3.7.2 C++ API
gr::fcd::source_c Class Referenceabstract

Funcube Dongle source block. More...

#include <gnuradio/fcd/source_c.h>

Inheritance diagram for gr::fcd::source_c:

Public Types

typedef boost::shared_ptr
< source_c
sptr
 
- Public Types inherited from gr::hier_block2
typedef basic_block_sptr opaque_self
 typedef for object returned from self(). More...
 

Public Member Functions

virtual void set_freq (int freq)=0
 Set frequency with Hz resolution. More...
 
virtual void set_freq (float freq)=0
 Set frequency with Hz resolution. More...
 
virtual void set_freq_khz (int freq)=0
 Set frequency with kHz resolution. More...
 
virtual void set_lna_gain (float gain)=0
 Set LNA gain. More...
 
virtual void set_mixer_gain (float gain)=0
 Set mixer gain. More...
 
virtual void set_freq_corr (int ppm)=0
 Set new frequency correction. More...
 
virtual void set_dc_corr (double _dci, double _dcq)=0
 Set DC offset correction. More...
 
virtual void set_iq_corr (double _gain, double _phase)=0
 Set IQ phase and gain balance. More...
 
- Public Member Functions inherited from gr::hier_block2
virtual ~hier_block2 ()
 
opaque_self self ()
 Return an object, representing the current block, which can be passed to connect. More...
 
void connect (basic_block_sptr block)
 Add a stand-alone (possibly hierarchical) block to internal graph. More...
 
void connect (basic_block_sptr src, int src_port, basic_block_sptr dst, int dst_port)
 Add gr-blocks or hierarchical blocks to internal graph and wire together. More...
 
void msg_connect (basic_block_sptr src, pmt::pmt_t srcport, basic_block_sptr dst, pmt::pmt_t dstport)
 Add gr-blocks or hierarchical blocks to internal graph and wire together. More...
 
void msg_connect (basic_block_sptr src, std::string srcport, basic_block_sptr dst, std::string dstport)
 
void msg_disconnect (basic_block_sptr src, pmt::pmt_t srcport, basic_block_sptr dst, pmt::pmt_t dstport)
 
void msg_disconnect (basic_block_sptr src, std::string srcport, basic_block_sptr dst, std::string dstport)
 
void disconnect (basic_block_sptr block)
 Remove a gr-block or hierarchical block from the internal flowgraph. More...
 
void disconnect (basic_block_sptr src, int src_port, basic_block_sptr dst, int dst_port)
 Disconnect a pair of gr-blocks or hierarchical blocks in internal flowgraph. More...
 
void disconnect_all ()
 Disconnect all connections in the internal flowgraph. More...
 
virtual void lock ()
 
virtual void unlock ()
 
flat_flowgraph_sptr flatten () const
 
hier_block2_sptr to_hier_block2 ()
 
bool has_msg_port (pmt::pmt_t which_port)
 
bool message_port_is_hier (pmt::pmt_t port_id)
 
bool message_port_is_hier_in (pmt::pmt_t port_id)
 
bool message_port_is_hier_out (pmt::pmt_t port_id)
 
void message_port_register_hier_in (pmt::pmt_t port_id)
 
void message_port_register_hier_out (pmt::pmt_t port_id)
 
void set_processor_affinity (const std::vector< int > &mask)
 Set the affinity of all blocks in hier_block2 to processor core n. More...
 
void unset_processor_affinity ()
 Remove processor affinity for all blocks in hier_block2. More...
 
std::vector< int > processor_affinity ()
 Get the current processor affinity. More...
 
- Public Member Functions inherited from gr::basic_block
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)
 
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)
 
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 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...
 
- Public Member Functions inherited from gr::msg_accepter
 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...
 
- Public Member Functions inherited from gr::messages::msg_accepter
 msg_accepter ()
 

Static Public Member Functions

static sptr make (const std::string device_name="")
 Return a shared_ptr to a new instance of fcd_source_c. More...
 

Additional Inherited Members

- Public Attributes inherited from gr::hier_block2
pmt::pmt_t hier_message_ports_in
 
pmt::pmt_t hier_message_ports_out
 
- Protected Types inherited from gr::basic_block
enum  vcolor { WHITE, GREY, BLACK }
 
- Protected Member Functions inherited from gr::hier_block2
 hier_block2 (void)
 
 hier_block2 (const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature)
 
- Protected Member Functions inherited from gr::basic_block
 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)
 
- Protected Attributes inherited from gr::basic_block
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
 

Detailed Description

Funcube Dongle source block.

This class provides a Funcube Dongle soure block by wrapping the USB audio interface and the USB HID control interface of the Funcube Dongle into one convenient source block.

The Funcube Dongle needs to have firmware 18f or later for the control interface to work properly. As of early 2011, FCDs still come with firmware 18b. You can use qthid 2.2 (not 3) to upgrade the firmware: http://qthid.sf.net

Member Typedef Documentation

Member Function Documentation

static sptr gr::fcd::source_c::make ( const std::string  device_name = "")
static

Return a shared_ptr to a new instance of fcd_source_c.

This is effectively the public constructor. To avoid accidental use of raw pointers, fcd_source_c's constructor is private. fcd_make_source_c is the public interface for creating new instances.

virtual void gr::fcd::source_c::set_dc_corr ( double  _dci,
double  _dcq 
)
pure virtual

Set DC offset correction.

Parameters
_dciDC correction for I component (-1.0 to 1.0)
_dcqDC correction for Q component (-1.0 to 1.0)

Set DC offset correction in the device. Default is 0.0.

virtual void gr::fcd::source_c::set_freq ( int  freq)
pure virtual

Set frequency with Hz resolution.

Parameters
freqThe frequency in Hz

Set the frequency of the Funcube Dongle with 1 Hz resolution applying the frequency correction set by set_freq_corr().

See Also
set_freq_khz()
virtual void gr::fcd::source_c::set_freq ( float  freq)
pure virtual

Set frequency with Hz resolution.

Parameters
freqThe frequency in Hz

This is a convenience function that uses float parameter in order to allow using engineering notation in GRC.

See Also
set_freq_khz()
virtual void gr::fcd::source_c::set_freq_corr ( int  ppm)
pure virtual

Set new frequency correction.

Parameters
ppmThe new frequency correction in parts per million

Version 1.1 FCDs (S/N 810 or later) need a correction of -12 ppm. Earlier FCDs need roughly -120 ppm (default for gr-fcd).

Ref: http://www.funcubedongle.com/?p=617

virtual void gr::fcd::source_c::set_freq_khz ( int  freq)
pure virtual

Set frequency with kHz resolution.

Parameters
freqThe frequency in kHz

Sets the frequency of the Funcube Dongle with 1 kHz resolution applying the frequency correction set by set_freq_corr().

See Also
set_freq()
virtual void gr::fcd::source_c::set_iq_corr ( double  _gain,
double  _phase 
)
pure virtual

Set IQ phase and gain balance.

Parameters
_gainThe gain correction (-1.0 to 1.0)
_phaseThe phase correction (-1.0 to 1.0)

Set IQ phase and gain balance in the device. The default values are 0.0 for phase and 1.0 for gain.

virtual void gr::fcd::source_c::set_lna_gain ( float  gain)
pure virtual

Set LNA gain.

Parameters
gainThe new gain in dB.

Set the LNA gain in the FCD. Valid range is -5 to

  1. Although the LNA gain in the FCD takes enumerated values corresponding to 2.5 dB steps, you can can call this method with any float value and it will be rounded to the nearest valid value.

By default the LNA gain is set to 20 dB and this is a good value for most cases. In noisy areas you may try to reduce the gain.

virtual void gr::fcd::source_c::set_mixer_gain ( float  gain)
pure virtual

Set mixer gain.

Parameters
gainThe new gain in dB.

Set the mixer gain in the FCD. Valid values are +4 and +12 dB.

By default the mixer gain is set to +12 dB and this is a good value for most cases. In noisy areas you may try to reduce the gain.


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