Status

Date

Doc Version

Applicable

Confidentiality

RELEASED

v1.0

Wirepas Network Tool v4.0.0

PUBLIC


Release Summary

Release Date

Wirepas Network Tool Version

Previous Wirepas Network Tool Version

v4.0.0

v3.0.1

Released Components

Component name

Component version

Wirepas Network Tool client

v4.0.0.1215

Wirepas Network Tool backend

v4.0.0

Wirepas Network Tool v4.0.0 Release Highlights

Here are the key new features enabled by Wirepas Network Tool v4.0.0 release: 

  • Wirepas Massive Firmware v5.1.0 support.
  • OTAP v2 support [2].
  • MQTT JSON API for publishing JSON encoded node update messages via MQTT. This feature is mainly for positioning updates [1].
  • Backend and client performance enhancements.
  • Events page for node boots and online status changes [3].

The full list of new features is available in New Features vs Wirepas Network Tool v3.0.x chapter.

Compatibility

Compatibility Summary

Wirepas Network Tool v4.0.0 is not backward compatible with v3.0.x version. The figure below provide the compatibility matrix updated with Wirepas Network Tool v4.0.0 release and other Wirepas components.

  • When WNT major version number changes e.g. from v3.0.0 to v4.0.0, it also means that WNT API has changed [1].

Wirepas Network Tool

(WNT)

Wirepas Massive Firmware

Wirepas Massive SDK

(SDK)

Wirepas Positioning Engine

(WPE)

Linux Gateway

Wirepas MQTT Library

Wirepas Terminal

Version

v4.0.0

v5.1.0

v1.2.0

v1.4.0

v1.4.0

v1.0

v0.101

Release Date

7th June 2021

27th May 2021

27th May 2021

7th June 2021

16th May 2021

20th Apr 2021

11th Feb 2019

 

 

 

 

Compatibility

Wirepas Massive Firmware

v4.0.x, v5.0.x, v5.1.x

Compatible with v5.0.x (when using the v5.0.x feature set)

v5.1

v4.0.x, v5.0.x, v5.1.x

v4.0.x, v5.0.x, v5.1.x

v4.0.x, v5.0.x, v5.1.x

v4.0.x, v5.0.x, v5.1.x
 OTAP Operations are not supported in v5.x

WM SDK

-

v1.2.0

-

Positioning App v4.0.0.0, v5.0.0.0, v1.2.0.2 (PosApp +PosLib)

-

-

-

WNT

-

v4.0.0

-

v4.0.0

v1.7, v2.x, v3.x, v4.0.0

-

-

WPE

v1.4.x

v1.4.x

-

-

v1.3.x, v1.4.x

-

-

Linux Gateway

v1.4.x

v1.3.x (without OTAP v2)

v1.4.x

v1.3.x (without OTAP v2)

-

-

-

v1.4.x

-

Wirepas Terminal

-

v0.101 -
 OTAP Operations are not supported

-

-

-

-

-

Compatibility Notes

Item

Description

Wirepas Network Tool

Wirepas Network Tool v4.0.0 backend & client are required when the network is running Wirepas Massive v5.1.0 because of updated boot diagnostics and new OTAP control require the WNT v4.0.0 backend & client and Linux Gateway v1.4.x. Wirepas Network Tool v4.0.0 is compatible with Wirepas Massive Firmware v4.0.x, v5.0.x and v5.1.x.

New Features vs Wirepas Network Tool v3.0.x


Item

Description

1

Wirepas Massive Firmware v5.1.0 support

Parsing of the new diagnostics fields and HW profiles added.

2

OTAP v2 support

Allow Wirepas Massive Firmware v5.1.0 users to use OTAP v2 [2].

3

MQTT JSON API

API for receiving mainly node location and corresponding metadata updates via MQTT [1].

4

Events page

Possibility to query node boots and online status changes for network [3].

5

Sink node mode update

Sink’s mode (low energy / low latency) can be changed via Node Configuration [3].

6

Node boot reason diagnostics

Boot reason diagnostics added to Boots and Events pages [3].

Performance/Feature Improvements vs Wirepas Network Tool v3.0.x

#

Item

Description

1

Faster map interactions

It is possible to hide the node connection arrows in map while doing zooming or panning of the map. This increases the rendering speed, and can be enabled from the General Settings page [3].

2

Legacy OTAP improvements

It is not anymore required that all the sinks in the network have the same stored scratchpad sequence.

3

Node positioning location update message buffering

It is possible to set time for how long the positioning location messages are buffered before the map and other controls are refreshed. This will help to keep the WNT client update rate low although there are several positioning location updates per second [3].

4

Multiple real-time situation manager and diagnostics injector processes

It is possible to run multiple real-time situation manager and diagnostics injector processes to have better performance. This also affects how the node counts are received from front-end router [1].

Deprecated Features vs Wirepas Network Tool v3.0.x

#

Item

Description and alternative approach to use

1

Positioning payload v1 support

Positioning payload v1 is not supported anymore.

Important Notes for Wirepas Network Tool v4.0.x

#

Description

1

When using positioning engine the anchors are not detected anymore automatically, as there is no bulletproof way to do this, but users need to set the nodes manually as anchors from the Node Management page. When doing backend update from WNT v3.0.x to WNT v4.0.0 the update runs a script that will import all router nodes that are approved and have valid location as anchors to WNT v4.0.0 backend.

Errata for Wirepas Network Tool v4.0.x

For errata please see Wirepas Network Tool Errata [4]

References

[1] WNT4 Backend API 

[2] How to perform OTAP with Wirepas Massive v5.1 

[3] Wirepas Network Tool Client User Guide 

[4] Wirepas Network Tool Errata 

Revision History

Date

Version

Notes

v1.0

Initial version

Legal Notice

Use of this document is strictly subject to Wirepas’ Terms of Use and Legal Notice.

Copyright © 2021 Wirepas Oy