You are on page 1of 23

BLADERF WINDOWS ® INSTALL GUIDE

INSTALLING BLADERF SOFTWARE WITH MATLAB ®

& SIMULINK® SUPPORT
JANUARY

8, 2016

® Install Guide

bladeRF Windows

Nuand, LLC

License
This work by Nuand, LLC is licensed under:
Creative Commons Attribution 4.0 International License

Authors
Jon Szymaniak
<jon.szymaniak@nuand.com>
Nuand, LLC

i

LLC Revisions Comments. feedback. and fixes may be sent to <bladeRF@nuand.01-rc1 installer ii . improvements.® Install Guide bladeRF Windows Nuand.com>. Revision 1 Date 2015-01-08 Summary Initial revision for 2016.

3. . . . . . . 3. . . . . . . .3 Viewing Documentation . . . . . . . . . . . . . . . .10 Installation Completed . .5 Start Menu Folder . . . . . . . . . . . . . . . . . . . . .2. . . . . . . . . . . . . . 5. . . . . . . . . . . . . . . . . . . . . . 3. . . . . . . iii . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7 Installation Progress . . .2. . .2.2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2. .2 Execute Installer . . . . . . .2. . . . . . . . . . . . . .2. . . 3. . . . . . 3. . . . . . . . . . . . . . .2. . . . . . .2. .® Install Guide bladeRF Windows Nuand. . 5. . . . . . . . . . . . . . .1 Download . . . . . . . . . . . . . . 5. 3. . . . .4 Adding a bladeRF block to a Simulink® Model 14 14 15 16 17 ® ® . . . . . . . . . . . . . . . . . . . 2 2 2 3 4 5 6 7 8 9 10 11 12 4 Testing Basic Device Access 13 5 MATLAB and Simulink 5. .2. . .6 Ready to Install .4 MATLAB® Search Path . . . . . . .3 Firmware Update . . . . . . . . . . . . . . .1 Destination Location . . . . . . . 3.1 MATLAB® Search Path . . . .9 System PATH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8 Firmware Update Progress 3. . . . . . . . . . .2 RX GUI Demo . . . . . . . .2 Driver Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . LLC Contents 1 Overview 1 2 System Requirements and Recommendations 1 3 Installation Procedure 3. . . . . . . . . 3. . . . . . 3. . . . . . . . . 3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

2 System Requirements and Recommendations PC system requirements.0 Controller ® 7 64-bit ˆ Windows Supported Windows® versions: ˆ XP (32-bit & 64-bit) ˆ Vista (32-bit & 64-bit) ˆ 7 (32-bit & 64-bit) ˆ 8. While the bladeRF can be used on a USB 2.0 port. a USB 3. are largely dependent upon one’s target SDR application. such as processor and RAM specifications. LLC Overview This document describes the Windows® installation procedure for pre-built bladeRF software and its associated MATLAB® & Simulink® support.1 (32-bit & 64-bit) Supported MATLAB® versions: ˆ 2014b ˆ 2015a ˆ 2015b 1 . Recommended minimum configuration: ˆ Quad-core 64-bit processor (3 GHz) ˆ 4 GB RAM ˆ USB 3.0 controller is recommended in order to fully leverage the sample rate capabilities of the device.® Install Guide bladeRF Windows 1 Nuand.

2. a welcome screen will be presented.® Install Guide bladeRF Windows 3 3. LLC Installation Procedure Download The latest available installer may always be found at: https://nuand. If Windows® prompts whether the program should be allowed to execute.php 3. Click Next to continue.3. as shown below.2 Execute Installer Ensure the bladeRF is not connected to the system. Once started.com/installers. verify that the publisher is listed as Nuand. Begin by running the installer executable.com/windows_installers/bladeRF-win-installer-latest. LLC before clicking Yes. or until instructed to do so in Section 3. 2 .exe Previous installer versions are located at: https://nuand.1 Nuand. Do not connect it until after the installer completes successfully.

the installer will prompt for an installation destination. 3 . and click Next.2.1 Nuand.® Install Guide bladeRF Windows 3. Update this field. LLC Destination Location Next. if desired.

ie/ 4 . If this is the first time setting up the bladeRF software on the machine.® Install Guide bladeRF Windows 3.2 Nuand. Click Next once the desired option is selected. Additionally. 1 http://zadig. LLC Driver Installation This screen presents three driver installation options. Should one driver prove to be problematic on a system. a driver may be installed at a later time using Zadig1 .akeo. Both are provided as a matter of preference. the last option may be used. Either driver may be used. If a driver is already installed.2. either the Cypress CyUSB3 or libusb (WinUSB) driver must installed. the installer may be re-run to install the other.

® Install Guide bladeRF Windows 3. 2 via bladeRF-cli -f <fx3 firmware> 5 .1. as firmware releases generally include feature updates and fixes.2. This is generally recommended. LLC Firmware Update The following page provides the option to update the bladeRF firmware during the installation process. Use Next to advance to the next screen. It is always possible to upgrade (or downgrade) firmware at a later time using the bladeRF-cli program2 .3 Nuand. The FX3 firmware image is used for the update is installed in the location selected in 3. under the fx3 firmware folder.2.

