Quick Start ​

This quick start guide describes the basic flow for measuring vital signs using Binah.ai SDK.

The SDK supports three measurements modes:

• Face Measurement
• Finger Measurement
• Polar Measurement

A sample flow for face measurement follows. A similar flow can be applied for finger measurements. See Measurement Modes for more information about measurement modes.

Creating a Measurement Session ​

A session is an interface for performing vital sign measurements.

• When creating a session, it is essential to define the measurement mode. The SDK supports three measurement modes:
  • Face Measurements (Front Camera): This mode utilizes the front camera for capturing face-related measurements.
  • Finger Measurements (Rear Camera): In this mode, the rear camera is used to take measurements from the user's finger.
  • Polar Measurements (External PPG Sensor): This mode enables measurements using the Polar Verity Sense sensor.
• Only a single session can be created at any given time. Terminate the previous session before creating a new session.
• When switching to a different measurement mode (for example, from face to finger, or from finger to face), the current session must be terminated, and a new session must be created.
• A session is intended for a single user. When measuring the vital signs of another user, a new session must be created. See Demographic Info.

The following code can be used to create a session with the relevant parameters:

do {
    let licenseDetails = LicenseDetails(licenseKey: "<ENTER_YOUR_LICENSE_KEY>")
    let session = try FaceSessionBuilder()
        .withImageListener(self)
        .withVitalSignsListener(self)
        .withSessionInfoListener(self)
        .build(licenseDetails: licenseDetails)
}
catch {
    let e = error as NSError
    print("Received Error. Domain: \(e.domain) Code: \(e.code)")
}

BNHLicenseDetails *licenseDetails = [[BNHLicenseDetails alloc] initWithLicenseKey:@"<ENTER_YOUR_LICENSE_KEY>"];
BNHFaceSessionBuilder *sessionBuilder = [[[[[BNHFaceSessionBuilder alloc] init]
                                           withImageListener:self]
                                          withVitalSignsListener:self]
                                         withSessionInfoListener:self];

NSError *error = nil;
id<BNHSession> _Nullable session = [sessionBuilder buildWithLicenseDetails:licenseDetails
                                                                     error:&error];
if (error != nil) {
    NSLog(@"Received Error. Domain: %@ Code: %ld", error.domain, (long)error.code);
}

Waiting for the Session to Transition into ready State ​

The application can receive session state updates by implementing onSessionStateChange as part of SessionInfoListener.

func onSessionStateChange(sessionState: SessionState) {
    DispatchQueue.main.async {
        if (sessionState == .ready) {
            print("Session is ready to start measuring")
        }
    }
}

- (void)onSessionStateChangeWithSessionState:(BNHSessionState)sessionState {
    dispatch_async(dispatch_get_main_queue(), ^{
        if (sessionState == BNHSessionStateReady) {
            NSLog(@"Session is ready to start measuring");
        }
    });
}

Starting a Measurement ​

A measurement can be started by calling the start method

do {
    let measurmentDuration = 60
    try session.start(measurmentDuration: measurmentDuration)
} 
catch {
    let nsError = (error as NSError)
    print("Received Error. Domain: \(nsError.domain) Code: \(nsError.code)")
}

NSInteger measurementDuration = 60;
[session startWithMeasurementDuration:measurementDuration error:&error];
if (error != nil) {
    NSLog(@"Received Error. Domain: %@ Code: %ld", error.domain, (long)error.code);
}

Receiving Results During a Measurement ​

The application can receive instantaneous vital signs values by implementing onVitalSign as part of VitalSignsListener.

func onVitalSign(vitalSign: VitalSign) {
    // Handle vital sign result
}

- (void)onVitalSignWithVitalSign:(BNHVitalSign *)vitalSign {
    // Handle vital sign result
}

During the measurement, the instantaneous vital sign values are available only for specific vital signs, while the results of all vital signs are received once the measurement has been completed.

Stopping a Measurement ​

The measurement is stopped either after the measurement duration (provided in the start function) has ended, or when the stop method is called.

do {
    try session.stop()
}
catch {
    let nsError = (error as NSError)
    print("Received Error. Domain: \(nsError.domain) Code: \(nsError.code)")
}

[session stopAndReturnError:&error];
if (error != nil) {
    NSLog(@"Received Error. Domain: %@ Code: %ld", error.domain, (long)error.code);
}

Receiving Final Results ​

The application can receive final vital sign results and vital sign confidence levels by implementing onFinalResults as part of VitalSignsListener.

func onFinalResults(results: VitalSignsResults) {
    // Handle the final results of the measurements
}

- (void)onFinalResultsWithResults:(BNHVitalSignsResults *)results {
    // Handle the final results of the measurements
}

The final results are computed when the session is in stopping state. For more information about receiving and handling the final results, see Vital Signs.

Terminating a Session ​

It is recommended to terminate the session whenever the measuring screen is not visible.

session.terminate()

[session terminate];