NAV Navbar
Logo
Examples

Welcome

Welcome to the ThingPark X Location Engine platform. The purpose of this webpage is to provide a high level overview of the platform, as well as a unique entry point for all the public services offered by the platform.

Overview of ThinkPark X Location Engine 2.7.7

Two categories of scenario are considered on the platform:

The two categories share the same platform and the software components. They are differentiated in authentication method and several specific use case workflows. For convenience, the architecture is presented in two diagrams illustrating the B2B and the B2C scenarios respectively.

B2B architecture

B2B architecture ThingPark X Location Engine for B2B scenarios (click here to show the original image)

Abeeway trackers are connected through LoRa to Operators’ system. LoRaWAN payloads are routed through IP network to ThingPark X Location Engine, then the customer can view the results in Abeeway Device Manager (ADM) GUI or implement a specific backend application using DX Location Push module (tracker information is pushed to the customer backend platform). Key management module manages the keys for authenticating the communications between the TPX Location Engine platform and the operators’ platforms.

B2C architecture

B2C architecture ThingPark X Location Engine for B2C scenarios (click here to show the original image)

In addition to LoRa connection through operators’ system, Abeeway trackers can also connect through BLE to the B2C mobile app which communicates with the ThingPark X Location Engine. The end user account and tracker registration management are handled by the modules of ThinkPark X platform which are integrated with ThinkPark X Location Engine. The mobile app gets tracker information from the ThinkPark X IoT API.

When the tracker is connected to the mobile app through BLE, the coordinates of the tracker take the value of the coordinates of the mobile phone. The mobile app is responsible for sending all the information of the tracker to the TPX Location Engine. When the tracker is connected through LoRa, the uplink data work flow is the same as in the B2B scenarios.

Components description

ThingPark X Location Engine Components list

In the scope of the project, the following DX components are used:

Some DX components also rely on Kafka / Zookeeper.

The documentation for each module is available by clicking the name of the modules

DX Location Binder Module (tpdx-location-binder)

DX Location binder module provides an API allowing Operator interface to push LRC uplink data which in turn will be digested by the Abeeway solver and pushed back to the B2B partners.

DX Location Connector Module (tpdx-location-connector)

DX Location connector module provides an API allowing B2B partners to configure to which URL the resolved positions should be pushed.

DX Location Tracker Command Module (tpdx-location-trackercommand)

DX Location tracker command module provides an API allowing to send downlink commands to Abeeway trackers.

DX Location Integration Module (tpdx-location-integration)

DX Location Integration provides the entry point for B2C Mobile application use cases, by providing a means to register and delete trackers.

The registration in turn results in creating necessary entries in the TPX ecosystem, enabling association of all trackers related activity to the specific mobile device user.

During a delete operation, the location integration module makes an internal call to the tracker command module to reset BLE bond for the tracker under contention and then invoking TPX Things API to disassociate the tracker user pairing and removing the tracker from the TPX ecosystem.

It also provides API for B2C user to change his/her keycloak password and account image.

Abeeway Firmware Update Module (abeeway-firmware-update)

Abeeway Firmware Update module paves way for two specific usecases revolving around tracker fimware version files. The first workflow is specific to administrator or operators who upload the specific tracker firmware version files to the ThingPark Location Engine (TPX-LE) backend. The second workflow is specific to the B2C Mobile application, where in the mobile device user on install of the app will download any updates available the tracker he owns.

DX Location Key Management Module (tpdx-location-key-management)

Key Management module enables configuration of Binders for Operators on the ThingPark X Location Engine Solution.

The module provides a Binder endpoint, to retrieve a specific or list of all available Binder configurations available on the platform. This provides details on the configuration schema to create specific Binder Connections for each Operator. The BinderConnection endpoint paves way for Operators to add specific keys on the platform adhering to the schema reviewed earlier. BinderConnections are created by SubscriberID and on creation, the keys provided are masked and also a signed TPX LE JWT encapsulating the SubscriberID is provided. This token is to be provided by the Operator on each uplink message for message validation. There is an Events endpoint, that is specifically for auditing purposes, where an Operator can view all operations on Binders by SubscriberID.

This module supports both DX SMP Authentication and Keycloak Authentication. In case of DX SMP Authentication, it is mandatory to provide SubscriberID as a query parameter in the requests to the specific endpoints.

DX Location Alarm Configuration (tpdx-location-alarm-config)

Alarm Configuration module enables configuration of alarms on the ThingPark X Location Engine Solution.

The module provides several endpoints to define alerts (mode change, battery, parameters, geofencing).

This module supports both DX SMP Authentication and Keycloak Authentication.

DX Location Notification (tpdx-location-notification)

Notification module enables configuration of B2C app push notifications on the ThingPark X Location Engine Solution.

The module provides an endpoint to register a mobile device (Android or iOS) for receiving push notifications

This module supports only Keycloak Authentication.

DX Location Driver Module (tpdx-location-driver)

DX Location driver module provides an API allowing B2B partners to encode / decode uplink and downlink payloads for Abeeway trackers. It forwards the calls to TPX IoT Flow Driver API for request processing.

DX Location Profile Management Module (tpdx-location-profile-management)

DX Location profile management module detects the combination of parameters of a tracker and translates it into a profile if the combination is registered as a profile. In the other direction, it translates a profile into a combination of parameters when a downlink request to update the tracker is received. It also provides API to get information of parameters and test patterns for a specific model of device.

DX Location Geolocation API Module (tpdx-location-geolocation-api)

DX Location geolocation API module provides up-to-date Almanac data to Abeeway solver for each AGPS computation. The module loads Almanac data from a database and sends it when API gets called.

Abeeway Solver

Abeeway solver provides decoding and solving functionality for the Abeeway trackers uplink and downlink payloads.

Abeeway solver features include:

Operator Interface

The Operator interface provides connectivity between operator LRC and DX Location binder module Feed API.

Operator interface features include:

Abeeway Device Manager

Abeeway Device Manager provides a frontend website allowing to demonstrate the capabilities of Abeeway trackers. This website connects to Abeeway solver database to read data.

Abeeway Device features include:

Abeeway Driver

Abeeway driver is used to encode/decode payloads of Abeeway firmware.

Examples