# NEUROFIT Vitals SDK

> Add a validated 60-second fingertip HRV (RMSSD) reading to your iOS or Android app.

- [Introduction](https://developer.neurofit.app/introduction.md): What the NEUROFIT Vitals SDK does, what a reading returns, and how the pieces fit together.
- [iOS quickstart](https://developer.neurofit.app/quickstart-ios.md): Add the NeurofitVitals Swift package, activate your license, request camera access and run a reading.
- [Android quickstart](https://developer.neurofit.app/quickstart-android.md): Add the vitals-sdk AAR, activate your license, request the camera permission and run a reading in Kotlin or Java.
- [React Native quickstart](https://developer.neurofit.app/quickstart-react-native.md): Use @neurofit/vitals-react-native, a thin TypeScript wrapper over the native iOS and Android SDKs.
- [Flutter quickstart](https://developer.neurofit.app/quickstart-flutter.md): Use the neurofit_vitals Dart package, a thin MethodChannel and EventChannel wrapper over the native SDKs.
- [Capacitor quickstart](https://developer.neurofit.app/quickstart-capacitor.md): Use @neurofit/vitals-capacitor, a Capacitor 6 plugin that wraps the native iOS and Android SDKs.
- [License keys](https://developer.neurofit.app/license-keys.md): How the offline license key works, how to install it, and what updatesUntil means for a perpetual license with maintenance.
- [Reading lifecycle](https://developer.neurofit.app/reading-lifecycle.md): The session state machine, every event the SDK emits, the guidance values with suggested copy, and the production defaults.
- [Metrics](https://developer.neurofit.app/metrics.md): What each metric means, its units, the quality tier, and the validated accuracy against a Polar H10 chest strap.
- [Outcomes best practices](https://developer.neurofit.app/outcomes-best-practices.md): How to design pre/post measurements and trends with the SDK, how to judge whether a change is real, and why a finger scan rather than a face scan.
- [Privacy and compliance](https://developer.neurofit.app/privacy-compliance.md): What the SDK does and does not do with data, how to answer the App Store and Google Play privacy questions, permissions, consent copy, and the not-a-medical-device position.
- [Device support](https://developer.neurofit.app/device-support.md): Supported OS versions and hardware, how the SDK reports support at runtime, and how to exclude specific device models.
- [Troubleshooting](https://developer.neurofit.app/troubleshooting.md): Symptoms, causes and fixes for activation, permissions, camera, signal, result and build problems.
- [Diagnostics](https://developer.neurofit.app/diagnostics.md): The keys in VitalsResult.diagnostics, what each one records, and which are platform-specific.
- [API reference (iOS)](https://developer.neurofit.app/api-reference-ios.md): Every public type in the NeurofitVitals Swift module, version 1.0.0, as declared in the SDK sources.
- [API reference (Android)](https://developer.neurofit.app/api-reference-android.md): Every public type in the com.neurofit.vitals Kotlin package, version 1.0.0, as declared in the SDK sources.
- [Changelog](https://developer.neurofit.app/changelog.md): Release notes for the NEUROFIT Vitals SDK.
- [Roadmap](https://developer.neurofit.app/roadmap.md): What is coming to the NEUROFIT Vitals SDK after 1.0.0.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.