Amarisoft Software Install Guide
Amarisoft Software Install Guide
Version: 2020-09-14
i
Table of Contents
1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.1 Background . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
2 Install Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
2.1 Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
2.2 Computer Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
2.3 Hardware Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.4 Installation Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.5 How to retrieve a fixed license key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.5.1 LTE 100 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.5.2 LTE UE 100 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.5.3 Fixed License Files generation and install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.6 How to use the floating licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.6.1 License server installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.6.2 Connecting a component to license server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.7 Getting license from a USB dongle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.8 RF driver configuration for multiple SDR card setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4 Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
5 Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
5.1 Contact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
6 Additional Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
1
1 Introduction
This document describes how to install and use your software binary LTE 100 and LTE UE 100.
It explains basic install procedure and where to find software. For advanced use, please refer to
software documentations.
1.1 Background
The LTE 100 product includes the following components:
• lteue: This component is a LTE UE simulator. It simulates one or more UEs by commu-
nicating through a RF system with an eNodeB and core network.
• trx_<name>: This component is your radio frontend driver where <name> represents your
radio frontend type. Examples are trx_sdr for PCIe SDR card and trx_uhd for USRP
SDR cards.
• www: this component is in charge of web interface to Amarisoft LTE software. It allows you
to control the software and visualize logs.
Note that each component has a doc directory where you can find its documentation. Alter-
natively, all documentations are available for download in our Extranet.
2
2 Install Guide
2.1 Requirements
Before proceeding, make sure that you have:
• A fast PC. For best performances, a quad core Intel Core i7 CPU with AVX2 support
(Haswell architecture or later) running at a clock of 3.6 GHz is recommended.
• Appropriate hardware interface(s) to connect your Radio front head, i.e:
− PCIe port (minimum 1x gen 2) per PCIe SDR card
− One Gigabit Ethernet port per USRP device such as N2x0
− One USB 3.0 port per USRP device such as B2x0
− One 10 Gigabit Ethernet port per USRP device such as X3x0
• Root privileges to be able to install and run the software.
• A 64 bit Linux distribution. Fedora 30 is the officially supported distribution.
The following distributions are known as compatible:
• Fedora 17 to 30
• Cent OS 7
• Ubuntu 12 to 18
• Internet access as new packages might be required to get installed on your PC.
For computer setup in Fedora, follow the following setups. For other Linux distributions, you
should find the similar commands.
• Install Fedora ISO image and create admin and user accounts:
• Install and launch openssh
− dnf -y install openssh
− systemctl enable sshd
− service sshd start
− service sshd status
• Disable firewall
− systemctl disable firewalld
− service firewalld stop
• Disable Selinux
− perl -p -i -e "s/enforcing/disabled/" /etc/selinux/config
− or edit the file /etc/selinux/config and edit the line Selinux to SElinux = disabled
• Disable graphical GUI
− sudo systemctl enable multi-user.target –force
− sudo systemctl set-default multi-user.target
Chapter 2: Install Guide 3
• Put this file on the PC at any place using the method you want (scp, http, USB key...) and
extract it:
• As root, Go to the directory YYYY-MM-DD and execute the provided script install.sh as
follows:
− By default if no <path> is specified, components are installed in /root, you can choose
other directories by specifying a new destnation in <path>. Please note that www
component will always be located under /var/www/html in Fedora or /var/www in
Ubuntu.
− The --default option forces answer to default for all questions asked during install
phase. The default answers for LTE 100 are depicted below:
Take a look at messages at the end of install phase, you may be requested to power on/off
your PC. This would be the case if there is, for example, an FPGA upgrade of your PCIe
SDR card.
If you would like to have a custom install, you can run the script without --default option
and answer each question separately. For LTE 100 product, this would typically be the case
if you do not want to enable automatic LTE service or if you would like to install eNB and
MME components on different PCs.
Once the installation phase is completed, you will need license files to use your system.
Depending on the purchased license type, there are different ways to activate your system:
• Fixed license : Each license delivered is dedicated to one specific PC. There is no possibility
to share the keys or move to another setup. The installation procedure is described in
chapter 2.4.
• Floating license with license server: The second method consists in using a floating license
provided by a license server. This mechanism is relevant when you want to timeshare
the license between different hardware or users or when the system is running on virtual
machines. The installation procedure is described in chapter 2.5.
• Floating license in USB dongle: The third mechanism consists in using a floating license
embedded in a USB dongle . It’s also relevant for time sharing but less convenient than
a floating license running on a server when it comes to the mobility. The installation
procedure is described in chapter 2.6.
• Send this hexadecimal code by email to [email protected]. License key files will
be generated in Amarisoft Extranet. You will get an email when they are available for
download.
• Downloaded your license key files from our Extranet. You need to have an active account to
connect to our Extranet. If you do not have one, send an email to [email protected]
to request one.
• Create a directory called .amarisoft under ${HOME} where ${HOME} is the home directory
of the root user. (exemple /root/.amarisoft )
• Copy the license files inside .amarisoft directory.
Once the license key files are installed, you need to restart the system.
• Under this directory, create a license server.cfg file and add the license server parameters :
Example :
{
license_server: {
server_addr: "192.168.1.1"
}
}
• Then change the server addr value with the IP address of your license server .
If the USB is not mounted automatically, you can do it manually by following the steps below:
1. Detect the USB hard disk drive
As root , type "fdisk -l" once the USB dongle is plugged
You should see a new Device enumerated with name "/dev/sdxx"
example: /dev/sdb1 * 56 15974399 15974344 7.6G b W95 FAT32
2. Create a mount point with command: mkdir <dir_name>
example: "mkdir /media/usb-drive"
3. Mount USB drive with command: mount <source=device_name> <directory>
example: "mount /dev/sdb1 /media/usb-drive"
The USB dongle should now be detected and amarisoft components should be able to get
the license keys from the dongle
Chapter 2: Install Guide 9
When your setup is composed of several SDR PCIe cards, the mapping between the PCIe
connectors and the Linux devices is not predictable (but it should not change after each boot).
Ideally, the mapping should follow the PCIe slot position and should result in :
PCIe slot#0=>dev/sdr0
PCIe slot#1=>dev/sdr1
PCIe slot#2=>dev/sdr2
etc ..
Unfortunately, this is not always the case. As a consequence, the first time you boot your
system, you have to identify the position of the SDR cards by following the steps below and
force the "sdr mapping" in order to align the linux device names and their physical positions.
To do so:
In that case, you need to force the sdr mapping by following the steps below :
5. As root, create the file /etc/sdr-mapping
6. Edit the file and fill it with the sdr mapping identified thanks to the steps above
In this example, the file shoud be filled this way:
04321
7. Reload the RF driver by doing a power cycle of the box (a soft reboot is not enough)
After the power cycle, you can verify that SDR mapping is OK now by repeating the steps
1,2,3,4.
Note: This procedure must be run each time a SDR card is added or remove
For more details , please refer to trx sdr.pdf documentation
11
Example:
Create a my-ots.cfg file and put the following inside:
# Include default configuration
source ots.default.cfg
Next sections show you basic methods. For more information please refer to screen docu-
mentation (https://www.gnu.org/software/screen/manual/screen.html).
Chapter 3: Initial Test and Setup 12
You can also switch to next window:
ctrl+a <space>
Each component screen offers a list of commands that can be used either to get status
or trigger action. Each of them are documented in the component documentations (example
lteenb.pdf) or inline with the "help" command
3.3 UE 100
This section only applies to UE 100 product with automatic LTE service.
For more information please refer to screen documentation (https: / / www . gnu . org /
software/screen/manual/screen.html).
3.4.1 Status
You can check the LTE service status this way:
service lte status
The command will return "active (running)" status if service is running
3.4.2 Stop
You can stop all LTE components this way:
service lte stop
3.4.3 Start
You can start them again this way:
service lte start
3.4.4 Disable
You may also prevent them to start at boot time:
systemctl disable lte
3.4.5 Enable
You may enable service at boot time this way:
systemctl enable lte
3.5.1 UE 100
This section only applies to UE 100 with automatic LTE service.
The LTE automatic service starts UE Simulator with the following config:
• UE /root/ue/config/ue.cfg
In order to change the configuration, you have to:
• Edit the ue.cfg file to change the configuration.
• restart the LTE service by typing service lte restart
For more details on config files, please refer to UE Simulator documentation.
You can change those links if you need to change software version to use.
15
4 Logging
Components put their current logs in /tmp directory. However, you can also have access to a
Web tool on the following URL that helps you visualize the logs as well as some useful stats for
real time analysis.
To get access to this log , open a web browser (Chrome or Firefox) on you remote PC and
connect to http://<my IP>/lte/ ,where my IP is the IP address of your PC where the Amarisoft
software is running.
This will open a web page composed of three panels.
To display log and/or interact with Amarisoft software, you need to add a client (click Add
server button as shown in picture below) The list of your client is displayed on left panel of
the interface.
Enter name you want to appear on client panel, set the IP address of your component PC
and the port of your software component.
*Note : each software component uses a specific port. To know this value, look at com addr
value in its configuration file (example ims.cfg).
Format is : com addr: "<IP Address>:<Port Number>"
Where <IP Address> is the IP address of the WebSocket server remote API and <port Number>
the port on which it listens. The WebSocket server for remote API will be enabled and bound
to this address and port number.
The default values used in configuration files are:
in /root/mme/config/ims.cfg , com_addr: "0.0.0.0:9003"
in /root/mme/config/mme.cfg , com_addr: "0.0.0.0:9000"
16
Port 9003 is used for IMS , 9000 for MME and 9001 for eNB.
Note: 0.0.0.0 will make remote API reachable from any network interface.
After clicking on Create button, the client will try to connect. If connection is successful,
the configuration window will appear so that you configure logs:
For each layer you can define a level of trace, from None to Debug (which gives the highest
verbosity for the layer) :
• Filter. This is the level of log that will be downloaded to the GUI.
• Level. This is the level of log on the component, as defined in log_options of its configu-
ration file) and will override its configuration.
As a result, each time the client connects to the component, it will apply the configuration,
overriding its current config.
• Max size. Log data size as defined in log_options of its configuration file.
Of course, you can keep default configuration and simply click on Update.
The icon means the client is not connected whereas means the client is connected.
When connected, a new tab will appear in main tab panel and provide you advanced features.
NOTE : If the client fails to connect and start logging , please check that HTTPD service
ing on your component PC
service httpd status
5 Troubleshooting
Below are some of the most common issues encountered during install phase with recommended
actions to address each issue.
Issue Cause/Correction
Could not load ./trx_uhd.so’ Fedora 23 and Ubuntu 16 are using C++11 ABI and
(Operation not supported) thus UHD driver is not compatible. If you are in this
case, please edit your RF config file and update name
of RF driver part from uhd to uhd_cxx11.
trx_lms7002m.cpp:30:28: fatal You need to first install LMS Suite available in URL
error: lime/LimeSuite.h: No such https://wiki.myriadrf.org/Lime_Suite.
file or directory
TRX discontinuity too wide seen af- The most likely explanation is that not enough CPU
ter running eNodeB time is available. Below is a check list:
• Run lte_init.sh script available under enb and
ue directories.
• Run the Linux top - H command to check if there
is not any process taking the CPU.
• Remove unnecessary drivers and peripherals such
as WiFi dongle.
• If you use a HDMI monitor, remove it and access
the system remotely by SSH for instance.
• Ensure that your CPU is fast enough. It should be
at least a Intel 4 Core i7 with a clock running at
3.6 GHz.
• Remove unused daemons or cron jobs.
PC crashes or freezes during install If you use PCIe card, below is a list to check:
phase or few seconds after running the • Make sure your PCIe card is correctly inserted in
SW the slot. Sometimes a loose card could lead to PC
freeze or software crash.
• Change the slot of your PCIe card in case there is
an issue with this particular slot.
• Check the version of your PCIe bus. You need a
PCIe bus 1x generation 2. You can check it by
typing the Linux commend lspci --vv and look-
ing at a line with LnkCtl2: Target Link Speed.
The generation of your PCIe bus could be iden-
tified by its speed: Data Transfer Rate: PCIe
3.0 = 8.0GT/s, PCIe 2.0= 5.0GT/s, PCIe 1.1 =
2.5GT/s.
Chapter 5: Troubleshooting 18
Install script returns the following This error means that the driver module is not com-
error message when using PCIe SDR patible with the kernel version of your PC. You should
card: rebuild and reload the driver as below. Make sure you
insmod: ERROR: could not insert reboot the system.
module sdr.ko: Invalid module cd /root/trx_sdr/kernel
format. make clean
make
./init.sh
Install script returns the following This error comes from the Linux kernel because you are
error message when using PCIe SDR trying to load an unsigned SDR driver. It means that
card: secure boot is activated. You should go to the BIOS
nsmod: ERROR: could not insert settings and deactivate it.
module sdr.ko: Required key not
available.
5.1 Contact
• Our Extranet site is located at extranet.amarisoft.com. This site would give you access
to our documentation and new releases.
• For all technical issues, you can create a ticket describing your problem on our support site
at support.amarisoft.com. Please note that you need to have an active account in our
Extranet in order to be able to login to our support site. Your credentials are the same as
the ones you use to access Extranet.
• our FTP server is located at ftp.amarisoft.com. This server should be used to exchange
big logs. Your credentials are the same as the ones you use to access Extranet. Please note
that you need to use an FTP client supporting SSL such as Filezilla.
• For any request concerning license delivery or addition of new accounts, please send an
email to [email protected].
19
6 Additional Information
This document is copyright (C) 2012-2020 Amarisoft. Its redistribution without authorization
is prohibited.
This document is available without any express or implied warranty and is subject to change
without notice. In no event will Amarisoft be held liable for any damages arising from the use
of this document.
For any technical issue, please raise a ticket at our support side at support.amarisoft.com.
To learn more about our technology and solutions, e-mail us at [email protected] or
visit www.amarisoft.com.