merged r10942:11199 from digital branch
[debian/gnuradio] / gnuradio-examples / python / digital / generic_usrp.py
index ac5b13c81af8abf0afd5b23e677052d1d7a3657e..7f062f3c72b83b1aa6fe512fc54d3aeb9a9bcd7e 100644 (file)
 # Boston, MA 02110-1301, USA.
 #
 
-USRP_TYPE = 'usrp'
+USRP1_TYPE = 'usrp1'
 USRP2_TYPE = 'usrp2'
-
+DUMMY_TYPE = 'dummy'
+#usrp2 rates common for decim and interp
+_USRP2_RATES = range(4, 128+1, 1) + range(130, 256+1, 2) + range(260, 512+1, 4)
+#dummy common rates
+_DUMMY_XRATES = range(4, 512, 2)
+_DUMMY_CONVERTER_RATE = 100e6
+#dummy freq result
+class _dummy_freq_result(object):
+    def __init__(self, target_freq):
+        self.baseband_freq = target_freq
+        self.dxc_freq = 0
+        self.residual_freq = 0
 from gnuradio import gr, usrp, usrp2
 
 ########################################################################
@@ -29,9 +40,9 @@ from gnuradio import gr, usrp, usrp2
 ########################################################################
 class _generic_usrp_base(object):
 
-    def __init__(self, which=0, subdev_spec=None, interface="", mac_addr="", fusb_block_size=0, fusb_nblocks=0, usrpx=None):
-        self._gain = 0
-        self._usrpx = usrpx
+    def __init__(self, which=0, subdev_spec=None, interface="", mac_addr="",
+        fusb_block_size=0, fusb_nblocks=0, usrpx=None, lo_offset=None, gain=None):
+        self._lo_offset = lo_offset
         #usrp options
         self._which = which
         self._subdev_spec = subdev_spec
@@ -41,37 +52,80 @@ class _generic_usrp_base(object):
         #fusb options
         self._fusb_block_size = fusb_block_size
         self._fusb_nblocks = fusb_nblocks
+        #pick which usrp model
+        if usrpx == '0': self._setup_usrpx(DUMMY_TYPE)
+        elif usrpx == '1' or self._subdev_spec: self._setup_usrpx(USRP1_TYPE)
+        elif usrpx == '2' or self._mac_addr: self._setup_usrpx(USRP2_TYPE)
+        else: #automatic
+            try: self._setup_usrpx(USRP2_TYPE)
+            except:
+                try: self._setup_usrpx(USRP1_TYPE)
+                except: raise Exception, 'Failed to automatically setup a usrp device.'
+        #post usrp setup
+        if self._lo_offset is not None:
+            self.set_lo_offset(self._lo_offset)
+        self.set_gain(gain)
+        self.set_auto_tr(True)
+
+    def _setup_usrpx(self, type):
+        """
+        Call the appropriate setup method.
+        @param type the usrp type constant
+        """
+        self._type = type
+        if self._type == USRP1_TYPE: self._setup_usrp1()
+        elif self._type == USRP2_TYPE: self._setup_usrp2()
+        elif self._type == DUMMY_TYPE: self._setup_dummy()
 
     def __str__(self):
-        if self._type == USRP_TYPE: return self._subdev.side_and_name()
-        elif self._type == USRP2_TYPE: return "D-Board ID 0x%x\n"%self._u.daughterboard_id()
+        if self._type == USRP1_TYPE: return self._subdev.side_and_name()
+        elif self._type == USRP2_TYPE:
+            return 'Interface: %s    MAC Address: %s    D-Board ID: 0x%.2x'%(
+                self._u.interface_name(), self._u.mac_addr(), self._u.daughterboard_id())
+        elif self._type == DUMMY_TYPE: return 'Dummy USRP Device'
 
     def gain(self): return self._gain
 
     def set_gain(self, gain=None):
-        if gain is None:
-            r = self.gain_range()
-            gain = (r[0] + r[1])/2               # set gain to midpoint
+        #automatic gain calculation
+        r = self.gain_range()
+        if gain is None: gain = (r[0] + r[1])/2 # set gain to midpoint
+        #set gain for usrp
         self._gain = gain
-        if self._type == USRP_TYPE: return self._subdev.set_gain(gain)
+        if self._type == USRP1_TYPE: return self._subdev.set_gain(gain)
         elif self._type == USRP2_TYPE: return self._u.set_gain(gain)
