Getting started

To begin your journey with's Asset Tracking iOS SDK, make sure you have met the necessary prerequisites, as outlined in the "Prerequisites" section. Then, proceed with the step-by-step installation instructions to integrate the SDK into your iOS project.


Before integrating the SDK into your application, ensure that your development environment meets the following prerequisites:

  1. API Key: Obtain a valid access key from our platform. This access key is essential for authentication and enables you to utilize the SDK's services.

  2. Platform Compatibility: Make sure you're using the right tools and versions:

    • IDE: Xcode 13.2.1 or a more recent version.

    • Minimum Deployment Target: iOS 11.0.

By meeting these prerequisites, you can guarantee a smooth and successful integration of our SDK into your application. These requirements have been established to ensure compatibility and optimal performance, enabling you to leverage the full potential of the SDK's features.


To integrate's iOS Asset Tracking SDK into your iOS project, follow the steps below

Step 0: Creating Your Project Folder

Before proceeding with the instructions below, you'll need to set up your project folder. You can do this by either creating a new empty iOS app project in Xcode or by cloning one from our official GitHub repository.

Creating a New Project in Xcode

  1. Open Xcode and go to File > New > Project.

  2. In the popup window, choose iOS > App and click Next.

  3. Fill in your project details on the subsequent screen, and then click Next to create your empty project.

Alternatively, Cloning from GitHub

If you prefer to start with our official demo code repository from GitHub, you can use the following command-line instructions

1git clone [email protected]:nextbillion-ai/nb-asset-tracking-ios-demo.git
2cd nb-asset-tracking-ios-demo

In the next section, we will execute specific commands within this project to complete the configuration. This step ensures you have the necessary project structure in place to seamlessly integrate the iOS Tracking SDK.

Step 1: Installing Carthage

To integrate the iOS Tracking SDK, you'll first need to install Carthage, a dependency manager for iOS. There are several methods for installing Carthage.

Using Homebrew (Recommended)

We recommend using Homebrew for a straightforward installation process. Open your terminal and execute the following commands.

1brew update
2brew install carthage

Using the Installer

Download the Carthage.pkg file for the latest release and follow the on-screen instructions to install Carthage. If you're installing the package via the command line, you may need to run the following command first:

1sudo chown -R $(whoami) /usr/local

Using MacPorts

If you prefer to use MacPorts, you can install Carthage by running the following commands:

1sudo port selfupdate
2sudo port install carthage

Again, remember to delete /Library/Frameworks/CarthageKit.framework if you had a previous binary installation.

From Source (Advanced)

If you want to use the latest development version of Carthage (although it may be unstable or incompatible), you can clone the master branch of the repository and run:

1make install

This method requires Xcode 10.0 (Swift 4.2).

Once Carthage is successfully installed, you'll be well-prepared to manage dependencies for your iOS Tracking SDK integration.

Install SDK via Carthage

To effortlessly integrate the NbAssetTracking framework using Carthage version 0.38 or above, follow these steps:

  1. (Optional) Clear Carthage Caches

    If you've previously downloaded the SDK, it's a good practice to clear your Carthage caches before updating. Execute the following commands:

    1rm -rf ~/Library/Caches/carthage/ ~/Library/Caches/org.carthage.CarthageKit/binaries/{MMKV,NBAssetDataCollectLib,NbAssetTracking}

  2. Create a Cartfile

    In your project directory, create a Cartfile using the following command:

    1touch Cartfile

    Open the Cartfile and add the following dependencies:

    1binary "" ~> 0.2.1
    2binary "" ~> 0.2.1
    3binary "" ~> 0.2.1

  3. Run Carthage Update

    Execute the following command to update the dependencies using xcframeworks:

    1carthage update --use-xcframeworks
    Run Carthage Update
  4. Link Frameworks

    In your Xcode project, navigate to your build phase and link the following frameworks:

    Link Frameworks
  5. Embed Frameworks

    Ensure that you embed these frameworks in your project to make them accessible for your application.

    Embed Frameworks

    By following these steps, you'll seamlessly integrate the NbAssetTracking framework using Carthage, enabling robust location-tracking capabilities within your iOS application.

Step 2: Location Data Access Explanation

Add the following to the Info.plist to explain why you need access to the location data:

1 <key>NSLocationAlwaysAndWhenInUseUsageDescription</key>
2 <string>Request for location update</string>
3 <key>NSLocationAlwaysUsageDescription</key>
4 <string>Request for location update</string>
5 <key>NSLocationWhenInUseUsageDescription</key>
6 <string>Request for location update</string>

Step 3: Initialization

A common way to initialize the SDK is to put the following code in your AppDelegate, otherwise, please make sure you have called the code below before you start using any functionalities of the SDK.

1let assetTracking = AssetTracking.shared
3// Customize asset tracking configuration
4// Enable notifications for asset status changes
5// And Customize data tracking configuration
7let notificationConfig = NotificationConfig()
8notificationConfig.showAssetEnableNotification = true
9notificationConfig.showLowBatteryNotification = true
10assetTracking.setNotificationConfig(config: notificationConfig)
12let dataTrackingConfig = DataTrackingConfig(baseUrl: "", dataStorageSize: 5000, dataUploadingBatchSize: 30, dataUploadingBatchWindow: 20, shouldClearLocalDataWhenCollision: true)
14assetTracking.setDataTrackingConfig(config: dataTrackingConfig)
16assetTracking.initialize( Key: "YOUR_ACCESS_KEY")

Replace YOUR_ACCESS_KEY with the access key provided to you by This initialization step is essential to authenticate your app and enable seamless communication with's services.

Step 4: Asset Binding and Tracking

To initiate asset binding and tracking with the iOS Tracking SDK, follow these steps:

  1. Creating an Asset

    If you don't have an asset yet, you can create one using the following API: AssetTracking.shared.createAsset(baseUrl, assetProfile, completionHandler, errorHandler)

    Retrieve the assetId from the API response.

    Here's a sample class structure for handling the response:

    1open class AssetCreationResponse {
    2 public let status: String
    3 public let data: AssetCreationResponseData{
    4 public let id: String
    5 }
  2. Binding the Asset to Your Device

    Once you have the assetId, use the following API to bind the asset to your current device:

    1AssetTracking.shared.bindAsset(baseUrl, assetId, completionHandler, errorHandler)

After a successful binding, you're ready to start tracking the location of the asset.

  1. Start and Stop Tracking

    You have the flexibility to initiate or halt tracking on your device, with location tracking and uploading adhering to your predefined configurations:

    To start data tracking:

    1// start data tracking

    To stop data tracking:

    1// stop data tracking

By following these steps, you'll effectively bind assets to your iOS device and commence location tracking as per your configuration settings. This allows you to seamlessly monitor and manage your assets using the iOS Tracking SDK.