Appearance

On this page

Measurement Modes ​

The SDK supports three measurements modes - face measurements, finger measurements and Polar measurements.

Face Measurement ​

A face measurement is performed by facing the front (selfie) camera.

TypeScript
import { 
    SessionBuilder
} from 'binah-react-native-sdk';

try { 
    const session = await SessionBuilder.faceSession({licenseKey: "<ENTER_YOUR_LICENSE_KEY>"});
} catch (e) {
    const exception = (e as HealthMonitorException)
    console.log(`Error: ${exception?.code}`);
}

Finger Measurement ​

Deprecation Warning

Finger measurements are deprecated and will be removed in future versions of Binah.ai's SDK.

A finger measurement is performed by covering the rear camera of a device with a finger.

TypeScript
import { 
    SessionBuilder
} from 'binah-react-native-sdk';

try { 
    const session = await SessionBuilder.fingerSession({licenseKey: "<ENTER_YOUR_LICENSE_KEY>"});
} catch (e) {
    const exception = (e as HealthMonitorException)
    console.log(`Error: ${exception?.code}`);
}

Polar Measurement ​

A Polar measurement is conducted by connecting to the Polar Verity Sense sensor and wearing it on the forearm, following the instructions provided in the Polar Verity Sense User Manual.

TypeScript
import { 
    SessionBuilder
} from 'binah-react-native-sdk';

try { 
    const session = await SessionBuilder.polarSession(
        {licenseKey: "<ENTER_YOUR_LICENSE_KEY>"},
        {deviceId: "<ENTER_POLAR_DEVICE_ID>"});
} catch (e) {
    const exception = (e as HealthMonitorException)
    console.log(`Error: ${exception?.code}`);
}

The Polar Device ID can either be retrieved by the PPG Device Scanner or found on the Polar device as shown in the image below: img