Getting Started

Overview

The sky’s the limit when it comes to the potential for unmanned aircraft. The AirMap SDK for Swift allows developers to authenticate with AirMap, create/manage a pilot profile, create/manage flights, send telemetry data & receive real-time traffic alerts.

Requirements

Environment

  • iOS 9.0+,
  • macOS 10.10+,
  • Swift 3.0 or 3.1
  • Xcode 8.2+

1. Sign up for an AirMap Developer Account.

https://developers.airmap.com/docs/introduction

2. Download an AirMap Configuration File

From the AirMap Developer portal, within your Application Settings, scroll down to Config JSON, and download the airmap.config.json file to add to your application.

WARNING

If you are using the Login UI from the SDK, then you must set a Callback URL.

You can add the callback URL in the developer portal under your Application settings.

MapBox Api Key

The Create Flight UI uses the MapBox GL Native SDK. Please request a MapBox Access Token: https://www.mapbox.com/ios-sdk/#access_tokens

You can add this key to your airmap.config.json file.

Installation

CocoaPods

Requires CocoaPods 1.2.0+

The AirMap SDK is a CocoaPod written in Swift. CocoaPods is a dependency manager for Cocoa projects. If you don't have CocoaPods, You can install it with the following command:

$ sudo gem install cocoapods

Troubleshooting CocoPods Installation

Can't install CocoaPods on OS X 10.11? See this issue on CocoaPods Github.

Otherwise, see CocoaPods Troubleshooting Guide.

Example Project

Warning

You must download an airmap.config file from the AirMap Developers Portal and add it to your Xcode project. See the Getting Started page for information of acquiring a Configuration File.

To run the example project, run pod try AirMapSDK. This should install the SDK and launch Xcode.

Integration into your project

To integrate the AirMap SDK into your Xcode project, navigate to the directory that contains your project and create a new Podfile with pod init or open an existing one, then add pod 'AirMapSDK' to the main target. Make sure to add the line use_frameworks!.

Make sure to add the line use_frameworks!.

target 'MyApp' do
  use_frameworks!
	pod 'AirMapSDK'
end

Then, run the following command to install the dependency:

$ pod install

Going forward, open the MyProject.xcworkspace file instead of the MyProject.xcodeproj file.

Updating

You can update the latest AirMap SDK by running the following command:

$ pod update AirMapSDK

Getting Started