ThingPark Wireless

ThingPark Wireless
Device Manager GUI

User Guide
Revision: 1.1
Date: 2015/06/22
Versioning
Version Date By
0.1 10/03/2015 FLC First draft
0.2 07/04/2015 LVH Updated draft
0.3 24/04/2015 GRE Document style review
0.4 06/05/2015 GRE Document review
0.5 13/05/2015 GRE Document review
1.0 09/06/2015 DSO Document review
1.1 22/06/2015 GRE Screenshots update after new server release
Added Annex > Device Profile
Added batch provisioning (DELETE feature)
Actility. All rights reserved. Reproduction rights are reserved and strictly limited. This document
cannot be copied, redistributed or modified without authorization of Actility.
ThingPark Wireless Device Manager GUI User Guide
Contents
1 Definitions and Abbreviations ......................................................................................................... 3
2 Summary.......................................................................................................................................... 4
3 Log-in to the tools ........................................................................................................................... 5
4 Interface overview........................................................................................................................... 6
5 Devices............................................................................................................................................. 7
5.1 Search devices ......................................................................................................................... 7
5.2 Device map .............................................................................................................................. 7
5.3 Device list ................................................................................................................................ 8
5.4 Device details .......................................................................................................................... 9
5.4.1 Device Network ............................................................................................................. 11
5.4.2 Device Alarms ................................................................................................................ 13
5.5 Device provisioning ............................................................................................................... 14
5.5.1 Manual Device creation................................................................................................. 14
5.5.2 Batch provisioning (device imports) .............................................................................. 17
5.5.3 Modify a device ............................................................................................................. 18
5.5.4 Delete a device .............................................................................................................. 19
6 Connectivity plans ......................................................................................................................... 20
6.1.1 Connectivity Plan details ............................................................................................... 21
6.1.2 Assign/Change a Connectivity Plan ............................................................................... 22
6.1.3 Remove a Connectivity Plan .......................................................................................... 22
7 AS routing profiles ......................................................................................................................... 23
7.1.1 Create an AS Routing Profile ......................................................................................... 24
7.1.2 Modify or Delete an AS Routing Profile......................................................................... 26
7.1.3 Define or Remove an AS Routing Profile ....................................................................... 27
8 Settings .......................................................................................................................................... 28
8.1.1 Account Information ..................................................................................................... 28
8.1.2 Alarm Management....................................................................................................... 28
9 Troubleshooting ............................................................................................................................ 30
9.1 Opening multiple views ......................................................................................................... 30
9.2 Confirming changes ............................................................................................................... 30
10 ANNEX ........................................................................................................................................... 31
10.1 Device Profile......................................................................................................................... 31
2 v 1.1
Actility. All rights reserved. Reproduction rights are reserved and strictly limited. This document cannot be copied,
redistributed or modified without the authorization of Actility.
1 Definitions and Abbreviations
Term Definition
ADR Adaptive Data Rate
API Application Programming Interface
AppSKey Application Session Key
AS Application Server
DevEUI Device EUI, globally unique 64 bit identifier assigned according to the IEEE
EUI-64 guidelines
GUI Graphical User Interface
LoRa Long range and low energy radio RF technology developed by Semtech
LRC Long Range Concentrator
LRR Long Range Relay: LoRa Basestation
NOC Network Operation Center
NwkSKey Network Session Key
ONG Object Network Gateway
OSS Operations Support System
OSS Operations Support System
RSSI Received Signal Strength Indicator
SF Spread Factor
SNR Signal to Noise Ratio
SSO Single Sign On
3 v 1.1
2 Summary
The ThingPark Wireless Device Manager is the back-end User Interface (UI) which allows you to
manage all of your LoRaWAN devices.
This User Guide will provide the guidelines on the entire GUI, the device provisioning, device
configuration and management, alarm and routing profile management and connectivity plan
association.
The Device Manager can be fully integrated into a third party customer UI, through all the ThingPark
Wireless OSS REST API.
4 v 1.1
3 Log-in to the tools

 Launch the browser to access the URL: http://actility.thingpark.com/deviceManager/
 Click on Sign in with ThingPark
 Enter your login and password (please check with Actility in case you do not have valid
credentials)
5 v 1.1
4 Interface overview
When you login to the Device Management portal, you get an overview of all the devices of the
account is listed. You can easily shift between the Map and List view of devices, by clicking the
corresponding tabs.
The interface is based on 2 frames, a left sidebar menu and a main application frame showing device
data.
The left sidebar menu gives access to Devices, Connectivity plans, AS routing profiles and Settings.
The first main frame contains a Search bar, allowing users to search devices by Location, device
Identifier or another filtering criteria.
6 v 1.1
5 Devices
5.1 Search devices
The Search bar proposes 3 ways to search for a device:
 Location
