Skip to content

Telemetry API

Telemetry API is a suite of tools designed to help collecting and working with telemetry data provided by sensor-equipped Kontakt.io beacons. It's an extension to Kontakt.io Location Engine introduced in Autumn 2017 together with firmware 1.10 for Beacon Pros.

As of October 2018 Beacon Pros BP16-3, Asset Tags S18-3, Card Tag CT18-3, Smart Beacon SB18-3 and Heavy Duty Beacons HD18-3 provide Telemetry data. These beacons are equipped with various assortment of sensors. Most of them have at least thermometer and accelerometer, so they can provide information about ambient temperature, raw acceleration (movement) values in X, Y and Z axis, as well as report events like double tap and free fall. Additionally, some devices have e.g. a light sensor, a high precision humidity and temperature sensor, and/or a button (telemetry data provide information how many times a button was pressed and how much time has passed since the last event).

All this data is collected by Kontakt.io Gateways GW 17-2 or other compatible 3rd party scanners, and sent to Location Engine, where it is processed. Access to these sensor readings and information about detected events is available through Location Engine's real-time WebSocket Data Streams. Instructions on how to access Location Engine data are available in this article: Location Engine Monitoring.

Since sensors impact power consumption on beacons, Telemetry data is not broadcasted by default. Kontakt.io Telemetry packet needs to be enabled on each beacon that we might want to use for collecting data. Configuration process and sensor parameters are described in detail in this article: Enabling and configuring the Telemetry Packet.