diff options
Diffstat (limited to 'host/docs/coding.dox')
| -rw-r--r-- | host/docs/coding.dox | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/host/docs/coding.dox b/host/docs/coding.dox new file mode 100644 index 000000000..32dbe944a --- /dev/null +++ b/host/docs/coding.dox @@ -0,0 +1,38 @@ +/*! \page page_coding Coding to the API + +\tableofcontents + +\section coding_api Various API interfaces + +\subsection coding_api_hilevel High-Level: The Multi-USRP + +The Multi-USRP class provides a high-level interface to a single USRP device +with one or more channels, or multiple USRP devicess in a homogeneous +setup. See the documentation for uhd::usrp::multi_usrp. + +\subsection coding_api_hilevelclock High-Level: The Multi-USRP-Clock + +The Multi-USRP-Clock class provides a high-level interface to a single clock +device or set of clock devices, from which the time can be queried. See the +documentation for uhd::usrp_clock::multi_usrp_clock. + +\subsection coding_api_lowlevel Low-Level: The device API + +A device is an abstraction for hardware that is connected to the host +system. For a USRP device, this means that the motherboard and +everything on it would be considered to be a "device". For a clock device, the +device itself would be considered a "device" in software. The device API +provides ways to: + +- Discover devices that are physically connected to the host system. +- Create a device object for a particular device identified by + address. +- 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. +- Access various sensors on the device. + +See the documentation for uhd::device. + +*/ +// vim:ft=doxygen: |