Professional Documents
Culture Documents
Under NDA
NOTICE
This document contains proprietary and confidential material of ACTILITY SA. This document
is provided under and governed by either a license or confidentiality agreement. Any
unauthorized reproduction, use, or disclosure of this material, or any part thereof, is strictly
prohibited.
The material provided in this document is believed to be accurate and reliable. However, no
responsibility is assumed by Actility SA for the use of this material. Actility SA reserves the
right to make changes to the material at any time and without notice. This document is
intended for information and operational purposes only. No part of this document shall
constitute any contractual commitment by Actility SA.
Portions of this documentation and of the software herein described are used by permission
of their copyright owners.
Actility, ThingPark, are registered trademarks of Actility SA or its subsidiaries may also be
registered in other countries.
Other denoted product names of Actility SA or other companies may be trademarks or
registered trademarks of Actility SA or its subsidiaries, or their respective owners.
Headquarters
Actility Lannion,
Actility S.A 4 rue Ampère BP 30225
22300 Lannion France
www.actility.com
REFERENCE DOCUMENTS
Documents Author
WHAT’S NEW
NOTICE ............................................................................................................. 2
VERSIONS.......................................................................................................... 3
REFERENCE DOCUMENTS ....................................................................................... 3
WHAT’S NEW .................................................................................................... 3
TABLE OF CONTENTS ............................................................................................ 4
ACRONYMS AND DEFINITIONS ................................................................................ 5
1 SCOPE........................................................................................................ 7
2 THINGPARK SOLUTION OVERVIEW .................................................................... 8
3 LOGGING IN ................................................................................................ 9
4 INTERFACE OVERVIEW...................................................................................10
4.1 Updating the Network Manager ............................................................................... 10
4.2 Finding a Base Station ............................................................................................... 11
4.3 Listing all Base Stations............................................................................................. 12
4.4 Managing a Base Station ........................................................................................... 12
4.4.1 Main Parameters ................................................................................................ 13
4.4.2 Antenna Parameters .......................................................................................... 17
4.4.3 GPS Antenna Parameters ................................................................................... 21
4.5 Using the Test Mode.................................................................................................. 22
5 LOGGING OUT ............................................................................................24
ABOUT ACTILITY ................................................................................................25
Acronyms Definitions
ABP Activation By Personalization
ADR Adaptive Data Rate
AES Advanced Encryption Standard
AS Application Server
BPM Business Process Management
BSS Billing Support Systems
CSP Communication Service Provider
DC Duty Cycle
End Device A sensor or actuator
ESP Estimated Signal Power
ETSI European Telecommunications Standards Institute
HAN Home Area Network
HSM Hardware Security Module
IaaS Infrastructure As A Service
IEC International Electrotechnical Commission
IoT Internet of Things
ISM Industrial Scientific Medical
GSCL Gateway Service Capability Layer
GTM Go To Market
KPI Key Performance Indicator
LC Logical Channel
LoRaWAN™ Long Range Wide Area NW
LPWAN Low Power Wide Area Network
LRC Long Range Controller
LRR Long Range Relay
MAC Media Access Control
M2M Machine-2-Machine
MTBF Mean Time Before Failure
NAT Network Address Translation
The scope of this document is to provide users with guidelines on how to use the ThingPark
Wireless BS Commissioning tool. This tool is part of ThingPark Wireless TWA platform and
typically used by Base Station commissioners to complete the following tasks:
API Layer
User Portal Store (E-Shop) Operator Connectivity Address Usage Record Supervision, System OCP Edition SaaS Edition RMC
Manager Manager Manager Manager (UDR) Monitoring, Management
Alarms Platform (SMP)
BPM Engine Market
Drivers Connectors
4. Click Accept.
Note The Network Supplier credentials are required (similar to those used in the Network
Manager tool). Subscribers with access to the Network Manager do not have access to this
tool because it is designed for commissioners who are responsible for massive Base Stations
installation, and not for subscribers with a few Base Stations installation. All parameters and
features of this tool can also be found in the Network Manager. For more information, see the
ThingPark Wireless Supplier User Guide.
Once logged into the BS Commissioning portal, the following window appears:
In the previous version of the BS Commissioning tool (version 1.x, supporting ThingPark
Wireless 3.x), a lot of fields set in the tool were stored in the “Administrative info” field of the
Base Station on the Network Manager.
In ThingPark Wireless 4.x, with the new version of the Network Manager, only a few
information is now stored in the “Administrative Info” field, because a dedicated tab has been
created for antennas parameters.
Accordingly, to ease the migration of existing information in the “Administrative Info” field
towards their new respective fields in the Network Manager, the BS Commissioning tool
supports an “Updated Network Manager” feature. This feature is useful for Base Stations of
which the data was already filled by the previous version of the tool.
Once logged in with a Network Supplier account, you can access all Base Stations already
provisioned on this account.
To find a Base Station, use the search bar as illustrated in the following the Figure:
To display the Base Stations registered on the Network Supplier account, click on the top
left of the tool.
The maximum number of Base Stations displayed is configurable during the database
installation; it can also be modified after installation to display more or less Base Stations.
It is configurable in the following file:
/var/www/html/thingpark/usr/etc/tools/bs-commissioning/define.inc.php
// Maximum number of BS to display
define('BS_LIST_MAX', 20);
Important By default, only the first twenty Base Stations are displayed.
In the “BS List” window, the search criteria displays a list of one/several Base Stations. Each
Base Station is displayed with some associated information (illustrated by the example in
Figure 7):
Note Clicking on the right allows you to directly switch to the Base Station testing mode.
This is the view of the packets exchanged in real time between a test device and the concerned
Base Station. This functionality is detailed in section 4.5.
▪ Activation state: determines the LRR activation state by one of 4 different options:
o Initializing: initial configuration.
o Validating: this is the LRR state when it is created but still waiting for validation
by the Operator Manager.
o Suspended: LRR is validated and deactivated by the Operator Manager.
o Active: LRR is validated and activated.
▪ Connection state: determines the LRR connection state:
o Disconnected: Base Station is offline and not running.
o Connected: Base Station is up and running.
▪ Name: Base Station’s given name. When this field is modified in the BS Commissioning
tool, changes are automatically updated in the Network Manager, in the orange
rectangle in Figure 9 below.
Note It is possible to select the name from a drop-down list, if the list of LRR names is
predefined by the tool administrator.
▪ Address: Physical (geographical) address of the Base Station. When this field is
modified in the BS Commissioning tool, changes are automatically updated in the
Network Manager, in the green rectangle in Figure 9.
▪ Altitude Above Ground: Reference altitude of the Base Station above the ground level,
in meters. Note that it is also possible to the altitude above ground separately for each
antenna (please refer to section 4.4.2).
▪ MAC Address: MAC address of the Base Station. This value is stored in the
“Administrative Info” space in the Network Manager (see the blue rectangle in Figure
9).
▪ SIM Card IMEI & SIM Card ICC ID: valid for cellular backhaul configurations (ppp
interface). These fields are populated in WAN Backhaul details in the Network
Manager tool - see brown rectangle in Figure 9 and Figure 10.
▪ Type of Gateway: selected from a drop-down list: either V0, V2, V3…
Type of gateway Semtech gateway version
V0 V1.0
V2 V1.5
V3 V2
This value is stored in the “Administrative Info” space in the Network Manager (see the
blue rectangle in Figure 9).
Input parameters
▪ Antenna:
o Type: Omnidirectional / Directional / Undefined.
Note In addition to the antenna type, it is possible to select the antenna model
from a drop-down list, if the list of antennas is predefined by the tool
administrator. In this case, the antenna gain will be automatically filled
according to the antenna model (the relation between the antenna model and
its gain shall be defined in the antenna-list file).
o Gain (dBi): sets the antenna gain in dBi.
Note If the antenna model is selected from a predefined list, the antenna gain
cannot be set manually, as it is already defined in the antenna list.
o Horizontal HPBW (degrees): Angle between the half-power (-3 dB) points and
the main lobe (Half Power Beam Width).
Note Only applicable when Type=Directional.
o Azimuth (degrees): sets the azimuth of the antenna in degrees.
Note Only applicable when Type=Directional.
o Additional information: sets any additional information related to the antenna.
Under Non-Disclosure Agreement
Actility S.A. au capital de 744 810 € - 4 rue Ampère, 22300 Lannion, France
RCS St Brieuc 522 305 473, Siret 522 305 473 00012, TVA FR62522305473
ThingPark_Wireless_BS_Commissioning_User_Guide_Ed2 - 17
▪ Location:
o GPS latitude (WSG84 decimal degrees): sets the latitude of the antenna.
o GPS longitude (WSG84 decimal degrees): sets the longitude of the antenna.
o Altitude above sea level (m): sets the altitude of the antenna.
o Height above the ground level (m): sets the height of the antenna.
▪ Cable:
o Cable loss (dB): refers to the total losses that are introduced by cables/jumpers
as well as any additional losses between the LRR and the antenna (for instance,
external diplexer…).
The value of this parameter is directly set in the LRR software, in order for the
LRR to derive the target conducted TX power from the radiated power
configured in the Base Station.
o Cable delay (ns): refers to the total transmission delay (in nanoseconds)
introduced by the cables/jumpers as well as any additional delay between the
LRR and the physical antenna.
Note This delay is not round-trip delay, and is particularly important for geo-
localization.
It is either set according to field measurements, or based on datasheet
specifications for a given cable type and length.
▪ Environment:
o Propagation environment: this field determines the dominant environment
where the Base Station is installed. Possible choices are: Undefined
environment / Rural flat / Rural trees / Rural forest / Suburban / Tower / Urban
/ Urban dense. Knowledge of the propagation environment makes
troubleshooting of radio-related issues much simpler.
o Installation mode: This field determines whether the gateway is installed
outdoors or indoors. For outdoor installation, 2 typical modes exist: either the
gateway is installed on a building rooftop (typical for macro-cell deployments),
or it is installed below a building rooftop (for instance, on street furniture, lamp
posts…) like a small-cell deployment scenario. Knowledge of the installation
mode is useful to predict the average RF coverage of the cell, it also makes
troubleshooting of radio-related issues much simpler.
o Antenna configuration mode: records information about the nearest obstacles
and their distance in each direction in space. The clearance type is either
“cleared within 500m” (meaning there is no direct obstacle within a 500m
radius) or “obstacle blocking” (meaning there is an obstacle within 500m
radius, in which case the distance to the nearest obstacle may be recorded).
Knowledge of the obstacle blocking information is very interesting to predict
the average RF coverage of the cell, it also makes troubleshooting of radio-
related issues much simpler.
Output parameters:
Two output parameters are sent to the Base Station when modified:
▪ the gain
▪ the cable loss
These metrics are then pushed by the BS Commissioning tool towards the LRR in question to
configure the corresponding “Gain” and “cable loss” fields of the /usr/etc/lrr/custom.ini
file.
These fields are read by the LRR software to configure its conducted TX Power = LRR_Power –
Gain + cableloss:
Figure 14 – BS Commissioning tool: Updating the antenna gain and cable loss on the base station
When the Base Station answer has been received by the BS Commissioning tool, it displays
the following screen:
Figure 15 – BS Commissioning tool: antenna gain and cable loss updated on the base station
Important
▪ Once the data have been saved in the BS Commissioning tool, the antenna gain and
cable loss values shall be sent to the Base Station via a dedicated web-service of the
Network Manager API. This web-service requires the following pre-requisites:
o The Network Supplier must have the “Delegate Administration” rights.
o The LRR version of the Base Station has to be at least 2.2.17.
If any of the two pre-requisites mentioned above is not fulfilled, the tool shall set the
antenna gain and cable loss into the LRR directly through the LRC (via POST
commands), which is the approach adopted by the previous release of the BS
Commissioning tool (v1.11.3 and before).
While the BS Commissioning tool is waiting for the Base Station’s response saying these
values have been taken into account, the values are tagged “updating”.
The Base Station will stay in this mode until the answer coming from the Base Station
has been received by the BS Commissioning tool.
▪ If the value of the antenna gain and/or cable loss is different between the
“Administration info” space and the “Antennas” tab in the Network Manager (as per
Figures 17 and 18 below), the BS Commissioning tool takes the “Administration info”
setting as reference values; hence the display is illustrated by Figure 19:
Figure 17 – Network Manager tool: antenna gain set to 2 in the “Administration info” space
Figure 18 – Network Manager tool: antenna gain value stored is 3 in the “Antennas” tab
The Base Station also is tagged as “NM partially updated”, which means it needs to be
updated, as the antenna gain values are not the same:
To switch to the test mode and check if the Base Station is correctly receiving LoRaWAN™
messages, proceed as follow:
1. Click on the “Test” button:
3. Click to validate.
To select a specific device, click and select the device in the drop-down list.
To logout from the BS Commissioning tool, click on the top left of the application.
Actility is an industry leader in LPWAN (Low Power Wide Area) large scale infrastructure with
ThingPark™, the new generation standard-based M2M communication platform. Actility’s
ThingPark Wireless™ network provides long-range coverage for low-power sensors used in
SmartCity, SmartBuilding and SmartFactory applications. Actility also provides the ThingPark
X which provides big data storage for sensor data and exposes sensor function through an
open API allowing developers to provide vertical applications on top of rolled out sensors. To
help vendors transform their sensors, Actility provides the ThingPark IoT platform which
include embedded software solutions and cloud solutions to help devices connect to
innovative applications. Via the ThingPark Market, an online marketplace engine dedicated to
the IoT sensors, applications and network solutions, Actility enables the roll-out of new
innovative IoT services for sensor vendors and network solution vendors. Actility is a founding
member of the LoRa Alliance™: the largest, most powerful standards-based effort to enable
the Internet of Things (IoT). Visit www.actility.com.
LoRaWAN™, the LoRa Alliance™, and LoRa Alliance Certified™ are trademarks of Semtech
Corporation, used with permission under a sublicense granted to the LoRa Alliance™ and its
members.