marcipops / ia-cordova-plugin

IndoorAtlas Apache Cordova plugin

IndoorAtlas React Native plugin can be found in react-native branch

IndoorAtlas Cordova Plugin

IndoorAtlas provides a unique Platform-as-a-Service (PaaS) solution that runs a disruptive geomagnetic positioning in its full-stack hybrid technology for accurately pinpointing a location inside a building. The IndoorAtlas SDK enables app developers to use high-accuracy indoor positioning in venues that have been fingerprinted.

Getting started

1. Before starting, read the quick overview of IndoorAtlas technology to understand the necessary steps in the deployment process
2. Set up your free developer account in the IndoorAtlas developer portal.
3. To enable IndoorAtlas indoor positioning in a venue, the venue needs to be fingerprinted with the IndoorAtlas MapCreator 2 tool.
4. To start developing your own app using the Cordova plugin, create an API key and plug it into our example application available on Github.

Documentation

The full documentation for the IndoorAtlas Cordova plugin is available at: https://docs.indooratlas.com/cordova/latest/

Development notes

The documentation is generated from the latest code with documentation.js. Usage:

npm install -g documentation
documentation build www/IndoorAtlas.js -f html -o /tmp/docs/

License

Copyright 2015-2021 IndoorAtlas Ltd. The Cordova Plugin is released under the Apache License. See the LICENSE.md file for details.