During the measurement

After the measurement has started, you can monitor the stage and progress of the measurement.

Checking the measurement state

To see what is happening underneath you can call the getMeasurementState() method. It returns the following enumeration informing you about the state of the measurement.

enum MeasurementState {
  notStarted,                       // Measurement has not started yet
  waitingForFace,                   // Waiting for face to be properly positioned in the frame
  runningSignalShort,               // Measurement started: Signal is too short for any conclusions
  runningSignalGood,                // Measurement proceeding: Signal quality is good
  runningSignalBad,                 // Measurement stalled due to poor signal quality
  runningSignalBadDeviceUnstable,   // Measurement stalled due to poor signal quality (caused by unstable device)
  finished,                         // Measurement has finished successfully
  failed,                           // Measurement has failed
}

enum MeasurementState {
  NOT_STARTED = 0,                    // Measurement has not started yet
  WAITING_FOR_FACE,                   // Waiting for face to be properly positioned in the frame
  RUNNING_SIGNAL_SHORT,               // Measurement started: Signal is too short for any conclusions
  RUNNING_SIGNAL_GOOD,                // Measurement proceeding: Signal quality is good
  RUNNING_SIGNAL_BAD,                 // Measurement stalled due to poor signal quality
  RUNNING_SIGNAL_BAD_DEVICE_UNSTABLE, // Measurement stalled due to poor signal quality (caused by unstable device)
  FINISHED,                           // Measurement has finished successfully
  FAILED                              // Measurement has failed
}

enum MeasurementState {
  case notStarted                     // Measurement has not started yet
  case waitingForFace                 // Waiting for face to be properly positioned in the frame
  case runningSignalShort             // Measurement started: Signal is too short for any conclusions
  case runningSignalGood              // Measurement proceeding: Signal quality is good
  case runningSignalBad               // Measurement stalled due to poor signal quality
  case runningSignalBadDeviceUnstable // Measurement stalled due to poor signal quality (caused by unstable device)
  case finished                       // Measurement has finished successfully
  case failed                         // Measurement has failed
}

enum MeasurementState {
  NOT_STARTED,                        // Measurement has not started yet
  WAITING_FOR_FACE,                   // Waiting for face to be properly positioned in the frame
  RUNNING_SIGNAL_SHORT,               // Measurement started: Signal is too short for any conclusions
  RUNNING_SIGNAL_GOOD,                // Measurement stalled due to poor signal quality
  RUNNING_SIGNAL_BAD,                 // Measurement proceeding: Signal quality is good
  RUNNING_SIGNAL_BAD_DEVICE_UNSTABLE, // Measurement stalled due to poor signal quality (caused by unstable device)
  FINISHED,                           // Measurement has finished successfully
  FAILED                              // Measurement has failed
}

import { MeasurementState } from "shenai-sdk";
 
// Retrieve the current measurement state
const measurementState = shenaiSDK.getMeasurementState();
 
switch (measurementState) {
  case MeasurementState.NOT_STARTED:
    console.log("Measurement has not started yet");
    break;
  case MeasurementState.WAITING_FOR_FACE:
    console.log("Waiting for face to be properly positioned in the frame");
    break;
  case MeasurementState.RUNNING_SIGNAL_SHORT:
    console.log("Measurement started: signal is too short for any conclusions");
    break;
  case MeasurementState.RUNNING_SIGNAL_GOOD:
    console.log("Measurement proceeding: signal quality is good");
    break;
  case MeasurementState.RUNNING_SIGNAL_BAD:
    console.log("Measurement stalled due to poor signal quality");
    break;
  case MeasurementState.RUNNING_SIGNAL_BAD_DEVICE_UNSTABLE:
    console.log("Measurement stalled due to device instability");
    break;
  case MeasurementState.FINISHED:
    console.log("Measurement has finished successfully");
    break;
  case MeasurementState.FAILED:
    console.log("Measurement has failed");
    break;
}

In particular, you should wait for Finished or Failed values, because they indicate that the measurement has concluded.

