IndoorAtlas Cordova plugin v3

All functions that are part of the IndoorAtlas Cordova plugin are scoped under the IndoorAtlas singleton object. For example the function #initialize can be used in code as IndoorAtlas.initialize(...).

Most classes returned by the plugin, such as FloorPlan (= IndoorAtlas.FloorPlan) are not supposed to be constructed by the user directly. The only exception is IndoorAtlas.Geofence.

Basic usage

Before you start, make sure you are familiar with the main phases of deploying IndoorAtlas technology. In particular, your physical location must be fingeprinted with the IndoorAtlas Map Creator 2 application before any of the below APIs will return meaningful values.

First, add IndoorAtlas plugin to the config.xml file of your project

<plugin name="cordova-plugin-indooratlas" spec="git+https://github.com/IndoorAtlas/cordova-plugin.git" />

Then you can initialize in Cordova's "deviceready" callback or later, e.g.,

document.addEventListener('deviceready', () => {
  // start positioning
  IndoorAtlas.initialize({ apiKey: YOUR_IA_API_KEY })
   .watchPosition(position => {
     console.log(
       "latitude: " + position.coords.latitude + ", " +
       "longitude: " + position.coords.longitude + ", " +
       "floor: " + position.coords.floor);
  });

  // auto-stop positioning after 60 seconds
  setTimeout(() => IndoorAtlas.clearWatch(), 60000);
}, false);

All methods return the IndoorAtlas singleton object to allow chaining like in the above example.

Initializes IndoorAtlas location manager object with provided API key. Must be called before using other methods. Should be called in Cordova's deviceready callback or later.

IndoorAtlas.initialize({ apiKey: "3795eee9-efaf-47db-8347-316b6bb0c834" })

Starts IndoorAtlas positioning

IndoorAtlas.watchPosition(position => {
    console.log(`
        ${position.coords.latitude}
        ${position.coords.longitude}
        ${position.coords.floor}`);
});

Stops IndoorAtlas positioning. Also clears any other watches.

IndoorAtlas.watchPosition(position => {
   // do some positioning
});
// stop after 10 seconds
setTimeout(() => { IndoorAtlas.clearWatch(); }, 10000);

Start observing floor plan changes

IndoorAtlas.watchFloorPlan(floorPlan => {
    if (floorPlan) {
        console.log(`entered floor plan ${floorPlan.name}`);
    }
});

Stop observing floor plan changes

Start observing venue changes

Stop observing venue changes

Start observing status changes

IndoorAtlas.onStatusChanged(console.log);

Stop observing status changes

Start observing for device orientation & heading changes

IndoorAtlas.watchOrientation(orientation => {
    console.log(`heading: ${orientation.trueHeading} degrees`);
});

Stop observing orientation changes

Request wayfinding from the current location of the user to the given coordinates. Also a #POI can be given as a destination.

const destination = { latitude: 60.16, longitude: 24.95, floor: 2 };
IndoorAtlas.requestWayfindingUpdates(destination, route => {
    console.log(`the route has ${route.legs.length} leg(s)`);
});

