User Guide for ThingPark Wireless and ThingPark OS - Version 4.3

User Guide for ThingPark Wireless & ThingPark OS - Version 4.3

This article is the official documentation provided by Actility for the 4.3 release.
It will contain User's Guide, Product Description, and other reference documents. 
The release notes can be found  in the release notes section

Today (end of 2017), these documents are provided thanks PDF files (see the attachment tab) but will be available in Q1 2018 as real articles, searchable from the Desk engine.





Functional Description

  • Product Functional Description: This document provides a functional-level description of  Actility’s ThingPark Product Version 4.3.
    Note: throughout the document, all references to LoRaWAN™ functionality are based on LoRaWAN™ version 1.0.2


User's Guide

  • BS Commissioning tool User's Guide: The scope of this document is to provide users with guidelines on how to use the ThingPark Wireless BS Commissioning tool. This tool is part of ThingPark Wireless TWA platform and typically used by Base Station commissioners to complete the following tasks:
    • Record Base Station engineering parameters such as antenna’s-built characteristics (antenna gain, cable losses, antenna type, azimuth for directional antennas, surrounding clutter environment and obstacles, delay between the Base Station equipment and the antenna, and so forth…). The electrical characteristics of the antenna can be either based on on-site measurements or provided in equipment datasheets. These engineering parameters are then used by the tool to update the maximum conducted TX power of the Base Station, considering the radiated power levels set in the LRR configuration files.
    • Validate that the Base Station is up and running after commissioning, by checking its “Status” in real time, as well as testing its connectivity to ThingPark core network. Using an appropriate test device provided to commissioners (for instance, LoRa® demonstrator), the tool allows testing connectivity between the Base Station and the network by displaying the packets exchanged in real time.
  • Device Manager User's Guide: The ThingPark Wireless Device Manager is the back-end User Interface that allows managing all LoRaWAN™ devices/ The scope of this document is to provide end users with guidelines on the entire Device Manager GUI, including:
    • The general use of the interface,
    • The device provisioning, configuration and management, 
    • The alarm monitoring and management,
    • The connectivity plans, Application Servers, and AS routing servers’ association.
  • Network Survey User's Guide: The Network Survey tool helps visualize device data (radio metrics, payload information) on the map. It also computes additional UL metrics based on those reported by LRR to LRC. This tool is very useful to assess LoRa network coverage status through walk/drive tests, and detect any coverage gaps if proper payload decoder is used. DL radio measurements can also be available in the tool if they are sent by the device in UL frame payload.
    As prerequisites:
    • Test device has to be configured to report GPS coordinates in its UL payload. To analyze DL measurements, the device should additionally report DL RSSI & DL SNR in its UL payloads
    • Proper payload decoder corresponding to the test device has to be available.
    • Application Session Key (AppSKey) has to be provisioned in ThingPark Wireless during device provisioning
  • Operator User's Guide: The scope of this User Guide is to provide administrators of an Operator with guidelines on the entire Operator role to get started and use the Operator application, in order to perform the following tasks, according to the group they belong:
    • Log in for the first time and every day
    • Manage administrators accounts
    • Set the Operator account and security policy
    • Access other accounts by invitation or impersonation
    • Manage others roles as Suppliers, Vendors, Subscribers
    • Manage the wireless network at the Operator’s technical top-level.
  • Quick Start User's Guide: The scope of this document is to describe the first step to set a turn-key ThingPark ecosystem.
  • Radio Parameters User's Guide: The scope of this document is to provide guidelines to ThingPark Wireless radio parameters optimization in ThingPark release 4.1.2. The target audience of this document is LoRaWAN™ radio network planning and optimization teams, as well as quality assurance teams. The document is divided into 3 main sections:
    • Description of the main radio algorithms: Adaptive Data Rate (ADR), RX1/RX2 selection and Antenna Diversity
    • Description of RF region concept, associating each base station to an RF region, configurable parameters per RF region
    • Interaction between parameters configured in device profile, connectivity plan
  • Spectrum Analysis User's Guide: The scope of this document is to present Spectrum Analysis. This tool is used to display noise scan results generated by the Base Station, and to determine the noise level seen by each frequency within the defined spectrum.and RF region.
    Noise-Scan statistics are used to derive the average interference level (that is rise above thermal noise floor) to be used for the link budget analysis. It is also mandatory for the appropriate selection of physical frequencies related to LoRaWAN™ logical channels.
  • Supplier User's Guide: The scope of this User Guide is to provide the guidelines on the entire role, user management, connectivity plans creation and management, base stations creation and network management and to provide applications and/or devices.
  • TWA Exporter User's Guide: The scope of this document is to provide users with guidelines using the TWA-Export tool version 1.10.1.
    This tool allows extracting information from the Network Manager, the Device Manager and the Wireless Logger tools using API OSS and API Wireless Logger. It also gathers the data into a downloadable file. Exports can be made from a GUI or directly with a URL. It is also possible to make automatic exports using the URL to save the generated file into a specific folder and to send it by email.
  • Wireless Logger User's Guide: The scope of this document is to provide Operators, Network Managers, Subscribers and End-Users with guidelines on the entire Graphical User Guide (GUI) to supervise frames, history export, data decoding for the ThingPark Wireless Logger tool. The ThingPark Wireless Logger is the back-end User Interface (UI) that allows you to monitor data frames of the LoRaWAN™ devices.


