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

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