Selecting a specific location in this field will zoom in the desired location.
 Identifier
This field allows users to search for a specific device by its EUI or its name. This field is case sensitive
 Filters
The other filters below will display devices matching any of the following criteria.
o Connectivity plan
o RSSI
o Battery level
o Alarm
5.2 Device map

The map displays the devices based on the manually-entered location information during the device
provisioning phase or based on the gateway location received during the last message.
If a device sends its location information inside its payload, and if the server has the ability to decode
such a payload format, the exact latitude and longitude can be extracted.
When clicking on a device, a pop-up window will display the following information on the device:
From this pop-up it is possible to go to the alarms list, View the device details or Edit the device
information.
7 v 1.1
5.3 Device list

The Device list displays all the filtered devices in a list.
In the Search section, a new check-box can Restrict search to visible map area, in order to filter only
devices displayed in the map view.
The displayed field are:
 Name / Type: name and device profile

 MAC address / Network address: DevEUI and DevAddr of the device
 Connectivity plan
 Average packets
 Average RSSI: based on the last 5 packets received
 Battery
 Alarm: number of alarms not acknowledged
 Locate: open a pop-up and display the device on a map
The filtering/sorting can be done on all the above mentioned properties. Users can therefore easily
display all devices for which e.g. the battery level is low, that have raised critical alarms, etc.
In order to View or Edit the device:
 View
o double click on a device
o select a device and click on View at the bottom of the list
 Edit
o Select a device and click on Edit at the bottom of the list
8 v 1.1
5.4 Device details

 Device frame
This frame displays the basic information of the device such as the model (device profile), name,
MAC address (DevEUI), Network address (devAddr).
The interface also provides information on the LoRaWAN traffic such as the average number of
packets, average RSSI, last RSSI/SNR/SF, date/time of the last message received/sent.
For devices supporting the feature, the battery status information can also be displayed.
The location of the device on the map could be provided in 3 different ways:
 Last GPS position reported by the device

 Manual location
 LRR (gateway) position which has received the last message
The “View location history” button displays a map with markers showing where the devices are
located.
HOW-TO update the location of a device

 In device Edit view
 Click on Update location under the map
 Select Manual location

 Enter an address in the Search field or click on the map to put a marker
 Click Save
9 v 1.1
 Uplink/Downlink frame
The graphic above displays the number of uplink/downlink packets and payloads (bytes) over the
selected period (Daily totals, last 7 days, last 15 days).
 RSSI/SNR/SF graph
The graphic above displays the RSSI, SNR or SF distribution over the selected period.
10 v 1.1
5.4.1 Device Network
The Devices/Network section provides information on the Network subscription, associated

connectivity plan, routing plans associated to the device and the Network Coverage.
 Network subscription
The Subscription section displays the current associated connectivity plan and the first date on which
the device has communicated.
The graphic displays the usage of the device in the connectivity plan, showing the number of packets
on the selected period.
HOW-TO change the Connectivity plan

 Go to the device Edit view
 Click on Change in the subscription section
 Select the desired Connectivity Plan from the drop-down menu
 Click Save
