summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJosh Blum2010-04-23 10:11:53 -0700
committerJosh Blum2010-04-23 10:11:53 -0700
commit999bba14d657a11fa9bfc1b9587e1341e2f28e07 (patch)
tree58ea437da91f0a37447ba402ee2ee600b83913ee
parent001bbc6a303218785337b1df7221a3fdcc47a2cd (diff)
downloadgnuradio-999bba14d657a11fa9bfc1b9587e1341e2f28e07.tar.gz
gnuradio-999bba14d657a11fa9bfc1b9587e1341e2f28e07.tar.bz2
gnuradio-999bba14d657a11fa9bfc1b9587e1341e2f28e07.zip
added docs to uhd grc blocks, added pkg config path to make support easier
-rw-r--r--config/grc_gr_uhd.m43
-rw-r--r--gr-uhd/grc/uhd_simple_sink.xml17
-rw-r--r--gr-uhd/grc/uhd_simple_source.xml17
3 files changed, 37 insertions, 0 deletions
diff --git a/config/grc_gr_uhd.m4 b/config/grc_gr_uhd.m4
index c3c701dbd..870a8abc6 100644
--- a/config/grc_gr_uhd.m4
+++ b/config/grc_gr_uhd.m4
@@ -24,6 +24,9 @@ AC_DEFUN([GRC_GR_UHD],[
GRC_CHECK_DEPENDENCY(gr-uhd, gnuradio-core)
if test $passed = yes; then
+ #by default, cmake likes to install the uhd.pc file here
+ #so lets make life easier for everybody and add this path
+ export PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/usr/local/lib/pkgconfig
PKG_CHECK_MODULES(
[UHD], [uhd], [],
[passed=no; AC_MSG_RESULT([gr-uhd requires libuhd])]
diff --git a/gr-uhd/grc/uhd_simple_sink.xml b/gr-uhd/grc/uhd_simple_sink.xml
index b6406e80d..2992f650e 100644
--- a/gr-uhd/grc/uhd_simple_sink.xml
+++ b/gr-uhd/grc/uhd_simple_sink.xml
@@ -72,5 +72,22 @@ self.$(id).set_antenna($ant)
<vlen>$type.vlen</vlen>
</sink>
<doc>
+The UHD Sink Block:
+
+Args:
+Args is a delimited string used to locate UHD devices on your system. \
+If left blank, the first UHD device found will be used. \
+Used args to specify a specfic device. \
+USRP2 Example: addr=192.168.10.2
+
+Sample rate:
+The sample rate is the number of samples per second input by this block. \
+The UHD device driver will try its best to match the requested sample rate. \
+If the requested rate is not possible, the UHD block will print an error at runtime.
+
+Antenna:
+For subdevices/daughterboards with only one antenna, this may be left blank. \
+Otherwise, the user should specify one of the possible antenna choices. \
+See the daughterboard application notes for the possible antenna choices.
</doc>
</block>
diff --git a/gr-uhd/grc/uhd_simple_source.xml b/gr-uhd/grc/uhd_simple_source.xml
index 34b6817c9..ecd963928 100644
--- a/gr-uhd/grc/uhd_simple_source.xml
+++ b/gr-uhd/grc/uhd_simple_source.xml
@@ -72,5 +72,22 @@ self.$(id).set_antenna($ant)
<vlen>$type.vlen</vlen>
</source>
<doc>
+The UHD Source Block:
+
+Args:
+Args is a delimited string used to locate UHD devices on your system. \
+If left blank, the first UHD device found will be used. \
+Used args to specify a specfic device. \
+USRP2 Example: addr=192.168.10.2
+
+Sample rate:
+The sample rate is the number of samples per second output by this block. \
+The UHD device driver will try its best to match the requested sample rate. \
+If the requested rate is not possible, the UHD block will print an error at runtime.
+
+Antenna:
+For subdevices/daughterboards with only one antenna, this may be left blank. \
+Otherwise, the user should specify one of the possible antenna choices. \
+See the daughterboard application notes for the possible antenna choices.
</doc>
</block>