Fixed base class name.
[debian/gnuradio] / gnuradio-examples / python / hier / usrp / usrp_fft.py
1 #!/usr/bin/env python
2 #
3 # Copyright 2004,2005,2007 Free Software Foundation, Inc.
4
5 # This file is part of GNU Radio
6
7 # GNU Radio is free software; you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3, or (at your option)
10 # any later version.
11
12 # GNU Radio is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 # GNU General Public License for more details.
16
17 # You should have received a copy of the GNU General Public License
18 # along with GNU Radio; see the file COPYING.  If not, write to
19 # the Free Software Foundation, Inc., 51 Franklin Street,
20 # Boston, MA 02110-1301, USA.
21
22
23 from gnuradio import gr, gru
24 from gnuradio import usrp
25 from gnuradio import eng_notation
26 from gnuradio.eng_option import eng_option
27 from gnuradio.wxgui import stdgui2, fftsink2, waterfallsink2, scopesink2, form, slider
28 from optparse import OptionParser
29 import wx
30 import sys
31
32
33 def pick_subdevice(u):
34     """
35     The user didn't specify a subdevice on the command line.
36     If there's a daughterboard on A, select A.
37     If there's a daughterboard on B, select B.
38     Otherwise, select A.
39     """
40     if u.db[0][0].dbid() >= 0:       # dbid is < 0 if there's no d'board or a problem
41         return (0, 0)
42     if u.db[1][0].dbid() >= 0:
43         return (1, 0)
44     return (0, 0)
45
46
47 class app_top_block(stdgui2.std_top_block):
48     def __init__(self, frame, panel, vbox, argv):
49         stdgui2.std_top_block.__init__(self, frame, panel, vbox, argv)
50
51         self.frame = frame
52         self.panel = panel
53         
54         parser = OptionParser(option_class=eng_option)
55         parser.add_option("-R", "--rx-subdev-spec", type="subdev", default=None,
56                           help="select USRP Rx side A or B (default=first one with a daughterboard)")
57         parser.add_option("-d", "--decim", type="int", default=16,
58                           help="set fgpa decimation rate to DECIM [default=%default]")
59         parser.add_option("-f", "--freq", type="eng_float", default=None,
60                           help="set frequency to FREQ", metavar="FREQ")
61         parser.add_option("-g", "--gain", type="eng_float", default=None,
62                           help="set gain in dB (default is midpoint)")
63         parser.add_option("-W", "--waterfall", action="store_true", default=False,
64                           help="Enable waterfall display")
65         parser.add_option("-8", "--width-8", action="store_true", default=False,
66                           help="Enable 8-bit samples across USB")
67         parser.add_option("-S", "--oscilloscope", action="store_true", default=False,
68                           help="Enable oscilloscope display")
69         (options, args) = parser.parse_args()
70         if len(args) != 0:
71             parser.print_help()
72             sys.exit(1)
73
74         self.show_debug_info = True
75         
76         self.u = usrp.source_c(decim_rate=options.decim)
77         if options.rx_subdev_spec is None:
78             options.rx_subdev_spec = pick_subdevice(self.u)
79         self.u.set_mux(usrp.determine_rx_mux_value(self.u, options.rx_subdev_spec))
80
81         if options.width_8:
82             width = 8
83             shift = 8
84             format = self.u.make_format(width, shift)
85             print "format =", hex(format)
86             r = self.u.set_format(format)
87             print "set_format =", r
88             
89         # determine the daughterboard subdevice we're using
90         self.subdev = usrp.selected_subdev(self.u, options.rx_subdev_spec)
91
92         input_rate = self.u.adc_freq() / self.u.decim_rate()
93
94         
95         if options.waterfall:
96             self.scope = waterfallsink2.waterfall_sink_c (panel, fft_size=1024, sample_rate=input_rate)
97         elif options.oscilloscope:
98             self.scope = scopesink2.scope_sink_c(panel, sample_rate=input_rate)
99         else:
100             self.scope = fftsink2.fft_sink_c (panel, fft_size=1024, sample_rate=input_rate)
101
102         self.connect(self.u, self.scope)
103
104         self._build_gui(vbox)
105
106         # set initial values
107
108         if options.gain is None:
109             # if no gain was specified, use the mid-point in dB
110             g = self.subdev.gain_range()
111             options.gain = float(g[0]+g[1])/2
112
113         if options.freq is None:
114             # if no freq was specified, use the mid-point
115             r = self.subdev.freq_range()
116             options.freq = float(r[0]+r[1])/2
117
118         self.set_gain(options.gain)
119
120         if self.show_debug_info:
121             self.myform['decim'].set_value(self.u.decim_rate())
122             self.myform['fs@usb'].set_value(self.u.adc_freq() / self.u.decim_rate())
123             self.myform['dbname'].set_value(self.subdev.name())
124             self.myform['baseband'].set_value(0)
125             self.myform['ddc'].set_value(0)
126
127         if not(self.set_freq(options.freq)):
128             self._set_status_msg("Failed to set initial frequency")
129
130     def _set_status_msg(self, msg):
131         self.frame.GetStatusBar().SetStatusText(msg, 0)
132
133     def _build_gui(self, vbox):
134
135         def _form_set_freq(kv):
136             return self.set_freq(kv['freq'])
137             
138         vbox.Add(self.scope.win, 10, wx.EXPAND)
139         
140         # add control area at the bottom
141         self.myform = myform = form.form()
142         hbox = wx.BoxSizer(wx.HORIZONTAL)
143         hbox.Add((5,0), 0, 0)
144         myform['freq'] = form.float_field(
145             parent=self.panel, sizer=hbox, label="Center freq", weight=1,
146             callback=myform.check_input_and_call(_form_set_freq, self._set_status_msg))
147
148         hbox.Add((5,0), 0, 0)
149         g = self.subdev.gain_range()
150         myform['gain'] = form.slider_field(parent=self.panel, sizer=hbox, label="Gain",
151                                            weight=3,
152                                            min=int(g[0]), max=int(g[1]),
153                                            callback=self.set_gain)
154
155         hbox.Add((5,0), 0, 0)
156         vbox.Add(hbox, 0, wx.EXPAND)
157
158         self._build_subpanel(vbox)
159
160     def _build_subpanel(self, vbox_arg):
161         # build a secondary information panel (sometimes hidden)
162
163         # FIXME figure out how to have this be a subpanel that is always
164         # created, but has its visibility controlled by foo.Show(True/False)
165         
166         def _form_set_decim(kv):
167             return self.set_decim(kv['decim'])
168
169         if not(self.show_debug_info):
170             return
171
172         panel = self.panel
173         vbox = vbox_arg
174         myform = self.myform
175
176         #panel = wx.Panel(self.panel, -1)
177         #vbox = wx.BoxSizer(wx.VERTICAL)
178
179         hbox = wx.BoxSizer(wx.HORIZONTAL)
180         hbox.Add((5,0), 0)
181
182         myform['decim'] = form.int_field(
183             parent=panel, sizer=hbox, label="Decim",
184             callback=myform.check_input_and_call(_form_set_decim, self._set_status_msg))
185
186         hbox.Add((5,0), 1)
187         myform['fs@usb'] = form.static_float_field(
188             parent=panel, sizer=hbox, label="Fs@USB")
189
190         hbox.Add((5,0), 1)
191         myform['dbname'] = form.static_text_field(
192             parent=panel, sizer=hbox)
193
194         hbox.Add((5,0), 1)
195         myform['baseband'] = form.static_float_field(
196             parent=panel, sizer=hbox, label="Analog BB")
197
198         hbox.Add((5,0), 1)
199         myform['ddc'] = form.static_float_field(
200             parent=panel, sizer=hbox, label="DDC")
201
202         hbox.Add((5,0), 0)
203         vbox.Add(hbox, 0, wx.EXPAND)
204
205         
206     def set_freq(self, target_freq):
207         """
208         Set the center frequency we're interested in.
209
210         @param target_freq: frequency in Hz
211         @rypte: bool
212
213         Tuning is a two step process.  First we ask the front-end to
214         tune as close to the desired frequency as it can.  Then we use
215         the result of that operation and our target_frequency to
216         determine the value for the digital down converter.
217         """
218         r = self.u.tune(0, self.subdev, target_freq)
219         
220         if r:
221             self.myform['freq'].set_value(target_freq)     # update displayed value
222             if self.show_debug_info:
223                 self.myform['baseband'].set_value(r.baseband_freq)
224                 self.myform['ddc'].set_value(r.dxc_freq)
225             return True
226
227         return False
228
229     def set_gain(self, gain):
230         self.myform['gain'].set_value(gain)     # update displayed value
231         self.subdev.set_gain(gain)
232
233     def set_decim(self, decim):
234         ok = self.u.set_decim_rate(decim)
235         if not ok:
236             print "set_decim failed"
237         input_rate = self.u.adc_freq() / self.u.decim_rate()
238         self.scope.set_sample_rate(input_rate)
239         if self.show_debug_info:  # update displayed values
240             self.myform['decim'].set_value(self.u.decim_rate())
241             self.myform['fs@usb'].set_value(self.u.adc_freq() / self.u.decim_rate())
242         return ok
243
244 def main ():
245     app = stdgui2.stdapp(app_top_block, "USRP FFT", nstatus=1)
246     app.MainLoop()
247
248 if __name__ == '__main__':
249     main ()