11 v 1.1
 Network/cloud routing
The Network routing section displays the current associated AS routing profile. It is possible to view
the details of this routing profile, or also change and remove it.
HOW-TO change or assign an AS Routing Profile
 Go to the device Edit view

 Click on Change in the Network routing section
 Select the preferred AS routing profile from the drop-down menu in the pop-up
 Click Save
12 v 1.1
5.4.2 Device Alarms
The Devices/Alarms section manages the alarms generated from the device on the network.
 Search filter
The filter allows users to search alarms in a specific date range or using other criteria.
o From / To: date range

o Alarm: type of alarm
o State: nature of the alarm
o Acked: Acknowledgement type
 Alarms list
The list shows when, why and how many times the alarm went off, as well as the current status of
the alarm. Furthermore, the Search tab gives extensive options to sort and filter alarms in order to be
able to treat them with the right priority level.
o To acknowledge an alarm, click on the desired alarm and click on Ack

o To acknowledge all alarm, click on Ack all
13 v 1.1
5.5 Device provisioning

The device provisioning allows users to create devices and register them on the network through
Activation By Personalization.
There are two ways to create a device
 Manual creation: create devices 1 by 1

 Batch creation: mass import from a csv file to create several devices in one go
Information required to create a new device:
 DevEUI
 DevAddr
 NwkSKey
Optional information may be required:
 AppSKey
5.5.1 Manual Device creation

The manual creation is mainly for support or development purpose. Once the device is in production,
refer to the Batch provisioning mode.
To create a new device manually:
 Right click on Devices
 Click on Create device

 A new pop-up appears with 4 sections: Device identification, Application layer, Network,
Administrative data
 Fill out the Device identification section. Please note that all fields are mandatory
o Device EUI (hexa): devEUI, device EUI, globally unique IEEE EUI-64 address
o Network address (hexa): devAddr, device Address
o Device profile: please refer to Device Profile
o Network key (hexa): NwkSKey, Network Session Key, 128-bit key
14 v 1.1
 Fill out the Application layer section
o To add a new Application Key

 Click on Add
 Fill the Key, 128-bit key
 Enter a port number
 Click on Update
NOTE
The port 0 is encrypted by the NwkSKey
The optional 128-bit AppSkey is used to encrypt the payload of the messages, and has to be shared
with the application server. You may decide to use a unique AppSkey for all LoRaWAN ports used by
your device (* keyword), or to allocate one AppSkey for each port.
 If you do not provision the AppSkey, ThingPark Wireless will forward the payload in
encrypted form to the application servers and has no access to the payload clear-form
content. Network tools like Wireless Logger will be unable to decode the payload and will
present it in encrypted form.
 If you provision the AppSkey(s), the LRC will decode the payload before forwarding it to the
application server(s) and the Wireless Logger tool will also present the packet payload in
decoded form (and parse this payload if the payload syntax is supported).
15 v 1.1
 Fill the Network section
o Choose a Connectivity plan in the drop-down menu, the displayed count indicates
the remaining connectivity plans available
o Choose an AS routing profile in the drop-down menu
 Fill out the Administrative data section
o Enter a name for the device

o Change the marker if you wish to customize the device marker
o Enter any relevant administrative information (Such information will be displayed in
the e-mail generated by an alarm)
o Set a location
 Network location
 Manual location
16 v 1.1
5.5.2 Batch provisioning (device imports)

The Device batch provisioning is more designed for a more industrialized provisioning process
including larger number of sensors.
Batch import provisioning starts with the preparation of a formatted CSV file to be imported into the
Device Manager.
The batch provisioning could also be used as mass deletion, in this case only the Device EUI is needed
to identify the device to delete.
 CSV file format

The structure of the CSV file is described below. The file should contain one row for every device that
has to be provisioned. The columns correspond to the device details that have to be completed for an
individual provisioning.
Column # Field name Description

