The following sections introduce you to the Cisco Spaces WayFinding SDK API resources and provide instructions to make your first project.

The Cisco Spaces WayFinding SDK lets developers add indoor navigation and wayfinding features to iOS and Android apps. It uses Cisco Spaces location services to give users accurate turn-by-turn directions inside large buildings. Users can quickly find meeting rooms, desks, amenities, and other important locations.

This SDK is part of the Cisco Spaces ecosystem. The platform connects people, devices, and spaces. It delivers smart workspace solutions such as asset tracking, occupancy analytics, and environmental monitoring.

This SDK enables mobile applications to use best-in-class map and user location data such as:

• Get the user’s location indoors using BLE.
• Display maps showing points of interest and the user’s location.
• Search for points of interest.
• Provide wayfinding to any point of interest or other mapped location.

Prerequisites

These are the prerequisites:

• A Cisco Spaces WayFinding API key
• Cisco Spaces WayFinding SDK download link

iOS Required Permissions

Minimum version

Android sample build.gradle

In build.gradle, add these libraries for Android SDK:

• org.maplibre.gl:android-sdk
• org.maplibre.gl:android-plugin-localization-v9
• org.maplibre.gl:android-plugin-markerview-v9

implementation(fileTree(mapOf("dir" to "libs", "include" to listOf("*.aar", "*.jar"))))
implementation("com.google.android.gms:play-services-location:21.0.1")
implementation("org.maplibre.gl:android-sdk:11.7.1")
implementation("org.maplibre.gl:android-plugin-localization-v9:3.0.2")
implementation("org.maplibre.gl:android-plugin-markerview-v9:3.0.2")
implementation("com.github.bumptech.glide:glide:4.16.0")
implementation("androidx.cardview:cardview:1.0.0")
implementation("androidx.lifecycle:lifecycle-extensions:2.2.0")
implementation("org.altbeacon:android-beacon-library:2.21.0")
implementation("androidx.fragment:fragment-ktx:1.6.2")

Download sample project

To download the sample project, contact Cisco Spaces team .

Start SDK

Before you display a map, start listening to the user’s location, or perform any other action, you first must start the SDK and ensure that the SDK is in running state.

1. Initialization

1. Create an instance SpacesWayFinding as spacesWayFinding.
2. To initialize the SDK, app initiates a call spacesWayFinding.getAllBuildings(), followed by spacesWayFinding.selectBuilding().

2. Get all buildings

1. Obtain a Cisco Spaces WayFinding API key in advance.
2. Provide the API key along with the region (io, eu, sg, event) as parameters when calling the method. This call returns a list of building location IDs and names.

iOS (Swift)

/// initialize Spaces WayFinding
let spacesWayFinding = SpacesWayFinding(
apiKey: String,
region: SpacesWayFindingRegion
)
spacesWayFinding.getAllBuildings(buildings, error in
/// Custom Logic
)

Android (Kotlin)

val spacesWayFinding = SpacesWayFinding(
apiKey: String,
region: SpacesWayFindingRegion
)
spacesWayFinding.getAllBuildings{ spacesBuildings, error ->
/// Custom Logic
}

3. Select building

1. Initialize SDK and get all buildings.
2. Select a building.
3. After you select the building successfully, the app state returns as running.

iOS (Swift)

/// Initialize SpacesWayFindingParams
let params = SpacesWayFindingParams(building: building)
params.mode = .debug
params.loggerLevel = .error
spacesWayFinding.selectBuilding(params: params) { [weak self] (state) in
/// Your Custom logic based on SDK start
}

Android (Kotlin)

/// Initialize SpacesWayFindingParams
val params = SpacesWayFindingParams(buildingCredential)
params.loggerLevel = .error
spacesWayFinding.selectBuilding(applicationContext, params) { state ->
/// Your Custom logic based on SDK start
}

4. Render MapWidget

To render the building map, instantiate and present the MapWidget class (iOS, Android) to the application view. For more information, see MapWidgetFragment Class and MapWidgetViewController Class in SDK Reference.