Skip to main content
Version: Next

Install SkyPath iOS SDK

Overview​

SkyPath iOS SDK enables your iOS applications to interact with SkyPath using either the Swift or Objective-C programming languages. This page details how to install SkyPath in your project and get started.

Prerequisites​

Before getting started, ensure your development environment meets the following prerequisites:

  • Xcode version 16.2 or higher.
  • A target of iOS 16.0 or higher.

Installation​

The SkyPath iOS SDK is provided as a pre-built .xcframework written in Swift.

The Swift Package Manager (SwiftPM) is a tool for automating the distribution of Swift code. It’s integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies.

  1. Add Package Dependency

    In Xcode, select File > Add Packages...

  2. Specify the Repository

    Copy and paste the following into the search/input box.

    https://github.com/Yamasee/skypath-ios-sdk

  3. Specify Options

    In the options for the skypath-ios-sdk package, we recommend setting the Dependency Rule to Up to Next Major Version, and entering the current SkyPath iOS SDK version. Then, click Add Package.

  4. Choose Package Products

    Select SkyPathSDK, then click Add Package.

tip

Make sure SkyPathSDK is added in "Target Dependencies" and "Link Binary With Libraries" as "Required" under "Build Phases" and in "Frameworks, Libraries, and Embedded Content" under "General".

info

Warnings in the console on app start, similar to: Class _TtC8GEOSwiftP33_548B91C3597A5AB2DA24C29309949B6D15MakeValidParams is implemented in both... This is due to a conflict in linking the GEOSwift library that is used by SkyPathSDK. SkyPathSDK doesn't use GEOSwift since v3.0.1 anymore, so please upgrade to the latest version.

info

Upload Symbols Failed

During uploading your app to the App Store, you may get a warning "Upload Symbols Failed - The archive did not include a dSYM for the SkyPathSDK.framework". The SkyPath SDK does not include a dSYM file, and it is safe to discard this warning.

Here is an answer from the Apple Engineer

This is a new warning in Xcode 16 where if you're missing a dSYM, Xcode lets you know in case you aren't expecting that — this is to reduce scenarios where you won't are able to fully symbolicating frames coming from your app's code in crash reports. In some cases, you may not have a dSYM, such as a closed source library from a vendor, and in those cases, the warning is safe to discard.

Import SkyPath​

Add the following line at the top of your source files to use SkyPath:

import SkyPathSDK

Background Mode​

Location will be used while the app is in the background to keep track of and alert to turbulence.

  1. Add Location Updates Background Mode

    Select your project in the Xcode File Navigator. Select your app's target and go to the Signing & Capabilities tab. Press Add Capability and choose Background Modes. Under Background Modes now select Location Updates.

  2. Open the Info.plist file of the project and add Privacy - Location When In Use Usage Description

<key>NSLocationWhenInUseUsageDescription</key>
<string>Location will be used to accurately report and get notified on turbulence ahead</string>

App Download File Size​

SkyPathSDK adds around 10 MB to your app's download size.

The releases we distribute are significantly larger because they include support for the iOS simulator which is stripped by the App Store automatically when apps are downloaded.