Stop wayfinding. Typically called after arriving to the destination (determined with #requestWayfindingUpdates) or if the user cancels the wayfinding session.

IndoorAtlas.removeWayfindingUpdates()

Request a single-shot wayfinding route. Also a #POI can be given as a source or destination.

const from = { latitude: 60.16, longitude: 24.95, floor: 2 };
const to = { latitude: 60.161, longitude: 24.951, floor: 3 };
IndoorAtlas.requestWayfindingRoute(from, to, route => {
    console.log(`the route has ${route.legs.length} leg(s)`);
});

Start monitoring for geofence events (entering or exiting geofences).

Stop monitoring enter/exit events for geofences.

Add a geofence to be monitored for enter/exit.

IndoorAtlas.addDynamicGeofence(new IndoorAtlas.Geofence({
  id: '12345678-90ab-cdef-1234-567890abcdef',
  name: 'My geofence',
  floor: 1,
  coordinates: [
    [65.1234, 25.51234],
    [65.1254, 25.51234],
    [65.1254, 25.51334],
    [65.1234, 25.51334],
    [65.1234, 25.51234]
  ]
}));

Removes a dynamic geofence from being monitored.

Provide a whole geofence object

var geofence = new IndoorAtlas.Geofence({ ... });
// ...
IndoorAtlas.removeDynamicGeofence(geofence);

Or just an geofence ID string

IndoorAtlas.removeDynamicGeofence('12345678-90ab-cdef-1234-567890abcdef');

Indicate current location to positioning service. This method can be used to pass a hint to the system e.g. when location is already known. This is completely optional and should only be used to shorten time it takes for the first fix. It is not recommended that this method is called with approximate locations with low or medium accuracy.

IndoorAtlas.setPosition({ latitude: 60.16, longitude: 24.95, floor: 2 });

Enable or disable indoor-outdoor detection. Disabled by default.

IndoorAtlas.lockIndoors(false);

Disable automatic floor detection and lock the floor level to a given number

IndoorAtlas.lockFloor(3);

Re-enable automatic floor detection after locking the floor with #lockFloor

IndoorAtlas.unlockFloor();

Returns the IndoorAtlas trace ID for this session in a callback.

IndoorAtlas.getTraceId(traceId => console.log(traceId));

Start observing beacon scans.

NOTE! To enable the callback, please contact IndoorAtlas support.

IndoorAtlas.watchIBeacons((error, beacons) => {
    if (error) {
       console.log(`error scanning beacons: ${error.description} details: ${JSON.stringify(error.details)}`);
    } else {
       console.log(`scanned beacon count: ${beacons.length}`);
    }
});

Stop observing beacon scans.

Start observing wifi scans. Only supported on Android.

NOTE! To enable the callback, please contact IndoorAtlas support.

IndoorAtlas.watchWifis((error, wifis) => {
    if (error) {
       console.log(`error scanning wifis: ${error.description}`);
    } else {
       console.log(`scanned wifi count: ${wifis.length}`);
    }
});

Stop observing wifi scans.

Callback function triggered on geofence events

Type: Function

Callback function triggered on beacon scans. Only one callback can be active at a time.

NOTE! To enable the callback, please contact IndoorAtlas support.

Type: Function

Callback function triggered on wifi scans. Only one callback can be active at a time.

NOTE! To enable the callback, please contact IndoorAtlas support.

Type: Function

Describes an indoor or outdoor location with coordinates, uncertainties and metadata such as IndoorAtlas floor plan and venue objects.

An IndoorAtlas.Coordinates object is attached to a IndoorAtlas.Position object that is available to callback functions in requests for the current position. It contains a set of properties that describe the geographic coordinates of a position.

A data object describing a floor plan. Can be obtained with #watchFloorPlan or as the Position#floorPlan member of the position returned by #watchPosition.

"5be07da6-6c8b-4fb8-b4a7-9b093fbb4dbb"

"Ground Floor"

"https://example.com/d346ea8a-3d1d-44a3-9c8b-3d4fa440a779.png"

2

143

1024

2048

25

50

20.48

0.05

[24.1234, 63.1234]

[24.1234, 63.1234]

[24.1234, 63.1234]

[24.1234, 63.1234]

floorPlan.pointToCoordinate(405, 185);
// returns { latitude: 63.1234, longitude: 24.1234 }

floorPlan.pointToCoordinate(63.1234, 24.1234);
// returns { x: 405, y: 185 }

A data object describing a venue, also known as a building or location. Can be obtained with #watchVenue or as the Position#venue member of the object returned by #watchPosition.

"bd169e67-33a9-418d-a3e3-caf98ff01877"

"Local Shopping Mall"

POI, or Point Of Interest, is a special position inside a building

'Reception desk'

IndoorAtlas service status obtained with #onStatusChanged.

2

"AVAILABLE"

Describes the heading and orientation of the device. Obtained with #watchOrientation

Describes a wayfinding route consisting of IndoorAtlas.RoutingLegs. Obtained with #requestWayfindingUpdates or #requestWayfindingRoute

Wayfinding route leg object

Wayfinding route point

A geofence describes a region of interest. Entering or exiting geofences will trigger SDK events caught by #watchGeofences. The geofences contained in a Venue are sent together with the venue (see #watchVenue and #watchPosition).

'12345678-90ab-cdef-1234-567890abcdef'

'Meeting room A101'

[
  { latitude: 65.01, longitude: 25.50 },
  { latitude: 65.02, longitude: 25.51 },
  { latitude: 65.01, longitude: 25.52 },
  { latitude: 65.01, longitude: 25.50 },
]

IBeacon

Wifi

Error