Building and Installing the USRP Open Source Toolchain (UHD and GNU Radio) on Windows
- 1 Application Note Number
- 2 Revision History
- 3 Abstract
- 4 UHD on Windows
- 5 Setup the Environment
- 6 Installing the dependencies
- 7 Obtain the UHD source code
- 8 Building
Application Note Number
|2016-01-19||Derek Kozel||Initial creation|
This Application Note provides a step-by-step guide for building, installing, and updating the open-source toolchain, specifically UHD and GNU Radio, for the USRP from source code on Windows.
UHD on Windows
UHD is fully supported on Windows 7, 8, 8.1, and 10 and can be compiled using Visual Studio 2012, 2013, or 2015. The future target is to support the latest three OS and Visual Studio releases.
Setup the Environment
The following dependencies are required for a regular build.
- Microsoft Windows (7, 8, 8.1, 10)
- Microsoft Visual Studio (2012, 2013, 2015)
- CMake (3.4.0 or later)
- Boost (1.56 or later)
- LibUSB (1.0 or later)
- Python (2.7.x)
- Mako (0.5.0 or later)
- Doxygen (1.8 or later, optional)
- NSIS (2.50 or later, optional)
Installing the dependencies
Microsoft Visual Studio
The free Express version of Visual Studio is sufficient for building UHD. This guide was tested using MSVC Express 2013.
CMake is a cross-platform build system used to configure and generate the files necessary to compile and test UHD for a particular computer environment.
During installation select the option to add CMake to the PATH for the current user.
CMake 3.4.1 win32 was used for the guide.
Boost is a set of C++ libraries providing useful algorithms and data structures.
The Boost binary installer must be selected to match the version of MSVC being used to compile UHD and architecture of Windows being run. Watch out as Microsoft has done the version numbering of MSVC such that the year and version number do not match.
MSVC 2013 is version 12 so boost_1_58_0-msvc-12.0-64 was selected.
LibUSB is a cross-platform library providing access to USB devices.
LibUSB releases are distributed in 7zip archives, the free 7zip program needed to open them is available at http://www.7-zip.org/download.html. After installing 7zip the LibUSB release archive can be extracted by right clicking on the downloaded file and selecting 7zip > Extract files.
LibUSB 1.20 was used for the guide and extracted to C:\Users\username\ libusb-1.0.20.
Python is a widely used general-purpose, high-level programming language. UHD includes several utilities written in Python and has several scripts which are part of the build process.
The latest Python 2 release, 2.7.11 was used.
Mako is a python template library used to generate source files and is distributed using a Python package management system.
Open a command line (Ctrl-X, select run, type cmd.exe and click ok)
cd C:\Python27\Scripts pip.exe install mako
This installed version 1.0.3 at the time of writing this guide.
Doxygen is a documentation generator which creates the HTML manual from text in the source code. It optional for building UHD.
Version 1.8.11 was used for this guide.
NSIS is a toolkit for creating Windows installers. NSIS is used for creating binary packages of UHD enabling easy distribution and installation of UHD, associated utilities, and examples.
Version 2.50 was used for this guide.
Obtain the UHD source code
From a release source archive
Archives of the source code for each stable release can be downloaded from the Ettus website.
7zip can be used to extract the tar.gz archive to a location of your choosing.
The guide uses the 3.9.2 release and extracted it to C:\Users\username\uhd-release_003_009_002.
From the Git repository
The latest development code, as well as tagged releases, is available from the git repository hosted on GitHub
All prerequisites have now been installed and downloaded.
Configuring the Building
- Open the Cmake GUI
- Select source code directory
- Select binary build directory
- Check the Advanced checkbox
- Click Configure
- Set Visual Studio 12 2013 Win64 as the compiler
- Change or add the following entries
- Add the following entries with type PATH
- Add the following entry with type FILEPATH
- Click Generate
Open Visual Studio 2013 and open the UHD project file generated by CMake.
- File > Open Project
Change the build type from Debug to Release. The **ALL_BUILD** project should be selected already. Run the build, Build > Build Solution.
Select the INSTALL project and run the build, Build > Build Solution.
Visual Studio must be run as Administrator for this to succeed as it needs write permission for the C:\Program Files directory.
Compiling a binary installer
Building the PACKAGE project will produce a binary installer if NSIS is installed. This installer with be for either 64 bit or 32 bit as chosen during the CMake step.
Running programs using UHD requires the Visual Studio C++ Runtime Redistributable to be installed. The version of the C++ Runtime Redistributable must match the version of Visual Studio used to compile the program.
- Visual Studio 2015
- Visual Studio 2012 and 2013
Installing the USB driver
If a USB connected USRP is used then the USB drivers must be installed.