Terminology
RTLS – Real-Time Location System. Consists of Ultra-Wideband (UWB) devices (anchors and tags) and the RTLS Server hardware and software components. In this document it is frequently referred as “the system”, when describing the client-server communication process.
RTLS Server – The central part of the Eliko RTLS. Consists of hardware and software components. In the context of this document, the term “RTLS Server” refers to the RTLS Server software components by default.
RTLS Server Machine – The hardware part of the Eliko RTLS Server. Can be dedicated or virtualized. In the context of this document, “RTLS Server Machine” by default refers to a dedicated server machine.
RTLS Server Software – The software component part of the Eliko RTLS Server. Includes such subcomponents as Eliko Real-Time Location System Server Daemon (ERTLSSD) and RTLS Ranging Software
RTLS Ranging Software – The software component part of the Eliko RTLS Server responsible for location data calculation.
ERTLSSD – Eliko Real-Time Location System Server Daemon. This is the central component of the Eliko RTLS Server Software.
ETH_A – the RTLS Server machine’s Ethernet socket dedicated to the anchor network.
ETH_C - the RTLS Server machine’s Ethernet socket dedicated to the client network.
PoE – Power over Ethernet.
UWB – Ultra Wide-Band.
API - Application Programming Interface. In context of this document the term “API commands” refers to the commands of the Eliko RTLS Communication protocol.
Communication protocol documentation scope and purpose
The Eliko RTLS Server can be considered as a central component of the RTLS. One the one side, it communicates with the RTLS anchors and on the other side, it allows external connections to the client’s systems. Eliko has developed a proprietary communication protocol for these connections.
This document describes the external protocol of the RTLS Server, which can be used to integrate the RTLS with the client’s application logic.
There are other communication protocols used in the RTLS, but these are considered internal to the system and should not be used directly by external parties. These additional protocols are not described in this document.
The document is organised as follows:
-
Introduction: a brief overview of the Eliko RTLS with a special focus on the RTLS Server software components followed by an overview of Eliko RTLS communication protocol.
-
Managing anchors: overview of the main API commands to query and modify the anchor and anchor group settings.
-
Managing tags: overview of the main API commands to query and modify the anchor and anchor group settings.
-
Positioning modes: overview of the API commands related to special positioning mode features in Eliko RTLS, which are 1D mode, corridor mode and proximity mode.
-
The geofencing subsystem: overview of static and dynamic (tag-based) zone concepts and the related API commands.
-
Notifications, live positioning and historic data: overview of the API commands related to configuring the RTLS notifications and reports (standard and custom), which can be streamed in real time to the customer’s application. In addition, API commands to retreive the ranging historic data are also given.
-
Alarm management: overview of the API commands related to the alarm managements for tags and accessories.
-
Eliko RTLS special features: an overview of the API commands related to the special features of the Eliko RTLS, such as accuracy verification and anchor self-positioning.
-
System status and management: an overview of the API commands related to the RTLS configuration, such as network parameters, VPN settings, system time and NTP settings.
-
Software upgrade: an overview of the API commands related to the firmware upgrade for anchors and tags, as well as for the RTLS Server software upgrade