README change

1 files changed, 193 insertions, 0 deletions

diff --git a/gr-wxgui/grc/wxgui_numbersink2.xml b/gr-wxgui/grc/wxgui_numbersink2.xml
new file mode 100644
index 000000000..255926610
--- /dev/null
+++ b/gr-wxgui/grc/wxgui_numbersink2.xml
@@ -0,0 +1,193 @@
+<?xml version="1.0"?>
+<!--
+###################################################
+##Number Sink
+###################################################
+ -->
+<block>
+	<name>WX GUI Number Sink</name>
+	<key>wxgui_numbersink2</key>
+	<category>WX GUI Widgets</category>
+	<import>from gnuradio.wxgui import numbersink2</import>
+	<make>#set $parent = $notebook() and 'self.%s.GetPage(%s)'%$notebook() or 'self'
+numbersink2.$(type.fcn)(
+	$(parent).GetWin(),
+	unit=$units,
+	minval=$min_value,
+	maxval=$max_value,
+	factor=$factor,
+	decimal_places=$decimal_places,
+	ref_level=$ref_level,
+	sample_rate=$samp_rate,
+	number_rate=$number_rate,
+	average=$average,
+	avg_alpha=#if $avg_alpha() then $avg_alpha else 'None'#,
+	label=$title,
+	peak_hold=$peak_hold,
+	show_gauge=$show_gauge,
+#if $win_size()
+	size=$win_size,
+#end if
+)
+#if not $grid_pos()
+$(parent).Add(self.$(id).win)
+#else
+$(parent).GridAdd(self.$(id).win, $(', '.join(map(str, $grid_pos()))))
+#end if</make>
+	<param>
+		<name>Type</name>
+		<key>type</key>
+		<value>complex</value>
+		<type>enum</type>
+		<option>
+			<name>Complex</name>
+			<key>complex</key>
+			<opt>fcn:number_sink_c</opt>
+		</option>
+		<option>
+			<name>Float</name>
+			<key>float</key>
+			<opt>fcn:number_sink_f</opt>
+		</option>
+	</param>
+	<param>
+		<name>Title</name>
+		<key>title</key>
+		<value>Number Plot</value>
+		<type>string</type>
+	</param>
+	<param>
+		<name>Units</name>
+		<key>units</key>
+		<value>Units</value>
+		<type>string</type>
+	</param>
+	<param>
+		<name>Sample Rate</name>
+		<key>samp_rate</key>
+		<value>samp_rate</value>
+		<type>real</type>
+	</param>
+	<param>
+		<name>Min Value</name>
+		<key>min_value</key>
+		<value>-100</value>
+		<type>real</type>
+	</param>
+	<param>
+		<name>Max Value</name>
+		<key>max_value</key>
+		<value>100</value>
+		<type>real</type>
+	</param>
+	<param>
+		<name>Factor</name>
+		<key>factor</key>
+		<value>1.0</value>
+		<type>real</type>
+	</param>
+	<param>
+		<name>Decimal Places</name>
+		<key>decimal_places</key>
+		<value>10</value>
+		<type>int</type>
+	</param>
+	<param>
+		<name>Reference Level</name>
+		<key>ref_level</key>
+		<value>0</value>
+		<type>real</type>
+	</param>
+	<param>
+		<name>Number Rate</name>
+		<key>number_rate</key>
+		<value>15</value>
+		<type>int</type>
+	</param>
+	<param>
+		<name>Peak Hold</name>
+		<key>peak_hold</key>
+		<value>False</value>
+		<type>enum</type>
+		<hide>#if $peak_hold() == 'True' then 'none' else 'part'#</hide>
+		<option>
+			<name>On</name>
+			<key>True</key>
+		</option>
+		<option>
+			<name>Off</name>
+			<key>False</key>
+		</option>
+	</param>
+	<param>
+		<name>Average</name>
+		<key>average</key>
+		<value>False</value>
+		<type>enum</type>
+		<hide>part</hide>
+		<option>
+			<name>On</name>
+			<key>True</key>
+		</option>
+		<option>
+			<name>Off</name>
+			<key>False</key>
+		</option>
+	</param>
+	<param>
+		<name>Average Alpha</name>
+		<key>avg_alpha</key>
+		<value>0</value>
+		<type>real</type>
+		<hide>#if $average() == 'True' then 'none' else 'all'#</hide>
+	</param>
+	<param>
+		<name>Show Gauge</name>
+		<key>show_gauge</key>
+		<value>True</value>
+		<type>enum</type>
+		<option>
+			<name>Show</name>
+			<key>True</key>
+		</option>
+		<option>
+			<name>Hide</name>
+			<key>False</key>
+		</option>
+	</param>
+	<param>
+		<name>Window Size</name>
+		<key>win_size</key>
+		<value></value>
+		<type>int_vector</type>
+		<hide>#if $win_size() then 'none' else 'part'#</hide>
+	</param>
+	<param>
+		<name>Grid Position</name>
+		<key>grid_pos</key>
+		<value></value>
+		<type>grid_pos</type>
+	</param>
+	<param>
+		<name>Notebook</name>
+		<key>notebook</key>
+		<value></value>
+		<type>notebook</type>
+	</param>
+	<check>not $win_size or len($win_size) == 2</check>
+	<sink>
+		<name>in</name>
+		<type>$type</type>
+	</sink>
+	<doc>
+Set Average Alpha to 0 for automatic setting.
+
+Leave the window blank for the default size, otherwise enter a tuple of (width, height) pixels.
+
+Use the Grid Position (row, column, row span, column span) to position the graphical element in the window.
+
+Use the Notebook Param (notebook-id, page-index) to place the graphical element inside of a notebook page.
+
+Incoming numbers are multiplied by the factor, and then added-to by the reference level.
+	</doc>
+</block>