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