Jump to: navigation, search

Difference between revisions of "LimeSDR Quick Start"

(Assemble the hardware)
(Update for physical cabling, firmware update, and other additional details.)
 
Line 1: Line 1:
So you've received your LimeSDR board... what next? This page is intended to help you get up and running as quickly as possible.
+
This page is designed to help new owners of LimeSDR hardware get started as quickly as possible.  
  
== Assemble the hardware ==
+
== Assembling the hardware ==
  
 
[[File:LimeSDR-USB_acrylic_case_asembly.jpg|700px]]
 
[[File:LimeSDR-USB_acrylic_case_asembly.jpg|700px]]
  
Unless you have U.FL to SMA cables for all the RF ports on the LimeSDR — and optionally a suitable case — decide which RF ports you are going to connect to.
+
The LimeSDR comes with multiple RF ports, to which U.FL to SMA cables can be connected. Not all of these ports need to be used simultaneously, and your first step is to decide which of the ports you need to connect for your particular use case - along with, optionally, choosing a case compatible with the number of ports you are going to use.
 +
 
 +
The below table explains the difference between each port on the LimeSDR.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 46: Line 48:
 
Note that:  
 
Note that:  
  
* optimal RX performance is provided by using the *_H and *_L ports with the frequency bands shown
+
* Optimal RX performance is provided by using the *_H and *_L ports with the frequency bands shown;
* the secondary TX ports for each channel can be used with power amplifiers covering different bands and for loopback etc.
+
* The secondary TX ports for each channel can be used with power amplifiers covering different bands as well as for loopback, etc.;
* which ports are used is selected in software
+
* You will need to select which ports you have chosen when configuring your software.
  
  
If you have a LimeSDR Acrylic Case see the [https://github.com/myriadrf/LimeSDR-USB_acrylic_case#assembly assembly instructions].
+
If you have the official LimeSDR Acrylic Case, see the [https://github.com/myriadrf/LimeSDR-USB_acrylic_case#assembly assembly instructions here].
  
== Connect to your computer ==
+
== Connecting to your computer ==
  
 
[[File:USB3 cable.jpg]]
 
[[File:USB3 cable.jpg]]
  
Depending on which board variant you have, it will require one of the following '''USB 3.0''' cables:
+
Depending on which LimeSDR board variant you have, it will require one of the following '''USB 3.0''' cables:
  
 
* Type A plug to Type Micro B plug
 
* Type A plug to Type Micro B plug
 
* Type A plug to A socket
 
* Type A plug to A socket
 +
 +
Note that the LimeSDR is a powerful device, and may not receive the power it needs from a single USB port. The use of a Y-splitter, which uses one Type A plug for power and data and a second Type A plug for additional power, is recommended; users of portable devices like the Apple MacBook Air or Microsoft Surface families, which have USB ports on opposite sides of the device, may also require a USB extension cable which should be connected to the secondary, power-only, leg of the Y-splitter.
  
 
== Install Lime Suite ==
 
== Install Lime Suite ==
Line 66: Line 70:
 
[[File:lime_suite_comps.png|700px]]
 
[[File:lime_suite_comps.png|700px]]
  
Lime Suite provides an SDR driver and a configuration GUI, along with numerous utilities. Support is provided for the following platforms:
+
Lime Suite provides an SDR driver and a configuration interface along with numerous utilities. Support is provided for the following platforms:
  
* Linux (Ubuntu packages)
+
* GNU/Linux, including official packages for Ubuntu Linux;
* Mac OS X (Homebrew)
+
* Apple macOS via Homebrew;
* Windows (PothosSDR Installer)
+
* Microsoft Windows via the PothosSDR Installer.
  
 +
Lime Suite can be installed by compiling from source or via binary packages. Note that in the case of Windows a hardware driver must also be installed as a separate part of the process.
  
It can be installed from source or via packages/installler. Note that a O/S driver must also be installed on Windows.
+
For further details see the [[Lime Suite|Lime Suite documentation]].
  
For further details see [[Lime Suite|Lime Suite documentation]].
+
== Testing the LimeSDR ==
 
+
== Test ==
+
  
 
[[File:LimeSDR-USB SelfTest FFT.jpg|700px]]
 
[[File:LimeSDR-USB SelfTest FFT.jpg|700px]]
  
=== Basic operation ===
+
=== Updating the firmware and gateware ===
 +
 
 +
The LimeSDR relies on firmware and gateware loaded onto its FPGA to operate, collectively known as the firmware. This firmware is constantly updated to improve the LimeSDR's functionality and reliability, and running the latest version is recommended.
 +
 
 +
To update the LimeSDR's firmware, as well as to test the communication between the host PC and the LimeSDR, open your operating system's command-line interface and run the following command:
 +
 
 +
<code>
 +
LimeUtil --update
 +
</code>
 +
 
 +
This will update both the firmware and the gateware on the LimeSDR to the version supplied with your copy of Lime Suite. Do not disconnect the LimeSDR during the update process.
 +
 
 +
=== Testing basic operations ===
  
Low level testing of RX and TX directly via the Lime Suite GUI in [[LimeSDR-USB Quick Test]]. The loopback test described is the simplest and most direct way of confirming that you have a functioning board with appropriate USB controller firmware and FPGA gateware loaded.
+
Instructions for carrying out a loopback test using Lime Suite are available on the page [[LimeSDR-USB Quick Test]]. This loopback test is the simplest and most direct way of confirming that you have a functioning board with appropriate USB controller firmware and FPGA gateware loaded.
  
=== SoapySDR ===
+
=== Testing via SoapySDR ===
  
The [[Lime_Suite#Device_enumeration|Lime Suite wiki page explains how]] LimeUtil can be used to get a list of available devices, and SoapySDRUtil to verify that it will be available to SDR ecosystem applications via SoapySDR.
+
The [[Lime_Suite#Device_enumeration|Lime Suite wiki page]] explains how LimeUtil can be used to get a list of available devices and SoapySDRUtil to verify that it will be available to SDR ecosystem applications via SoapySDR. Providing the LimeSDR is listed by SoapySDRUtil, you are ready to begin working with it using the compatible software of your choice.
  
 
{{Community}}
 
{{Community}}

Latest revision as of 14:50, 21 February 2018

This page is designed to help new owners of LimeSDR hardware get started as quickly as possible.

1 Assembling the hardware

LimeSDR-USB acrylic case asembly.jpg

The LimeSDR comes with multiple RF ports, to which U.FL to SMA cables can be connected. Not all of these ports need to be used simultaneously, and your first step is to decide which of the ports you need to connect for your particular use case - along with, optionally, choosing a case compatible with the number of ports you are going to use.

The below table explains the difference between each port on the LimeSDR.

LimeSDR-USB RF ports
Label Description
RX1_H Channel 1 RX - frequencies above 1.5GHz
RX2_H Channel 2 RX - frequencies above 1.5GHz
RX1_L Channel 1 RX - frequencies below 1.5GHz
RX2_L Channel 2 RX - frequencies below 1.5GHz
RX1_W Channel 1 RX - wideband
RX2_W Channel 2 RX - wideband
TX1_1 Channel 1 TX - primary (all frequencies)
TX2_1 Channel 2 TX - primary (all frequencies)
TX1_2 Channel 1 TX - secondary (all frequencies)
TX2_2 Channel 2 TX - secondary (all frequencies)

Note that:

  • Optimal RX performance is provided by using the *_H and *_L ports with the frequency bands shown;
  • The secondary TX ports for each channel can be used with power amplifiers covering different bands as well as for loopback, etc.;
  • You will need to select which ports you have chosen when configuring your software.


If you have the official LimeSDR Acrylic Case, see the assembly instructions here.

2 Connecting to your computer

USB3 cable.jpg

Depending on which LimeSDR board variant you have, it will require one of the following USB 3.0 cables:

  • Type A plug to Type Micro B plug
  • Type A plug to A socket

Note that the LimeSDR is a powerful device, and may not receive the power it needs from a single USB port. The use of a Y-splitter, which uses one Type A plug for power and data and a second Type A plug for additional power, is recommended; users of portable devices like the Apple MacBook Air or Microsoft Surface families, which have USB ports on opposite sides of the device, may also require a USB extension cable which should be connected to the secondary, power-only, leg of the Y-splitter.

3 Install Lime Suite

Lime suite comps.png

Lime Suite provides an SDR driver and a configuration interface along with numerous utilities. Support is provided for the following platforms:

  • GNU/Linux, including official packages for Ubuntu Linux;
  • Apple macOS via Homebrew;
  • Microsoft Windows via the PothosSDR Installer.

Lime Suite can be installed by compiling from source or via binary packages. Note that in the case of Windows a hardware driver must also be installed as a separate part of the process.

For further details see the Lime Suite documentation.

4 Testing the LimeSDR

LimeSDR-USB SelfTest FFT.jpg

4.1 Updating the firmware and gateware

The LimeSDR relies on firmware and gateware loaded onto its FPGA to operate, collectively known as the firmware. This firmware is constantly updated to improve the LimeSDR's functionality and reliability, and running the latest version is recommended.

To update the LimeSDR's firmware, as well as to test the communication between the host PC and the LimeSDR, open your operating system's command-line interface and run the following command:

LimeUtil --update

This will update both the firmware and the gateware on the LimeSDR to the version supplied with your copy of Lime Suite. Do not disconnect the LimeSDR during the update process.

4.2 Testing basic operations

Instructions for carrying out a loopback test using Lime Suite are available on the page LimeSDR-USB Quick Test. This loopback test is the simplest and most direct way of confirming that you have a functioning board with appropriate USB controller firmware and FPGA gateware loaded.

4.3 Testing via SoapySDR

The Lime Suite wiki page explains how LimeUtil can be used to get a list of available devices and SoapySDRUtil to verify that it will be available to SDR ecosystem applications via SoapySDR. Providing the LimeSDR is listed by SoapySDRUtil, you are ready to begin working with it using the compatible software of your choice.