Developer's Guide

  • LRC-AS Tunnel Interface Developer Guide (former ThingPark Tunneling API): The scope of this document is to give development guidelines on the tunnel mode interface to applications developers.
  • OSS_API - Description Administrators (ThingPark OS): This document describes the /admins WS.
  • OSS_API - Description Connectivity Manager: This document describes the REST interface exposed by the ThingPark Wireless Application for Connectivity Manager application (CM).
  • OSS_API - Description Device Manager: This document describes the REST interface exposed by the ThingPark Wireless Application for Device Manager application (DM).
  • OSS_API - Description Network Manager: This document describes the REST interface exposed by the ThingPark Wireless Application for Network Manager application (NM).
  • OSS_API - Description Subscribers (ThingPark OS): This document defines the /subscribers WS-Interface.
  • OSS_API - Description Suppliers (ThingPark OS): This document describes the /suppliers WS-Interface.
  • OSS_API - Description Vendors (ThingPark OS): This document defines the /vendors WS-Interface.
  • OSS_API - User's Guide: The OSS API User Guide explains how to use the ThingPark Wireless OSS API’s web services that allows you to control the ThingPark Wireless Applications (TWA): Connectivity Manager, Network Manager, Device Manager. This guide is based on a scenario that shows with extended examples how to manage:
    • LoRaWAN™ connectivity plans in the Connectivity Manager.
    • LoRaWAN™ base stations in the Network Manager.
    • LoRaWAN™ devices in the Device Manager.
Handling the OSS API consists in calling web services by the means of REST requests. You are invited to refer to the previous documents for the optional parameters that can be used when applying are quest.


Specifications and other documents 

  • LRR Administration Guide: The scope of this document is to provide the LRR user with administration guidelines. The target audience of this document is network deployment teams and support teams.This document includes two main parts:
    • Part One - Shell commands and scripts for base station monitoring.
    • Part Two - Base station configuration files
  • Kafka Administration Guide: The scope of this document is to provide a functional-level description of ThingPark Wireless integration to a publish-subscribe messaging framework based on Apache Kafka. This document also provides all the necessary information to setup, to run and to debug a multi-center Kafka messaging system. Note that, at this stage, there is no multi-center server-side replication: this has to be handled at the producer or consumer side.

    • Related Articles

    • User Guide for ThingPark Wireless & ThingPark OS - Version 4.2

      This article is the official documentation provided by Actility for the 4.2 release. It will contain User's Guide, Product Description, and other reference documents.  The release notes can be found  in the release notes section Today (end of 2017), ...

    • Configuration Guides for ThingPark Wireless - Version 5.2

            Configuration Guides for ThingPark Wireless - Version 5.2  This article is the official documentation provided by Actility for the 5.2 release. It will contain configuration guides for:  LRR Administration Guide Kafka Administration Guide HSM ...

    • Functional Descriptions for ThingPark Wireless - Version 5.2

            Functional Descriptions for ThingPark Wireless - Version 5.2 This article is the official documentation provided by Actility for the 5.2 release. It will contain functional descriptions for ThingPark Wireless products but not all ThingPark ...

    • User Guide for ThingPark Wireless - Version 5.1

      This article is the official documentation provided by Actility for the 5.1 release. It will contain User's Guide, Product Description, and other reference documents.  The release notes can be found  in the release notes section (click here) User's ...

    • Developer Guides for ThingPark Wireless - Version 5.2

            Since 5.0 release, the OSS-API description is available at https://oss-api.thingpark.com/ ( website powered by Swagger). Developer Guides for ThingPark Wireless - Version 5.2 This article is the official documentation provided by Actility for ...