uhd/host/docs/coding.rst

31 lines
1.3 KiB
ReStructuredText
Raw Normal View History

2010-04-20 23:18:39 +00:00
========================================================================
UHD - Coding to the API
========================================================================
.. contents:: Table of Contents
------------------------------------------------------------------------
Various API interfaces
2010-04-20 23:18:39 +00:00
------------------------------------------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Low-Level: The device API
^^^^^^^^^^^^^^^^^^^^^^^^^^^
2010-04-20 23:18:39 +00:00
A device is an abstraction for hardware that is connected to the host system.
2012-12-18 23:47:17 +00:00
For a USRP device, this means that the motherboard and everything on it would be
considered to be a "device". The device API provides ways to:
2010-04-20 23:18:39 +00:00
* Discover devices that are physically connected to the host system.
* Create a device object for a particular device identified by address.
2010-04-20 23:18:39 +00:00
* Register a device driver into the discovery and factory sub-system.
* Streaming samples with metadata into and out of the device.
* Set and get properties on the device object.
See the documentation in *device.hpp* for reference.
2010-04-20 23:18:39 +00:00
^^^^^^^^^^^^^^^^^^^^^^^^^^^
High-Level: The Multi-USRP
^^^^^^^^^^^^^^^^^^^^^^^^^^^
2012-12-18 23:47:17 +00:00
The Multi-USRP class provides a fat interface to a single USRP device with
one or more channels, or multiple USRP devicess in a homogeneous setup.
See the documentation in *usrp/multi_usrp.hpp* for reference.