abeeway device analyzer user guide

15
Abeeway Device Analyzer User Guide REVISION 1.1 JUNE 2019

Upload: others

Post on 22-Nov-2021

3 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Abeeway Device Analyzer User Guide

Abeeway Device Analyzer

User Guide

REVISION 1.1

JUNE 2019

Page 2: Abeeway Device Analyzer User Guide

Abeeway Device Analyzer User Guide – V1.1

2

TABLE OF CONTENTS

1. INTRODUCTION 3

2. LOGIN 3

3. TRACKER SELECTION 3

4. ANALYZER 4

4.1 Main menu 4

4.2 Devices 5

4.3 Map 6

4.3.1 Device name 6

4.3.2 Map Marker selectors 6

4.3.3 Date range selector 7

4.3.4 Export to CSV 8

4.3.5 Import GPX 8

4.3.6 Marker Information 8

4.4 Performance Monitor 8

4.4.1 Battery 9

4.4.2 Packets Lost 10

4.4.3 RSSI 10

4.4.4 SNR 10

4.4.5 Temperature 10

4.4.6 Activity Counter 11

4.4.7 Payload Length 11

4.5 Tracker configuration 11

4.6 Location Log 14

5. REFERENCES 15

Page 3: Abeeway Device Analyzer User Guide

Abeeway Device Analyzer User Guide – V1.1

3

1. INTRODUCTION

Abeeway Device Analyzer (ADA) is a tool to visualize and configure data for Abeeway trackers.