Tracking the measurement progress

To check the progress of the whole measurement you can call the getMeasurementProgressPercentage() method, returning a floating point number between 0 and 100.

Real-time metrics

During the measurement you can query the SDK for real-time metrics. These metrics are updated every second.

Heart rate

You can query the real-time heart rate based on either the last 10 or 4 seconds of the measurement. The provided value is the average heart rate over the specified time interval and is expressed in beats per minute (BPM), rounded to the nearest integer.

var hr = await ShenAiSdk.getHeartRate10s();
var hr = await ShenAiSdk.getHeartRate4s();

import { getHeartRate10s, getHeartRate4s } from 'react-native-shenai-sdk';
 
const hr10s = await getHeartRate10s();
const hr4s = await getHeartRate4s();

You can also use provided React Hooks to get realtime heart rate values:

import { useRealtimeHeartRate, useRealtimeHeartRate4s } from 'react-native-shenai-sdk';
 
const hr10s = useRealtimeHeartRate();
const hr4s = useRealtimeHeartRate4s();

let hr = ShenaiSDK.getHeartRate10s()
let hr = ShenaiSDK.getHeartRate4s()

int hr = ShenAiSdk.getHeartRate10s();
int hr = ShenAiSdk.getHeartRate4s();

const hr = shenaisdk.getHeartRate10s();
const hr = ShenAiSdk.getHeartRate4s();

The 10 seconds value will be more stable (like a value displayed on a typical smartwatch), while the 4 seconds value will more accurately depict moment-to-moment fluctuations of the heart rate.

HRV and Stress Index

You can query the SDK for real-time Heart Rate Variability and Stress Index values. You can choose the period over which the metrics are calculated. Note that shorter time periods may lead to unstable values, but may be useful in biofeedback scenarios.

See the Measurement Results section for details on the returned structure shape. Note that Breathing Rate and Blood Pressure will be null in the result of getRealtimeMetrics.

var metrics = await ShenaiSDK.getRealtimeMetrics(30.0);

import { getRealtimeMetrics, MeasurementResults } from 'react-native-shenai-sdk';
 
const metrics: MeasurementResults = await getRealtimeMetrics(30.0);

let metrics = ShenaiSDK.getRealtimeMetrics(30.0)

MeasurementResults metrics = shenaiSDKHandler.getRealtimeMetrics(30.0);

const metrics = await shenaiSDK.getRealtimeMetrics(30.0);

Intervals

You can also query the SDK for real-time heartbeat intervals. Optionally, you can specify the period to limit the heartbeats. Each returned heartbeat interval includes the start and end locations (in seconds) and the duration between heartbeats (in milliseconds, rounded to the nearest integer).

var heartbeats = await ShenaiSDK.getRealtimeHeartbeats(30.0);

import { getRealtimeHeartbeats, Heartbeat } from 'react-native-shenai-sdk';
 
const heartbeats: Heartbeat[] = await getRealtimeHeartbeats(30.0);

let heartbeats = ShenaiSDK.getRealtimeHeartbeats(30.0)

Heartbeat[] heartbeats = shenaiSDKHandler.getRealtimeHeartbeats(30.0);

const heartbeats = await shenaiSDK.getRealtimeHeartbeats(30.0);

Signal quality

You can query the SDK for real-time signal quality - the value can be used to provide additional feedback to the user. A higher value means a better signal quality.

var signal_quality = await ShenAiSdk.getCurrentSignalQualityMetric();

import { getCurrentSignalQualityMetric } from 'react-native-shenai-sdk';
 
const signal_quality = await getCurrentSignalQualityMetric();

let signal_quality = ShenaiSDK.getCurrentSignalQualityMetric()

float signal_quality = ShenAiSdk.getCurrentSignalQualityMetric();

const signal_quality = shenaisdk.getCurrentSignalQualityMetric();

Measurement success

When the Shen.AI SDK engine enters the Finished state it means that the measurement has concluded and computed metrics are available.

See Results to see how to access the results.

Preparation Results