1 - WMC - Wanesy Management Center - 20210922
1 - WMC - Wanesy Management Center - 20210922
1
1. Concept 7. Selection
6. Network Management
2
Wanesy Management Center
- Concept -
3
Structure
Modifiez le style duof
titre a LoRaWAN Network
Smart grid
Smart metering
Downlink
The initial need is to exchange data between end-devices and application servers.
A LoRaWAN network implies an infrastructure made of gateways and of a LoRa Network
Server (LNS).
The LoRaWAN Network Server (LNS) processes packets received from multiple gateways and
sends packets to the appropriate application server which handles the customer application
and treats the data to present them as relevant.
Deploying and operating a performant LoRaWAN network requests powerful tools to
monitor, optimize, manage or troubleshoot the gateways, their configuration and grant the
requested network QoS.
4
Wanesy
Modifiez le style Management
du titre Center – More than a LNS !
Smart grid
Smart metering
On top of LoRaWAN Network Server (LNS), Base Stations Controller (BSC) is a key set of
features to remotely operate the LoRaWAN® gateways deployed on the field (gateways
configuration and management, fault management), whereas Radio Network Controller
(RNC) helps to constantly monitor and optimize radio performances and coverage of the
entire network (frequencies, spectrum, coverage, power, load).
5
- Get the status of gateways
- And do all of this simultaneously on all the gateways
The Radio Network Controller (RNC) gets statistics about the LoRa Network such as RSSI,
SNR, TOA, Numbers of messages.
On top of that, the Gateway Management System (GMS) provides a single interface to the
user, manages users and rights, and can manage different companies in a single system. GMS
is the access point of the solution for Application servers.
WMC comes with a set of dashboards and thus provides a user-friendly web interface that
facilitates the management of the Lora network.
5
Secured
Modifiez le style channels
du titre - OpenVPN
OpenVPN
certificate
Smart cities Smart agriculture
OpenVPN VPN
certificate
Smart grid
Smart metering
OpenVPN
certificate
OpenVPN protocol
• Creation of secure channels between the gateway and the WMC
• Authentication thanks to OpenVPN certificates installed on gateways and WMC server
Since the gateways can be anywhere, connected over ethernet, GSM or Wi-Fi, the Kerlink
solution must be managed remotely and securely.
OpenVPN protocol is used to create secure channels between the gateway and the WMC.
OpenVPN supports bidirectional authentication based on certificates, meaning that the client
must authenticate the server certificate, and the server must authenticate the client
certificate before mutual trust is established.
The OpenVPN certificates on Gateway is linked to its serial number. It is valid for 2 years and
must be renewed every 2 years.
The OpenVPN certificates is generated and provided by Kerlink support team, but Customer
has the responsibility to update the gateways with the up-to-date certificates
6
WMC
Modifiez le - Features
style du titre
Gateways Management
(Status, update, configuration)
Multicast Workflows
As we have seen previously, the WMC is not just a simple LNS. It offers many features that
help to operate your LoRa network simply.
Thanks to a user-friendly interface, you can manage your gateways. It is simple to get their
status, update and configure them. You’ll be able to manage your fleets of gateways and your
clusters of end-devices, and to configure the backhaul of each gateway.
It is also easy to configure the radio, launch spectral scan to analyze radio conditions.
The alarms on WMC allow to highlight events, such as high CPU or memory usage and help to
detect dysfunctions or abnormal behaviors.
WMC also offers operational KPI & Statistics, allowing to easily operate the LoRa Network.
The workflow feature is very helpful to execute one or several tasks on one or several
equipments at the same time. As an example, upgrading the gateway firmware of an entire
fleet at the same time.
The WMC also makes it possible to manage the multicast functionality. It allows to aggregate
several end-devices together to send them the same message.
As an example, a multicast usage can be the use of a multicast message to stop the
7
streetlights of a city at the same time. Multicast feature allows then to optimize the use of
the network avoiding message congestions.
Finally, the WMC is an open-solution that offers an API to users and applications.
7
Wanesy Management Center
- LoRaWAN protocol -
In this module, we will see or review some Lora notions that it is important to understand for
a good use of the WMC.
8
LoRa
Modifiez leNetwork
style du titre Server & Application Server
Wanesy Management Center
NWSKey1
AppSKey1 AppSKey1
DevAddr1 End-device 1 DevAddr1
Gateways 2 NWSkey1
NWSKey2
AppSKey2
Internal Application Server Customer
DevAddr2 LoRa Network Server Application Server
End-device 2 for encryption/decryption
Gateways 1
The end-devices send information to all the gateways that are in their coverage area. The
messages then pass over the IP network to the Network Server and then the Application
Server.
9
Network Server.
It is also necessary to be able to address the end-devices. The end-devices will therefore have
a DevAddr address. This address will also be written in the application server.
In summary, we will find 3 parameters on the end-device side that will make it possible to
manage the addressing, authentication and encryption and these 3 parameters must be the
same on the Network Server and Application Server side.
- Network Session Key : NWSkey
- Application Session key : AppSkey
- Device Address : DevAddr
That means that messages from end-device 1 will be authorized by Network Server and
transmitted to Application Server where messages from end-device 2 will be blocked by the
Network Server.
9
Encryption & Authentication
Modifiez le style du titre
MIC at sending
Let's see how are done the encryption and the authentication.
The data measured by the end-device at the start is unencrypted. In order to transmit this
information securely, the end-device uses the key AppSkey to encrypt it. It is this encrypted
information that is transmitted to the application server. Since the key AppSkey used by the
end-device to encrypt the data is known by the application server, the latter can decrypt it.
How is this encrypted data authenticated? We saw that the encrypted data is transmitted. It
is part of the frame. This encrypted data is also used by the end-device to generate a number
called MIC for Message Integrity Control by using the key NWSKey. This MIC is also
transmitted in the frame. That means that the network server will receive the encrypted data
and the generated MIC. The key NWSKey being known by the network server, the latter can
for its part calculate a value of MIC from the encrypted data received. If the MIC received in
the frame is equal to the MIC generated by the network server, then the frame is
authenticated.
Note that the same key is used to encrypt and decrypt the data.
10
End-device declaration – ABP method
Modifiez le style du titre
• Those fields are defined in the end-devices and provided by the end-device
provider
To be able to use a LoRA end-device, you must first activate it, that means declare the
information required for the transmission on the server side.
As seen previously, the mandatory parameters are
- Network Session Key : NWSkey
- Application Session key : AppSkey
- Device Address : DevAddr
We will see later in the training how to declare a end-device in the WMC using ABP method.
11
End-device declaration – OTAA method
Modifiez le style du titre
• Those fields are defined in the end-devices and provided by the end-device
provider
The 2nd method to declare an end-device is OTAA for Over The Air Activation.
The purpose remains the same, namely that the end-device and the server have the
mandatory parameters Network Session Key, Application Session key and Device Address.
On the server side, this time, we will declare 2 new parameters : the application EUI, AppEUI
and the application key, AppKey. These 2 parameters are also declared in the LORA end-
device. The unique identifier of the end-device, Dev EUI must also be configured on both
side. These are the parameters that will be used to know the mandatory parameters Network
Session Key, Application Session key and Device Address.
12
End-device declaration – OTAA method
Modifiez le style du titre
DevEUI DevEUI
AppEUI AppEUI
AppKey ➔ MIC End-device
LoRa Network Server AppKey
JOIN REQUEST
DevAddr
NWSKey
AppSKey AppKey ≠ AppSKey
The end-device send a join request using the DevEUI, AppEUI and AppKey information it has.
It will transmit the AppEUI, the DevEUI and a MIC which was generated by the device from
the AppKey.
The Network server authenticates the frame then generates 1 DevAddr, 1 NWSKey and 1
AppSKey which are the expected mandatory parameters.
So that these parameters are known by the end-device, the Network server will send a join
accept to the end device by transmitting the DevAddr and some other parameters. These
transmitted parameters, associated with the AppKey, will allow the device to generate the
same NWSKey and AppSKey as those initially generated by the Network server. The DevAddr
is directly transmitted in the frame.
Be careful !The application key, AppKey is different from the Application Session key
AppSKey.
We will see later in the training how to declare an end-device in the WMC using OTAA
method.
13
Frame Counter
Modifiez le style du titre
Frame 1
FCnt = 0 FCnt = 0
Frame 2
End-device FCnt = 1 FCnt = 1 LoRa Network Server
ABP Frame 3
FCnt = 2 FCnt = 2
Device RESET
Frame 0 FCnt = 3 > 0
FCnt = 0 Frame invalid !
Frame 1
FCnt = 0 FCnt = 0
End-device
Frame 2
OTAA FCnt = 1 FCnt = 1
Frame 3
FCnt = 2 FCnt = 2
Device RESET
Frame 0 FCnt = 0 Frame valid !
FCnt = 0
We can easily understand that this security measure has some consequences for end-devices,
which are declared using the ABP method. The frame counters reset to 0 every time the
device restarts (when you flash the firmware or when you unplug it). As a result, the WMC
will block all messages from the end-device until the FCntUp becomes higher than the
previous FCntUp. Therefore, you should re-register your end-device in the backend every
14
time you reset it.
This case does not occur with an end-device declared with OTAA method since each time the
end-device starts up, a join request is sent, and the frame counters are reset to 0.
14
Rx Delay
Modifiez &titreCFList
le style du
1s
2s
• CFList
• 3 mandatory channels
• 5 customizable channels, transmitted in the CFList
In the LoRa training module, we saw that in the case of class A end-devices, the reception
windows RX1 and RX2 are defined 1s and 2s after the uplink message.
It is possible to define an Rx Delay parameter which allows to change the delay between the
uplink message and the Rx windows. This parameter is transmitted in the JOIN ACCEPT
frame. It could be helpful in case of network with latency.
The end-device, to communicate, will use a certain number of channels. 3 are mandatory and
then known by the end-devices (868.1, 868.2 and 868.3 for the 868-band case). 5 channels
are customizable. These channels are defined by the server and transmitted to the end-
device in the JOIN ACCEPT frame.
The Rx Delay and the CFList are only available with OTAA method.
15
Adaptive
Modifiez le style duData
titre Rate - ADR
The last concept presented in this module is the ADR for Adaptive Data Rate.
The ADR allows an end-device to communicate in good conditions without wasting power.
The idea is to consume enough power to be understood but not too much so as not to waste.
The 2 adjusted parameters are the spreading factor and the Transceiver transmit power.
These parameters are automatically adjusted by the LoRa Network Server and transmitted to
end-devices in the LinkADRReq frame. The ADR algorithm used by the WMC is proprietary
and confidential.
The principle is as follows :
If the spreading factor is too high, then the transmission is longer. The impact
is a loss of energy.
If the spreading factor is too low, then the SNR (Signal Noise Ratio) is too
low. The impact is reception noise problem.
If spreading factor is well adapted, then there will be no reception problem
or loss of energy.
If the transmit power is too high, it is a loss of power.
If the transmit power is too low, then the receiver doesn’t understand the
transmission.
If the transmit power is just above the receiver sensitivity, the receiver
understand the transmission without any lost of power
16
Wanesy Management Center
- Rights Management -
17
Users
Modifiez le and roles
style du titre
• ADMIN
• Customer administrator
• Can only access and configure the data of the customer he belongs
• USER
• Can access and configure a part of the data of the customer he belongs
• READER
• Can only access data of the customer he belongs in read-only mode
18
What
Modifiez le to
style do
du titrewith what role?
19
What
Modifiez le to
style do
du titrewith what role?
A reader user can only consult end-device overview, list data up and down, list the messages
and the events for the customer he belongs.
The user level can in addition reset the frame counter down and send data down messages
for the customer he belongs.
The admin and super admin can in addition edit and delete end-device, the admin for the
customer he belongs and the super admin for all the customers.
20
What
Modifiez le to
style do
du titrewith what role?
Finally, a user and an admin can preview a template, execute a workflow on a selection,
consult running workflows, completed workflows and workflows result.
A super admin can in addition create, edit and delete a template.
21
How tostylecreate
Modifiez le du titre a WMC user ?
To create a new WMC user, go to Users menu in the Administration section. Then click on the
plus button. A new windows is displayed for user creation.
[CLICK]
Enter the username, the email of the user. Then specify the Customer he belongs.
Add his role and a password.
You have the possibility to define an expiration date for this user.
Finally, a radio button offers the possibility to activate or deactivate the user.
Note that, on the list of existing users, you can edit a user by clicking on the pencil icon. If you
click on the trash can icon, the user will be deleted.
22
Wanesy Management Center
- Resources organization -
23
Resources organization
Modifiez le style du titre
CUSTOMER 1 CUSTOMER 2 …
FLEET 1 FLEET 3 FLEET 4 CLUSTER 1 CLUSTER 2 FLEET 2 CLUSTER 3
Push API
• REST
• WS
Push API
• REST
• WS
Push API
• REST
• WS
AS2
AS1
AS3 AS4
We have seen that a LoRa network is made up of end-devices, gateways and application
servers.
Let's see how these elements are organized in the WMC.
The grouping of gateways into several fleets is often linked to the way you operate your
network.
This can be by type of gateway or by geographical grouping for example.
A cluster is often used to group end-devices that have the same function (for example
measuring the amount of water in the soil) but above all, a cluster groups together end-
devices which send their data to the same application server.
Note that a cluster is linked to only 1 application server. If you manage several applications
servers, you must define as many cluster as application servers or you must put in place
MQTT solution to push the same data to several application servers.
24
How tostylecreate
Modifiez le du titre a customer ?
Let’s see how to create customer in WMC. Note that this option is available only for SUPER
ADMIN users.
As we previously saw, multiple customers can share the same WMC instance. They only see
their own fleets and clusters, unless the gateways are declared in public mode.
As a Super Admin user, you can create, update and delete a customer.
To create a new customer, go to Customer menu in the Administration section. Then click on
the plus button. A new windows is displayed for Customer creation.
[CLICK]
Complete the Name field which is mandatory. Then you can add an external URL to point to a
logo.
Enable the Billing option if you want to generate MDR messages (Message Detail Record).
We’ll see later in the training how it works.
Then click on Next button. A new window is displayed to set Customer limitations if any.
[CLICK]
Leave fields empty to deactivate limitations.
25
Then click on Next button. A final window is displayed to enable the Geolocation option if
purchased.
[CLICK]
Check the box to enable it and set an expiration date if any.
Then click on Validate button.
Now, your customer id created.
25
Available
Modifiez le style duactions
titre on a customer
Edition
Deletion
Fleet names
Cluster names
26
How tostylecreate
Modifiez le du titre a fleet ?
A fleet is a logical way to group gateways. Note that a gateway can only be present in one
fleet.
As a Super Admin user, you can create, update and delete fleets for all the Customer.
As an Admin user, you can create, update and delete fleets of the Customer you belong. Only
the name of the fleet can then be modified.
To create a new Fleet, go to Fleets menu in the Administration section. Then click on the plus
button. A new windows is displayed for Fleet creation.
Select the customer to which you wish to attach the fleet and complete the Name field which
is mandatory.
For Admin user, the Customer is selected by default.
When accessing to the fleets menu in the administration section, the list of existing fleets is
displayed.
Fleet ID can be retrieve in this page, it can be useful for API requests for example.
If you click on the pencil icon, then you can edit the fleet.
If you click on the trash can icon, then you can delete the fleet. It will automatically delete
the gateways attached to the fleet.
A filtering section allows you to search on a fleet name or a customer name for Super Admin
27
users.
27
How tostyledeclare
Modifiez le du titre a gateway ?
Ex:7276FF003903046C
As a Super Admin user or an Admin user, you can create, and delete gateways.
As a Super Admin user, you have access to the gateways of all the customers.
As an Admin user, you only have access to the gateways for the customer you belong.
Note that if you want to update the settings of a gateways (its fleet as an example), it must
be done in the Gateways menu of the Management section. We will come back to this part
later.
To declare a new gateway, go to Gateways menu in the Administration section. Then click on
the plus button. A new windows is displayed for Gateway creation.
[CLICK]
Select the fleet to which you want to attach the gateway, then enter its EUI. As we saw in the
KerOS training module, a gateway is identified by its EUI. It is the combination of the OUI (for
Organizational Unit Identifier) and a part of the serial number of the gateway.
You can then enter a name. You must select the Brand (Kerlink for example), the region
(868MHz for example) and the visibility (private or public).
Note that a gateway can only be present in one fleet.
If the gateway is declared in private mode, then only the end-devices belonging to the same
28
customer can communicate with this gateway.
If the gateway is declared in public mode, then all the end-devices of all the customers can
communicate with this gateway.
The IP and the port section corresponds to the VPN. You must let them empty. They will be
automatically completed at the gateway connection.
Some advanced parameters can be set. The Geolocation to enable the GPS position of the
gateway, the downlink option to allow downlink on the gateway and the Adaptive latency to
enable Adaptive latency.
We highly recommend to set the network delay manually if needed instead of using the
adaptive latency.
Finally, it is also possible to set Max. TX power in dBm. If it is let empty, then the default
value is 27dBm.
Network max. delay up and Network max. delay down are accessible at gateway creation but
generally, these fields are completed, if needed, during optimization phase as you must know
about network latency.
28
How tostyleimport
Modifiez le du titre several gateways ?
29
How tostylecreate
Modifiez le du titre a push configuration?
To create a new push configuration, go to Clusters menu in the Administration section. Then
click on the push configuration tab and click on the plus button. A new windows is displayed
for push configuration creation.
[CLICK]
Select a Customer and enter a name. Choose either HTTP, Websocket or MQTT.
Define the message detail you want to transmit to your application server, either Payload,
Radio or Network.
Radio means Payload messages plus radio fields. Network which is the most detailed
message, means Radio plus network fields.
30
the uplink route, and /dataDownEvent for the downlink route.
Those 2 routes must exist on your application server from the ROOT_DIRECTORY path.
Then click on next button. The window to define Custom headers is displayed if any.
[CLICK]
These fields are optional. It could be used in case of HTTP/HTTPS to indicate the application
server what the format of the data is if it wants to decode it. JSON format in our case.
30
Available
Modifiez le style duactions
titre on push configuration
To access the list of push configurations, go to clusters menu in the Administration section
and click on Push configurations tab.
All the existing push configurations are displayed.
For each push configuration, you can click on the eye icon to display the detail of the push
configuration.
If you click on the heart icon, a message is displayed to inform if the push configuration is
well configured or not.
The pencil icon allows to edit the push configuration and modify it.
The trash can icon allows to delete the push configuration.
31
How tostylecreate
Modifiez le du titre a cluster ?
As a super admin user, I can see the clusters of all the customers and as an admin user, I can
only see the clusters of the customer I belong.
An ADMIN user can manage (create/modify/delete) clusters of his own customer.
A SUPER ADMIN can manage (create/modify/delete) clusters of all customers.
Click on the plus button. A new windows is displayed for cluster creation.
[CLICK]
Select the Customer, enter a name, enable the Push and select the required push
configuration.
Also define the type of payload : Hexadecimal or Base 64.
On the list of existing clusters, you can edit a cluster by clicking on the pencil icon. If you click
on the trash can icon, the cluster will be deleted. All the end-devices attached to this cluster
will be deleted too.
32
How tostyledeclare
Modifiez le du titre an end-device ?
As a Super Admin user, you can create an end-device for all the customers.
As an Admin user, you can only create an end-device for the customer you belong.
[CLICK]
First of all, select the cluster, enter a name and select a Profile (Static, Walking or Vehicle).
Then select the Region (868 MHz as an example). You then must specify the LoRaWAN MAC
and the Regional parameters revision of the end-device. The LoRaWAN MAC version depends
on the region and the Regional parameters depend on the LoRaWAN MAC version. This
information is given by the end-device provider.
Check the ADR box if you want to enable the Adaptative data rate for this end-device.
[CLICK]
33
A new window is displayed to specify the type of end-device, Over The Air Activation or
Activation By Personalization. Depending on the choice, the configuration will not be the
same.
As we saw in the LoRaWAN protocol training module, for OTAA type, you must specify the
device EUI, the Application EUI and the Application key. In case of ABP type, you must specify
device EUI, Application session key, Device addr and Network session key. This information is
given by the end-device provider.
Be careful. For OTAA, DO NOT CHECK THE BOX 'Enable' of 'DevNonceCounter’. When
disabled, the devNonce value is choosen randomly.
[CLICK]
A new window is displayed to specify if you want to override RX parameters.
If you check the “Override RX parameters” checkbox, it will allow you to set specific
parameters for an end device instead of using the default ones described in the LoRaWAN
Specification.
Those parameters are:
- RX1 delay: delay in seconds before the opening of the RX1 receive window.
- RX2 data rate : the spreading factor of the RX2 receive window.
- RX2 frequency: the frequency in Hertz of the RX2 receive window.
- RX WINDOWS: the receive window to use. Auto value allows to use RX1 or RX2 receive
windows.
- RX1DROffset : which is an offset applied on the data rate for downlink messages according
to the uplink data rate
You can also define a CF List. You then specify up to 5 customizable channels that will be
configure on the end-device.
[CLICK]
A new window is displayed to for end-device geolocation. If you choose the Manual option,
then you must enter the latitude, the longitude and the Altitude.
33
How tostyleimport
Modifiez le du titre several end-devices ?
34
Multicast
Modifiez le style duGroups
titre
To create a new multicast group, go to multicast groups menu in the Administration section.
Then click on the plus button. A new windows is displayed for multicast group creation.
[CLICK]
First of all, select the cluster and enter a name for your new multicast group. All the end-
devices concerned by a multicast must belong to the same cluster.
Then, you must specify the multicast address, the application session key and the network
session key. The multicast address and associated network session key and application
session key must come from the application layer.
Note that all the end-devices must be flashed with 2 pairs of keys:
•The end-device's own keys (OTAA or ABP keys).
•the Multicast group keys defined above.
35
Specify the region (868 MHz as an example), the LoRaWAN MAC version and the regional
parameters revision.
You also must define a fixed frequency in MHz and a DataRate (a string formatted as
"SFxxBWyyy" with xx from 7 to 12 and yyy = 125/250/500 for LoRa modulation or yyy=5000
for FSK modulation)
Then click on Next button. A new window is displayed to select the end-devices.
[CLICK]
On the left, all the end-devices belonging to the selected cluster are displayed. You just have
to click on the end-devices to add or remove them.
Finally, on the list of existing multicast groups, you can edit a multicast group by clicking on
the pencil icon. If you click on the trash can icon, the multicast group will be deleted.
35
Softwares
Modifiez le style du titre
The menu Softwares in Administration section allows a super admin user to upload and
delete software to the server repository.
An admin user can select a software already available in the server repository.
A package uploaded on this repository can be used in a workflow command. For example,
when you want to upgrade the firmware of one or several gateways, upload it first on this
repository and update the gateway directly using the workflow. Thus, it secures the upload of
the firmware on the gateway.
36
Wanesy Management Center
- How to connect gateways ? -
37
How tostyleconnect
Modifiez le du titre a new gateway to WMC?
For new gateway out of the box, Magic Link (SSH session) or Zero Touch
Provisioning (ZTP) are recommended
A gateway that comes out of production only contains the KerOS firmware. It must be
updated with the last KerOS version. The packet forwarder CPF must be activated and the
WMC embedded applications installed.
Except if you have purchased a prestaging service, you will have to make these updates
yourself.
There are several ways to do this, the magic link, the USB stick, the Ethernet connection or
the Zero Touch Provisioning ZTP.
In order to facilitate these updates and avoid errors, we recommend using magic link or zero
touch provisioning. More information are available on the Kerlink Wiki
38
How tostyleget
Modifiez le a Magic Link?
du titre
When you want to connect a new gateway to a WMC instance, you must send an email to the
support team or open an OTRS ticket to request a Magic Link. You must provide the following
information :
1. The Gateway EUI or Board ID
2. The WMC Server name
3. The Customer name
4. The Fleet name
5. And the Regional parameters
Then Kerlink will create a magic link for your gateway or add it to an existing one if it is
possible. Several gateways can be managed in the same Magic Link if they share the same
parameters. The magic link will be sent with Pastebin. Be careful, Pastebin link has a limited
validity and can be open once.
39
How tostyleuse
Modifiez le du titreyour Magic Link?
When you receive the magic link, just copy paste the script to an SSH session. The gateway
will then connect to the kerlink provisioning server which will verify provisioning information
and check gateway serial number. It will then send software and provisioning data to the
gateway.
The gateway will reboot and be ready within 5 minutes. It may vary depending on the
number and type of provisioning operations.
And finally, the Magic link will declare your gateway on the WMC instance. Note that this last
step is not available for on-premises instance.
40
Zero
Modifiez Touch Provisioning (ZTP)
le style du titre
The KerOS FW 4.3.3 integrates the Zero Touch provisioning (ZTP) feature.
When you receive the gateway, you don’t need anymore to install software or to configure it,
it is plug&play: you connect the gateway to the network with an Ethernet connection and the
gateway will be automatically self-provisioned and configured for your needs.
We recommend that you discuss this functionality with your kerlink sales representative
when ordering your gateways to anticipate these declaration otherwise you will have to ask
the Kerlink support team as usually for Magic Link process.
.
41
Wanesy Management Center
- Network Management -
Now we have seen how to set up our Lora network, we will see how to manage it.
42
Consult
Modifiez le styleand
du titre analyze a fleet
A global overview of each fleet is available by clicking on the Fleets menu of the Management
section.
Select the desired fleet at the top left of the dashboard.
If you click on one of these links, it displays the list of the concerned gateways allowing you to
get more information about the issue.
A map showing the position of the gateways is available at the top right. The GPS must be
activated on the gateway to have this display.
Finally, an overview of the gateways is displayed for CPU, RAM, System disk, User disk, RSSI
cellular and temperature. If you click on one of these sections, it displays the list of the
43
concerned gateways allowing you to get more information about the issue.
43
Search and
Modifiez le style list the gateways of your fleets
du titre
It is possible to display all the gateways belonging to a specific fleet or to all the fleets.
This dashboard is accessible by clicking on Gateways menu of the Management section.
Select the desired fleet at the top left of the dashboard. It is also possible to choose All fleets
selection.
By default, the list of all the gateways belonging to the selected fleet is displayed.
[CLICK]
Then, you can use the filter panel to filter the gateways you want to display according to one
or several of the following criteria:
• The Name of the gateway
• The EUI of a gateway.
• The status of the gateways (connected, disconnected or never connected).
• The door status of the gateways (open, closed, not applicable or unknown).
• The GPS status of the gateways (locked, unlocked, not applicable or unknown).
• Different alarms (CPU, RAM, system or user disk, RSSI, Temperature or voltage)
• Specific values on CPU, RAM, system or user disk, RSSI, Temperature or voltage
At the top right of the list, there is a 3 vertical dots button. By clicking on it, you access to a
44
menu allowing to refresh the dashboard, select the columns you want to show and hide and
export all the gateways in a csv file.
From this list of gateways, it is possible to go down to a gateway view. To do this, just click on
the gateway that you want to access.
44
Gateways - Overview
Modifiez le style du titre
And finally, the list of the modems with radio information is displayed.
[CLICK]
By clicking on the pencil button at the bottom left, it is possible to update some settings of
the gateways, the fleet, the name, region, country and visibility, the GPS activation, the
downlink activation and the Adaptive latency.
It is also possible to change the VPN IP address and port, but it is not recommended. It can
only be used for specific configuration and only with on-premises instances.
45
The coordinates of the gateways can also be updated from this menu (latitude, longitude and
altitude).
45
Gateways – Configuration - SNMP
Modifiez le style du titre
You can configure remotely each gateway. All the available options are under Configuration
Menu.
[CLICK]
It is possible to define an external application that can be used to monitor the solution.
The MIB is available on the Kerlink WIKI on WMC SNMP MIBs section.
46
Gateways – Configuration - Alarms
Modifiez le style du titre
[CLICK]
It gives the current values for CPU, RAM, System disk, User disk, RSSI cellular, Temperature
and door) and the possibility to set the threshold and the hysteresis for each parameter.
This menu is related to the selected gateway.
47
Gateways – Configuration - Clock
Modifiez le style du titre
The Clock menu allows to define/modify NTP servers used by the gateway.
48
Gateways – Configuration - VPN
Modifiez le style du titre
49
Gateways – Configuration - Backhaul
Modifiez le style du titre
The Menu Configuration/Backhaul allows you to define the configuration of the gateway
backhaul.
You can define the priority between the interfaces (Ethernet, WiFi and Cellular).
You can activate DHCP for Ethernet, configure the WiFi, defines the cellular operators (MCC,
MNC and APN).
If there is latency on the network, it is possible to define a networks delays for uplink and
downlink.
50
Gateways – Configuration - Radio
Modifiez le style du titre
The radio menu allows to configure the radiopath and channel frequencies of the gateway
modems.
[CLICK]
You can specify the Max Tx power that the gateway will be able to use. This value is linked to
each country regulation.
[CLICK]
You can also define the radiopath width and intervals of each modem, set the antenna gain
and insertion loss depending and your installation and define each channel.
This parameters must be adjusted depending on the country regulation and the supported
channels of your end-devices.
51
Gateways – Configuration - Software
Modifiez le style du titre
The menu Software queries the gateway to get its current component versions.
The information concerning the Last update is displayed as well as the versions history.
This dashboard can also be used to update the gateway. You just have to drag’n’drop the
package and plan the update.
52
Gateways – Configuration - History
Modifiez le style du titre
53
Gateways - KPI
Modifiez le style du titre
The following menu is the one giving access to the KPIs (Key Performance Indicators).
It gives access to a certain number of indicators at the gateway level such as link status, CPU,
RAM, number of uplink messages, RSSI, SNR etc…
[CLICK]
Just choose the indicator and the level of temporal aggregation. Then the trend is displayed
according to the previous selection.
54
Gateways - Data
Modifiez le style du titre
The menu Data Up and Down allows to display the RX & TX messages transmitted between
the gateway and the LNS.
For each message, you have access to the following information :
• Date
• Device EUI
• Device address
• Frequency
• RSSI
• SNR
• DataRate
• Radio ID
• Channel
• Coding rate
• Modulation
• Fine timestamp (if AES keys are defined)
• Delayed (used in case of buffering)
It is possible to apply filters on the period, the datarate and the frequency.
If you click on the Device EUI, you are automatically redirected to the dashboard device, on
55
the selected device.
[CLICK]
If you click elsewhere on the message, the detail of the message is displayed with the
payload.
[CLICK]
At the top right of the list, there is a 3 vertical dots button. By clicking on it, you access to a
menu allowing to refresh the dashboard, select the columns you want to show and hide and
export the current page in a csv file.
55
Gateways – Remote access
Modifiez le style du titre
• File explorer
• Shell
• Command
It is possible to remotely access the gateway either by launching the file explorer, or by a
shell or in command.
56
Gateways - Spectrum
Modifiez le style du titre
The SPECTRUM feature allows to launch a Radio frequency spectral scan of the gateway.
When you click on the Spectrum menu, it displays a dashboard with the list of executed
spectrum scan.
[CLICK]
To launch a new spectral scan, just click on the plus button, select the modem and the time
duration.
The minimum duration is 90 seconds
Once launched, the status is pending until the spectral scan is available. Once ready, the
Status becomes OK.
[CLICK]
If you click on the player icon, it launches a spectral scan player, and values are displayed in
3D.
If you click on the download icon, the measurements are downloaded in a csv file.
If you click on the trash can icon, the spectral scan is deleted.
57
Gateways - Diagnostic
Modifiez le style du titre
• Tasks
• SNMP
• Gateway events
• Network events
[CLICK]
SNMP option shows the SNMP traffic between the gateway and the WMC
[CLICK]
Gateway EVENTS option lists all the events that were triggered on the gateway.
Events can be alarms (high CPU value for instance) or simple events such as station start,
door open/closed….
[CLICK]
Network EVENTS option lists events related to network such as FRQ_Duty_Cycle. The
gateway measures how long it transmits over 1 rolling hour. For example, no more than 6min
of transmission (TX) over 1 hour rolling, otherwise an alarm is issued by WMC.
58
Consult
Modifiez le styleand
du titre analyze a Cluster
A global overview of each cluster is available by clicking on the Clusters menu of the
Management section.
Select the desired cluster at the top left of the dashboard.
59
Search and
Modifiez le style list the end-devices of your clusters
du titre
It is possible to display all the end-devices belonging to a specific cluster or to all the clusters.
This dashboard is accessible by clicking on End-devices menu of the Management section.
Select the desired cluster at the top left of the dashboard. It is also possible to choose All
Clusters selection.
By default, the list of all the end-devices belonging to the selected cluster is displayed.
[CLICK]
Then, you can use the filter panel to filter the end-devices you want to display according to
one or several of the following criteria:
• Device EUI
• Name
• Device addr
• Class A, B or C
• Region
• LoRaWAN MAC version
• Regional parameters revision
• Status
• Profile (Static, Walking, Vehicule)
60
• ADR (enabled or diabled)
At the top right of the list, there is a 3 vertical dots button. By clicking on it, you access to a
menu allowing to refresh the dashboard and export all the end-devices in a csv file.
60
End-devices
Modifiez le style du titre - Overview
If the GPS is activated on the gateways which communicate with this end-device, then these
gateways will be displayed on the map.
The activation mode (OTAA or ABP) and the parameters are also displayed in the Overview.
In the OverrideRX parameters section, we find the values of the parameters Rx delay and CF
list if any.
Finally, 3 sections allow to display the last messages, the last gateways which communicate
with the end-device and the last events. If you click on one of the gateways listed, you are
automatically redirected to the Overview of the selected gateway.
61
[CLICK]
Clicking on the pencil button, at the bottom right of the dashboard, allows to edit the end-
device.
It is then possible to change its cluster, its name, to enable/disable ADR, to enable/disable
DevNonceCounter and to change geolocation type.
61
End-devices
Modifiez le style du titre - Channels
The channels menu displays the channels that are configured on the end-device.
This dashboard is purely informative. No modification is possible.
From version WMC 3.2, when no CF list is defined at end-device level, this list is created
directly from the radio configuration of the gateways through which the uplink messages
transit.
62
End-devices
Modifiez le style du titre – KPI
The following menu is the one giving access to the KPIs (Key Performance Indicators) for an
end-device.
It gives access to a certain number of indicators at end-device level, for uplink and downlink
such as the number of messages, the total size of messages, the time on air by channels etc…
[CLICK]
Just choose the indicator and the level of temporal aggregation and the trend is displayed
according to the previous selection.
63
End-devices
Modifiez le style du titre – Data Up
RX messages (Uplink) sent from the end-device to the LNS through a gateway registered in WMC
The panel “Data Up” lists the RX messages sent by the end-device and received by the
gateways.
For each message, you have access to the following information :
• Date
• Device address
• Fport
• FCntUp
• FCntDown
• ADR
• Class B
• Pushed
• Frequency
• RSSI
• SNR
• DataRate
• Gateway
• Radio ID
• Channel
• Modulation
• Fine timestamp
64
• Coding rate
• Delayed (used in case of buffering)
• Gateway received time
It is possible to apply filters on the period, the pushed information, the Fport, the datarate
and the frequency.
If you click on the Gateway EUI, you are automatically redirected to the dashboard Gateways,
on the selected gateway.
[CLICK]
If you click on a message row, it displays its details (payload type and payload).
[CLICK]
At the top right of the list, there is a 3 vertical dots button. By clicking on it, you access to a
menu allowing to refresh the dashboard, select the columns you want to show and hide and
export the current page in a csv file.
64
End-devices
Modifiez le style du titre – Data Down
The panel “Data Down” lists the TX messages (Downlink) sent (or tried to send) to the end-
device through a gateway registered in WMC
.
For each message, you have access to the following information :
• Date
• Gateway
• Fport
• FCntDown
• Acknowledged
• Attempts
• Status
• RX Window
• Frequency
• DataRate
It is possible to apply filters on the period, the status and the Fport.
If you click on the Gateway EUI, you are automatically redirected to the dashboard Gateways,
on the selected gateway.
65
The panel “Data Down” enables you to send a TX message to the end device.
[CLICK]
Just click on the plus button to create the message to be sent
• FPort: The frame port number
• Payload type : The type of the message content (Hexadecimal or text)
• Payload: The message content
• Acknowledgement enabling/disabling: If you click on Enable, then 2 parameters
are requested, Nb max attempts and Timeout. Nb max attempts corresponds to
the number of re-transmissions of the message when the ACK is not received by
the end-device. Timeout is the time between 2 re-transmissions of the confirmed
message. Please note that the timeout value must be greater than or equal to the
period for sending uplink messages. For example, if the transmission of an uplink
message is every 60s then the timeout must be at least equal to 60s. If this rule is
not respected, then a KO will be systematically returned by the WMC.
65
End-devices
Modifiez le style du titre - Messages
All messages sent/received to/by the end-device through a gateway registered in WMC
The Messages dashboard displays all the messages sent and received to and by the end-
device through a gateway registered in WMC.
66
[CLICK]
It is possible to apply filters on the period, the direction, the ack, the mac command and the
gateway.
If you click on the Gateway EUI, you are automatically redirected to the dashboard Gateways,
on the selected gateway.
[CLICK]
If you click on a message row, it displays its details (payload type and payload).
[CLICK]
At the top right of the list, there is a 3 vertical dots button. By clicking on it, you access to a
menu allowing to refresh the dashboard, select the columns you want to show and hide and
export the current page in a csv file.
66
End-devices
Modifiez le style du titre – Events
It is possible to apply filters on the period, the type and the name of the event.
[CLICK]
At the top right of the list, there is a 3 vertical dots button. By clicking on it, you access to a
menu allowing to refresh the dashboard and export the current page in a csv file.
67
Multicast
Modifiez le style dugroups
titre
When you click on Multicast groups menu in the Management section, the list of the
Muticast groups created in the administration section is displayed.
For each multicast group, you have access to the following information :
• Multicast address
• Its Name
• The FCntDown defined
• The frequency that will be used to send multicast. Pay attention to the chosen
channel in relation to the duty cycle. Some channels allow 1% use of the channel
(ex 868.1Mhz), others 10% (ex: 869.525Mhz).
• The Datarate
• And the number of end-devices associated to this multicast group
It is possible to apply filters on the multicast address, the name, the frequency or the
dataRate.
[CLICK]
At the top right of the list, there is a 3 vertical dots button. By clicking on it, you access to a
menu allowing to refresh the dashboard and export the current page in a csv file.
68
If you click on one of the Multicast address in the list, you are redirected on an Overview
dashboard for the selected Multicast group.
68
Multicast
Modifiez le style dugroups
titre - Overview
The overview dashboard summarizes the parameters of the selected multicast group and the
list of end-devices that can be addressed by this multicast.
69
Multicast
Modifiez le style dugroups
titre – Data Down
If you click on the DATA DOWN tab, it lists all the Downlinks multicast message sent to this
multicast group.
For each message, you have access to the following information :
• Date of the multicast
• The Fport. Be carreful. Do not use the value 0 for "Fport“ as it is reserved for MAC
commands
• The FCntDown
• The Global status of the multicast
• The Gateways. If several gateways are used to send this multicast to the end-
devices listed in the group, then they are all displayed in the dashboard
• The Status per gateway
• The Frequency
• And the datarate
If you click on the Gateway EUI, you are automatically redirected to the dashboard Gateways,
on the selected gateway.
[CLICK]
If you click on a message row, it displays the detail of the multicast (payload and history).
70
In order to create a new downlink for the group, just click on the plus icon.
[CLICK]
You can then define the Fport, the payload type and the payload to be sent.
70
KPI
Modifiez le style du titre
Just select the Customer, the fleet and the gateway or the cluster and the end-device.
[CLICK]
And then choose the indicator and the level of temporal aggregation. The trend is then
displayed according to the previous selection.
71
Wanesy Management Center
- Selection -
72
Manage
Modifiez le style Selection
du titre – Gateways and End-devices
Gateways End-devices
selection selection
In order to manage certain actions massively, the WMC offers a multi-selection system at the
gateway and end-device level.
These selections are accessible thanks to the 2 shopping cart icons displayed at the top of
each dashboard, one for gateways and one for end-devices.
Clicking on these icons allow to manage the selection.
The current selection is displayed on the left with the possibility to empty it.
73
Manage
Modifiez le style Selection
du titre – Save current selection
Gateways End-devices
selection selection
You can save the current selection by clicking on this icon. You then must name it and
eventually enter a description to easily use it in the future.
74
Manage
Modifiez le style Selection
du titre – import a saved selection
Gateways End-devices
selection selection
75
Manage
Modifiez le style Selection
du titre – Manage saved selections
Gateways End-devices
selection selection
Add to current
selection
And finally, you can manage the saved selections. It is then possible to add one or several
selections to the current selection, view the detail of each saved selection or delete them.
76
Selection
Modifiez le style du– Gateway - Edit
titre
The Edit tab available in the Gateway selection allows to massively set the same Max Tx
Power to the current selection.
77
Selection
Modifiez le style du– Gateway - Move
titre
The Move tab available in the Gateway selection allows to massively move the gateways
displayed in the current selection to a specific fleet.
[CLICK]
You just must define this fleet.
78
Selection
Modifiez le style du– Gateway - Delete
titre
The Delete tab available in the Gateway selection allows to massively delete all the gateways
of the current selection.
79
Selection
Modifiez le style du– Gateway – Execute workflow
titre
And finally, the Execute Workflow tab available in the Gateway selection allows to massively
execute one or several tasks on the current selection at the same time.
[CLICK]
You must choose a template in the list and fill the parameters to start your workflow. The
parameters to be set depend on the tasks to be executed.
80
Selection
Modifiez le style du– End-devices - Edit
titre
The Edit tab available in the End-device selection allows to massively activate/deactivate the
ADR on the current selection.
81
Selection
Modifiez le style du– End-devices - Move
titre
The Move tab available in the End-device selection allows to massively move the end-devices
displayed in the current selection to a specific cluster.
[CLICK]
You just must define this cluster.
82
Selection
Modifiez le style du– End-devices - Delete
titre
The Delete tab available in the End-device selection allows to massively delete all the end-
devices of the current selection.
83
Selection
Modifiez le style du– End-devices – Execute workflow
titre
And finally, the Execute Workflow tab available in the End-device selection allows to
massively execute one or several tasks on the current selection at the same time.
[CLICK]
You must choose a template in the list and fill the parameters to start your workflow. The
parameters to be set depend on the tasks to be executed.
84
Wanesy Management Center
- Workflows -
85
Workflows - Templates
Modifiez le style du titre
The workflow feature is very helpful to execute one or several tasks on one or several
equipment at the same time. As an example, upgrade the gateway firmware of an entire fleet
at the same time.
Equipment can be either gateways or end-devices.
Then, you can use the filter panel to filter the workflow template you want to display
according to one or several of the following criteria:
• The Name of the template
• The description
• And the category (End-device or gateway)
At the top right of the list, there is a 3 vertical dots button. By clicking on it, you access to a
menu allowing to refresh the dashboard and export the current page in a csv file.
86
From this list of templates, it is possible to execute the template, view the detail of the
template, edit the template or delete it.
[CLICK]
In order to create a new template of Workflow, just click on the plus icon. A new window is
displayed for creation. Enter a name, a category, a description and the tasks you want to
execute.
86
Workflows – Templates – Available Web Services
Modifiez le style du titre
Gateways
• createGatewayCommand : allows to execute a command on the remote gateway
• createGatewayPutFileCommand : allows to put a file on the gateway file system
• getGatewayControl : allows to retrieve the control data* of a gateway
• getGatewayCurrentConfiguration : allows to retrieve the current configuration of one gateway
• getGatewayCurrentVersion : allows to retrieve the current version of one gateway
• getGatewayManagement : allows to retrieve the management fields** of a gateway
• updateGatewayControl : allows to update the control data* of a gateway
• updateGatewayManagement : allow to update the current gateway management data**
• updateGatewayManagedSoftware : allows to update the software of a list of gateways (from repository)
End-Devices
• createDataDown : allows to create a data down
• resetEndDeviceFrameCounters : allows reset the fCntUp and fCntDown to 0
The list of the available web services that can be used for workflow depends on the category
(end-device or gateway).
The descriptions of these web services are available in the GMS REST API documentation.
Thanks to workflow you can massively execute commands, retrieve control data,
configuration or management data on gateways for example.
87
How tostyleexecute
Modifiez le du titre a workflow?
After you created a workflow:
1. First, add equipment to your basket
2. Go in the workflows or directly in the selection
to execute the workflow
OR
Once your template is created, you must add the desired gateways or end-devices to your
selection.
[CLICK]
Then go in the workflow template menu and click on Execute icon
[CLICK]
or directly go in the selection to execute the workflow.
[CLICK]
Enter the expected parameters and launch the workflow.
88
Workflows - Running
Modifiez le style du titre
You can consult the running workflows. Just click on Running menu in the Workflows section.
You can easily see which workflow is running, the number of pending equipments, the
number of successful equipments, the number of failed equipments and the start date.
Note that it is possible to filter on the name or the Workflow.
89
Workflows - Completed
Modifiez le style du titre
[CLICK]
If you click on a row, the detail of the executed workflow is displayed. You can thus display
the list of equipment, the status per equipment and the start and end date.
90
How tostyleconsult
Modifiez le du titre an executed workflow?
[CLICK]
you get the detail of the executed workflow for this equipment.
[CLICK]
Then, if you click on the result, you display the detail of the execution.
91
Wanesy Management Center
- Alarms -
92
Gateways Alarms
Modifiez le style du titre
The alarms on WMC allows to highlight events, such as high CPU or memory usage and helps
to detect dysfunctions or abnormal behaviors.
At the top left of each dashboard, there are 3 icons displayed allowing to access to the list of
alarms.
• Alarms on gateways on the left
• Alarms on end-devices in the middle
• Alarms on network on the right
If you click on the alarm on gateways, the number of alarms is displayed per fleet. Just click
on the fleet to display the alarms.
[CLICK]
You can apply filters to adapt the display according to the following criteria :
[CLICK]type of alarm,
[CLICK]
status (read or unread) and the period.
93
The list of alarms is displayed with the following information : date, type, value and gateway.
To cancel an alarm, you must click on the bell icon of a given alarm.
If you click on the gateway, you are automatically redirected on the overview dashboard of
the gateway. You can then change the status and mark it as read.
93
End-devices
Modifiez le style du titre Alarms
If you click on the alarm on end-devices, the number of alarms is displayed per cluster. Just
click on the cluster to display the alarms.
[CLICK]
You can apply filters to adapt the display according to the following criteria :
[CLICK]
type of alarm,
[CLICK]
status (read or unread) and the period.
The list of alarms is displayed with the following information : date, type, value and end-
device.
To cancel an alarm, you must click on the bell icon of a given alarm.
If you click on the end-device, you are automatically redirected on the overview dashboard of
the end-device. You can then change the status and mark it as read.
94
Network Alarms
Modifiez le style du titre
If you click on the network alarm, the total number of alarms is displayed.
You can apply filters to adapt the display according to the following criteria : type of alarm,
status (read or unread) and the period.
The list of alarms is displayed with the following information : date, type, value and gateway.
To cancel an alarm, you must click on the bell icon of a given alarm.
If you click on the gateway, you are automatically redirected on the overview dashboard of
the gateway. You can then change the status and mark it as read.
Note that for Network category, only Duty Cycle alarm type is available.
95
Wanesy Management Center
- User Menu -
96
User Menu
Modifiez le - Profile
style du titre
It is possible to access the user menu by clicking on the user account icon at the top right of
the dashboard.
The first menu is Profile. It gives information on the user account.
97
User Menu
Modifiez le - Settings
style du titre
The Settings menu give access to the application settings. It allows to adapt some parameters
such as Refresh frequency for alarm, the Health refresh frequency for gateway and the tile
server URL for the map.
98
User Menu
Modifiez le – Activity logs
style du titre
The Activity logs menu gives access to all the activity performed by a user on the equipment.
[CLICK]
Some filters can be applied in order to facilitated the research of an activity.
[CLICK]
You can filter by user, GMS web service, IP, KTI, period, http status code, user agent and
duration.
If you click on a row, you display the detail of the web service.
99
User Menu
Modifiez le – Documentations
style du titre
The menu Documentations gives access to the available documentations of the WMC.
You can then easily access the GMS REST API documentation, the user manual but also some
useful videos helping to configure your WMC.
100
User Menu
Modifiez le – About
style du titre
The 2 last menus are About to get application version and sign out to disconnect.
101
Wanesy Management Center
- HTTP REST API -
102
GMS
Modifiez leREST
style du titre API - How to use Swaggerui?
The WMC comes with its http rest API which allows easy access to the application.
[CLICK]
This API is fully documented and provided with SwaggerUI, accessible on the link displayed at
the top of the http rest API documentation.
[CLICK]
Let’s see how to use SwaggerUI.
103
How tostylelogin?
Modifiez le du titre
Once on swaggerui, search for the login function, click on it to expand and click on Try it out
button.
[CLICK]
The request body is then displayed below. Change the login and password fields and click on
Execute button.
104
How tostylelogin?
Modifiez le du titre
Once executed, download the file with you token or directly copy the token.
[CLICK]
Go back to Authorize section (at the beginning of swaggerui)
[CLICK]
and enter your token.
[CLICK]
You are now connected to your WMC and ready to use swaggerui and test the API.
105