TP-Wireless-5.2.2-Network Manager User Guide-Rev2
TP-Wireless-5.2.2-Network Manager User Guide-Rev2
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
01 ThingPark Wireless Supplier User Guide Actility
02 ThingPark Wireless Device Manager User Guide Actility
03 ref-tpw5.2-alarms-base-stations Actility
04 ThingPark Wireless BS-Commissioning User Guide Actility
05 ThingPark Wireless Radio Parameters User Guide Actility
06 ThingPark Wireless Operator User Guide Actility
07 ThingPark Wireless Spectrum Analysis User Guide Actility
WHAT’S NEW
NOTICE ............................................................................................................. 2
VERSIONS.......................................................................................................... 3
REFERENCE DOCUMENTS ....................................................................................... 4
WHAT’S NEW .................................................................................................... 4
TABLE OF CONTENTS ............................................................................................ 5
ACRONYMS AND DEFINITIONS ................................................................................ 7
SCOPE.......................................................................................................10
THINGPARK SOLUTION OVERVIEW ...................................................................11
LOGGING INTO THE NETWORK MANAGER ..........................................................12
3.1 Prerequisites .............................................................................................................. 12
3.2 Supplier Access .......................................................................................................... 12
3.3 Subscriber access ....................................................................................................... 13
USING THE GRAPHICAL USER INTERFACE ............................................................15
4.1 Searching Base Stations ............................................................................................. 15
4.2 Base Stations List ....................................................................................................... 16
CREATING A NEW BASE STATION .....................................................................19
VIEWING/EDITING A BASE STATION .................................................................23
6.1 Main Frame................................................................................................................ 23
6.1.1 Indicators Frame ................................................................................................ 24
6.1.2 Uplink/Downlink Packets Frame ........................................................................ 27
6.1.3 Ownership Frame ............................................................................................... 28
6.1.4 Status Frame....................................................................................................... 28
6.2 Base Station Antennas ............................................................................................... 28
6.3 Base Station System .................................................................................................. 33
6.4 Base Station RF Cell Information ............................................................................... 34
6.5 Base Station WAN Backhaul Information .................................................................. 39
6.5.1 Backhaul statistics between LRR and LRC-cluster .............................................. 39
6.5.2 Per-interface backhaul statistics ........................................................................ 41
6.5.3 IEC uplink Queue ................................................................................................ 43
6.5.4 Other WAN indicators ........................................................................................ 43
Under Non-Disclosure Agreement
Actility S.A. au capital de 1 122 916 € - 4 rue Ampère, 22300 Lannion, France
RCS St Brieuc 522 305 473, Siret 522 305 473 00012, TVA FR62522305473
TP_Wireless_5.2.2-rev2_Network_Manager_User_Guide.docx- 5
6.6 Administering Base Station ....................................................................................... 43
6.6.1 Settings ............................................................................................................... 44
6.6.2 Maintenance ...................................................................................................... 45
6.6.3 Configuration ...................................................................................................... 47
6.6.4 Advanced Maintenance ..................................................................................... 49
6.6.5 Backup Configuration ......................................................................................... 55
6.7 Base Stations Tagging ................................................................................................ 55
6.7.1 Prerequisites....................................................................................................... 56
6.7.2 Tagging a Base Station........................................................................................ 56
6.7.3 Tagging Multiple Base Stations .......................................................................... 57
6.7.4 Searching for Base Stations with a Tag .............................................................. 58
6.7.5 Deleting Tags from Base Stations....................................................................... 58
6.8 Modifying a Base Station ........................................................................................... 58
6.9 Deleting Base Station................................................................................................. 58
WORKING WITH BASE STATION ALARMS ...........................................................59
7.1 Searching Alarms ....................................................................................................... 60
7.2 Troubleshooting Base Stations .................................................................................. 62
7.2.1 System Alarms .................................................................................................... 62
7.2.2 RF Cell Alarms ..................................................................................................... 65
7.3 Acknowledging Alarms .............................................................................................. 70
7.4 Configuring Alarms .................................................................................................... 71
7.4.1 Configuring an Inactivity Alarm .......................................................................... 71
7.4.2 Receiving Alarm Notification Email .................................................................... 72
USING SETTINGS ..........................................................................................73
8.1 Accessing the Settings panel and Viewing Account Details ...................................... 73
8.2 Setting Alarm notification e-mails ............................................................................. 74
8.2.1 Setting Alarm Notifications Emails in Basic Mode ............................................. 74
8.2.2 Setting Alarm Notifications Emails in Advanced Mode ..................................... 75
8.3 Setting ISM Bands ...................................................................................................... 76
MORE ABOUT LORAWAN™ RADIO STATISTICS ..................................................77
WHAT’S NEW HISTORY .................................................................................78
ABOUT ACTILITY ..........................................................................................80
Acronyms Definitions
ABP Activation By Personalization
ADR Adaptive Data Rate
AES Advanced Encryption Standard
AS Application Server
ATM Asynchronous Transfer Mode
BPM Business Process Management
BSS Billing Support Systems
CRC Cyclic Redundancy Check
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
The purpose of the Network Manager application is to manage the LoRaWAN™ Radio Access
Network (RAN) by creating and administrating LoRa gateways (also known as Long-Range
Relays – LRR).
This guide provides ThingPark’s network providers with all the information needed to use the
Network Manager application that could be subscribed by the network provider. A network
provider could either refer to the roll-out teams within the Operator’s organization, the
system integrator of the Operator or the subscriber that also manages his own gateways
(typically the case of Managed Customer Networks).
▪ ThingPark X
▪ ThingPark Enterprise
The ThingPark platform is a modular solution enabling Network Operators to:
▪ Deploy LPWANs based on LoRaWAN™ or LTE with ThingPark Wireless.
▪ Manage, activate and monetize IoT bundles (Device, connectivity and application)
with ThingPark OS.
▪ Provide value-added data layer services, such as protocol drivers and storage with
ThingPark X.
ThingPark OSS acts as the central System Management Platform (SMP), enabling all other
ThingPark platform modules with base capabilities such as subscriber management,
centralized authentication and access rights, and workflow management.
ThingPark Enterprise is an Internet of Things (IoT) platform that manages private LoRa®
Networks. The ThingPark Enterprise edition is used by companies to support their specific
business.
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
Please note that the modules above may be representing a physical server, a function, a service or a business support layer as part of the
overall ThingPark solution and not necessarily a physical HW server
This section shows you login tasks that are specific to the Network Manager, especially when
logging in for the first time.
To perform other authentication operations as password creation and reset, forgotten
password, account authentication and reset, and so forth follow the guidelines provided by
the interface messages when prompted or contact your Vendor.
Refer to the Administrator for further information regarding logging policy.
3.1 Prerequisites
To login to Network Manager Application, you should have a Network Partner role. ThingPark
Wireless supports two Network Partner types:
1. Supplier type (also known as Network Provider): this is the conventional mode dealing
with Network Manager application. The Operator’s Network Provider administrates
and maintains the LoRa gateways provisioned on the Operator’s public network.
2. Subscriber type: addresses the use case of subscribers having access to the Network
Manager application to administrate their own gateways. A typical use case of this type
is the Managed Customer Networks, where the LoRa gateways are hosted on customer
premises but are provisioned/backhauled on the Operator’s LoRaWAN network.
Supplier/Network Providers can access Network Manager application using the following URL:
https://<operator-domain.name>/admin/
Then the following window appears; you are now logged in to Network Manager application.
If you have a subscriber account, you can connect to Network Manager application using one
of the following URLs:
▪ Via ThingPark Portal (if the option is enabled by the Operator): https://<operator-
domain.name>/portal/
When you log into the Network Manager application, the following screen is displayed:
The interface is based on a left sidebar menu and a main application frame showing:
▪ Location: inserting a location (for instance, a city name) zooms at the map on the
desired location. This search option is only valid for “Map” view.
Under Non-Disclosure Agreement
Actility S.A. au capital de 1 122 916 € - 4 rue Ampère, 22300 Lannion, France
RCS St Brieuc 522 305 473, Siret 522 305 473 00012, TVA FR62522305473
TP_Wireless_5.2.2-rev2_Network_Manager_User_Guide.docx- 15
For “List” view, the checkbox “Restrict search to visible map area” allows filtering the
base station list to only base stations located on the corresponding map view.
▪ Identifier: This field determines the base station of interest based on its name, LRR-ID
or LRR-UUID. Note: This field is case sensitive.
▪ Tag: Allows searching for all base stations associated with a given tag. For more details
about base station tagging, please refer to 6.7.2 Tagging a Base Station.
Other search options include:
▪ Version: search for all base stations having a specific LRR software version.
▪ Software restart: search for all base stations that have restarted since a specific
date/time.
▪ Min. remaining DC: displays only the base stations whose remaining Duty Cycle is
higher than or equal to a specific threshold. This option allows a quick monitoring of
congested base stations.
▪ Alarm: shows only base stations associated with a given alarm state (only active alarms
are considered). For more information about base station alarms and their severity,
please refer to Section 7 Working with Base Station Alarms.
Note that the list view of the Search section is updated only when the user clicks the Search
button.
The Base Stations list displays all the base stations issued from the filtering criteria defined in
the Search bar. The following figure shows an example screenshot of the List view:
▪ Power source: Power supply configuration if it is provisioned for the base station
(inherited from the BS profile). It could be either “mains”, “power over ethernet”,
“wind + battery” or “solar + battery”.
▪ Average packets up/down: average number of packets per hour in uplink (from device
to base station) or downlink (from base station to device) directions, estimated over
the last hour preceding the reception of the last uplink frame.
Note: for uplink frames received by several base stations at the same time (thanks to
macro diversity), the frame is counted only for the uplink best-serving gateway (that is
to say, the gateway having the highest reception signal to noise ratio (uplink SNR)).
▪ Alarm: Number of active alarms currently raised on this LRR but not yet acknowledged.
▪ Locate: when the user clicks the “Locate” icon, the Network Manager application
opens a new window and locates the base station on the map. The position of each
base station is either based on the GPS coordinates reported by the LRR or on the
coordinates manually provisioned. To configure the location mode, please refer to
Section 6.6.3.2 Update Location and Altitude.
When clicking on a Base Station, a pop-up window displays the base station details, as
per the following screenshot:
On the Base Station list, the user can sort columns by ascending or descending order; by
clicking the arrow button on the right of each column as per the following screenshot:
Note: The sorting function applies to the current page only, it doesn’t sort the list elements
across several pages.
The “Columns” menu allows the user to customize its column view by removing some columns
not relevant for his day-to-day activities.
For each base station displayed in the list, the following actions are supported:
▪ View : use this option to consult the base station details in read only mode
▪ Tag : Opens the base station tag manager to associate a tag to this base station.
For more details about tag management, please refer to section 6.7.
▪ Delete : use this option to delete a base station, a pop-up window with a
confirmation message will be display to make sure users don’t accidentally delete base
stations.
The base station provisioning process allows the Network Partner to add new base stations to
the network.
To create a new base station, go the “Base stations” panel and click the “Create” button:
There are two different modes to identify a base station during provisioning phase:
1. Either using the LRR-UUID (recommended mode): this ID refers to the Universal
Unique Identifier of the LRR. The advantage of this mode is that, unlike the LRR-ID
whose unicity is not guaranteed across the different gateway manufacturers, the LRR-
UUID is always unique. The UUID consists of a manufacturer-specific prefix (the IEEE
OUI of the base station vendor) followed by the vendor-related base station identifier.
In this mode, the LRR-UUID is provisioned during base station creation whereas the
LRR-ID is assigned by ThingPark.
2. Or using the LRR-ID: This mode is only kept for backward compatibility purpose. In this
mode, the LRR-ID is statically associated with the base station by the vendor;
therefore, collision may occur!
The information required to create a new Base Station is the following:
▪ Model: defines the base station profile, the drop-down list is filtered based on the
selected Manufacturer
▪ VPN & authentication (only valid for LRR-UUID identification mode): enables the
automatic generation of the Base Station certificate for IPSec or TLS VPN security
modes on the backhaul interface between LRR and the LoRaWAN core network. This
field is greyed if the option is not activated at operator level.
Note that for LRR-ID identification, IPSec/TLS modes are also supported by ThingPark,
but the Base Station certificate is not automatically generated by TWA upon Base
Station created (needs to be generated manually by the Network Partner).
The following figure illustrates an example for a base station creation window using LRR-UUID
mode:
Note: Do not forget to press the “Create” button when you are done provisioning the required
fields.
A message displaying that the Base Station is successfully created is displayed in
the bottom left corner of your screen, then the base station becomes visible in the
list.
You should see something like the following capture in the List tab.
Note that after a new Base Station has been created, it stays in status VALIDATING until your
Operator Manager has validated the Base Station in the network, unless the Operator has
delegated this BS validation action to the Network Partner.
Note that if the Base Station has been provisioned with the LRR ID, the LRR UUID field can be
later updated to enable future LRR migration to the LRR SW version superior to 2.2.20.
To view all the details of a base station in read-only mode, click the button in the “List”
view. If the user wants to edit the base station configuration or perform administrative actions
(for instance launch the RF scan functionality, reset the radio board…etc.), then he should click
the button.
Once a base station is selected for view/edit, it appears in the sidebar menu under the “Base
station” root node as illustrated by the following figure:
This frame displays the basic information of the Base Station such as the model (referring to
the base station profile), name, LRR ID, LRR UUID and SMN (Serial Number).
The “Administrative info” space is a free-text field that can be used by the administrator to fill
additional information about the gateway. This is field is also used by the BS-Commissioning
tool to provision specific installation details during on-site commissioning (for instance, MAC
address…). For more information about this tool, please refer to [4].
▪ Power source: if the power supply configuration is defined for the corresponding
model, it can take one of the following values: Mains, Power Over Ethernet (PoE), Wind
+ Battery, Solar + Battery. Note that, if the base station model is equipped with several
power sources, only the primary source is referenced in this field.
▪ GPS receiver: indicates whether the gateway is equipped with an embedded GPS
receiver.
▪ Antennas: this configuration indicates how many antennas are available for this
model. Note: pico/nano gateways are equipped with a single antenna whereas macro
v2 gateways may be equipped with up to 3 antennas depending on their model.
▪ WAN backhaul: indicates which backhaul options are supported by the base station
model. Ethernet and Cellular are the most common modes, but satellite backhaul is
also possible. For Cellular mode, the administrator can enter the SIM card details by
clicking the “Details” button then filling the fields related to the SIM card and
equipment identity (IMEI).
▪ Software version: indicates the LRR software version used by the base station. More
details on the software version (including operating system version, firmware, HAL,
FPGA…) can be found by clicking the “Custom versions” button.
▪ VPN and Authentication: enable/disabled. Enabled means that the Base Station
certificate is automatically generated by TWA upon Base Station creation
Note that “VPN and Authentication” flag does not show the dynamic status of the Base
Station backhaul security mode, it only determines whether automatic generation of
the BS certificate is enabled or not.
Note: to provision the Public Key for existing base station (RDTP-7582):
▪ In base station dashboard, click “Manage Public Key” button, then fill the Public Key.
The location of the Base Station on the map can be provided in two different ways:
1. Either based on the GPS position reported by the LRR (using the GPS receiver)
2. Or manually set by the administrator in Network Manager GUI / web-services. For
more details about manually provisioning the base station coordinates, please
refer to Section 6.6.3.2 Update Location and Altitude.
▪ Most busy channel: indicates the RF channel having the highest uplink/downlink duty
cycle over the last 10 minutes. The duty cycle statistics are provided for each antenna
(in case the base station has several antennas). The antenna having the highest duty
cycle is indicated as Ax (for instance, A1, A2, A3…).
o Duty cycle: utilization of the duty cycle on the busiest channel
o Rem. capacity: remaining capacity of the duty cycle (not yet supported in the
current release).
Note: Uplink corresponds to packets sent from the device to the network, whereas downlink
corresponds to packets sent from the network to the device.
▪ Connection status to each LRC in the LRC-cluster. Please note that LRC-1 is the primary
LRC while LRC-2 is the hot standby / secondary LRC used in case of switchover to
support High Availability.
▪ For each network interface (eth = Ethernet, wwan = Wireless WAN (typically cellular,
but could also be WiFi backhaul)):
o Connection status to LRC cluster
o Activity: Time duration with this interface in “Up and Used” state, since the
start of the WAN stats’ recording. Note that the start date/time of WAN stats -
for each network interface - is logged by Network Manager in WAN Backhaul
panel. It is also possible to reset statistics to initialize the aggregation period.
Note that all charts can be exported or printed by clicking on the top right menu icon in
the chart as shown in the following screen.
You can access the Antennas list along with their properties by clicking “Antennas” in the left
sidebar.
▪ ID
▪ Type:
o Omnidirectional: the horizontal antenna pattern covers 360°, typical case for
LoRaWAN deployments.
o Directional: the antenna has a directional pattern on the horizontal plane to
maximize the radiated energy on a given direction. Directional antennas are
typically used in tri-sector antenna deployments where the Base Station has
three different antennas, each one covers around 120° on the horizontal plane.
o Undefined: the antenna type is not provisioned by the administrator.
▪ Azimuth: the rotation of the whole antenna around a vertical axis, measured in
degrees. Azimuth is only relevant for directional antennas (not applicable for
omnidirectional antenna types).
▪ Used: Yes/No. The activation state of each antenna depends on the number of
antennas configured in the “RF hardware configuration in use” field.
The “RF hardware configuration in use” field determines the effective antenna configuration
mode. Please note that the maximum configuration supported by the Base Station hardware
is defined in the Base Station profile, but the effective hardware configuration in use could be
downgraded for each Base Station with respect to the maximum hardware capability, using
Under Non-Disclosure Agreement
Actility S.A. au capital de 1 122 916 € - 4 rue Ampère, 22300 Lannion, France
RCS St Brieuc 522 305 473, Siret 522 305 473 00012, TVA FR62522305473
TP_Wireless_5.2.2-rev2_Network_Manager_User_Guide.docx- 29
the “RF hardware configuration in use” parameter in Network Manager, under the Antennas
panel, as shown by the following figure:
For example, for a Kerlink iBTS gateway with 2 radio boards and 2 antennas physically cabled
to the gateway, the Base Station Profile shall be configured to “1 sector, 2 antennas, 2 boards”,
then each Base Station can be individually configured to one of the following configurations:
▪ 1 sector, 1 antenna, 1 board
▪ 1 sector, 2 antenna, 1 board
▪ 1 sector, 2 antenna, 2 board
Note that the hardware configuration options proposed in the drop-down list are limited by
the maximum hardware capability defined in the Base Station profile associated with this BS.
The following hardware configurations are fully supported by ThingPark in the current release:
To view the detailed Antenna description, please click . To update the antenna details,
please use the icon.
Clicking either icon given above transfers you to the page containing a full description of
the concerned Antenna divided into the following sections:
▪ Antenna: showing the Antenna ID, its type, horizontal half power beamwidth (HPBW,
only relevant for directional antennas), azimuth (only for directional antennas) and
additional administrative information (free text fields).
▪ Location: in this section, the user can view/edit the location of each RF antenna as well
as its height above the ground and sea levels (the latter reflects the absolute antenna
height).
Note that the information provided in this section is necessary for network geolocation
(using sophisticated triangulation algorithms) where it is crucial to precisely provision
the antenna location if it is different from the Base Station GPS location; this could be
the case when the RF antennas are installed several meters away from the LoRa Base
Station on a building rooftop, for instance.
▪ Cable: showing the RF cable loss (in dB) and delay (in nanoseconds). The RF cable loss,
together with the RF antenna gain, are mandatory information required by the Base
Station to use the correct downlink transmission power in compliance with the local
regulations. This information could be either derived from field measurements or
directly estimated from the cable’s electrical specification provided in its datasheet.
Note that precisely setting the RF cable delay is very important for geolocation use
cases, this information is reported to the location solver to precisely estimate the
device location using TDoA algorithms.
▪ TX Power: this section reports the maximum and effective radiated transmission
power (EIRP) used by the LRR for RX1 and RX2 slots. The maximum EIRP is based on
the RF Region configuration setting (reflecting the maximum allowed radiated power
set by the regulatory limits) whereas the effective EIRP reflects the real radiated power
estimated by the LRR based on the RF gain / cable loss configured by this antenna and
the calibrated TX power levels supported by this Base Station.
Note: do not forget to click at the top-right corner once you complete editing the
antenna details. If you close this screen without saving the last configuration, the new changes
will not be considered.
Besides the RF antenna, Network Manager application allows the user to provision the details
of the GPS antenna; this is available directly in the “Antennas” tab. The most important
information about GPS antenna is the cable delay (in nanoseconds) since it directly impacts
the geolocation precision for TDoA algorithms.
By clicking the System menu in the left sidebar (as shown by the following figure), the user
can access the detailed statistics about the LRR system: CPU, RAM and partition usage.
Note that it is possible to reset the statistics by clicking Reset Statistics. This action resets only
the min/max values; the chart data remains stored.
As described in Section 6.1 Main Frame, the summary overview for an LRR presents
information on the busiest logical channel depending on duty cycle information. However, you
can drill down into the data of each specific logical channel in the RF Cell menu. This allows
you to identify potential noise issues on specific frequencies.
▪ Duty Cycle per logical channel: You can access uplink and downlink Duty Cycle
(channel utilization) per Logical Channel.
o Uplink duty cycle reflects the aggregated reception time of physically-valid
LoRaWAN frames over the logical channel. This stat can be correlated with the
average uplink packet loss rate to establish a relation between the target
packet error rate for a given network deployment (considering the gateway
macro diversity) and the maximum tolerable uplink channel occupancy rate. If
radio congestion is identified, it can be mitigated by network densification.
o Downlink duty cycle reflects the aggregated transmission time of downlink
LoRaWAN frames over the logical channel, using RX1 transmission slot. In
countries where transmission duty cycle is limited by the local regulation, it is
mandatory to keep this metric below the maximum allowed duty cycle (set in
RF Region configuration). Even if TX duty cycle is not constrained by the local
Under Non-Disclosure Agreement
Actility S.A. au capital de 1 122 916 € - 4 rue Ampère, 22300 Lannion, France
RCS St Brieuc 522 305 473, Siret 522 305 473 00012, TVA FR62522305473
TP_Wireless_5.2.2-rev2_Network_Manager_User_Guide.docx- 34
regulation, it is recommended to keep the average Tx duty cycle, aggregated
over all the downlink channels, below 10% to avoid excessive packet loss with
half-duplex gateways.
Note: downlink duty cycle for RX2 transmission slot is displayed separately in
the “RX2” tab.
Duty cycle statistics displayed by Network Manager with either daily or hourly
aggregation. For each aggregation period, the statistics can be displayed for 7 or 15
days. Note that hourly duty cycles are aggregated over full hours, not over sliding
3600s windows.
The maximum uplink/downlink hourly duty cycles are recorded and displayed by
Network Manager, allowing the Network Partner to keep the historical maximum
values beyond the 15-days timeline display limit.
Note that it is possible to reset the statistics by clicking Reset Statistics. This action resets only
the min/max values; the chart data remains stored.
▪ Spreading Factor distribution per logical channel: For a given logical channel, you can
also access the uplink/downlink spreading factor distribution of the various
LoRaWAN™ packets. The distribution can be aggregated over the last 10 minutes or
over the last day. The following picture shows a sensor transmitting only at SF10
throughout the previous day.
▪ Downlink delivery status: This tab illustrates the split of downlink transmission status
between those successfully transmitted by the Base Station and those where
transmission failed. For failed transmissions, Network Manager provides a distribution
of the different failure causes (aggregated over the last 7 or 15 days).
▪ Downlink:
o Number of frames sent towards the RF interface (downlink applicative payload,
MAC commands, ACKs…etc.): total number of downlink frames sent to the RF
radio board.
o Number of frames waiting for a transmission slot.
o Number of times the modem was busy when a frame was sent: indicates the
number of downlink frames not sent by the radio board due to radio
congestion (modem being already busy transmitting another downlink frame
at the same time). NOTE: the Base Station transmit only one downlink frame at
a time.
▪ Uplink:
o Number of frames received from the RF interface.
o Number of frames received with a CRC error: physical CRC error means that the
frame is not a valid LoRa frame; so, it may be used as an indication of the radio
pollution perceived by the gateway from other technologies.
o Number of frames received with a wrong length.
This panel provides the Network Manager user with statistics related to the backhaul between
the Base Station and the ThingPark core network (also known as the LRC cluster), for the
different backhaul interfaces configured in this Base Station. The LRR-LRC interface uses IEC-
104 protocol at the application layer.
▪ Deviation of the latency round trip (showing the standard deviation of the round-trip
time between the LRR and LRC), measured over the last LRR reporting period (5
minutes by default).
▪ Max. latency round trip and its timestamp measured at the application layer (IEC-104)
between LRR and LRC.
▪ Number of IEC link disconnections, indicating the number of times the LRR-LRC link
was broken (e.g. due to loss of network connectivity, timeout…) since the recording
time of the current statistics.
Note that the all the statistics presented above are generated for a time period specified by
the “Recorded since:” information.
Note that the user can reset the statistics to restart the recording from the current time.
The following picture shows hourly totals for the number of packets transmitted over backhaul
WAN links over the last 7 days.
Note that all the graphs can be exported in several formats by clicking
Note that uplink frames buffered/queued by the LRR during temporary backhaul
disconnection are flagged “LATE” when they are reported to the Application Server or
ThingPark back-office applications (TWA).
The Administration section is visible only if you have the correct rights to access it. These rights
are given to you by your operator by delegating the Base Station administration to the
Network Partner.
allows you to refresh indicators after having performed administrative actions on the Base
Station.
6.6.1 Settings
▪ Activate RX2 optimization: this algorithm allows the LRC Network Server to optimize
the choice between RX1 & RX2 slots used by end-devices to receive downlink frames.
This optimization is based on a combination of several criteria:
o RF link budget: to favor the RX slot having the higher transmission power (in
case of difference) for end-devices located in difficult radio conditions
o Downlink capacity: for devices located in fair/good/excellent radio conditions,
favor the RX slot having the highest data rate to optimize downlink
capacity/airtime.
o Maximum allowed MAC payload size: force the use of RX2 slot if the required
applicative downlink payload size can only be sent over RX2 slot but not RX1
slot.
For more details about the RX2 Optimization algorithm, please refer to [5].
▪ Support for IEEE 802.15.4: technical standard defining Low-Rate Wireless Personal
Area Networks, specific to old Watteco devices. Please contact Actility Support team
before ticking this checkbox.
▪ Activate Class B: Tick this flag if you want the Base Station to support Class B devices
by sending downlink pingslots. To support Class B in the current release, the Base
Station must be equipped with a GPS receiver.
▪ Activate Beacon transmission: If this flag is ticked, the Base Station shall contribute to
the beacon transmission. The beacon transmission periodicity is determined by the
LRC based on the RF Region configuration of the beacon randomization parameter. To
support beacon transmission in the current release, the Base Station must be equipped
with a GPS receiver.
6.6.2 Maintenance
The command instructs the Base Station to download and install a new LRR software (using
the FTP protocol). If the command is successful, the LRR process may be automatically
restarted or rebooted. The execution of the command may take several minutes. The Base
Station will be unavailable during this time.
When the user clicks “Upgrade”, the following window appears; it allows setting the target
LRR software version among a drop-down list of available versions.
Note: Starting release 5.2.2, only the LRR software versions compatible with the Base Station’s
current firmware/HAL/FPGA versions is proposed in the drop-down list.
The command either stops the RF Cell uplink/downlink communications (Stop) or only stops
the downlink communications (Downlink stop). When the RF cell is completely stopped, the
Base Station becomes invisible to all LoRaWAN end-devices.
When the RF Cell is Started, the radio interface is up and running; whereas when the RF Cell
is Stopped, the radio interface is unavailable.
The command launches a full operating system reboot. The execution of the command may
take several minutes. The Base Station will be unavailable during this time.
The “Base Station uptime” indicates the date/time of the last system reboot action.
This command launches a restart of the LRR process only without full system reboot. This
command also reloads the configuration of the radio subsystem and the configuration of the
WAN backhaul interfaces.
The “LRR process uptime” indicates the date/time of the last LRR process restart action.
The drop-down list of RF Regions represents the list of RF Regions authorized by the Operator,
either based on Actility’s RF Region catalog or based on a manual Operator-personalized RF
“Current location status” indicates the location mode used by the Base Station: GPS (position
is automatically reported by the LRR) or Administrative (position set manually). To configure
the location mode, click “Update"; the following window will appear:
▪ When Base Station location mode is set to “GPS”, the absolute altitude (that is to say,
the altitude above sea level) is automatically reported by the LRR. Only the height
above ground level (in meters) can be configured by the Network Partner.
▪ When Base Station location mode is set to “Administrative”, the Network Partner can
determine the location directly on the map, by clicking on the required position then
the marker will be moved to this new position. Additionally, both the absolute altitude
(that is to say, the altitude above sea level) and the height above ground level can be
configured by the Network Partner.
Please don’t forget to click “Update” at the top right of the window to save your changes, or
press cancel to revert to previous configuration.
Under Non-Disclosure Agreement
Actility S.A. au capital de 1 122 916 € - 4 rue Ampère, 22300 Lannion, France
RCS St Brieuc 522 305 473, Siret 522 305 473 00012, TVA FR62522305473
TP_Wireless_5.2.2-rev2_Network_Manager_User_Guide.docx- 48
6.6.3.3 Update Antenna Gain and Cable Loss
The command updates the gain and cable loss for each antenna on the Base Station. A dialog
window will be opened to configure the gain and cable loss as shown by the following
screenshot:
Note: it is essential to set the correct values for the antenna gain and cable loss, otherwise
the downlink transmission power used by the LRR will be wrongly set. The LRR derives the
conducted TX power from the maximum allowed radiated power (also known as Effective
Isotropic Radiated Power – EIRP) configured in the RF Region associated with the Base Station
as per the following formula: Conducted Tx Power = EIRP – Antenna Gain + Cable Loss.
The command updates the fine-timestamp decryption keys for all FPGA boards on the Base
Station. A dialog window will be opened to configure the gain and cable loss for all antennas.
This command opens a reverse SSH session with the Base Station. This may be used for
advanced maintenance and troubleshooting operations. Once the session is open, you may
launch the embedded SSH terminal (see button below) or you may connect the ThingPark
Support server by using the default support account provided by your operator.
To reverse the SSH session:
1. Click Open reverse SSH button.
2. The port value is preconfigured in Network Manager window (but you may choose a
different port of it is also open).
▪ Logs:
o Allows the user to visualize log files for the current + historical logs of the last
7 days. To scroll up/down, please use the up/down keys on your keyboard.
o It also allows searching in logfiles (grep functionality) watching activity via tail
functionality.
o The user can also export the Base Station configuration and log files via
FTP/SFTP, by setting the server details, username / password…etc.
▪ LRR configuration:
o Get the current radio configuration: number of antennas, ISM band, LBT
configuration, TX Power look-up tables (LUT), physical channel
configuration…etc.
o Get LRR-UID: useful to provision LRR-UID of the Base Station in Network
Manager in case the information is not available on the Base Station sticker.
▪ Backup – The command launches a backup of the current configuration. The LRR
software, LRR configuration, RF configuration, WAN backhaul configuration and Base
Station login/password will be saved. This command must be used CAREFULLY: the
backup configuration will be erased and replaced by the current configuration.
▪ Restore – The command launches a restore process of the backup configuration. The
backup LRR software, LRR configuration, RF Cell configuration, WAN backhaul
configuration and Base Station login/password will be restored. The execution of the
command might take several minutes. The Base Station will be rebooted and
unavailable during this time. This command must be used CAREFULLY: the current
configuration will be erased and replaced by the backup configuration.
The tagging functionality allows to group Base Stations for Multicast and Managed Customer
Network usage.
A Managed Customer Network is a set of Base Stations deployed by an operator on the
customer premises for its own usage. A billing policy is applied by the Operator to the
LoRaWAN™ traffic routed through the Managed Customer Network. The discrimination is
performed according to the best Base Station for uplink frames and according to the selected
Base Station for downlink frames.
Several sets of Base Stations can be associated within a group and then be tagged. The tag can
be used to localize the Base Station or for other classification.
You can create class B or C Multicast Groups to send simultaneously a same downlink payload
to many target multicast devices in your LoRaWAN™ network. The class of the Multicast Group
must be the same as the class of the target multicast devices working with it.
6.7.1 Prerequisites
Ensure that the delegation for BS tagging is activated for your Network Partner. Otherwise,
the BS tagging stays in read-only mode. To do this, go to the Operator Manager > Network
partners and activate the Delegate BS Tagging of your supplier. For more information, please
refer to [6].
Approach #2:
Modifying a Base Station allows you to update Base Station-related data such as the name,
the address, the manually entered location or the administrative info.
Start by opening a Base Station in Edit view:
a) Select the Base Station to edit in the list.
b) Click Edit to enter in the Edit view.
Finally, to confirm the changes, go back to the Device details by selecting the Device in the
column in the left sidebar, then click Save in the top-right corner of the screen.
Deleting a Base Station is an action that cannot be undone and should be handled with care.
All Base Station details and status information will be lost.
The steps to delete a Base Station are as follows:
a) Select the Base Station to delete in the list.
b) Click Edit to enter in Edit view.
c) Click Delete and confirm in the pop-up to delete the Base Station.
Tips: All actions Save or Delete displays the result in the status bar at the bottom of the screen.
Use this information if you want to know more about the Base Station alarms that are
displayed by the Network Manager. You can access the Base Station alarms by clicking the
Alarms section in the left menu.
The Alarms panels display all alarms generated for the Base Station and lets you monitor them.
Network Manager application supports two panels to manage BS alarms:
▪ “Alarms” panel shows the active alarms associated with the Base Station. Active alarms
are those currently raised by the system (not yet cleared) regardless of their
acknowledgment status.
▪ “History” sub-panel (located under “Alarms” panel): show historical alarms associated
with this Base Station, historical alarms are those already cleared by the system (i.e.
not active anymore) in the past 15 days.
Notes:
▪ Historical alarms represent the latest known status about the alarm before it was
cleared. In other words, when an alarm is cleared, the alarm before clearance is cloned
in the history.
▪ When an alarm is cleared, it is still displayed in “Alarms” panel under the state
“Cleared” to inform the BS administrator about the last issue. This implementation
allows the user to quickly monitor the latest state of their BS without switching
between active and historical alarms. If the user does not want to see cleared alarms
in active alarm list, they can use the filter State = “not cleared” (see below the
search/filter options).
▪ By default, an alarm in the history expires 15 days after clearance.
▪ Historical alarms are only available starting the upgrade of ThingPark Wireless
platform to release 5.2.2-3.
Network Manager application supports several search filters allows you to search alarms using
one of the following criteria:
The same search options are available in “Alarms” panel and “History” sub-panel.
▪ Acked: the user may search for alarms by their acknowledgment status. For more
information, please refer to Section 7.3 Acknowledging Alarms.
The search result shows the list of Base Station alarms matching the filtering criteria. Each
alarm is associated with a state to define its severity and activity status as well as a color code.
The following screenshot refers to active alarm list:
▪ Event-driven alarms
Each time the event associated with the alarm is detected, the alarm occurrence is
incremented by one.
Example: If a Join Request has been rejected ten times due to repeated DevNonce, the
Alarm 113 - Join request replay detected (DevNonce replay)- displays ten occurrences.
Note: For an event-driven alarm, no email notification is sent for any new occurrence
if the alarm state, related to a severity level of the alarm, stays the same. For more
information, see Section 8.2.2 Error! Reference source not found..
Event-driven Base Station alarms include the replay attack alarms (alarm ID 113…120)
in addition to alarm 101 “LRR software restarted by watchdog”.
▪ State-driven alarms
A state is a stable event that cannot repeat unless stopped. Each time the state
associated with the alarm is detected, the alarm occurrence does not increase and
always displays one. This type is valid for all Base Station alarms except replay attacks
and alarm 101.
Example: If a power failure of the Base Station has been detected with the same alarm
reported ten consecutive times (on ten LRR consecutive LRR reports), the Alarm 110 -
Power failure detected - displays only one occurrence.
106 Unusually high CPU usage The alarm gets triggered once See the sub-chapter Error!
CPU usage level reaches an the CPU’s average and Reference source not found. Error!
abnormal level standard deviation cumulated Reference source not found. to
load exceeds 85%: collect logs, and contact your
▪ Warning alarm if average support.
+ standard deviation of
the CPU load > 85%
▪ Major alarm if average +
standard deviation of the
CPU load > 95%
108 Unusually high File-system usage The alarm gets triggered once See the sub-chapter Error!
file system reaches an the file-system average and Reference source not found. Error!
usage level abnormal level standard deviation cumulated Reference source not found. to
load exceeds 95%:
collect logs, and contact your
▪ Warning alarm if average
+ standard deviation of support.
the CPU load > 95%
▪ Major alarm if average +
standard deviation of the
CPU load > 99%
109 Time The Base Station ▪ NTP launched before Connect on the Base station and
synchronization uses the local getting an IP address. restart the NTP: settime restart.
lost time instead of ▪ The Base station
using the NTP restarted but the NTP See the sub-chapter Error!
time reference. was not launched Reference source not found. Error!
correctly Reference source not found. to
collect logs, and contact your
support.
110 Power failure Power supply ▪ Base station disconnected ▪ Check the connection of the
detected defect detected; from the grid Base station to the grid.
the Base Station is ▪ Power grid failure ▪ Check the power of the grid.
running on
battery.
104 Unusually high LoRa frames ▪ Number of packets ▪ If the uplink duty cycle of the
level of invalid received by the generated by devices in Base Station is high, switch off
uplink physical LRR (on the last the cell is too high (frame some Devices.
CRC hour) cannot be collisions). ▪ Check if an RF equipment has
demodulated ▪ Noise generated by been installed next to the Base
properly, or there another LoRa network's Station (causing potential
are many non- gateway nearby. interference).
LoRa frames ▪ Jammer/Non-LoRa ▪ Scan the radio on the Base
received by the equipment is interfering Station to check the noise level.
gateway with (most likely if ratio is very
physical high). If the alarm persists, contact your
preamble similar ▪ LRR RF chain defect. support.
to LoRa.
114 Wrong MIC A wrong MIC has ▪ The LRR is the target of a If the number of the alarm
detected in Join been detected in join request replay attack. occurrences is high:
request a Join request, ▪ A Device sent a join 1. Check the Device's information
failing to request containing a
and behavior and fix issues.
authenticate the wrong MIC possibly due to
activation wrong Device provisioning 2. The Base Station may be the
request for the (that is, bad Appkey). victim of a join request replay
device in attack. Stop the radio and try to
question. identify the attacker.
If the alarm persists, contact your
support.
115 Join request A wrong MIC If the number of the alarm Stop the radio and try to identify the
replay detected correlation has occurrences is high, the attacker.
(wrong MIC been detected
Base Station may be the
correlation) between a Join
request and the victim of a join request If the alarm persists, contact your
following Uplink replay attack. support.
frame,
invalidating the
last join request
received from
this device.
117 Wrong MIC A wrong MIC has ▪ The LRR is the target of an If the number of the alarm
detected in been detected in uplink frame replay occurrences is high:
Uplink frame an Uplink frame, attack. 1. If the Device has sent an uplink
failing to ▪ A Device sent an uplink
packet containing a wrong MIC,
authenticate the frame containing a wrong
frame. MIC (for instance, bad fix it (check NwkSKey).
NwkSKey provisioned for 2. The Base Station may be the
ABP device). victim of a join request replay
attack. Stop the radio and try to
identify the attacker.
If the alarm persists, contact your
support.
118 Uplink frame A repeated FCnt ▪ The LRR is the target of an If the number of the alarm
replay detected has been uplink frame replay attack occurrences is high:
(repeated FCnt) detected in an 1. Stop the radio and try to identify
Uplink frame. ▪ A Device exceeds its
configured number of the attacker.
transmissions 2. Check the behavior of the device
and fix it if needed.
3. If the replay attack risk is highly
persistent, it is recommended to
reduce the maximum number of
transmissions to 1 in the
Connectivity Plan.
120 Join request A DevNonce If the number of the alarm If a join request replay attack: stop
replay detected attack has been occurrences is high, the Base the radio and try to identify the
(invalid detected in a Join Station may be the victim of a attacker.
DevNonce) request when the join request replay attack.
If the alarms persists, contact your
device is
support.
supposed to use
counter-based
DenNonce.
When you have dealt with an alarm, you can acknowledge it. It will appear as checked in the
alarm list if the search filter is set to “No filter” or “Acked”. It should look like this.
▪ To acknowledge one alarm, click the alarm you want to acknowledge, then click Ack.
▪ To acknowledge multiple alarms, use the Ctrl Key and click the alarms you want to
acknowledge.
▪ To acknowledge all alarms, click Ack all. If a message is displayed, click Yes to confirm.
Note: If the filter is set to “Acked”, only acknowledged Alarms marked by a green check mark
and corresponding metdata describing the Alarm are displayed. This is shown in the following
screen.
Minor A fault that does not affect the service should be corrected to prevent a
more serious problem.
Warning A potential or impending fault affecting the service should be diagnosed
and corrected, if necessary.
Indeterminate The severity cannot be determined.
Optional: If you want to create another threshold for the alarm, select Active threshold2 and
repeat the sub-steps above.
2) Click Save.
The alarm will be displayed in the Alarms panel of the Base Station when the conditions are
met.
The Settings panel displays information about the Network partner account and lets you
configure alarm email notifications.
▪ The Network partner frame gives the activation date and status of the subscription.
▪ The Delegations frame confirms or denies Network partner’s administration and Base
Station validation along with tagging rights.
▪ The Alarm notifications frame lets you configure alarm notification emails and appears
by default with the basic mode.
Under Non-Disclosure Agreement
Actility S.A. au capital de 1 122 916 € - 4 rue Ampère, 22300 Lannion, France
RCS St Brieuc 522 305 473, Siret 522 305 473 00012, TVA FR62522305473
TP_Wireless_5.2.2-rev2_Network_Manager_User_Guide.docx- 73
▪ The Subscription information frame provides the following
o a roll-out list of available ISM bands per country, being “Undefined” by default;
o Base Station credit;
o used Base Station credit quantity;
▪ The Status frame indicates when the Settings section got updated and by whom.
In addition to the alarm notifications appearing in the Alarms panel of a Base Station (For more
information, see Section 7 Working with Base Station Alarms), you can set alarm notifications
by email to monitor all Base Stations of the account when necessary, and independently of
the Base Station the alarm belongs to.
▪ The basic mode lets you send notification emails whatever the alarm state to all
recipients.
▪ The advanced mode lets you send notification emails to the recipients per the alarm
state.
Important
▪ Click Save after you have finished your configuration in any mode.
▪ When shifting from the advanced mode to the basic mode and clicking Save, the
basic mode overwrites what you have set in the advanced mode.
▪ The Setting panel opens with the last saved configuration mode.
▪ Whenever the alarm has been acknowledged and increases to this alarm state.
Note: When an acknowledged alarm increases its alarm state, the acknowledgement
is cancelled by the system.
Each alarm state corresponds to a severity level of the alarm, or a cleared or acknowledged
alarm:
Alarm State Definition
Critical The service is affected, and an immediate corrective action is required.
Minor A fault that does not affect the service should be corrected to prevent a
more serious problem.
Warning A potential or impending fault affecting the service should be diagnosed
and corrected if necessary.
Under Non-Disclosure Agreement
Actility S.A. au capital de 1 122 916 € - 4 rue Ampère, 22300 Lannion, France
RCS St Brieuc 522 305 473, Siret 522 305 473 00012, TVA FR62522305473
TP_Wireless_5.2.2-rev2_Network_Manager_User_Guide.docx- 75
Indeterminate The severity cannot be determined.
Cleared or The alarm has been cleared by the system or acknowledged by the user
Acknowledged and is kept in an history for one year.
1. Apply all steps described in Error! Reference source not found. Error! Reference source
not found. entering the email addresses of all the recipients you want to notify, whatever
the alarm state of the devices.
2. Click Switch to the advanced mode.
All the recipients email addresses have been copied in all alarm state areas.
3. In the Alarm state area that you want, select the recipient you do not want to notify, and
click Delete. Repeat as necessary in any other alarm state area.
If necessary, you can add more recipients in the alarm state area you want.
4. Click Save.
The recipients registered will receive an email when the corresponding
alarm state is reached for any device.
Next time you open the Settings panel, the Alarm notifications frame will
appear with the advanced mode.
ThingPark Wireless supports a various range of ISM bands. When the Network administrator
sets one or several ISM bands in Network Manager, only Base Station Profiles compatible with
these selected ISM bands shall be proposed during Base Station creation.
1. In the Default ISM band table in the Subscription information frame, click Add.
This section provides information on the calculation of radio parameters. This includes
This section lists changes implemented in the previous versions of this document.
NFR 472 - Map service
4.2 Base Stations List 4.2
based on OSM
NFR 684 - TWA Redesign
Error! Reference source not found. Error! Reference
LRR ID Format, Length and 4.2
source not found.
Association
NFR 758 - Set LRR trace
level via the Network Error! Reference source not found. Error! Reference 4.2
Manager source not found.
NFR 730 - Join request Error! Reference source not found. Error! Reference 4.3
replay attack by LRC source not found.
NFR 731 - Device UL to
Application Server to Error! Reference source not found. Error! Reference 4.3
prevent replay attacks source not found.
NFR 1043 - DevNonce as a Error! Reference source not found. Error! Reference 5.0.1
counter source not found.
RDTP-1086/NFR698
ThingPark Wireless LRR/No Error! Reference source not found. Error! Reference 5.0.1
Radio Packet Activity source not found.
(Watchdog) Completion
NFR 2262 – New backhaul Error! Reference source not found. Error! Reference 5.1
link status alarm source not found.
NFR 3755 – Support
5.1
several ISM Bands 8.3 Setting ISM Bands
RDTP-2343: IPv6 support Error! Reference source not found. Error! Reference 5.2.2
on Base Stations
source not found.
RDTP-7849: LRR upgrade
depending on 5.2.2
6.6.2.1 Upgrade LRR software
firmware/FPGA versions
An event-driven alarm 7.1 7.1Searching Alarms
increases its occurrence
number, a state-driven
alarm does not (RDTP-
9073) 5.2.2
7.3 Acknowledging Alarms
Clarification on
acknowledged alarms and 8.2.2 Setting Alarm Notifications Emails in Advanced
alarm notification emails. Mode
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 https://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.