summaryrefslogtreecommitdiffstats
path: root/host/docs
diff options
context:
space:
mode:
authorJosh Blum <josh@joshknows.com>2011-02-16 13:40:43 -0800
committerJosh Blum <josh@joshknows.com>2011-02-16 13:40:43 -0800
commite43b47d65891d30ac5888635a1e3cec3f5046464 (patch)
tree69fb626ce57f7c16715586e4f62df2854ca39a58 /host/docs
parentd04939215fdfce79be515c9d56a3cdadadd0ebd4 (diff)
downloaduhd-e43b47d65891d30ac5888635a1e3cec3f5046464.tar.gz
uhd-e43b47d65891d30ac5888635a1e3cec3f5046464.tar.bz2
uhd-e43b47d65891d30ac5888635a1e3cec3f5046464.zip
uhd: work on identification docs, moved duplicated notes in general
Diffstat (limited to 'host/docs')
-rw-r--r--host/docs/general.rst49
-rw-r--r--host/docs/identification.rst44
2 files changed, 36 insertions, 57 deletions
diff --git a/host/docs/general.rst b/host/docs/general.rst
index 90a880c2e..50ef24d6c 100644
--- a/host/docs/general.rst
+++ b/host/docs/general.rst
@@ -5,55 +5,6 @@ UHD - General Application Notes
.. contents:: Table of Contents
------------------------------------------------------------------------
-Finding devices
-------------------------------------------------------------------------
-
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Device addressing
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Deviced are addressed through key/value string pairs.
-These string pairs can be used to narrow down the search for a specific device or group of devices.
-Most UHD utility applications and examples have a --args parameter that takes a device address;
-where the device address is expressed as a delimited string.
-
-* See the documentation in types/device_addr.hpp for reference.
-* See device-specific application notes for usage.
-
-**Example:**
-::
-
- serial=0x1234, type=usrpx
-
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Device discovery
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Devices attached to your system can be discovered using the "uhd_find_devices" program.
-The find devices program scans your system for supported devices and prints
-out an enumerated list of discovered devices and their addresses.
-The list of discovered devices can be narrowed down by specifying device address args.
-
-**Usage:**
-::
-
- uhd_find_devices
-
- -- OR --
-
- uhd_find_devices --args <device-specific-address-args>
-
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Device properties
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Properties of devices attached to your system can be probed with the "uhd_usrp_probe" program.
-The usrp probe program constructs an instance of the device and prints out its properties;
-properties such as detected daughter-boards, frequency range, gain ranges, etc...
-
-**Usage:**
-::
-
- uhd_usrp_probe --args <device-specific-address-args>
-
-------------------------------------------------------------------------
Misc notes
------------------------------------------------------------------------
diff --git a/host/docs/identification.rst b/host/docs/identification.rst
index 49d36ec1a..90484744c 100644
--- a/host/docs/identification.rst
+++ b/host/docs/identification.rst
@@ -7,20 +7,36 @@ UHD - Device Identification Notes
------------------------------------------------------------------------
Identifying USRPs
------------------------------------------------------------------------
-Every device has several ways of identifying it on the host system:
+Devices are addressed through key/value string pairs.
+These string pairs can be used to narrow down the search for a specific device or group of devices.
+Most UHD utility applications and examples have a --args parameter that takes a device address;
+where the device address is expressed as a delimited string.
+See the documentation in types/device_addr.hpp for reference.
-* **Serial:** A globally unique identifier.
-* **Address:** A unique identifier on a network.
-* **Name:** An optional user-set identifier.
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Common device identifiers
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Every device has several ways of identifying it on the host system:
-The address is only applicable for network-based devices.
-See the USRP2 application notes.
++------------+------------+--------------------------------------------+
+| Identifier | Key | Notes |
++============+============+============================================+
+| Serial | serial | globally unique identifier |
++------------+------------+--------------------------------------------+
+| Address | addr | unique identifier on a network |
++------------+------------+--------------------------------------------+
+| Name | name | optional user-set identifier |
++------------+------------+--------------------------------------------+
+| Type | type | hardware series identifier |
++------------+------------+--------------------------------------------+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Device discovery via command line
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-A "find devices" utility application comes bundled with the UHD.
-The find devices application will search for all devices on the host system and print the results.
+Devices attached to your system can be discovered using the "uhd_find_devices" program.
+The find devices program scans your system for supported devices and prints
+out an enumerated list of discovered devices and their addresses.
+The list of discovered devices can be narrowed down by specifying device address args.
::
@@ -60,6 +76,18 @@ The hint argument can be populated to narrow the scope of the search.
hint["serial"] = "12345678";
uhd::device_addrs_t dev_addrs = uhd::device::find(hint);
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Device properties
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Properties of devices attached to your system can be probed with the "uhd_usrp_probe" program.
+The usrp probe program constructs an instance of the device and prints out its properties;
+properties such as detected daughter-boards, frequency range, gain ranges, etc...
+
+**Usage:**
+::
+
+ uhd_usrp_probe --args <device-specific-address-args>
+
------------------------------------------------------------------------
Naming a USRP
------------------------------------------------------------------------