added option to choose the antenna on RFX and WBX boards
[debian/gnuradio] / gr-utils / src / python / usrp_fft.py
1 #!/usr/bin/env python
2 #
3 # Copyright 2004,2005 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 stdgui, fftsink, waterfallsink, scopesink, 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_flow_graph(stdgui.gui_flow_graph):
48     def __init__(self, frame, panel, vbox, argv):
49         stdgui.gui_flow_graph.__init__(self)
50
51         self.frame = frame
52         self.panel = panel
53         
54         parser = OptionParser(option_class=eng_option)
55         parser.add_option("-w", "--which", type="int", default=0,
56                           help="select which USRP (0, 1, ...) default is %default",
57                           metavar="NUM")
58         parser.add_option("-R", "--rx-subdev-spec", type="subdev", default=None,
59                           help="select USRP Rx side A or B (default=first one with a daughterboard)")
60         parser.add_option("-A", "--antenna", default=None,
61                           help="select Rx Antenna (only on RFX-series boards)")
62         parser.add_option("-d", "--decim", type="int", default=16,
63                           help="set fgpa decimation rate to DECIM [default=%default]")
64         parser.add_option("-f", "--freq", type="eng_float", default=None,
65                           help="set frequency to FREQ", metavar="FREQ")
66         parser.add_option("-g", "--gain", type="eng_float", default=None,
67                           help="set gain in dB (default is midpoint)")
68         parser.add_option("-W", "--waterfall", action="store_true", default=False,
69                           help="Enable waterfall display")
70         parser.add_option("-8", "--width-8", action="store_true", default=False,
71                           help="Enable 8-bit samples across USB")
72         parser.add_option("-S", "--oscilloscope", action="store_true", default=False,
73                           help="Enable oscilloscope display")
74         (options, args) = parser.parse_args()
75         if len(args) != 0:
76             parser.print_help()
77             sys.exit(1)
78
79         self.show_debug_info = True
80         
81         # build the graph
82
83         self.u = usrp.source_c(which=options.which, decim_rate=options.decim)
84         if options.rx_subdev_spec is None:
85             options.rx_subdev_spec = pick_subdevice(self.u)
86         self.u.set_mux(usrp.determine_rx_mux_value(self.u, options.rx_subdev_spec))
87
88         if options.width_8:
89             width = 8
90             shift = 8
91             format = self.u.make_format(width, shift)
92             print "format =", hex(format)
93             r = self.u.set_format(format)
94             print "set_format =", r
95             
96         # determine the daughterboard subdevice we're using
97         self.subdev = usrp.selected_subdev(self.u, options.rx_subdev_spec)
98
99         input_rate = self.u.adc_freq() / self.u.decim_rate()
100
101         if options.waterfall:
102             self.scope = \
103               waterfallsink.waterfall_sink_c (self, panel, fft_size=1024, sample_rate=input_rate)
104         elif options.oscilloscope:
105             self.scope = scopesink.scope_sink_c(self, panel, sample_rate=input_rate)
106         else:
107             self.scope = fftsink.fft_sink_c (self, panel, fft_size=1024, sample_rate=input_rate)
108
109         self.connect(self.u, self.scope)
110
111         self._build_gui(vbox)
112
113         # set initial values
114
115         if options.gain is None:
116             # if no gain was specified, use the mid-point in dB
117             g = self.subdev.gain_range()
118             options.gain = float(g[0]+g[1])/2
119
120         if options.freq is None:
121             # if no freq was specified, use the mid-point
122             r = self.subdev.freq_range()
123             options.freq = float(r[0]+r[1])/2
124
125         self.set_gain(options.gain)
126
127         if options.antenna is not None:
128             print "Selecting antenna %s" % (options.antenna,)
129             self.subdev.select_rx_antenna(options.antenna)
130
131         if self.show_debug_info:
132             self.myform['decim'].set_value(self.u.decim_rate())
133             self.myform['fs@usb'].set_value(self.u.adc_freq() / self.u.decim_rate())
134             self.myform['dbname'].set_value(self.subdev.name())
135             self.myform['baseband'].set_value(0)
136             self.myform['ddc'].set_value(0)
137
138         if not(self.set_freq(options.freq)):
139             self._set_status_msg("Failed to set initial frequency")
140
141     def _set_status_msg(self, msg):
142         self.frame.GetStatusBar().SetStatusText(msg, 0)
143
144     def _build_gui(self, vbox):
145
146         def _form_set_freq(kv):
147             return self.set_freq(kv['freq'])
148             
149         vbox.Add(self.scope.win, 10, wx.EXPAND)
150         
151         # add control area at the bottom
152         self.myform = myform = form.form()
153         hbox = wx.BoxSizer(wx.HORIZONTAL)
154         hbox.Add((5,0), 0, 0)
155         myform['freq'] = form.float_field(
156             parent=self.panel, sizer=hbox, label="Center freq", weight=1,
157             callback=myform.check_input_and_call(_form_set_freq, self._set_status_msg))
158
159         hbox.Add((5,0), 0, 0)
160         g = self.subdev.gain_range()
161         myform['gain'] = form.slider_field(parent=self.panel, sizer=hbox, label="Gain",
162                                            weight=3,
163                                            min=int(g[0]), max=int(g[1]),
164                                            callback=self.set_gain)
165
166         hbox.Add((5,0), 0, 0)
167         vbox.Add(hbox, 0, wx.EXPAND)
168
169         self._build_subpanel(vbox)
170
171     def _build_subpanel(self, vbox_arg):
172         # build a secondary information panel (sometimes hidden)
173
174         # FIXME figure out how to have this be a subpanel that is always
175         # created, but has its visibility controlled by foo.Show(True/False)
176         
177         def _form_set_decim(kv):
178             return self.set_decim(kv['decim'])
179
180         if not(self.show_debug_info):
181             return
182
183         panel = self.panel
184         vbox = vbox_arg
185         myform = self.myform
186
187         #panel = wx.Panel(self.panel, -1)
188         #vbox = wx.BoxSizer(wx.VERTICAL)
189
190         hbox = wx.BoxSizer(wx.HORIZONTAL)
191         hbox.Add((5,0), 0)
192
193         myform['decim'] = form.int_field(
194             parent=panel, sizer=hbox, label="Decim",
195             callback=myform.check_input_and_call(_form_set_decim, self._set_status_msg))
196
197         hbox.Add((5,0), 1)
198         myform['fs@usb'] = form.static_float_field(
199             parent=panel, sizer=hbox, label="Fs@USB")
200
201         hbox.Add((5,0), 1)
202         myform['dbname'] = form.static_text_field(
203             parent=panel, sizer=hbox)
204
205         hbox.Add((5,0), 1)
206         myform['baseband'] = form.static_float_field(
207             parent=panel, sizer=hbox, label="Analog BB")
208
209         hbox.Add((5,0), 1)
210         myform['ddc'] = form.static_float_field(
211             parent=panel, sizer=hbox, label="DDC")
212
213         hbox.Add((5,0), 0)
214         vbox.Add(hbox, 0, wx.EXPAND)
215
216         
217     def set_freq(self, target_freq):
218         """
219         Set the center frequency we're interested in.
220
221         @param target_freq: frequency in Hz
222         @rypte: bool
223
224         Tuning is a two step process.  First we ask the front-end to
225         tune as close to the desired frequency as it can.  Then we use
226         the result of that operation and our target_frequency to
227         determine the value for the digital down converter.
228         """
229         r = self.u.tune(0, self.subdev, target_freq)
230         
231         if r:
232             self.myform['freq'].set_value(target_freq)     # update displayed value
233             if self.show_debug_info:
234                 self.myform['baseband'].set_value(r.baseband_freq)
235                 self.myform['ddc'].set_value(r.dxc_freq)
236             return True
237
238         return False
239
240     def set_gain(self, gain):
241         self.myform['gain'].set_value(gain)     # update displayed value
242         self.subdev.set_gain(gain)
243
244     def set_decim(self, decim):
245         ok = self.u.set_decim_rate(decim)
246         if not ok:
247             print "set_decim failed"
248         input_rate = self.u.adc_freq() / self.u.decim_rate()
249         self.scope.set_sample_rate(input_rate)
250         if self.show_debug_info:  # update displayed values
251             self.myform['decim'].set_value(self.u.decim_rate())
252             self.myform['fs@usb'].set_value(self.u.adc_freq() / self.u.decim_rate())
253         return ok
254
255 def main ():
256     app = stdgui.stdapp(app_flow_graph, "USRP FFT", nstatus=1)
257     app.MainLoop()
258
259 if __name__ == '__main__':
260     main ()