Imported Upstream version 3.2.2
[debian/gnuradio] / grc / blocks / usrp_simple_source_x.xml
1 <?xml version="1.0"?>
2 <!--
3 ###################################################
4 ##USRP Simple Source
5 ###################################################
6  -->
7 <block>
8         <name>USRP Source</name>
9         <key>usrp_simple_source_x</key>
10         <import>from grc_gnuradio import usrp as grc_usrp</import>
11         <make>grc_usrp.simple_source_$(type.fcn)(which=$which, side=$side, rx_ant=$rx_ant#if $hb_filters() then ', no_hb=True' else ''#)
12 #if $format()
13 self.$(id).set_format(width=$format.width, shift=$format.shift)
14 #end if
15 self.$(id).set_decim_rate($decimation)
16 self.$(id).set_frequency($frequency, verbose=True)
17 self.$(id).set_gain($gain)
18 #if $lo_offset() != float('inf')
19 self.$(id).set_lo_offset($lo_offset)
20 #end if</make>
21         <callback>set_lo_offset($lo_offset)</callback>
22         <callback>set_decim_rate($decimation)</callback>
23         <callback>set_frequency($frequency)</callback>
24         <callback>set_gain($gain)</callback>
25         <param>
26                 <name>Output Type</name>
27                 <key>type</key>
28                 <type>enum</type>
29                 <option>
30                         <name>Complex</name>
31                         <key>complex</key>
32                         <opt>fcn:c</opt>
33                 </option>
34                 <option>
35                         <name>Short</name>
36                         <key>short</key>
37                         <opt>fcn:s</opt>
38                 </option>
39         </param>
40         <param>
41                 <name>Format</name>
42                 <key>format</key>
43                 <value></value>
44                 <type>enum</type>
45                 <hide>#if $format() then '' else 'part'#</hide>
46                 <option>
47                         <name>16 Bits (Default)</name>
48                         <key></key>
49                         <opt>width:16</opt>
50                         <opt>shift:0</opt>
51                 </option>
52                 <option>
53                         <name>8 Bits, Shift 8</name>
54                         <key>w8_s8</key>
55                         <opt>width:8</opt>
56                         <opt>shift:8</opt>
57                 </option>
58         </param>
59         <param>
60                 <name>Unit Number</name>
61                 <key>which</key>
62                 <value>0</value>
63                 <type>int</type>
64         </param>
65         <param>
66                 <name>Decimation</name>
67                 <key>decimation</key>
68                 <type>int</type>
69         </param>
70         <param>
71                 <name>Frequency (Hz)</name>
72                 <key>frequency</key>
73                 <type>real</type>
74         </param>
75         <param>
76                 <name>LO Offset (Hz)</name>
77                 <key>lo_offset</key>
78                 <value>float('inf')</value>
79                 <type>real</type>
80                 <hide>#if $lo_offset() == float('inf') then 'part' else 'none'#</hide>
81                 <option>
82                         <name>Default</name>
83                         <key>float('inf')</key>
84                 </option>
85         </param>
86         <param>
87                 <name>Gain (dB)</name>
88                 <key>gain</key>
89                 <value>0</value>
90                 <type>real</type>
91         </param>
92         <param>
93                 <name>Side</name>
94                 <key>side</key>
95                 <value>A</value>
96                 <type>string</type>
97                 <option>
98                         <name>A</name>
99                         <key>A</key>
100                 </option>
101                 <option>
102                         <name>B</name>
103                         <key>B</key>
104                 </option>
105         </param>
106         <param>
107                 <name>RX Antenna</name>
108                 <key>rx_ant</key>
109                 <value>RXA</value>
110                 <type>string</type>
111                 <option>
112                         <name>RXA</name>
113                         <key>RXA</key>
114                 </option>
115                 <option>
116                         <name>RXB</name>
117                         <key>RXB</key>
118                 </option>
119                 <option>
120                         <name>RXAB</name>
121                         <key>RXAB</key>
122                 </option>
123                 <option>
124                         <name>TX/RX</name>
125                         <key>TX/RX</key>
126                 </option>
127                 <option>
128                         <name>RX2</name>
129                         <key>RX2</key>
130                 </option>
131         </param>
132         <param>
133                 <name>Halfband Filters</name>
134                 <key>hb_filters</key>
135                 <value></value>
136                 <type>enum</type>
137                 <hide>#if $hb_filters() then 'none' else 'part'#</hide>
138                 <option>
139                         <name>Enable</name>
140                         <key></key>
141                 </option>
142                 <option>
143                         <name>Disable</name>
144                         <key>1</key>
145                 </option>
146         </param>
147         <source>
148                 <name>out</name>
149                 <type>$type</type>
150         </source>
151         <doc>
152 The USRP source outputs 64 Megasamples per second / decimation.
153
154 The "Receive Antenna Setting" selects one of the SMA connectors as the data source. \
155 Flex RF boards use the "TX/RX" and "RX2" settings. \
156 Basic RX and LFRX use the "RXA", "RXB", and "RXAB" settings. \
157 All other boards use the "RXA" setting.
158
159 With the format set to 8 bits and the halfband filters disabled, the USRP can acheive a decimation rate of 4. \
160 Disabling the halfband filters requires a special USRP firmware without halfband filters or TX paths. \
161 For this reason, the USRP cannot transmit with the halfband filters disabled.
162         </doc>
163 </block>