Skip to content

Introduction

The GiPStech Mobile Development Kit (MDK) is an integral component of the GiPStech Location Framework. It empowers Android and iOS applications to leverage GiPStech's location technology for precise device positioning and related data acquisition.

This documentation covers key concepts, API references, configuration options, and best practices for implementing precise indoor positioning and navigation solutions.

Important note

Please carefully read License Agreement terms and conditions before continuing. Downloading or consulting any material within this developer site will constitute acceptance of those terms and conditions.

Development Key

To use this software, you will need a valid development key. The development key is a unique string required to enable and authorize access to all the features of this library.

Each key is linked to a specific application and must match the package name (on Android) or the bundle identifier (on iOS).

Please contact GiPStech to request your development key.

Requirements

The full-stack technology, which enables the highest level of precision, is available on devices that meet specific hardware and software requirements.

This is the default configuration assumed in the following documentation. As a result, running the provided examples on hardware that does not meet these requirements may lead to unexpected errors.

However, in certain cases, a different tradeoff between hardware constraints and achievable location precision may be necessary. At GiPStech, we can customize a server-side configuration tailored to a specific app, allowing for relaxed hardware requirements. Please contact us for more details.

Based on these considerations, the full-stack location can be executed on devices that meet the following criteria:

  • Android
    • All Android devices with OS version 6 or greater;
    • The device must be equipped with accelerometer, magnetometer, gyroscope and Bluetooth 4.0 or greater;
    • The device must comply with the Android Compatibility Test Suite (CTS). Since verifying CTS compatibility is the responsibility of each manufacturer, guaranteeing full compliance for a specific phone is not possible without conducting a lab test.
  • iOS
    • All iPhones starting from 6s;
    • iOS version 15 or greater.

Examples

All code examples provided in this documentation are written in Kotlin, as they are intended for use within a Kotlin Multiplatform application. If you're targeting pure Android (Java or Kotlin) or iOS (Swift or Objective-C), function calls will be similar.

Complete sample projects for all three platforms are available in our GitHub repository mdk_examples.