+        elif self._type == DUMMY_TYPE: return True
 
     def gain_range(self):
-        if self._type == USRP_TYPE: return self._subdev.gain_range()
+        if self._type == USRP1_TYPE: return self._subdev.gain_range()
         elif self._type == USRP2_TYPE: return self._u.gain_range()
+        elif self._type == DUMMY_TYPE: return (0, 0)
 
     def set_center_freq(self, target_freq):
-        if self._type == USRP_TYPE:
-            return bool(self._u.tune(self._dxc, self._subdev, target_freq))
+        if self._type == USRP1_TYPE:
+            return self._u.tune(self._dxc, self._subdev, target_freq)
         elif self._type == USRP2_TYPE:
             return self._u.set_center_freq(target_freq)
+        elif self._type == DUMMY_TYPE: return _dummy_freq_result(target_freq)
+
+    def freq_range(self):
+        if self._type == USRP1_TYPE: return self._subdev.freq_range()
+        elif self._type == USRP2_TYPE: return self._u.freq_range()
+        elif self._type == DUMMY_TYPE: return (-10e9, 10e9, 100e3)
+
+    def set_lo_offset(self, lo_offset):
+        if self._type == USRP1_TYPE: return self._subdev.set_lo_offset(lo_offset)
+        elif self._type == USRP2_TYPE: return self._u.set_lo_offset(lo_offset)
+        elif self._type == DUMMY_TYPE: return True
 
     def set_auto_tr(self, enable):
-        if self._type == USRP_TYPE: return self._subdev.set_auto_tr(enable)
+        if self._type == USRP1_TYPE: return self._subdev.set_auto_tr(enable)
 
     def __del__(self):
-        # Avoid weak reference error
-        if self._type == USRP_TYPE: del self._subdev
+        try: # Avoid weak reference error
+            del self._u
+            del self._subdev
+        except: pass
 
 ########################################################################
 # generic usrp source
@@ -84,34 +138,35 @@ class generic_usrp_source_c(_generic_usrp_base, gr.hier_block2):
     """
 
     def __init__(self, **kwargs):
-        _generic_usrp_base.__init__(self, **kwargs)
         gr.hier_block2.__init__(self, "generic_usrp_source",
             gr.io_signature(0, 0, 0), # Input signature
             gr.io_signature(1, 1, gr.sizeof_gr_complex)) # Output signature
-        #pick usrp or usrp2
-        if self._usrpx == '1' or self._subdev_spec:
-            self._setup_usrp_source()
-        elif self._usrpx == '2' or self._mac_addr:
-            self._setup_usrp2_source()
-        else: #automatic
-            try: self._setup_usrp2_source()
-            except: self._setup_usrp_source()
+        _generic_usrp_base.__init__(self, **kwargs)
         self.connect(self._u, self)
-        self.set_auto_tr(True)
 
     ####################################################################
     # generic access methods
     ####################################################################
     def set_decim(self, decim):
-        if self._type == USRP_TYPE: return self._u.set_decim_rate(decim)
+        if decim not in self.get_decim_rates(): return False
+        if self._type == USRP1_TYPE: return self._u.set_decim_rate(decim)
         elif self._type == USRP2_TYPE: return self._u.set_decim(decim)
+        elif self._type == DUMMY_TYPE: return True
+
+    def get_decim_rates(self):
+        if self._type == USRP1_TYPE: return range(8, 256+1, 2) #default firmware w/ hb filters
+        if self._type == USRP2_TYPE: return _USRP2_RATES
+        elif self._type == DUMMY_TYPE: return _DUMMY_XRATES
 
-    def adc_rate(self): return self._u.adc_rate()
+    def adc_rate(self):
+        if self._type == USRP1_TYPE: return self._u.adc_rate()
+        if self._type == USRP2_TYPE: return self._u.adc_rate()
+        elif self._type == DUMMY_TYPE: return _DUMMY_CONVERTER_RATE
 
     ####################################################################
     # setup usrp methods
     ####################################################################
-    def _setup_usrp_source(self):
+    def _setup_usrp1(self):
         self._u = usrp.source_c (self._which,
                                 fusb_block_size=self._fusb_block_size,
                                 fusb_nblocks=self._fusb_nblocks)
@@ -120,12 +175,12 @@ class generic_usrp_source_c(_generic_usrp_base, gr.hier_block2):
             self._subdev_spec = usrp.pick_rx_subdevice(self._u)
         self._subdev = usrp.selected_subdev(self._u, self._subdev_spec)
         self._u.set_mux(usrp.determine_rx_mux_value(self._u, self._subdev_spec))
-        self._type = USRP_TYPE
         self._dxc = 0
 
-    def _setup_usrp2_source(self):
+    def _setup_usrp2(self):
         self._u = usrp2.source_32fc(self._interface, self._mac_addr)
-        self._type = USRP2_TYPE
+
+    def _setup_dummy(self): self._u = gr.null_source(gr.sizeof_gr_complex)
 
 ########################################################################
 # generic usrp sink
@@ -138,39 +193,37 @@ class generic_usrp_sink_c(_generic_usrp_base, gr.hier_block2):
     """
 
     def __init__(self, **kwargs):
