summaryrefslogtreecommitdiff
path: root/gr-uhd/lib/uhd_simple_sink.h
blob: 7f15962599750bcd9e311815af98a736da2cb21f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
/* -*- c++ -*- */
/*
 * Copyright 2010 Free Software Foundation, Inc.
 * 
 * This file is part of GNU Radio
 * 
 * GNU Radio is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3, or (at your option)
 * any later version.
 * 
 * GNU Radio is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with GNU Radio; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */

#ifndef INCLUDED_UHD_SIMPLE_SINK_H
#define INCLUDED_UHD_SIMPLE_SINK_H

#include <gr_sync_block.h>
#include <uhd/usrp/simple_usrp.hpp>

class uhd_simple_sink;

boost::shared_ptr<uhd_simple_sink> uhd_make_simple_sink(
    const std::string &args,
    const uhd::io_type_t::tid_t &type
);

class uhd_simple_sink : public gr_sync_block{
public:

    /*!
     * Set the IO signature for this block.
     * \param sig the input signature
     */
    uhd_simple_sink(gr_io_signature_sptr sig);

    /*!
     * Set the sample rate for the usrp device.
     * \param rate a new rate in Sps
     */
    virtual void set_samp_rate(double rate) = 0;

    /*!
     * Get the sample rate for the usrp device.
     * This is the actual sample rate and may differ from the rate set.
     * \return the actual rate in Sps
     */
    virtual double get_samp_rate(void) = 0;

    /*!
     * Tune the usrp device to the desired center frequency.
     * \param freq the desired frequency in Hz
     * \return a tune result with the actual frequencies
     */
    virtual uhd::tune_result_t set_center_freq(double freq) = 0;

    /*!
     * Get the tunable frequency range.
     * \return the frequency range in Hz
     */
    virtual uhd::freq_range_t get_freq_range(void) = 0;

    /*!
     * Set the gain for the dboard.
     * \param gain the gain in dB
     */
    virtual void set_gain(float gain) = 0;

    /*!
     * Get the actual dboard gain setting.
     * \return the actual gain in dB
     */
    virtual float get_gain(void) = 0;

    /*!
     * Get the settable gain range.
     * \return the gain range in dB
     */
    virtual uhd::gain_range_t get_gain_range(void) = 0;

    /*!
     * Set the antenna to use.
     * \param ant the antenna string
     */
    virtual void set_antenna(const std::string &ant) = 0;

    /*!
     * Get the antenna in use.
     * \return the antenna string
     */
    virtual std::string get_antenna(void) = 0;

    /*!
     * Get a list of possible antennas.
     * \return a vector of antenna strings
     */
    virtual std::vector<std::string> get_antennas(void) = 0;

    /*!
     * Set the clock configuration.
     * \param clock_config the new configuration
     */
    virtual void set_clock_config(const uhd::clock_config_t &clock_config) = 0;

    /*!
     * Get the current time registers.
     * \return the current usrp time
     */
    virtual uhd::time_spec_t get_time_now(void) = 0;

    /*!
     * Set the time registers asap.
     * \param time_spec the new time
     */
    virtual void set_time_now(const uhd::time_spec_t &time_spec) = 0;

    /*!
     * Set the time registers at the next pps.
     * \param time_spec the new time
     */
    virtual void set_time_next_pps(const uhd::time_spec_t &time_spec) = 0;

    /*!
     * Get access to the underlying uhd device object.
     * \return the simple usrp device object
     */
    virtual uhd::usrp::simple_usrp::sptr get_device(void) = 0;
};

#endif /* INCLUDED_UHD_SIMPLE_SINK_H */