diff options
| author | Josh Blum <josh@joshknows.com> | 2011-01-27 15:24:47 -0800 |
|---|---|---|
| committer | Josh Blum <josh@joshknows.com> | 2011-01-27 15:24:47 -0800 |
| commit | e16445483e1505942b7b1ddcd9fc575532fd93ba (patch) | |
| tree | 9f08b9439e8ce46cb876396b32da138105348381 /host/docs/coding.rst | |
| parent | 8a62a20041605238320eae1f1a69221ef00b6bf1 (diff) | |
| download | uhd-e16445483e1505942b7b1ddcd9fc575532fd93ba.tar.gz uhd-e16445483e1505942b7b1ddcd9fc575532fd93ba.tar.bz2 uhd-e16445483e1505942b7b1ddcd9fc575532fd93ba.zip | |
uhd: remove single usrp (leave a typedef), multi-usrp is a superset now
Diffstat (limited to 'host/docs/coding.rst')
| -rw-r--r-- | host/docs/coding.rst | 34 |
1 files changed, 2 insertions, 32 deletions
diff --git a/host/docs/coding.rst b/host/docs/coding.rst index 7533445ea..ecca4e8b8 100644 --- a/host/docs/coding.rst +++ b/host/docs/coding.rst @@ -23,40 +23,10 @@ The device API provides ways to: See the documentation in *device.hpp* for reference. ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -High-Level: The single usrp -^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The goal of the single usrp API is to wrap high level functions around the device properties. -The single usrp provides a fat interface to access the most common properties. -The single usrp provides ways to: - -* Set and get daughterboard gains. -* Set and get daughterboard antennas. -* Set and get the streaming rates. -* Tune the DSPs and daughterboards. -* Issue stream commands. -* Set the clock configuration. -* Set the usrp time registers. -* Get the underlying device (as discussed above). - -See the documentation in *usrp/single_usrp.hpp* for reference. - -^^^^^^^^^^^^^^^^^^^^^^^^^^^ High-Level: The multi usrp ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The multi usrp API provides a wrapper around a device that represents several motherboards. -This API provides convenience calls just like the single usrp, -however the calls either work across all channels in the configuration, -or take a channel argument to specify which channel to configure. -The multi usrp provides ways to: - -* Set and get the sample rate across all channels. -* Issue a stream command across all channels. -* Set the time registers across all channels. -* Set and get individual daughterboard gains. -* Set and get individual daughterboard antennas. -* Tune individual DSPs and daughterboards. -* Get the underlying device (as discussed above). - +The Multi-USRP class provides a FAT interface to a single USRP with +one or more channels, or multiple USRPs in a homogeneous setup. See the documentation in *usrp/multi_usrp.hpp* for reference. ------------------------------------------------------------------------ |