options for hb filter in usrp simple source
[debian/gnuradio] / grc / data / platforms / python / 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.eval then ', no_hb=True' else ''#)
12 #if $format.eval
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 $auto_tr.eval and $rx_ant.flex
19 self.$(id).set_auto_tr($auto_tr)
20 #end if</make>
21         <callback>set_decim_rate($decimation)</callback>
22         <callback>set_frequency($frequency)</callback>
23         <callback>set_gain($gain)</callback>
24         <param>
25                 <name>Output Type</name>
26                 <key>type</key>
27                 <type>enum</type>
28                 <option>
29                         <name>Complex</name>
30                         <key>complex</key>
31                         <opt>fcn:c</opt>
32                 </option>
33                 <option>
34                         <name>Short</name>
35                         <key>short</key>
36                         <opt>fcn:s</opt>
37                 </option>
38         </param>
39         <param>
40                 <name>Format</name>
41                 <key>format</key>
42                 <value></value>
43                 <type>enum</type>
44                 <hide>#if $format.eval then '' else 'part'#</hide>
45                 <option>
46                         <name>16 Bits (Default)</name>
47                         <key></key>
48                         <opt>width:16</opt>
49                         <opt>shift:0</opt>
50                 </option>
51                 <option>
52                         <name>8 Bits, Shift 8</name>
53                         <key>w8_s8</key>
54                         <opt>width:8</opt>
55                         <opt>shift:8</opt>
56                 </option>
57         </param>
58         <param>
59                 <name>Unit Number</name>
60                 <key>which</key>
61                 <value>0</value>
62                 <type>int</type>
63         </param>
64         <param>
65                 <name>Decimation</name>
66                 <key>decimation</key>
67                 <type>int</type>
68         </param>
69         <param>
70                 <name>Frequency</name>
71                 <key>frequency</key>
72                 <type>real</type>
73         </param>
74         <param>
75                 <name>Gain</name>
76                 <key>gain</key>
77                 <type>real</type>
78         </param>
79         <param>
80                 <name>Side</name>
81                 <key>side</key>
82                 <value>A</value>
83                 <type>enum</type>
84                 <option>
85                         <name>Side A</name>
86                         <key>A</key>
87                 </option>
88                 <option>
89                         <name>Side B</name>
90                         <key>B</key>
91                 </option>
92         </param>
93         <param>
94                 <name>RX Antenna</name>
95                 <key>rx_ant</key>
96                 <value>RXA</value>
97                 <type>enum</type>
98                 <option>
99                         <name>RXA</name>
100                         <key>RXA</key>
101                         <opt>flex:</opt>
102                 </option>
103                 <option>
104                         <name>RXB</name>
105                         <key>RXB</key>
106                         <opt>flex:</opt>
107                 </option>
108                 <option>
109                         <name>TX/RX</name>
110                         <key>TX/RX</key>
111                         <opt>flex:1</opt>
112                 </option>
113                 <option>
114                         <name>RX2</name>
115                         <key>RX2</key>
116                         <opt>flex:1</opt>
117                 </option>
118         </param>
119         <param>
120                 <name>Auto T/R</name>
121                 <key>auto_tr</key>
122                 <value></value>
123                 <type>enum</type>
124                 <hide>#if $rx_ant.flex then 'none' else 'all'#</hide>
125                 <option>
126                         <name>Auto</name>
127                         <key></key>
128                 </option>
129                 <option>
130                         <name>Enable</name>
131                         <key>True</key>
132                 </option>
133                 <option>
134                         <name>Disable</name>
135                         <key>False</key>
136                 </option>
137         </param>
138         <param>
139                 <name>Halfband Filters</name>
140                 <key>hb_filters</key>
141                 <value></value>
142                 <type>enum</type>
143                 <hide>#if $hb_filters.eval then 'none' else 'part'#</hide>
144                 <option>
145                         <name>Enable</name>
146                         <key></key>
147                 </option>
148                 <option>
149                         <name>Disable</name>
150                         <key>1</key>
151                 </option>
152         </param>
153         <source>
154                 <name>out</name>
155                 <type>$type</type>
156         </source>
157         <doc>
158 The USRP source outputs 64 Megasamples per second / decimation.
159
160 The "Receive Antenna Setting" selects one of the SMA connectors as the data source. \
161 Flex RF boards use the "TX/RX" and "RX2" settings. \
162 Basic RX and LFRX use the "RXA" and "RXB" settings. \
163 All other boards use the "RXA" setting.
164
165 Flex RF boards only: If enabled, "Auto Transmit/Receive Switching" handles the preference for transmit packets vs receive packets. \
166 By default, "Auto TR" is disabled.
167
168 With the format set to 8 bits and the halfband filters disabled, the USRP can acheive a decimation rate of 4. \
169 Disabling the halfband filters requires a special USRP firmware without halfband filters or TX paths. \
170 For this reason, the USRP cannot transmit with the halfband filters disabled.
171         </doc>
172 </block>