Appearance

On this page

Binah Android SDK Developer Portal ​

Welcome to the Binah.ai Developer Portal!

This portal provides information about the API and the steps required for integration with the Binah.ai SDK. The Binah.ai SDK utilizes PPG technology to compute health indicators either by capturing a short video stream from the user’s face or finger, or by analyzing data from external PPG devices.

What's New in This Version - SDK v5.4 ​

1. Shortening Required Measurement Duration ​

The required duration for the following vital signs has been reduced to 35 seconds when using both face and Polar measurement modes. Users are required to strictly follow Binah.ai's best practices for taking a measurement to obtain accurate results.

For additional information regarding these vital signs, refer to the Vital Signs and Health Indicators Information page.

2. Measurement Guidance Enforcement ​

The application can now toggle the SDK behavior between strict measurement guidance with higher statistical precision and non-strict measurement guidance, allowing users to complete the measurement even if Binah.ai's best practices for taking a measurement were not adequately followed.

In version 5.4 the default SDK behavior was modified from strictMeasurementGuidance=true to strictMeasurementGuidance=false.

For further information, see the Measurement Guidance page.

3. Updated Sample Application ​

The sample application now demonstrates some UI guidance practices that help users adhere to best practices, such as displaying a cross and an elliptical mask to center the face in the camera view and prompting users for any image validation issues.

Known Limitations ​

  • Instruct the user to wait for 3 minutes between measurements to prevent device overheating.
  • During a finger measurement, prolonged contact with the torch may lead to discomfort or slight burns on the skin.
  • Breathing rate results may exhibit fluctuations during finger measurement.
  • Android devices with lower Geekbench 6.0 (single-core) benchmark scores might encounter inconsistency when using the SDK.
  • The SDK must have a valid internet connection on the first launch to obtain license information. If an issue occurs, instruct the user to check their network connection and recreate the SDK session.
  • Hemoglobin and Hemoglobin A1c are under research.
  • It was found that the rear camera of some devices like Huawei P30 responds differently to the common camera API calls, and the image looks significantly more ‘greenish’ than normal. This is clearly visible when inspecting the camera preview. As a result, some vital signs like the HRV-derived vital signs (RRI, stress, SDNN, parasympathetic indicators, and LF/HF) might not be available in finger measurements.
  • Polar pairing issues:
    • During the discovery process, some other Polar devices might appear in the device list as Polar Verity Sense. Instruct users to pair only with Polar Verity Sense devices.
    • In some cases, repeated connections to the same device fail. In such cases, instruct the user to open the Android Bluetooth settings, find the device, open its settings and choose to 'unpair' it. If the problem persists, the user should verify the official Polar Flow app successfully pairs with this device and follow the instructions on https://support.polar.com/en/support/pairing_polar_device_with_flow_app_fails_now_what.

Getting the SDK and a License Key ​

In order to build and run the sample application, you must have the SDK binary and a valid license key. To obtain the SDK binary and the license key, please contact us through our website at https://www.binah.ai/contact/.

Sample Application ​

Binah.ai has prepared a sample application that demonstrates the integration with the SDK. The purpose of this app is to facilitate the development process of a new application. It is highly recommended as a starting point for developers to familiarize themselves with the API. For more information, please refer to the Sample App page.

Getting Support ​

The Binah.ai professional support team is available to assist you throughout the integration process and can be contacted via the support center at https://support.binah.ai.

For more information about Binah.ai's technology and solution, please visit https://www.binah.ai.