ThingPark Wireless Logger GUI

User Guide

Revision: 0.2

Date: 2015/06/22

Versioning
Version Date By
0.1 12/06/2015 GRE Initial version
0.2 22/06/2015 GRE Document review

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 Logger GUI User Guide

Contents
1 Definitions and Abbreviations ......................................................................................................... 3
2 Summary.......................................................................................................................................... 4
3 Log-in to the tools ........................................................................................................................... 5
4 Interface overview........................................................................................................................... 6
5 Message result ................................................................................................................................ 7
5.1 Metadata ................................................................................................................................. 7
5.2 Payload .................................................................................................................................... 7
5.3 Payload decoder ...................................................................................................................... 8
5.4 Auto reload .............................................................................................................................. 8
5.5 Expand all ................................................................................................................................ 9
5.6 Sorting ..................................................................................................................................... 9
6 Search ............................................................................................................................................ 10
6.1 Search focus .......................................................................................................................... 10
7 Export ............................................................................................................................................ 11
7.1 Export analyses ...................................................................................................................... 11
8 Map................................................................................................................................................ 12

2 v 0.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.
ThingPark Wireless Logger GUI User Guide

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
LC Logical Channel
LRC Long Range Concentrator
LRR Long Range Relay: LoRa Basestation
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 0.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.
ThingPark Wireless Logger GUI User Guide

2 Summary
The ThingPark Wireless Logger is an interface where a user can see the entire network traffic packets
of its devices.

This interface is mostly dedicated to development tools in order to verify the messages without the
need of an Application Server. In addition, the Wireless Logger displays all network metadata, which
is very useful for checking the messages transferred over the network.

This User Guide provides the guidelines for the entire GUI, from the searching method to the
displayed data.

4 v 0.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.
ThingPark Wireless Logger GUI User Guide

3 Log-in to the tools

 Launch the browser to access the URL: http://actility.thingpark.com/wlogger/

 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 0.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.
ThingPark Wireless Logger GUI User Guide

4 Interface overview
When you login to the Wireless Logger interface, the interface automatically displays the 50 last
messages received from the devices provisioned into your Device Manager.

The interface contains a search bar and a result window displaying the messages.

6 v 0.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.
ThingPark Wireless Logger GUI User Guide

5 Message result

5.1 Metadata
The metadata available for each messages are:

 UTC Timestamp
 Local Timestamp: Timestamp translated to browser timezone
 Device UID: Device EUI
 Port: Application port of the message
 Counter UP
 LRR RSSI: RSSI of the received message on LRR side
 LRR SNR: SNR of the received message on LRR side
 Sp Fact: Spreading Factor
 Sub Band: LoRa sub band used for the message
 Channel: LoRa logical channel used for the message
 LRC Id
 LRR Id: LRR with better SNR
 LRR Lat: LRR latitude
 LRR Long: LRR longitude
 LRR Count: number of LRR receiving the message
 Device Lat: Device latitude
 Device Lon: Device longitude
 LoS Distance (m): distance between the device and the LRR
 Map: displays the device and LRR on a map
 Trip: displays the location path of the device (if device location available)
 Checksum

5.2 Payload
Click on the icon on the left of a message in order to expand and display the message payload.

By default the message is displayed in raw data:

NOTE

If the AppSKey has been entered during the Device provisioning, then the payload has been
decrypted by the LRC, if not then the payload is displayed encrypted.

7 v 0.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.
ThingPark Wireless Logger GUI User Guide

5.3 Payload decoder

The payload can be displayed with the application data format if the decoded is known by the
Wireless Logger.

 Select your decoder in the Decoder list:

 Click on to refresh the messages

 Click on the icon left of a message to expand the message payload

NOTE

The payload can only be decoded if the AppSKey is known by the ThingPark Wireless,

5.4 Auto reload

The interface can automatically reload the messages in the search filter.

The auto reload intervals available are 10 or 60 seconds.

8 v 0.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.
ThingPark Wireless Logger GUI User Guide

5.5 Expand all

The Expand All check box will automatically expand all messages displayed in the message frame.

5.6 Sorting
All fields in the message frame can be sorted ascending or descending. By default the sorting is done
by UTC Timestamp, descending.

More options are available by clicking on the arrow left of the column title.

9 v 0.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.
ThingPark Wireless Logger GUI User Guide

6 Search

The Search bar proposes several ways to search for messages:

 Device UID Filtering

Enter a specific Device UID or a part of Device UID using the ‘*’ character.

Ex: *01234

 LRR Id Filtering
This field allows users to search all messages received by a specific LRR.

 LRC Id Filtering
This field allows users to search all messages routed to a specific LRC.

 From / To:
These 2 fields allow users to search all messages received on a specific date range. If there is no date
range defined, it is the last messages until now.

 Last
This field allows users to search the selected number of last messages in the defined date range or
until now.

After all search fields have been filled out, click on to reload the messages.

6.1 Search focus

It is possible to focus the research on a specific field of the messages frame by clicking on the
icon, which will automatically fill out the corresponding field in the search bar. Click on Refresh to
reload the messages.

10 v 0.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.
ThingPark Wireless Logger GUI User Guide

7 Export
The export capability will extract the search result to a CSV file (export.csv).

 Click on

The available fields in the export file are (refer to message metadata description):

 Timestamp
 Device EUI
 Port
 Counter UP
 LRR RSSI
 LRR SNR
 Sp Fact
 Sub Band
 Channel
 LRC Id
 LRR Id
 LRR Lat
 LRR Lon
 LRR Count
 Device Lat
 Device Lon
 LoS distance
 Checksum
 Payload(hex)
The payload is decrypted by the LRC if the AppSKey has been provisioned with the Device. In any
other case, the payload is still encrypted.

7.1 Export analyses

From the export file, several analyses can be done:

 % Lost messages
 % LC traffic
 % SF per LRR
And many others.

11 v 0.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.
ThingPark Wireless Logger GUI User Guide

8 Map
By clicking on , all LRR that have received messages will be displayed.

12 v 0.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.