Jump to: navigation, search

Difference between revisions of "Lime Suite"

(Building LimeSuite)
(Building LimeSuite)
Line 7: Line 7:
  
  
== Building LimeSuite ==
+
== Get the dependencies ==
 
+
=== Install dependencies ===
+
  
 
The dependencies required change based on how much of the suite will be used.
 
The dependencies required change based on how much of the suite will be used.
Line 42: Line 40:
 
|}
 
|}
  
==== Ubuntu ====
+
=== Ubuntu ===
  
 
<pre>
 
<pre>
Line 50: Line 48:
  
 
#install core library and build dependencies
 
#install core library and build dependencies
sudo apt-get install g++ cmake libsqlite3-dev
+
sudo apt-get install git g++ cmake libsqlite3-dev
  
 
#install hardware support dependencies
 
#install hardware support dependencies
Line 59: Line 57:
 
</pre>
 
</pre>
  
==== Windows ====
+
=== Windows ===
  
 
Users building LimeSuite on windows will need a recent visual studio compiler, preferable 2015.
 
Users building LimeSuite on windows will need a recent visual studio compiler, preferable 2015.
 
Other dependencies can be obtained from the following download links:
 
Other dependencies can be obtained from the following download links:
  
 +
* Git for windows - https://git-for-windows.github.io/
 
* CMake - https://cmake.org/download/
 
* CMake - https://cmake.org/download/
 
* wxWidgets  - https://www.wxwidgets.org/downloads/
 
* wxWidgets  - https://www.wxwidgets.org/downloads/
 
* CyUSB - http://www.cypress.com/documentation/software-and-drivers/ez-usb-fx3-software-development-kit
 
* CyUSB - http://www.cypress.com/documentation/software-and-drivers/ez-usb-fx3-software-development-kit
 
** It may be easier to download "cy_ssusbsuite_*.zip" rather than the full SDK
 
** It may be easier to download "cy_ssusbsuite_*.zip" rather than the full SDK
 +
 +
== Building LimeSuite ==
  
 
=== Build on unix ===
 
=== Build on unix ===
Line 81: Line 82:
 
make -j4
 
make -j4
 
sudo make install
 
sudo make install
 +
</pre>
 +
 +
Post install step **linux-only**. Install the udev rules. This enabled non-root users to access usb-based devices like the LimeSDR:
 +
 +
<pre>
 +
cd LimeSuite/
 +
udev-rules
 +
sudo ./install.sh
 
</pre>
 
</pre>
  
 
=== Build on windows ===
 
=== Build on windows ===
  
TODO
+
After installing the dependencies, open a cmd prompt and run the following command to clone the repository:
 +
 
 +
<pre>
 +
git clone https://github.com/myriadrf/LimeSuite.git
 +
</pre>
 +
 
 +
Now use cmake-gui or cmake command line to configure the project and to generate a visual studio project solution.
 +
The following settings are an example on how to specify the dependencies (cmake command line or gui),
 +
your installation directories may vary:
 +
 
 +
<pre>
 +
-DWX_ROOT_DIR=C:/wxWidgets-3.1.0
 +
-DwxWidgets_ROOT_DIR=C:/wxWidgets-3.1.0
 +
-DwxWidgets_LIB_DIR=C:/wxWidgets-3.1.0/lib/vc140_x64_lib
 +
-DFX3_SDK_PATH=C:/EZ-USB FX3 SDK/1.3
 +
-DSoapySDR_DIR=C:/PothosSDR
 +
</pre>
  
=== Install udev rules (linux) ===
+
Build the generated visual studio project solution.
  
 
== LimeSuite binaries ==
 
== LimeSuite binaries ==

Revision as of 02:49, 20 May 2016

1 Welcome to Lime Suite

Lime Suite is a collection of software supporting several hardware platforms including the LimeSDR, drivers for the LMS7002M transceiver RFIC, and other tools for developing with LMS7-based hardware.

1.1 Supported hardware

1.2 Get the dependencies

The dependencies required change based on how much of the suite will be used. LimeSuite will automatically try and build all components that it can satisfy the dependencies for. The following table is a guide to the the requirements for various components.

Component Dependencies Notes
Core library sqlite3 Has embedded copy for windows
LMS7 GUI wx widgets & OpenGL Has embedded GL for windows
LimeSDR libusb 1.0/CyAPI Use CyAPI for windows
NovenaRF7 i2c and spi dev Linux only device
SoapyLMS7 SoapySDR SDR app ecosystem support

1.2.1 Ubuntu

#packages for soapysdr available at myriadrf PPA
sudo add-apt-repository -y ppa:myriadrf/drivers
sudo apt-get update

#install core library and build dependencies
sudo apt-get install git g++ cmake libsqlite3-dev

#install hardware support dependencies
sudo apt-get install libsoapysdr-dev libi2c-dev libusb-1.0-0-dev

#install graphics dependencies
sudo apt-get install libwxgtk3.0-dev freeglut3-dev

1.2.2 Windows

Users building LimeSuite on windows will need a recent visual studio compiler, preferable 2015. Other dependencies can be obtained from the following download links:

1.3 Building LimeSuite

1.3.1 Build on unix

The following commands will clone the LimeSuite repository, configure the project using CMake, build the project, and install it. The output of the cmake command will show enabled and disabled components. Pay careful attention to this before building with make.

git clone https://github.com/myriadrf/LimeSuite.git
cd LimeSuite
mkdir builddir && cd builddir
cmake ../
make -j4
sudo make install

Post install step **linux-only**. Install the udev rules. This enabled non-root users to access usb-based devices like the LimeSDR:

cd LimeSuite/
udev-rules
sudo ./install.sh

1.3.2 Build on windows

After installing the dependencies, open a cmd prompt and run the following command to clone the repository:

git clone https://github.com/myriadrf/LimeSuite.git

Now use cmake-gui or cmake command line to configure the project and to generate a visual studio project solution. The following settings are an example on how to specify the dependencies (cmake command line or gui), your installation directories may vary:

-DWX_ROOT_DIR=C:/wxWidgets-3.1.0
-DwxWidgets_ROOT_DIR=C:/wxWidgets-3.1.0
-DwxWidgets_LIB_DIR=C:/wxWidgets-3.1.0/lib/vc140_x64_lib
-DFX3_SDK_PATH=C:/EZ-USB FX3 SDK/1.3
-DSoapySDR_DIR=C:/PothosSDR

Build the generated visual studio project solution.

1.4 LimeSuite binaries

1.4.1 Ubuntu PPA

1.4.2 Windows

1.4.3 OSX homebrew

1.5 LimeSDR notes

1.5.1 CyUSB driver (windows)

1.5.2 Locating the LimeSDR

1.5.3 Updating firmware/FPGA