ADA URL is sent by mail when your devices are registered, or it is present as an application within the Click&Go Portal page (https://iot.thingpark.com/portal/web) if you purchased low power trial pack from here, https://iot.thingpark.com/clickandgo/442-location-asset-tracking.

ADA is distributed as part of ThingPark X Location Engine. Hence, one of the pre-requisites for using ADA is that LoRaWAN Network Server (NS), whether from Actility or third-party is connected to ThingPark X Location Engine.

If you are using Abeeway trackers on some other platform, please contact your local support for instructions and URL to access ADA.

This user guide assumes that the reader is familiar with the Abeeway tracker features described in [1][2].

The sections below describe how to use ADA with Abeeway trackers.

2. LOGIN

Log into ADA by using Thingpark username and password or credentials supplied by your local operations team.

The password can be reset by clicking on Recover password link if you don’t remember your credentials.

3. TRACKER SELECTION

The first step is to select the trackers from the drop-down menu. ADA allows selection of up to 10 trackers at a time from the menu.

Page 4: Abeeway Device Analyzer User Guide

Abeeway Device Analyzer User Guide – V1.1

4

Note: ADA gets the tracker list from the device list on Thingpark Wireless’ device manager.

The actual selected trackers are now shown in a table below the date selectors. You can select the dates for the period you want to monitor. The first field is the beginning date, and the second one is the end date

Finally, click the Select button to launch the analyzer.

ADA only analyzes the last 5000 positions of the selected period. If you want to see older data, you must restrict the chosen period of time.

It should be noted that only the last 3 months payloads are saved in geolocation backend

The Logout button ends connection.

Note: the monitoring period is applicable for all tabs except the device configuration tab.

4. ANALYZER

The analyzer is split in two main parts:

• The main menu, located on the top

• The display area

4.1 Main menu

It is always visible on top of the screen.

The Analyzer main menu located at the top of the page, contains five items:

• Devices: This tab shows the information on each tracker

Page 5: Abeeway Device Analyzer User Guide

Abeeway Device Analyzer User Guide – V1.1

5

• Map: This tab shows location history of the selected trackers

• Performance monitor: This tab shows statistics of several parameters of the trackers (like battery,

RSSI, temperature…)

• Device configuration: This tab is used to change configuration of the trackers

• Location log: This tab is used to download the location logs

On the right side, your user icon is displayed.

By hovering over it, you can:

• Be redirected to the tracker selection page when clicking on the New

device search item

• Access to support when clicking on the Support item

• Log out the analyzer when clicking on the Logout item.

We now describe the different sections of the main menu in more detail.

4.2 Devices

The Devices tab shows a table which has four different sections: 1. The first section shows basic device information such as:

a. Device name: This field shows the name of the device as entered in ThingPark Wireless

b. Firmware Version: This field shows the firmware version of the tracker. Note that it is important

to refer to the user documentation that corresponds to your firmware version. Please contact

support if your firmware version shown on ADA is different from the firmware reference guide

c. Uplink frames: This field shows the number of uplink frames for the selected period

d. PER: This field shows the packet error rate

e. First position: This field shows the date of the first position

1

2

3

4

Page 6: Abeeway Device Analyzer User Guide

Abeeway Device Analyzer User Guide – V1.1

6

f. Last position: This field shows the date of the last position

g. First packet: This field shows the date of the first packet

h. Last packet: This field shows the date of the last packet

i. Last mode: This field shows the last tracking mode. For more information on tracking modes,

refer to the Tracker Firmware Reference Guide [1] [2]

j. Battery: This field shows the remaining battery level

2. The second section has statistics for uplink packet transmissions and the respective LoRaWAN spreading

factors used for the transmission

3. The third section corresponds to information on link quality statistics

4. The fourth section corresponds to geolocation technologies used by the tracker. The description and

behavior of different geolocation technologies is described in tracker firmware reference guide [1][2]

4.3 Map

The Map window shows the tracker position and their history for the selected period. In the next few sections we describe in detail the different fields of the map window.

4.3.1 Device name

This section is used to select the device to display on the map

4.3.2 Map Marker selectors

The map markers can be used to filter positions using several different criteria:

• Technology: The geolocation technology used by the tracker

Page 7: Abeeway Device Analyzer User Guide

Abeeway Device Analyzer User Guide – V1.1

7

• RSSI: The received signal strength indication of LoRaWAN signal

• SNR: The signal to noise ratio of the LoRaWAN signal.

For each criterion, a given selected field can be shown/hidden by clicking on its name.

Note that an opened eye indicates a shown selected field, while a closed eye hides the selected field.

Example:

Clicking on the Lost Packet selector of the technology criteria will close its associated eye and all Lost Packet markers will be suppressed from the map

Notes:

• Lost Packet: This field shows the number of lost packets and their estimated location during

communication

• Unresolved Location: This is a position estimated by the server due to the lack of position information.

This can happen when minimum number of GPS satellites seen by the trackers not reached to be able

to calculate the real position

• Standard Deviation Radius: This marker turns on the circle to show the estimated accuracy of the

position

4.3.3 Date range selector

The slider above the map can be used to select the period you want to monitor. By default, the minimum is the first position received and the maximum is the last position received. When this slider is moved, only markers and tracks for the selected period are shown.

Page 8: Abeeway Device Analyzer User Guide

Abeeway Device Analyzer User Guide – V1.1

8

Clicker on the slider circle and move the mouse on the left or right direction.

4.3.4 Export to CSV

This action exports the positions in a CSV (Coma Separated Value) file. Such format can be directly imported in Excel.

Example of CSV format displayed using excel:

4.3.5 Import GPX

Import GPX: Geolocation tracking format generated by a mobile application such as Geo Tracker.

A GPX file format that can be imported to compare the route calculated by the tracker and the route calculated by a smartphone. The GPX position will be displayed in black on the map.

4.3.6 Marker Information

The marker on the map can be clicked to display information about the position. In addition, a circle is displayed around the point (if Standard Deviation Marker is selected above). This circle represents the position accuracy.

4.4 Performance Monitor

The performance monitor tab allows user to see statistics about different tracker characteristics.

Page 9: Abeeway Device Analyzer User Guide

Abeeway Device Analyzer User Guide – V1.1

9

The trackers need to be first selected from the device tab.

The next step for the user is to select which statistics of the tracker need to be displayed.

By default, only the Battery chart is shown. Other charts can be displayed by clicking on buttons above charts. This will show every selected chart from all trackers.

For every chart, the date and details of the packet are displayed on the top right when hovering mouse over it.

The slider located at the bottom of the chart allows the user to change the monitoring period range. Note that for a given tracker all the sliders are synchronized between each other.

4.4.1 Battery

This chart shows the battery evolution for the selected period. The selected period can be changed using the slider at the bottom.

Page 10: Abeeway Device Analyzer User Guide

Abeeway Device Analyzer User Guide – V1.1

10

4.4.2 Packets Lost

This chart shows the packet loss for the selected period. Each spike represents an amount of loses.

4.4.3 RSSI

This chart shows the LoRa RSSI (Receive Signal Strength Indication) evolution for the selected period.

4.4.4 SNR

This chart shows the LoRa SNR (Signal to Noise Ratio) evolution for the selected period.

4.4.5 Temperature

This chart shows the temperature evolution for the selected period.

Page 11: Abeeway Device Analyzer User Guide

Abeeway Device Analyzer User Guide – V1.1

11

4.4.6 Activity Counter

This chart shows the activity counter evolution for the selected period.

Note: Activity counter will always be 0 if the tracker mode is not Activity Tracking.

4.4.7 Payload Length

This chart shows the payload length statistics for the selected period.

4.5 Tracker configuration

The Tracker configuration tab is used to change the configuration of a tracker.

Page 12: Abeeway Device Analyzer User Guide

Abeeway Device Analyzer User Guide – V1.1

12

Select a tracker on the left of the screen by clicking on its button to make the configuration window visible. The actual configuration of the tracker is shown below its name.

Note: Hovering a field name or an option with the cursor, displays its help.

The main configuration window contains seven main parts: 1. Mode Selection: This option allows the selection of a new operational mode of the tracker. Available

modes for the tracker are as follows:

o Motion: A position is sent once every “position report period (ul_period)” while tracker is in

movement.

o Activity: A counter tracking a single motion or action. E.g: no of steps, door opening.

o Permanent: Send periodic position message every “position report period (ul_period)”.

o Start/End: A position is sent when a motion starts or ends.

o Standby: Device is in stand-by and sends a LoRa heartbeat at regular interval.

o Off: This mode is available for micro-trackers only. It puts the tracker in deep sleeping mode. It is no

more accessible by the LoRa network. The only way to wake up the tracker is to long press the

tracker’s button.

2. Position Report period: It specifies the reporting period of position updates. It refers to ul_period

parameter in firmware reference document. This reporting is used with the Motion, Permanent and

Start/End operational modes. In the case of the Activity mode, this parameter is the sending period of

the activity counter (no positions).

3. Positioning Strategy: Geolocation policy used with the operational mode. This parameter corresponds

to geoloc_sensor in the firmware reference document. There are up to six policies can be used:

Page 13: Abeeway Device Analyzer User Guide

Abeeway Device Analyzer User Guide – V1.1

13

o WIFI only: This mode uses only WIFI geolocation for tracking. This mode is commonly used in indoor

only environment.

o GPS only: This mode reports only GPS positions by the tracker. This mode provides highest accuracy

but incurs highest power consumption. It is commonly used for outdoor accurate positions.

o LP_GPS only: This mode computes position using low power GPS (LP-GPS). LP-GPS is a proprietary

technology that computes part of location information in the cloud thus dramatically reducing the

first time to fix and dramatically reducing power consumption. LP-GPS works much better than GPS

especially under poor GPS conditions. It consumes less power than the GPS only mode but maybe

less accurate under certain environmental conditions. This mode it can be used for outdoor and

daylight indoor environment.

o WIFI-GPS: This is multi-technology mode alternating the WIFI and GPS, and particularly suitable for

accurate indoor and outdoor environment. In this mode, tracker searches for at least 3 WiFi BSSID

and in case of WiFi timeout, it switches to GPS.

o WIFI-LP_GPS: This multi-technology mode alternating the WIFI and low power GPS, is suitable for

accurate indoor and outdoor environment. However, it consumes significantly less level of power

than the previous mode.

o WIFI-GPS/WIFI-LP_GPS: This multi-technology mode is particularly efficient. It alternates WIFI, GPS

and Low power GPS to get the best accuracy and the lowest consumption possible in the indoor and

outdoor environments.

4. LoRa Heartbeat Period: This parameter defines the frequency at which the tracker sends LoRa heartbeat

messages. LoRa heartbeat messages contain information related to the state of the tracker. Heartbeat

messages also allow LoRa downlink messages to be transmitted as every uplink from the tracker open

two downlink transmission opportunities according to LoRaWAN standard.

5. Periodic position: This parameter can be enabled or disabled. When active, it allows extra positions to

be sent periodically. This extra reporting is uncorrelated from the operational mode.

6. Periodic or On demand mode: This parameter corresponds to Geoloc_method parameter in firmware

reference document. It describes the geolocation policy used with the periodic or on demand mode. It

uses the following geolocation policies:

o WIFI only: In this mode, geolocation is done using nearby WiFi BSSIDs. This mode is commonly used

in indoor environment.

o GPS only: In this mode, tracker reports only GPS positions. This mode, requiring a high level of power

is commonly used for outdoor accurate positions.

o LP_GPS only: In this mode, tracker performs geolocation using low power GPS (LP-GPS). It consumes

less power than the previous mode but is less accurate. However, it can be used for outdoor and

daylight indoor environment.

o WIFI-GPS: This is multi-technology mode alternating the WIFI and GPS, is particularly suitable for

accurate indoor and outdoor environment. However, it requires a significant level of power.

Page 14: Abeeway Device Analyzer User Guide

Abeeway Device Analyzer User Guide – V1.1

14

o WIFI-LP_GPS: This multi-technology mode alternating the WIFI and low power GPS, is suitable for

accurate indoor and outdoor environment. However, it requires a significant less level of power than

the previous mode.

7. Send Payload: This setting can be used to send custom downlink payloads for changing tracker

configuration. Refer to firmware reference documents for details on different payload settings.

Note:

• All configuration parameters are updated at the same time. So, all the parameters must be set before clicking on Apply

• The downlink parameters are applied when the tracker sends the next uplink message. The periodicity of uplink messages is defined by the minimum of (Position report period, LoRa heartbeat period). It is recommended to wait for this period before sending another downlink. The downlink message can also be seen on ThingPark Wireless logger (if the tracker is using ThingPark Wireless LoRaWAN network).

• ADA does not support downlink re-transmissions, so the downlink needs to be sent again in case it gets lost due to poor conditions on the radio network.

• Once the downlink parameters are received from the tracker, the tracker sends the updated parameters in the next uplink messages

• The analyzer supports dynamic help. Hovering over the name of an item displays its associated help.

• ADA configuration page must to be refreshed from the browser to load the updated tracker parameters.

4.6 Location Log

This tab allows viewing and export of the tracker logs in csv file. The duration of the logs can also be filtered by entering the start and end dates.

Page 15: Abeeway Device Analyzer User Guide

Abeeway Device Analyzer User Guide – V1.1

15

The different fields displayed in the logfile are described below:

• Date: This field shows the exact timestamp of the location message.

• Seqno: This field shows the sequence number of LoRaWAN messages

• Latitude unfiltered: This field shows the unfiltered latitude parameter reported from the tracker

• Longitude unfiltered: This field shows the unfiltered longitude parameter reported from the tracker

• Accuracy unfiltered: This field shows the unfiltered accuracy parameter reported from the tracker

• Accuracy: This field shows the filtered accuracy parameter reported from the geolocation solver

(backend).

• Age: This field shows the age of the location.

• Latitude filtered: This field shows the unfiltered latitude parameter reported from the geolocation

solver (backend)

• Longitude filtered: This field shows the unfiltered longitude parameter reported from the geolocation

solver (backend)

• Techno: This field uses the geolocation method used to compute the location.

5. REFERENCES

[1] Abeeway Micro Tracker Firmware Reference Guide

[2] Abeeway Industrial Tracker Firmware Reference Guide

[3] Click and Go Low Power Location Trial Package User Guide