1 Type  ‘#’: commented line
 ‘CREATE’ or empty: device creation
 ‘DELETE’: device deletion
2 DevEUI (hexa) globally unique IEEE EUI-64 address
In case of DELETE type, only DevEUI is required
3 DevAddr (hexa) device address
4 Profile ID Device profile ID, ask Actility to get the profile ID mapping
5 NwkSKey (hexa) Network Session Key, 128-bit key
6 AppSKeys XML encoded application keys, 128-bit key per port (see below)
7 Tpk Cloud Config XML encoded ThingPark Cloud config (see below)
8 Connectivity Name of the connectivity plan
Plan ID
9 AS Routing AS Routing Profile ID, go in Routing Profile details to get the profile
Profile ID ID
10 Marker ID Marker ID in the icon bank (between 100 and 114)
11 Device Name Name of the device

12 Admin LAT Latitude (decimal degrees)
13 Admin LON Longitude (decimal degrees)
14 Admin info Administrative information
File format: comma-separated values ‘,‘.
o AppSKeys format
<AppSKeys><AppSKey
Port="1">2B7E151628AED2A6ABF7158809CF4F3C</AppSKey><AppSKey
Port="2">2B7E151628AED2A6ABF7158809CF4F3C</AppSKey></AppSKeys>
o Tpk Cloud Config format

<modelCfgs><modelCfg>0</modelCfg></modelCfgs>
17 v 1.1
 Import the CSV file

 Right click on Devices
 Click on Import devices
 Click on Browse…
 Select the .csv file from your directory
 Click on Import
 The result of the import will appear in the “Importation result” screen.
5.5.3 Modify a device

Modifying a device allows you to update device-related data such as the name, the manually entered
location, define another connectivity plan or define a routing plan.
Start by opening a device in Edit view:
 Select the device to delete in the list

 Click on Edit to enter the Edit view
Modification allowed:
 Device name
 Administrative info
 Device location
 Device marker
 Change/remove a connectivity plan
 Change/remove a AS routing plan
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.
18 v 1.1
5.5.4 Delete a device

Deleting a device is an action which cannot be undone and should be handled with care. All device
details and device status information will be lost.
Below are the steps to delete a device:

 Click on Delete
 Confirm in the pop-up to delete the device

 Go back to the device list, click on Refresh to refresh the list
19 v 1.1
6 Connectivity plans
The Connectivity plan defines the network connectivity features (e.g. confirmed messages, downlink
traffic), and traffic policing parameters (token bucket regulators for uplink and downlink traffic) and is
associated to a given activation and recurring fee.
To access Connectivity plans, click on Connectivity plans in the left sidebar menu:
 Connectivity plans section

The first Connectivity plans section displays the available plans in your account:
o Connectivity plans: name of the connectivity plan

o ID: ID of the connectivity plan (needed for device batch provisioning)
o Purchased credit for end devices: number of maximum devices allowed in the plan
o Used up credit by end devices: number of devices registered on the selected plan
So the remaining devices that could be provisioned are “Purchased credit” – “Used up credit”.
Users can purchase other Connectivity Plans by clicking on Buy, and accessing the ThingPark Store.
20 v 1.1
6.1.1 Connectivity Plan details
In the Connectivity Plan details tab, the name, ID and description of the plan are displayed.
Furthermore, this tab provides a view on the following characteristics of the plan:
 Uplink frame parameters

o Ack: Feature flag to allow the network to send an ACK when requested by a device
operating in confirmed frame up mode.
o Rate regulator: nb of frames allowed per hour, nb of frames allowed in burst
o Regulator policy: uplink and downlink regulator policy
 Mark: the system will keep track of devices exceeding the limits set
 Drop: the system will drop packets that are beyond the limits set
