Skip to content

Introduction

The GiPStech Way-Fi library is a component of the GiPStech Location Framework. When used in conjunction with the GiPStech MDK, it enables advanced indoor and outdoor way finding functionalities.

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.

Memory management

This library is a wrapper for a native library that allocates objects on the native heap. Memory associated with these native objects must be explicitly released, as the garbage collector only handles managed wrappers and does not free native memory.

To prevent memory leaks, you must manually call the release method on instances of classes that inherit from WayFiNative. Alternatively, you can release all native memory in one step by calling WayFi.releaseAll. If you no longer intend to use the library, call WayFi.shutdown instead.

Once a native object has been released, its isAlive property is set to false. Attempting to access a released object will result in a WayFiException.InvalidReference being thrown.

Support

If you need GiPStech technical support, you can submit a ticket through our Help Desk.

If you have encountered a bug in the Way-Fi library, please include the following details in your report:

  • Device name and manufacturer
  • Operating system version
  • Library version
  • Name and version of the IDE/Compiler used to build the app
  • A brief description of the steps to reproduce the issue
  • A sample application that replicates the bug

The last point is mandatory. The sample application must include the complete project files along with the source code, which should be as minimal as possible. Ideally, it should contain only the necessary calls to the GiPStech Way-Fi library, avoiding third-party libraries whenever possible.