Installation

The iOS SDK is distributed as a Swift Package. It targets iOS 16+ and runs the entire measurement on-device.

Access — coming soon

The iOS SDK is in a pre-release phase and the Swift Package is distributed on request. Contact us to request access and we will share the package URL for your account. The snippet below shows where that URL goes once you have it.

Requirements

Xcode 15+ / Swift 5.9+
iOS 16.0 deployment target or higher
A device with a front-facing camera

Add the package (Xcode)

File → Add Package Dependencies…
Enter the package URL we provide for your account.
Select the neccessory SDK library product and add it to your app target.

Add the package (Package.swift)

// swift-tools-version: 5.9
import PackageDescription

let package = Package(
  name: "YourApp",
  platforms: [.iOS(.v16)],
  dependencies: [
    // Contact us for the package URL for your account.
    .package(url: "https://<provided-on-request>", branch: "main"),
  ],
  targets: [
    .target(
      name: "YourApp",
      dependencies: [
        .product(name: "NeccessorySDK", package: "NeccessorySDK"),
      ]
    ),
  ]
)

Everything runs on-device

The iOS SDK is the on-device tier. It bundles everything it needs to detect the face, recover the pulse, and compute the metrics locally — there is nothing to download at runtime and no cloud video processing. Raw camera frames never leave the device.

This is a statement about this SDK, not about neccessory as a whole

The cloud tier does transmit cropped images of the face for server-side processing. If you build against it, the sentence above no longer describes your app — read Cloud privacy.

Camera permission

The SDK consumes camera frames you provide; it does not open the camera for you. Add a usage description to your app's Info.plist:

<key>NSCameraUsageDescription</key>
<string>Used to measure your vital signs from the camera.</string>

Import

import NeccessorySDK

Next: Quickstart.