o Minimal/Maximal SF: Lowest/highest spreading factor allowed for a device
o LRR buffering policy: RFU
 Downlink frame parameters
o Downlink transmission: activation state of the downlink transmission
o Rate regulator: nb of frames allowed per hour, nb of frames allowed in burst
o Regulator policy: uplink and downlink regulator policy
 Network parameters
o Mobility: RFU
o Network geolocation: RFU
o Base station metadata: feature flag to provide LRR meta information (RSSI, SR, SNR,
LRR, …) to third party application
 Routing parameters
o ThingPark cloud routing: Feature flag to allow routing to the ThingPark cloud service
o Third party application routing: Feature flag to allow routing to the ThingPark cloud
service
o Max. destinations per route: maximum number of destinations per route
21 v 1.1
6.1.2 Assign/Change a Connectivity Plan

First of all, go to the Device Edit view in order to modify a device:

 Go to the Network section
 In the Network subscription > Subscription section

 Click on Change
 Select your new Connectivity plan in the drop-down menu
 Click on Save
6.1.3 Remove a Connectivity Plan

To remove a Connectivity Plan, use the same process as above to assign/change a Connectivity Plan,
then click Remove.
22 v 1.1
7 AS routing profiles
The AS (Application Server) routing profile defines how the sensor data is routed to a back-end
application.
To access an AS routing profile, click on AS routing profiles on the left sidebar menu:
You will see the existing AS routing profiles in the list where you can View details or Edit an AS routing
profile.
The second section New AS routing profile gives the capability to add a new AS routing profile.
23 v 1.1
7.1.1 Create an AS Routing Profile

In order to create a new AS Routing Profile, go through the following steps:
 Click on Add in the New AS routing profile section
 Enter a name to the desired new AS routing profile
 Click on Create
 This new AS routing profile is opened and you can now edit it
 Set or unset the profile as default: check Is default checkbox

 Add a route
o Click on Add in the “Add a route” section
o A new section “Route” appears with a default route created
24 v 1.1
o Enter the Source ports to route

The Source ports can be only one port (enter the port number) or it could be all ports (enter ‘*’).
o Choose the Routing strategy

In case multiple destinations are given, the routing strategy defines how the data will be sent to
these destinations.
If “Sequential” is selected, the data will be sent to the first destination and only be sent to the
subsequent destination if the previous one is not available.
If “Blast” is selected, the data will be sent to all destinations at the same time
o By default, the route is the ThingPark Cloud (bigONG1)

o Select ThingPark Cloud and click on Delete to delete it
o Click on Add to create a new one
o Select the Type and the Destination of the new route
Type Destination
ThingPark Cloud bigONG1
bigONG2
netONG1
Third party AS (HTTP) url/ip:port
ex: http://actility.myserver.com/messages:1234
Refer to the “Application Developer Guide” for LRC frame
tunneling interface description
o Click on Add to add this new destination
25 v 1.1
 Sort between different destinations

o You can change the order in which messages will be sent using the arrow buttons
 To edit a destination, select it and click on Edit

 To delete a destination, select it and click on Delete
7.1.2 Modify or Delete an AS Routing Profile

In order to modify or remove an AS Routing Profile
 select the applicable Profile in the list

 click on Edit
 On the AS routing profile details in Edit view

 Click on Delete
NOTE
Remeter to click on Save after any modification made.
26 v 1.1
7.1.3 Define or Remove an AS Routing Profile

First, go to the Device Edit view in order to modify a device:

 Go to the Network section
 In the Network/cloud routing section

 Click on Change
 Select your new AS routing profile in the drop-down menu
 To remove the current associated AS routing profile, click on Remove
27 v 1.1
8 Settings
When selecting Settings in the navigation column in the left sidebar, the following overview of the
account and alarms is given.
8.1.1 Account Information

The subscription details (activation date and status) and the subscriber (ID, name and organization)
are given in the corresponding field.
8.1.2 Alarm Management

