switch source package format to 3.0 quilt
[debian/gnuradio] / gnuradio-examples / python / digital / transmit_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 eng_notation
25
26 import copy
27 import sys
28
29 # /////////////////////////////////////////////////////////////////////////////
30 #                              transmit path
31 # /////////////////////////////////////////////////////////////////////////////
32
33 class transmit_path(gr.hier_block2):
34     def __init__(self, modulator_class, options):
35         '''
36         See below for what options should hold
37         '''
38         gr.hier_block2.__init__(self, "transmit_path",
39                                 gr.io_signature(0, 0, 0),                    # Input signature
40                                 gr.io_signature(1, 1, gr.sizeof_gr_complex)) # Output signature
41         
42         options = copy.copy(options)    # make a copy so we can destructively modify
43
44         self._verbose            = options.verbose
45         self._tx_amplitude       = options.tx_amplitude    # digital amplitude sent to USRP
46         self._bitrate            = options.bitrate         # desired bit rate
47         self._samples_per_symbol = options.samples_per_symbol  # desired samples/baud
48
49         self._modulator_class = modulator_class         # the modulator_class we are using
50
51         # Get mod_kwargs
52         mod_kwargs = self._modulator_class.extract_kwargs_from_options(options)
53     
54         # transmitter
55         modulator = self._modulator_class(**mod_kwargs)
56         self.packet_transmitter = \
57             blks2.mod_pkts(modulator,
58                            access_code=None,
59                            msgq_limit=4,
60                            pad_for_usrp=True)
61
62         self.amp = gr.multiply_const_cc(1)
63         self.set_tx_amplitude(self._tx_amplitude)
64
65         # Display some information about the setup
66         if self._verbose:
67             self._print_verbage()
68
69         # Connect components in the flowgraph
70         self.connect(self.packet_transmitter, self.amp, self)
71
72     def set_tx_amplitude(self, ampl):
73         """
74         Sets the transmit amplitude sent to the USRP in volts
75         @param: ampl 0 <= ampl < 1.
76         """
77         self._tx_amplitude = max(0.0, min(ampl, 1))
78         self.amp.set_k(self._tx_amplitude)
79         
80     def send_pkt(self, payload='', eof=False):
81         """
82         Calls the transmitter method to send a packet
83         """
84         return self.packet_transmitter.send_pkt(payload, eof)
85         
86     def bitrate(self):
87         return self._bitrate
88
89     def samples_per_symbol(self):
90         return self._samples_per_symbol
91
92     def add_options(normal, expert):
93         """
94         Adds transmitter-specific options to the Options Parser
95         """
96         if not normal.has_option('--bitrate'):
97             normal.add_option("-r", "--bitrate", type="eng_float", default=100e3,
98                               help="specify bitrate [default=%default].")
99         normal.add_option("", "--tx-amplitude", type="eng_float", default=0.250, metavar="AMPL",
100                           help="set transmitter digital amplitude: 0 <= AMPL < 1 [default=%default]")
101         normal.add_option("-v", "--verbose", action="store_true", default=False)
102
103         expert.add_option("-S", "--samples-per-symbol", type="float", default=None,
104                           help="set samples/symbol [default=%default]")
105         expert.add_option("", "--log", action="store_true", default=False,
106                           help="Log all parts of flow graph to file (CAUTION: lots of data)")
107
108     # Make a static method to call before instantiation
109     add_options = staticmethod(add_options)
110
111     def _print_verbage(self):
112         """
113         Prints information about the transmit path
114         """
115         print "Tx amplitude     %s"    % (self._tx_amplitude)
116         print "modulation:      %s"    % (self._modulator_class.__name__)
117         print "bitrate:         %sb/s" % (eng_notation.num_to_str(self._bitrate))
118         print "samples/symbol:  %.4f"    % (self._samples_per_symbol)
119