README.Debian
1UHD, the "Universal Software Radio Peripheral" hardware driver on Debian:
2=========================================================================
3
4usrp group
5----------
6
7The Debian uhd-host package installs a usrp group.
8This provides two main benefits:
9 - Access control:
10 The udev rules limit access to members of the group
11 (at least for USB attached USRPs).
12 - Real Time Priority privilege:
13 The pam limits setting allows UHD to boost the
14 thread scheduling priority for usrp group members.
15
16To avail yourself of these benefits, add your username
17to the usrp group, perhaps by running, as root something like:
18
19 adduser myusername usrp
20
21substituting your user name for myusername.
22Settings will not take effect until the user has logged in and out.
23
24
25Multiple packages
26-----------------
27
28uhd-host:
29 The uhd-host package contains the uhd_find_devices and
30 uhd_usrp_probe commands for locating and examining USRP devices
31 available to the host system.
32
33 Also, under /usr/lib/uhd/ are examples, tests and utils
34 directories. The utils include tools for managing the
35 flash memory or EEPROM configuration of various USRPs.
36
37libuhd003:
38 Small package just for the library itself.
39
40libuhd-dev:
41 Small package just for developing applications
42 using the library itself.
43
44UHD Firmware / FPGA images
45--------------------------
46
47 The uhd-images package is not part of the main Debian distribution
48 because the FPGA firmware requires non-free vendor tools to compile
49 from source.
50
51 For USRP devices with non-volatile configuration having the firmware
52 images on the host is optional. But some USRPs are volatile, and
53 the UHD library will fetch files from the /usr/share/uhd/images/
54 directory at runtime.
55
56 The uhd_images_downloader is a python script to download from
57 Ettus.com and install the files.
58
59More Information
60----------------
61
62Additional HTML documentation is installed. See
63file:///usr/share/doc/uhd-host/doxygen/html/index.html
64
65 -- A. Maitland Bottoms <bottoms@debian.org>, Thu, 9 Oct 2014 23:14:19 -0400
66