-        _generic_usrp_base.__init__(self, **kwargs)
         gr.hier_block2.__init__(self, "generic_usrp_sink",
             gr.io_signature(1, 1, gr.sizeof_gr_complex), # Input signature
             gr.io_signature(0, 0, 0)) # Output signature
-
-        #pick usrp or usrp2
-        if self._usrpx == '1' or self._subdev_spec:
-            self._setup_usrp_source()
-        elif self._usrpx == '2' or self._mac_addr:
-            self._setup_usrp2_source()
-        else: #automatic
-            try: self._setup_usrp2_source()
-            except: self._setup_usrp_source()
-        self.connect(self, self._u)
-        self.set_auto_tr(True)
+        _generic_usrp_base.__init__(self, **kwargs)
+        if self._type == USRP1_TYPE: #scale 0.0 to 1.0 input for usrp1
+            self.connect(self, gr.multiply_const_cc((2**15)-1), self._u)
+        else: self.connect(self, self._u)
 
     ####################################################################
     # generic access methods
     ####################################################################
     def set_interp(self, interp):
-        if self._type == USRP_TYPE: return self._u.set_interp_rate(interp)
+        if interp not in self.get_interp_rates(): return False
+        if self._type == USRP1_TYPE: return self._u.set_interp_rate(interp)
         elif self._type == USRP2_TYPE: return self._u.set_interp(interp)
+        elif self._type == DUMMY_TYPE: return True
 
-    def dac_rate(self): return self._u.dac_rate()
+    def get_interp_rates(self):
+        if self._type == USRP1_TYPE: return range(16, 512+1, 4)
+        if self._type == USRP2_TYPE: return _USRP2_RATES
+        elif self._type == DUMMY_TYPE: return _DUMMY_XRATES
 
-    def ampl_range(self):
-        if self._type == USRP_TYPE: return (0.0, 2.**15-1)
-        elif self._type == USRP2_TYPE: return (0.0, 1.0)
+    def dac_rate(self):
+        if self._type == USRP1_TYPE: return self._u.dac_rate()
+        if self._type == USRP2_TYPE: return self._u.dac_rate()
+        elif self._type == DUMMY_TYPE: return _DUMMY_CONVERTER_RATE
 
     ####################################################################
     # setup usrp methods
     ####################################################################
-    def _setup_usrp_source(self):
+    def _setup_usrp1(self):
         self._u = usrp.sink_c (self._which,
                                 fusb_block_size=self._fusb_block_size,
                                 fusb_nblocks=self._fusb_nblocks)
@@ -179,9 +232,8 @@ class generic_usrp_sink_c(_generic_usrp_base, gr.hier_block2):
             self._subdev_spec = usrp.pick_tx_subdevice(self._u)
         self._subdev = usrp.selected_subdev(self._u, self._subdev_spec)
         self._u.set_mux(usrp.determine_tx_mux_value(self._u, self._subdev_spec))
-        self._type = USRP_TYPE
         self._dxc = self._subdev.which()
 
-    def _setup_usrp2_source(self):
-        self._u = usrp2.sink_32fc(self._interface, self._mac_addr)
-        self._type = USRP2_TYPE
+    def _setup_usrp2(self): self._u = usrp2.sink_32fc(self._interface, self._mac_addr)
+
+    def _setup_dummy(self): self._u = gr.null_sink(gr.sizeof_gr_complex)