git.gag.com Git - debian/gnuradio/blob - gnuradio-examples/python/digital/receive_path.py

   1 #!/usr/bin/env python
   2 #
   3 # Copyright 2005,2006,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, blks2
  24 from gnuradio import usrp
  25 from gnuradio import eng_notation
  26 import copy
  27 import sys
  28
  29 # from current dir
  30 from pick_bitrate import pick_rx_bitrate
  31
  32 # /////////////////////////////////////////////////////////////////////////////
  33 #                              receive path
  34 # /////////////////////////////////////////////////////////////////////////////
  35
  36 class receive_path(gr.hier_block2):
  37     def __init__(self, demod_class, rx_callback, options):
  38
  39         gr.hier_block2.__init__(self, "receive_path",
  40                                 gr.io_signature(0, 0, 0), # Input signature
  41                                 gr.io_signature(0, 0, 0)) # Output signature
  42
  43         options = copy.copy(options)    # make a copy so we can destructively modify
  44
  45         self._verbose            = options.verbose
  46         self._rx_freq            = options.rx_freq         # receiver's center frequency
  47         self._rx_gain            = options.rx_gain         # receiver's gain
  48         self._rx_subdev_spec     = options.rx_subdev_spec  # daughterboard to use
  49         self._bitrate            = options.bitrate         # desired bit rate
  50         self._decim              = options.decim           # Decimating rate for the USRP (prelim)
  51         self._samples_per_symbol = options.samples_per_symbol  # desired samples/symbol
  52         self._fusb_block_size    = options.fusb_block_size # usb info for USRP
  53         self._fusb_nblocks       = options.fusb_nblocks    # usb info for USRP
  54
  55         self._rx_callback   = rx_callback      # this callback is fired when there's a packet available
  56         self._demod_class   = demod_class      # the demodulator_class we're using
  57
  58         if self._rx_freq is None:
  59             sys.stderr.write("-f FREQ or --freq FREQ or --rx-freq FREQ must be specified\n")
  60             raise SystemExit
  61
  62         # Set up USRP source; also adjusts decim, samples_per_symbol, and bitrate
  63         self._setup_usrp_source()
  64
  65         g = self.subdev.gain_range()
  66         if options.show_rx_gain_range:
  67             print "Rx Gain Range: minimum = %g, maximum = %g, step size = %g" \
  68                   % (g[0], g[1], g[2])
  69
  70         self.set_gain(options.rx_gain)
  71
  72         self.set_auto_tr(True)                 # enable Auto Transmit/Receive switching
  73
  74         # Set RF frequency
  75         ok = self.set_freq(self._rx_freq)
  76         if not ok:
  77             print "Failed to set Rx frequency to %s" % (eng_notation.num_to_str(self._rx_freq))
  78             raise ValueError, eng_notation.num_to_str(self._rx_freq)
  79
  80         # copy the final answers back into options for use by demodulator
  81         options.samples_per_symbol = self._samples_per_symbol
  82         options.bitrate = self._bitrate
  83         options.decim = self._decim
  84
  85         # Get demod_kwargs
  86         demod_kwargs = self._demod_class.extract_kwargs_from_options(options)
  87
  88         # Design filter to get actual channel we want
  89         sw_decim = 1
  90         chan_coeffs = gr.firdes.low_pass (1.0,                  # gain
  91                                           sw_decim * self._samples_per_symbol, # sampling rate
  92                                           1.0,                  # midpoint of trans. band
  93                                           0.5,                  # width of trans. band
  94                                           gr.firdes.WIN_HANN)   # filter type
  95
  96         # Decimating channel filter
  97         # complex in and out, float taps
  98         self.chan_filt = gr.fft_filter_ccc(sw_decim, chan_coeffs)
  99         #self.chan_filt = gr.fir_filter_ccf(sw_decim, chan_coeffs)
 100
 101         # receiver
 102         self.packet_receiver = \
 103             blks2.demod_pkts(self._demod_class(**demod_kwargs),
 104                              access_code=None,
 105                              callback=self._rx_callback,
 106                              threshold=-1)
 107
 108         # Carrier Sensing Blocks
 109         alpha = 0.001
 110         thresh = 30   # in dB, will have to adjust
 111
 112         if options.log_rx_power == True:
 113             self.probe = gr.probe_avg_mag_sqrd_cf(thresh,alpha)
 114             self.power_sink = gr.file_sink(gr.sizeof_float, "rxpower.dat")
 115             self.connect(self.chan_filt, self.probe, self.power_sink)
 116         else:
 117             self.probe = gr.probe_avg_mag_sqrd_c(thresh,alpha)
 118             self.connect(self.chan_filt, self.probe)
 119
 120         # Display some information about the setup
 121         if self._verbose:
 122             self._print_verbage()
 123
 124         self.connect(self.u, self.chan_filt, self.packet_receiver)
 125
 126     def _setup_usrp_source(self):
 127         self.u = usrp.source_c (fusb_block_size=self._fusb_block_size,
 128                                 fusb_nblocks=self._fusb_nblocks)
 129         adc_rate = self.u.adc_rate()
 130
 131         # derive values of bitrate, samples_per_symbol, and decim from desired info
 132         (self._bitrate, self._samples_per_symbol, self._decim) = \
 133             pick_rx_bitrate(self._bitrate, self._demod_class.bits_per_symbol(), \
 134                             self._samples_per_symbol, self._decim, adc_rate)
 135
 136         self.u.set_decim_rate(self._decim)
 137
 138         # determine the daughterboard subdevice we're using
 139         if self._rx_subdev_spec is None:
 140             self._rx_subdev_spec = usrp.pick_rx_subdevice(self.u)
 141         self.subdev = usrp.selected_subdev(self.u, self._rx_subdev_spec)
 142
 143         self.u.set_mux(usrp.determine_rx_mux_value(self.u, self._rx_subdev_spec))
 144
 145     def set_freq(self, target_freq):
 146         """
 147         Set the center frequency we're interested in.
 148
 149         @param target_freq: frequency in Hz
 150         @rypte: bool
 151
 152         Tuning is a two step process.  First we ask the front-end to
 153         tune as close to the desired frequency as it can.  Then we use
 154         the result of that operation and our target_frequency to
 155         determine the value for the digital up converter.
 156         """
 157         r = self.u.tune(0, self.subdev, target_freq)
 158         if r:
 159             return True
 160
 161         return False
 162
 163     def set_gain(self, gain):
 164         """
 165         Sets the analog gain in the USRP
 166         """
 167         if gain is None:
 168             r = self.subdev.gain_range()
 169             gain = (r[0] + r[1])/2               # set gain to midpoint
 170         self.gain = gain
 171         return self.subdev.set_gain(gain)
 172
 173     def set_auto_tr(self, enable):
 174         return self.subdev.set_auto_tr(enable)
 175
 176     def bitrate(self):
 177         return self._bitrate
 178
 179     def samples_per_symbol(self):
 180         return self._samples_per_symbol
 181
 182     def decim(self):
 183         return self._decim
 184
 185     def carrier_sensed(self):
 186         """
 187         Return True if we think carrier is present.
 188         """
 189         #return self.probe.level() > X
 190         return self.probe.unmuted()
 191
 192     def carrier_threshold(self):
 193         """
 194         Return current setting in dB.
 195         """
 196         return self.probe.threshold()
 197
 198     def set_carrier_threshold(self, threshold_in_db):
 199         """
 200         Set carrier threshold.
 201
 202         @param threshold_in_db: set detection threshold
 203         @type threshold_in_db:  float (dB)
 204         """
 205         self.probe.set_threshold(threshold_in_db)
 206
 207
 208     def add_options(normal, expert):
 209         """
 210         Adds receiver-specific options to the Options Parser
 211         """
 212         add_freq_option(normal)
 213         if not normal.has_option("--bitrate"):
 214             normal.add_option("-r", "--bitrate", type="eng_float", default=None,
 215                               help="specify bitrate.  samples-per-symbol and interp/decim will be derived.")
 216         normal.add_option("-R", "--rx-subdev-spec", type="subdev", default=None,
 217                           help="select USRP Rx side A or B")
 218         normal.add_option("", "--rx-gain", type="eng_float", default=None, metavar="GAIN",
 219                           help="set receiver gain in dB [default=midpoint].  See also --show-rx-gain-range")
 220         normal.add_option("", "--show-rx-gain-range", action="store_true", default=False,
 221                           help="print min and max Rx gain available on selected daughterboard")
 222         normal.add_option("-v", "--verbose", action="store_true", default=False)
 223         expert.add_option("-S", "--samples-per-symbol", type="int", default=None,
 224                           help="set samples/symbol [default=%default]")
 225         expert.add_option("", "--rx-freq", type="eng_float", default=None,
 226                           help="set Rx frequency to FREQ [default=%default]", metavar="FREQ")
 227         expert.add_option("-d", "--decim", type="intx", default=None,
 228                           help="set fpga decimation rate to DECIM [default=%default]")
 229         expert.add_option("", "--log", action="store_true", default=False,
 230                           help="Log all parts of flow graph to files (CAUTION: lots of data)")
 231         expert.add_option("", "--log-rx-power", action="store_true", default=False,
 232                           help="Log receive signal power to file (CAUTION: lots of data)")
 233
 234     # Make a static method to call before instantiation
 235     add_options = staticmethod(add_options)
 236
 237
 238     def _print_verbage(self):
 239         """
 240         Prints information about the receive path
 241         """
 242         print "\nReceive Path:"
 243         print "Using RX d'board %s"    % (self.subdev.side_and_name(),)
 244         print "Rx gain:         %g"    % (self.gain,)
 245         print "modulation:      %s"    % (self._demod_class.__name__)
 246         print "bitrate:         %sb/s" % (eng_notation.num_to_str(self._bitrate))
 247         print "samples/symbol:  %3d"   % (self._samples_per_symbol)
 248         print "decim:           %3d"   % (self._decim)
 249         print "Rx Frequency:    %s"    % (eng_notation.num_to_str(self._rx_freq))
 250         # print "Rx Frequency:    %f"    % (self._rx_freq)
 251
 252     def __del__(self):
 253         # Avoid weak reference error
 254         del self.subdev
 255
 256 def add_freq_option(parser):
 257     """
 258     Hackery that has the -f / --freq option set both tx_freq and rx_freq
 259     """
 260     def freq_callback(option, opt_str, value, parser):
 261         parser.values.rx_freq = value
 262         parser.values.tx_freq = value
 263
 264     if not parser.has_option('--freq'):
 265         parser.add_option('-f', '--freq', type="eng_float",
 266                           action="callback", callback=freq_callback,
 267                           help="set Tx and/or Rx frequency to FREQ [default=%default]",
 268                           metavar="FREQ")