Customizing the Neurofit Vitals SDK Scan Interface

The Neurofit Vitals SDK ships a complete, self-contained scan interface that guides users through placing their finger, counts down the 60-second measurement window, and communicates signal quality in real time. You control the visual style and feel through VitalsSDKConfiguration; the core measurement logic and quality guidance copy remain under SDK control to ensure result validity.

What the built-in scan UI includes

Every scan session presents the following screens and components without any additional code on your part:

Finger Placement Indicator

An animated overlay shows real-time coverage feedback so users know when their fingertip is correctly positioned over the rear camera lens.

Countdown Timer

A 60-second countdown keeps users informed of scan progress. The SDK enforces the fixed duration — it cannot be shortened or extended.

Live Signal Quality Indicator

A continuous signal-strength indicator updates throughout the scan so users can correct their finger position before the reading is withheld.

Completion Screens

Separate success and withheld-result screens are shown automatically at the end of every scan, with localized copy derived from the device locale.

The quality guidance text, animation assets, and completion screen copy are intentionally not customizable. Keeping these elements consistent across integrations ensures that users receive accurate instructions and that measurement validity is not compromised by copy changes.

Customization options

You configure the scan UI at SDK initialization time by passing a VitalsSDKConfiguration object to VitalsSDK.configure. The three configurable properties are described below.

Locale

The locale used for all SDK-managed UI copy. Defaults to the current device locale. Override this if your app forces a specific language independently of system settings.

UIColor (iOS) / Int color (Android)

The primary accent color applied to the progress ring, countdown numerals, completion checkmark, and interactive controls. Defaults to the system blue on iOS and #1f1f1f on Android. Use your app’s brand color for a seamless experience.

Boolean

default:"true"

When true, the SDK fires haptic feedback at scan start, at key quality milestones, and on completion. Set to false if your app context makes haptics inappropriate (for example, a clinical quiet environment).

The code samples below show a complete configuration for both platforms:

iOS (Swift)
Android (Kotlin)

VitalsSDKConfiguration — iOS

import NeuroFitVitals

VitalsSDK.configure(
    licenseKey: "YOUR_LICENSE_KEY",
    configuration: VitalsSDKConfiguration(
        locale: Locale(identifier: "en_US"),   // Override device locale
        tintColor: UIColor(                    // Brand accent color
            red: 0.12,
            green: 0.47,
            blue: 0.71,
            alpha: 1
        ),
        enableHaptics: true                    // Haptic feedback during scan
    )
)

VitalsSDKConfiguration — Android

import android.graphics.Color
import app.neurofit.vitals.VitalsSDK
import app.neurofit.vitals.VitalsSDKConfiguration
import java.util.Locale

VitalsSDK.configure(
    context = this,
    licenseKey = "YOUR_LICENSE_KEY",
    configuration = VitalsSDKConfiguration(
        locale = Locale("en", "US"),            // Override device locale
        accentColor = Color.parseColor("#1E78B4"), // Brand accent color
        enableHaptics = true                    // Haptic feedback during scan
    )
)

Pass your app’s primary brand color as tintColor / accentColor and the scan screen will feel like a native part of your product. Because the SDK uses the color across the progress ring, countdown display, and completion animations, even a small color alignment makes a noticeable difference to perceived cohesion.

Embedding the scan view

In addition to presenting the scan as a full-screen modal, the SDK offers embedding options for apps that manage their own navigation structure.

iOS — SwiftUI
iOS — UIKit
Android — Fragment

Use VitalsScanView directly inside any SwiftUI view hierarchy. The result and error closures are called on the main actor, so you can update @State or @ObservedObject properties directly.

SwiftUI embedding

import SwiftUI
import NeuroFitVitals

struct ContentView: View {
    @State private var showingScan = false
    @State private var latestResult: VitalsResult?

    var body: some View {
        Button("Start Scan") { showingScan = true }
            .sheet(isPresented: $showingScan) {
                VitalsScanView(
                    onComplete: { result in
                        latestResult = result
                        showingScan = false
                    },
                    onError: { error in
                        print("Scan error: \(error.localizedDescription)")
                        showingScan = false
                    }
                )
            }
    }
}

Instantiate VitalsScanViewController, assign your delegate conformance, and present it as you would any other view controller. The SDK calls dismiss automatically when the scan completes or is cancelled.

UIKit embedding

import UIKit
import NeuroFitVitals

class DashboardViewController: UIViewController {
    func presentScan() {
        let scanVC = VitalsScanViewController()
        scanVC.delegate = self
        scanVC.modalPresentationStyle = .fullScreen
        present(scanVC, animated: true)
    }
}

extension DashboardViewController: VitalsScanDelegate {
    func vitalsScan(_ scan: VitalsScan, didComplete result: VitalsResult) {
        // Handle completed result
    }

    func vitalsScan(_ scan: VitalsScan, didUpdate progress: ScanProgress) {
        // Optional: mirror progress in your own UI
    }

    func vitalsScan(_ scan: VitalsScan, didFailWith error: VitalsError) {
        // Handle error
    }
}

VitalsScanFragment can be embedded inside any FragmentContainerView for apps that use a single-Activity architecture. Add it to your layout container via a fragment transaction as shown below.

Fragment embedding

import app.neurofit.vitals.VitalsScanFragment

class DashboardFragment : Fragment() {

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, savedInstanceState)

        val scanFragment = VitalsScanFragment.newInstance()

        childFragmentManager.beginTransaction()
            .replace(R.id.scan_container, scanFragment)
            .commit()
    }
}

Localization

The SDK ships localized strings for all built-in UI copy. When locale is set to .current / Locale.getDefault(), the SDK automatically selects the matching language bundle. If a translation is not available for the requested locale, the SDK falls back to English.

Custom string overrides are not supported in the current SDK version. If you need a language that is not yet available, contact support@neurofit.app with your locale identifier and use case.

Overview

Getting Started

Integration Guide

Metrics Reference

Help

Customizing the Neurofit Vitals SDK Scan Interface

What the built-in scan UI includes

Finger Placement Indicator

Countdown Timer

Live Signal Quality Indicator

Completion Screens

Customization options

Embedding the scan view

Localization

​What the built-in scan UI includes

Finger Placement Indicator

Countdown Timer

Live Signal Quality Indicator

Completion Screens

​Customization options

​Embedding the scan view

​Localization

What the built-in scan UI includes

Customization options

Embedding the scan view

Localization