One can shift between the basic and advanced alarm configuration mode. Be aware that, when shifting
from the advanced to the basic mode, all alarm settings will be lost in the process.
In the basic alarm configuration mode:

One can add (and remove) standard alarms, including the name of the alarm, the type (currently only
email) and the destination.
In the advanced alarm configuration mode:

One can add the same alarm details, but with a split in criticality of the alarm: Critical, Major, Minor,
Warning, Indeterminate, Cleared or acknowledged (with the corresponding color code).
28 v 1.1
Alarm type Description

001: Battery level threshold <10%: critical
<40%: warning
>=40%: clear
002: Traffic exceeds the downlink regulator Downlink traffic overflow exceeded
settings
003: Traffic exceeds the uplink regulator Uplink traffic overflow exceeded
settings
004: No uplink activity warning Device not communicating for a predefined
threshold period
005: Node uses higher data rate than expected ADR enabled and received SF < expected SF
006: Node uses lower data rate than expected ADR enabled and received SF > expected SF
29 v 1.1
9 Troubleshooting
9.1 Opening multiple views

The frame Device details or AS Routing profile details stays open until you click on Close button.
So in order to prevent any unintended operation, open views should be closed before switching to
others views.
9.2 Confirming changes

Following the previous topic, please note that modifications should be saved after editing a Device or
an AS Routing profile.
30 v 1.1
10 ANNEX
10.1 Device Profile
A Device Profile describes the settings concerning the LoRaWAN layer of a device:
 LoRaWAN version, and LoRaMAC for older version

 LoRaWAN class: class A, B or C
 Rx window:
o Rx delay 1: default 1000ms
o Rx delay 2: default 2000ms
31 v 1.1

ThingPark Wireless - Device Mannager GUI User Guide

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

ThingPark Wireless - Device Mannager GUI User Guide

Uploaded by

Copyright:

Available Formats

Device Manager GUI

1 Definitions and Abbreviations

3 Log-in to the tools

 Click on Sign in with ThingPark

The Search bar proposes 3 ways to search for a device:

5.2 Device map

5.3 Device list

The displayed field are:

 Name / Type: name and device profile

In order to View or Edit the device:

5.4 Device details

 Last GPS position reported by the device

HOW-TO update the location of a device

 Select Manual location

5.4.1 Device Network

The Devices/Network section provides information on the Network subscription, associated

HOW-TO change the Connectivity plan

HOW-TO change or assign an AS Routing Profile

 Go to the device Edit view

5.4.2 Device Alarms

o From / To: date range

o To acknowledge an alarm, click on the desired alarm and click on Ack

5.5 Device provisioning

There are two ways to create a device

 Manual creation: create devices 1 by 1

Information required to create a new device:

5.5.1 Manual Device creation

To create a new device manually:

 Right click on Devices

 Click on Create device

 Fill out the Application layer section

o To add a new Application Key

The port 0 is encrypted by the NwkSKey

 Fill the Network section

 Fill out the Administrative data section

o Enter a name for the device

5.5.2 Batch provisioning (device imports)

 CSV file format

Column # Field name Description

11 Device Name Name of the device

o Tpk Cloud Config format

 Import the CSV file

 Click on Import devices

5.5.3 Modify a device

Start by opening a device in Edit view:

 Select the device to delete in the list

5.5.4 Delete a device

Below are the steps to delete a device:

 Select the device to delete in the list

 Confirm in the pop-up to delete the device

 Connectivity plans section

o Connectivity plans: name of the connectivity plan

6.1.1 Connectivity Plan details

 Uplink frame parameters

6.1.2 Assign/Change a Connectivity Plan

 Select the device to delete in the list

 Go to the Network section

 In the Network subscription > Subscription section

 Select your new Connectivity plan in the drop-down menu

6.1.3 Remove a Connectivity Plan

7.1.1 Create an AS Routing Profile

 Click on Add in the New AS routing profile section