® Install Guide bladeRF Windows 3. the following screen will be presented. Click Next when the desire option is selected. LLC MATLAB® Search Path If a 64-bit MATLAB® installation is detected. 6 . It is recommended to select the default option of adding bladeRF items to the MATLAB® search path.4 Nuand.2.

LLC Start Menu Folder This page provides the ability to customize the Start Menu location under which shortcuts to the bladeRF-cli and uninstall program are placed. 7 .® Install Guide bladeRF Windows 3.2. Click Next to continue.5 Nuand.

LLC Ready to Install Click Next be begin installing files to the system.2. This is the last step at which the program can be cancelled before changes are made.® Install Guide bladeRF Windows 3.6 Nuand. 8 .

® Install Guide bladeRF Windows 3. as shown below.7 Nuand. a MATLAB® window will momentarily appear while this is updated. 9 . denoting the driver install progress. a dialog will appear during this stage. If items are to be added to the MATLAB® path. If a driver has been selected for installation.2. LLC Installation Progress The installation will display a progress bar.

the firmware update will begin.® Install Guide bladeRF Windows 3. After pressing Enter. Progress messages will be displayed as the on-board flash is erased and reprogrammed. 3 https://github. Check Device Manager if it is unclear whether this has been done.com/Nuand/bladeRF/wiki/Upgrading-bladeRF-firmware#Upgrading_ using_the_FX3_bootloader 10 .8 Nuand. A message is displayed. the bladeRF will need to be unplugged and reconnected for the changes to take effect.2. Should one accidentally disconnect the device or encounter a failure. a console similar to the one shown below will appear. Information on re-flashing firmware while in this mode is available on the bladeRF wiki3 . the device will enter a recovery bootloader mode. LLC Firmware Update Progress If a firmware update was selected. indicating that the bladeRF to update should be connected to the system. After a firmware update. Connect a bladeRF and wait for Windows® to finish installing its driver. Do not disconnect the bladeRF until the console displays a message noting that this process has completed.

2. Adding bladeRF items to %PATH% will allow bladeRF-cli to be executed from cmd.dll 11 .exe.9 Nuand.® Install Guide bladeRF Windows 3. LLC System PATH At the end of the installation. and other programs to locate bladeRF. the following screen is presented.

LLC Installation Completed Upon completion of the previous steps. Important: You may need to log out and log back in order for changes to the System PATH and MATLAB® search path variables to take effect. 12 .2. the final screen is displayed.10 Nuand.® Install Guide bladeRF Windows 3.

2. info. and print commands. LLC Testing Basic Device Access A quick means of verifying that the installation has succeeded is to view information about a bladeRF using the bladeRF-cli program. information about the device may be obtained using the version. A shortcut to bladeRF-cli may be executed from the Start Menu location selected in Section 3. it can be executed from cmd. Sample output is shown below. 13 .® Install Guide bladeRF Windows 4 Nuand. Alternatively.1.exe as follows: bladeRF-cli -i Once in the command-line interface.

com 14 .2.4. then the following paths must be provided to the addpath4 function. ˆ C:\Program Files\bladeRF\x64 ˆ C:\Program Files\bladeRF\matlab Change C:\Program Files\bladeRF as necessitated by the installation location.1 MATLAB® Search Path If bladeRF items were not added to the MATLAB® search path in Section 3.mathworks. LLC MATLAB® and Simulink® 5 5.html?requestedDomain=www. 4 http://www.com/help/matlab/ref/addpath.® Install Guide bladeRF Windows Nuand. mathworks.

LLC RX GUI Demo A receive-only demo program implemented entirely in MATLAB® may be executed via the command: bladeRF rx gui As shown below.2 Nuand.® Install Guide bladeRF Windows 5. this program allows various parameters to be manipulated while viewing FFT plots and sample values in real time. 15 .

the libbladeRF API documentation5 may also be referenced for more detailed information.® Install Guide bladeRF Windows 5.dll. LLC Viewing Documentation For information about available device properties and functions.3 Nuand. Because the bladeRF MATLAB® support is implemented as a thin layer atop of bladeRF. run doc bladeRF. 5 https://nuand.com/bladeRF-doc/libbladeRF 16 .

4 Nuand. To add a bladeRF block to a model.com/help/vision/system-objects. 6 http://www.mathworks. select the MATLAB System block from the Library Brower: Once placed.® Install Guide bladeRF Windows 5. double click the System block to specify that it should implement a bladeRF Simulink object.html 17 . LLC Adding a bladeRF block to a Simulink® Model Simulink® support is implemented via a System Object6 .

As shown below. An input for the transmit path may be enabled in the TX Configuration tab. Double-click the block to open up the block parameters. 18 . LLC A bladeRF block will default to being receive-only. as denoted by only having an RX Samples output. with both RX and TX ports. the block may be configured for a full-duplex configuration.® Install Guide bladeRF Windows Nuand.

LLC Before running a simulation. the following settings must be applied: ˆ Select Simulate using: Devices tab Interpreted Execution in the block parameters ˆ Configure the model’s Solver Options for Fixed-Step.® Install Guide bladeRF Windows Nuand. with a discrete (no continuous state) Solver. 19 .