ArcGIS IPS is an indoor positioning system that allows you to locate yourself and others inside a building in real time. Similar to GPS, it puts a blue dot on indoor maps and uses location services to help you navigate to any point of interest or destination.
ArcGIS IPS supports:
- Real-time indoor wayfinding
- Real-time indoors location tracking and sharing
- Real-time indoor location data collection
- Indoor analytics
Your app can work with ArcGIS IPS to show device location using an indoor location data source.
How ArcGIS IPS works
ArcGIS IPS provides geoprocessing tools for setting up and authoring your IPS environment in ArcGIS Pro. It also includes ArcGIS Setup, a mobile app to collect radio signals from Bluetooth Low Energy (BLE) Beacons inside your building(s) to enable the indoor positioning system. It can make use of an existing or new beacon infrastructure and is beacon vendor agnostic.
See Get started with ArcGIS IPS in the ArcGIS Pro documentation for detailed instructions for setting up an indoor positioning system.
At version 100.14, this API supports Wi-Fi for indoor positioning on Android devices. The ability to create a Wi-Fi based IPS will be available in a forthcoming release of ArcGIS Pro. ArcGIS IPS does not support BLE and Wi-Fi systems in the same facility but a mix of these systems can be deployed in different facilities within the same site.
Android 9 introduced Wi-Fi scan throttling to limit the number of Wi-Fi scans. To use Wi-Fi IPS, Android devices (9 or higher) must enable developer mode and disable Wi-Fi scan throttling (Developer Options > Networking > Wi-Fi scan throttling).
Floor-aware maps
ArcGIS Setup supports two types of floor-aware maps:
- ArcGIS Indoors floor-aware maps created according to the ArcGIS IPS Information Model.
- ArcGIS IPS floor-aware maps created using the guidelines described in the ArcGIS Pro Create floor plan data topic. Creating this type of floor-aware map does not require an ArcGIS Indoors license.
The ArcGIS Setup app automatically displays a floor picker when one of the two supported floor-aware maps is used. The floor picker is a custom component that you might want to implement in your own app. For an ArcGIS Indoors map, you can use the FloorManager class to expose available sites, facilities, and levels in your floor picker. For an ArcGIS IPS map, you'll need to also implement a custom floor manager component to manage those datasets in a floor picker.
IPS positioning table
An IPS positioning feature table is stored with an IPS-enabled map. Each row in the table contains an indoor positioning file. The positioning file is created when setting up the IPS environment using the Generate positioning file geoprocessing tool. The tool processes one or more indoor surveys and creates a new row in the IPS positioning table with the positioning file (as an attachment) along with the date and time it was created. When working with an indoor location source in your app, the most recent positioning file is used unless you specify a different one, as described in the following section.
Indoor location data source
Your app can work with indoor positioning by using a location data source and the geoview's location display. The basics are the same as working with any other LocationDataSource. The IndoorsLocationDataSource wraps the logic to find location using an indoor positioning file, Bluetooth signals, and information from device sensors. The IndoorsLocationDataSource provides the geographic location along with other metadata, such as the floor.
To work with ArcGIS IPS, the constructor for the IndoorsLocationDataSource requires an IPS positioning table. Optionally, you can provide the following.
-
Row ID: A globally unique ID that identifies a row in the IPS positioning table. The positioning file associated with this row will be used to find indoor locations. If not specified in the constructor, the positioning file from the most recent survey is used.
-
Pathways table: An
ArcGISFeatureTablewith line features that represent paths through the indoor space. Locations provided by theIndoorsLocationDataSourceare snapped to the lines in this feature class.
In the image below, the red + represents raw locations determined by the IPS. These locations are snapped to the nearest line feature in the pathways feature table before being displayed. This provides a more consistent display of the blue dot as it moves across the map.
You can handle a status changed event for the IndoorsLocationDataSource to be notified when the location data source starts, stops, or fails to start.
Caching the positioning file
Upon creation, an IndoorsLocationDataSource caches its positioning file on the device. The next time an indoors location data source is created for the same positioning table, the cached version of the file will be used under any of these circumstances:
- The cached positioning file is requested in the constructor (by row ID).
- A row ID isn't provided in the constructor and the cached positioning file is determined to be the most recent one available.
- No internet connection is available.
Handle location change
You can handle the location changed event for the IndoorsLocationDataSource to read information about the current Location.
An IPS location populates additional properties with the current floor and the transmitter (beacon) count. When the floor changes, you can update the map to filter the display of features for the current floor. The floor value returned with the location is an integer that represents the vertical offset, where 0 is the ground floor. This value increases by one for each floor above the ground floor and decreases by one for each floor below.
Use code like the following to read additional properties for the location when it changes.
locationDisplay.dataSource.locationChanged.first().let { location ->
if (location.additionalSourceProperties.isEmpty()) {
return@launch showError("Indoor positioning data source does not have any property fields")
}
// filter layers for the current floor (level)
val floor = (location.additionalSourceProperties["floor"] ?: "").toString()
setupLayers(floor.toInt())
}
In addition to getting the floor, you can get the position source, which will be BLE (Bluetooth Low Energy) when using IPS and GNSS (Global Navigation Satellite Systems) when using GPS. You can also get the count of transmitters (beacons) or satellites used to determine the location.
You can use a definition expression to filter layers in the map to only show features for the current floor. For efficiency, you should only filter features when the floor changes rather than with each location update. Depending on the schema for your floor-aware data, you may need to map the vertical offset value to a level ID in order to filter features by floor (level).
private fun setupLayers(floor: Int) {
mapView.map?.operationalLayers?.forEach { layer ->
val name = layer.name
// filter applicable layers to show features for the current floor (level)
if (layer is FeatureLayer && (name == "Details" || name == "Units" || name == "Levels")) {
layer.definitionExpression = "VERTICAL_ORDER = $floor"
}
}
}
Examples
Add indoor positioning to your app
To use indoor positioning in your app, you must have an IPS-enabled map. In addition to layers that describe the floor plan, an IPS-enabled map contains an IPS positioning table. See Get started with ArcGIS IPS in the ArcGIS Pro documentation for detailed instructions for setting up an IPS-enabled map.
In your app, make sure you request permissions for Bluetooth scanning. Also request permissions for accessing location (to use GPS).
Add these permissions to your Androidmanifest.xml file.
android.permission.BLUETOOTH_ADMIN
android.permission.BLUETOOTH
<!-- Needed if your app targets Android 12 or higher -->
android.permission.BLUETOOTH_SCAN
android.permission.ACCESS_FINE_LOCATION-
Load the IPS-enabled map. This can be a web map hosted as a portal item in ArcGIS Online or an Enterprise Portal or a mobile map package (.mmpk) created with ArcGIS Pro.
-
Create an
IndoorsLocationDataSource. Provide the positioning table (stored with the map) and the pathways feature class. -
Handle location change events if you want to respond to floor changes or read other metadata for locations.
-
Assign the
IndoorsLocationDataSourceto the map view's location display. -
Enable the map view's location display. Device location will appear on the display as a blue dot and update as the user moves throughout the space.
You can read the positioning table and pathways dataset from the map and use them to create the IndoorsLocationDataSource.
// get the positioning table from the map
val positioningTable = map.tables.firstOrNull { ft: FeatureTable -> ft.tableName == "ips_positioning" }
?: return showError("Positioning table not found")
// query positioning table to get the positioning ID
val queryParameters = QueryParameters().apply {
maxFeatures = 1
whereClause = "1 = 1"
orderByFields.add(OrderBy("DateCreated", SortOrder.Ascending))
}
val serviceFeatureTable = positioningTable as ServiceFeatureTable
val queryResult = serviceFeatureTable.queryFeatures(queryParameters).getOrNull()
val positioningId = if (queryResult == null) {
null
} else {
val feature = queryResult.first() as ArcGISFeature
feature.attributes[serviceFeatureTable.globalIdField] as Guid
}
// get the pathways layer (optional for creating the IndoorsLocationDataSource)
val pathwaysLayer : FeatureLayer = map.operationalLayers.firstOrNull { layer: Layer -> layer.name == "Pathways" } as FeatureLayer
// get the levels layer (optional for creating the IndoorsLocationDataSource)
val levelsLayer: FeatureLayer = map.operationalLayers.firstOrNull { layer: Layer -> layer.name == "Levels" } as FeatureLayer
// Setting up IndoorsLocationDataSource with positioning, pathways tables and positioning ID.
// positioningTable - the "ips_positioning" feature table from an IPS-enabled map.
// pathwaysTable - An ArcGISFeatureTable that contains pathways as per the ArcGIS Indoors Information Model.
// Setting this property enables path snapping of locations provided by the IndoorsLocationDataSource.
// levelsTable - An ArcGISFeatureTable that contains floor levels in accordance with the ArcGIS Indoors Information Model.
// Providing this table enables the retrieval of a location's floor level ID.
// positioningID - an ID which identifies a specific row in the positioningTable that should be used for setting up IPS.
indoorsLocationDataSource = IndoorsLocationDataSource(
positioningTable = positioningTable,
pathwaysTable = (pathwaysLayer.featureTable as ArcGISFeatureTable),
levelsTable = (levelsLayer.featureTable as ArcGISFeatureTable),
positioningId = positioningId
)
Assign the IndoorsLocationDataSource as the geoview's location display data source. Enable the location display to start receiving locations.
private suspend fun setupLocationDisplay() {
val locationDisplay = mapView.locationDisplay.apply {
// assign the IndoorLocationDataSource
dataSource = indoorsLocationDataSource
showLocation = true
}
locationDisplay.setAutoPanMode(LocationDisplayAutoPanMode.CompassNavigation)
lifecycleScope.launch {
// start the location display which will trigger IndoorsLocationDataSource to start receiving IPS updates
locationDisplay.dataSource.start()
.onFailure {
showError("Error when starting location display")
}
.onSuccess {
}
}
}