Install the Neurofit Vitals SDK in Your Mobile App

Before writing any measurement code, you need the SDK package in your project and the correct system permissions granted so the OS allows camera access during a scan. This page walks through both steps for iOS and Android. The whole process takes under ten minutes on a clean project.

Prerequisites

License Key

Obtain your license key from Neurofit after signing a license agreement. See Licensing for how to get one.

iOS Requirements

Xcode 15 or later. Deployment target iOS 15+. A physical device is required for camera-based scanning — the iOS Simulator does not have a rear camera.

Android Requirements

Android Studio Hedgehog (2023.1.1) or later. minSdk 24 (Android 7.0) or higher. A physical device or emulator with camera support.

Install the Package

iOS — Swift Package Manager
Android — Gradle

The iOS SDK is distributed as a Swift Package. Add it to your project using Xcode’s built-in package manager.

Open the Add Packages dialog

In Xcode, choose File → Add Package Dependencies… (or File → Add Packages in older Xcode versions).

Enter the package URL

Paste the Neurofit Vitals package URL into the search field:

https://sdk.neurofit.app/vitals-ios

Select a version rule

Choose Up to Next Major Version with 1.0.0 as the minimum. Click Add Package.

Add to your app target

When prompted, check the box next to NeuroFitVitals and confirm your app target is selected. Click Add Package to finish.

Required Permissions — Info.plist

The SDK opens the rear camera during a scan. Add the following key to your Info.plist so the OS can show a permission prompt with a meaningful reason string:

<key>NSCameraUsageDescription</key>
<string>Used for heart rate and HRV measurements</string>

If NSCameraUsageDescription is absent, iOS will terminate your app the first time the SDK requests camera access. Do not omit it.

Import

Add the import at the top of any Swift file that uses the SDK:

import NeuroFitVitals

The Android SDK is distributed through a private Maven repository. Add the repository and the dependency to your Gradle build files.

Add the Neurofit Maven repository

Open settings.gradle.kts (project root) and add the repository inside dependencyResolutionManagement:

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven { url = uri("https://sdk.neurofit.app/vitals-android") }
    }
}

Add the SDK dependency

Open your app module’s build.gradle.kts and add the dependency:

dependencies {
    implementation("app.neurofit:vitals-sdk:1.0.0")
}

Sync your project after saving.

Add permissions to AndroidManifest.xml

The SDK requires camera permission and declares the camera hardware feature. Add both entries to your AndroidManifest.xml:

<uses-permission android:name="android.permission.CAMERA" />

<uses-feature
    android:name="android.hardware.camera"
    android:required="true" />

CAMERA is a runtime permission on Android 6.0+. You must also request it at runtime before launching a scan. The SDK will surface a VitalsError.cameraPermissionDenied error if permission has not been granted when a scan starts.

Minimum OS Version Summary

Platform	Minimum Version
iOS	iOS 15.0
Android	API 24 (Android 7.0 Nougat)

Securing Your License Key

Your license key is required during SDK initialization (see Quickstart). Keep it out of your version control system and avoid hard-coding it as a plain string in production builds.

Store the license key in an environment variable injected at build time, a secrets manager, or a remote config service that your app fetches at launch. This prevents the key from being extracted from a committed source file or a decompiled binary.

Overview

Getting Started

Integration Guide

Metrics Reference

Help

Install the Neurofit Vitals SDK in Your Mobile App

Prerequisites

License Key

iOS Requirements

Android Requirements

Install the Package

Required Permissions — Info.plist

Import

Minimum OS Version Summary

Securing Your License Key

​Prerequisites

License Key

iOS Requirements

Android Requirements

​Install the Package

​Required Permissions — Info.plist

​Import

​Minimum OS Version Summary

​Securing Your License Key

Prerequisites

Install the Package

Required Permissions — Info.plist

Import

Minimum OS Version Summary

Securing Your License Key