-
Notifications
You must be signed in to change notification settings - Fork 462
Getting started: Mac OSX
This guide describes the process of building and installing the bladeRF host libraries and tool for a Mac OSX system, and quickly getting a device up and running using pre-built firmware and FPGA images.
Install XCode from Apple, as you will need a compiler. This is available in the App Store.
If you plan to use graphical tools (i.e., GNU Radio Companion), ensure you have X11 installed. See the XQuartz project for additional information and instructions.
Next, install a package management system, such as MacPorts (another option is Homebrew).
The required redependencies are: libusb (with USB 3.0 support), pkgconfig, and cmake. The libtecla package is optional; it improves the bladeRF interactive console experience (adds history, vi-bindings, etc.).
With MacPorts, you can install these with:
$ sudo port install libusb pkgconfig cmake
Ensure that your shell configuration (e.g., .bashrc, .zshrc) contains the following items (adjusted accordingly):
export DISPLAY=:0.0
export PATH=/opt/local/bin:/opt/local/sbin:$PATH
export MANPATH=/opt/local/share/man:$MANPATH
export PYTHONPATH=/opt/local/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages:/opt/local/lib/python2.7/site-packages:${PYTHONPATH}
There is no portfile for libtecla currently, so MacPorts users will have to build libtecla from source.
If you're using Homebrew, install the dependencies via the following command. Note that you want to select libusbx.
$ brew install libusbx pkgconfig cmake libtecla
To obtain the latest source code for the first time, clone the Nuand git repository via:
$ git clone https://github.com/Nuand/bladeRF.git $ cd ./bladeRF
In the future, you can update the repository via:
$ git pull
First enter the directory containing the host source. Then create and enter a directory to perform the build in. By working out of the a 'build' directory, it's easy to later clean up, by simply removing 'build/'.
$ cd host/ $ mkdir build; cd build
Next, configure the build. In the below example, we:
- Set up a Debug build
- Specify that files should be installed into /usr/local
- You can install into a different location via the -DCMAKE_INSTALL_PREFIX=/some/desired/path option. Note that you'll need to need to configure binary and library search paths if you install elsewhere. If you're unsure how to do this, simply follow the steps below to use the default install location.
$ cmake -DCMAKE_BUILD_TYPE=Debug ../
The following commands:
- Perform the build
- Install files to /usr/local or the location specified by CMAKE_INSTALL_PREFIX
- Updated share library paths, so that libbladeRF can be found
$ make && sudo make install
Note that from this same directory, you can run the following to uninstall the files place on your system in the previous step.
sudo make uninstall
The install_manifest.txt file, created after running the install step successfully, lists all the files installed. It is a good idea to back up this file if you plan on removing this build directory later.
With the libraries and tools installed, we can now use the bladeRF-cli (command line interface) to probe for devices attached to the system.
First, take a look at the command-line options:
$ bladeRF-cli --help
- If you see the help text, you can skip ahead to the invocation with the -p option.
$ bladeRF-cli -p
Backend: libusb
Serial: f12ce1037830a1b27f3ceeba1f521413
USB Bus: 253
USB Address: 5
If you do not see any device listed:
- Double-check that device is plugged in and that the jumpers on J70 are populated correctly
- LED D1 should be illuminated
- Try looking in Command-Space 'System Information' to see your USB devices.
- Verify that you have libusb 1.0.17 (check with 'port installed | grep libusb')
- Try both USB 2.0 and 3.0 ports
More information about the attached device can be viewed while running bladeRF-cli in interactive mode. Enter this mode and issue the help command to see a list of available command. Use the info command to print information about the device, and version to view version information, most notably, the firmware:
$ bladeRF-cli -i bladeRF> help ... (Help text shown here ) ... bladeRF> info Serial #: f12ce1037830a1b27f3ceeba1f521413 VCTCXO DAC calibration: 0x9857 FPGA size: 115 KLE FPGA loaded: yes USB bus: 253 USB address: 5 USB speed: Hi-Speed Backend: libusb Instance: 0 bladeRF> version bladeRF-cli version: 0.7.0-git-74980ad-dirty libbladeRF version: 0.9.0-git-74980ad-dirty Firmware version: 1.4.0 FPGA version: 0.0.0
Here we see the device's serial number, DAC calibration, FPGA information, and USB connection information. Take note of the FPGA size, as this will help determine which FPGA file to load.
Support for loading the FPGA from flash automatically is currently supported and undergoing further testing. See the bladeRF-cli --help text for information on how to write an FPGA image to flash for autoloading.
For simplicity, this guide shows how to load the FPGA without storing it into flash for autoloading. (As a result, you'll have to load the FPGA each time the device is reset or plugged in.)
FPGA images can be obtained from the Nuand website or from a nightly build of "bleeding edge" images.
To load an image from the command line.
$ bladeRF-cli -l <path/to/fpga/file>
Or to load an image while in interactive mode:
bladeRF> load fpga <path/to/fpga/file>
After the FPGA loads, you should see LEDs on the board begin blinking. At this point, you're ready to start using your device!
The following command may be used to install GNU Radio via MacPorts, and any neccessary dependencies.
$ sudo port install gnuradio +grc +swig +wxgui +qtgui +python27
After the installation completes (it may take quite some time), you can verify the installation by starting XQuartz and then running gnuradio-companion.
The current gr-osmosdr portfile doesn't yet include libbladeRF support, and needs to be built from source.
To avoid conflicts between the native python and the MacPorts-supplied python, it is necessary to point gr-osmosdr to the desired python items. Be sure to adjust the python-related items in your CMake invocation for any differences. See the gr-osmosdr portfile as a reference.
h/t to Leonardo (@lvbernal) for identifying and pointing out the python caveats in his blog post.
$ git://git.osmocom.org/gr-osmosdr
$ cd gr-osmosdr
$ mkdir build
$ cd build
$ cmake -DPYTHON_EXECUTABLE=/opt/local/bin/python2.7 \
-DPYTHON_INCLUDE_DIR=/opt/local/Library/Frameworks/Python.framework/Versions/2.7/Headers \
-DPYTHON_LIBRARY=/opt/local/Library/Frameworks/Python.framework/Versions/2.7/Python \
-DGR_PYTHON_DIR=/opt/local/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages \
../
In the CMake output, you should see a nuand bladeRF entry in the gr-osmosdr enabled components list. Build and install via the following.
$ make $ sudo make install
Back up your install_manifest.txt for any future debugging or manual removal. You can run sudo make uninstall to remove the gr-osmosdr items.
Note: gr-osmosdr will be installed into /usr/local, with SWIG and python items in the python site-packages residing in /opt/local.
If you prefer that all gr-osmosdr items instead reside in the /opt/local prefix, append -DCMAKE_INSTALL_PREFIX=/opt/local to the CMake invocation shown above. Note that you may need to add export DYLD_FALLBACK_LIBRARY_PATH=/opt/local/lib to your shell runtime-config, to ensure that libgnuradio-osmosdr is located.
TO DO: Any Homebrew users mind filling this in?
See the Getting Started: Linux guide for some quick tests to verify device operation with GNU Radio.