Binah.ai SDK Release Notes

V3.0.5 - July 20, 2020 (Released)

Upgrading from 3.0.2 to 3.0.5?

Please refer to the "SDK And API Changes" below section for the purple sentences.

Accuracy And General Changes

  • Fix low SpO2 readings in Android By Finger.
  • Fix "Error creating session" on Android.
  • Fix "faceDetectionAlwaysOn" flag on iOS.
  • Better handling heart rate measurements in bad conditions.
  • Better finger detection on Android devices.
  • Fixed low summary results for SpO2 and respiration rate.
  • Fixed low summary results for SpO2 and respiration rate.
  • Partial report/Report - The recommended times refers to measurement without any signal-quality issues

New Features

  • Signal quality checks during rPPG and PPG measurements:
    In order to make sure Binah’s SDK provides the best available vital sign measurements, there are signal quality validation checks during the measurement.
    The validation addresses cases in which the subject fails to follow best practices, and helps to avoid inaccurate results.
    Please click here for more info (Customers only)

Supported Devices Changes

  • No changes.

Known Issues And Limitations

  • iOS and Android - HR could be doubled on the last report
  • iOS and Android - RR can show invalid results in the last report
  • iOS and Android - Stress level is always low / SDNN is always high
  • Wait 2 minutes between tests to avoid device overheating.
  • Android - PPG mode (Finger), the torch may cause low-temperature burns when in prolonged contact with the skin
  • The SDK supports portrait mode only.

SDK And API Changes

  • iOS - Change Error 303 to be Error 204 -
    for an upgrade just change the impact of the error 303 to be 204.
  • iOS - Error 303 is now the Unsupported orientation
    for an upgrade, implement it when moving the device to a landscape mode
  • iOS - Error 301 and 302 were changed by name
    For an upgrade, change "AttachFinger" to be "FingerUndetected", also change "NoFace" to "FaceUndetected"

V3.0.2 - June 29, 2020 (Released)

Upgrading from 3.0.1 to 3.0.2?

Please refer to the "SDK And API Changes" below section for the pink sentences.

Accuracy And General Changes

  • Improved accuracy for SpO2 and respiration in challenging conditions.
  • SDNN unit of measurements - SDNN value returns in ms (milliseconds) instead of seconds.
  • Partial report - Fine-tune response time.

New Features

  • Full report - no need to manually calculate all vital signs values, just wait for the final report.
  • Partial report - You can now stop the test and you will get back all available vital signs.

Supported Devices Changes

  • No changes.

Known Issues And Limitations

  • Android - PPG on Pixel4 and Pro20 lite are not supported (There might be more devices that will not detect the finger skin color).
  • Wait 2 minutes between tests to avoid device overheating.
  • Android - PPG mode (Finger), the torch may cause low temperature burns when in prolonged contact with the skin.
  • The SDK supports portrait mode only.

SDK And API Changes

  • Vital signs default values are null and not -1. (for upgrade purposes change your report and UI)
  • iOS framework folder name changed to BinahAI.framework - for upgrade purposes you have to remove it from build phases and then attaching again.
  • SDNN is now set to appear in ms - for an upgrade, please do not multiply by 1000.
  • iOS - End session can take up to 2 seconds. You can use the synchronic way and application might freeze for 2 seconds, you can use the asynchronous way but wait for 2 seconds for next session.
  • Android - SDK will block building below API level 27. (Application build.gradle should be above API level 27)
  • Android - SDK blocks none arm64-v8a devices (DO not build for any arm64-v8a devices)
  • Mental Stress and SDNN parameters are available only on summary report and not during the measurement (Upgrade - please do not try to show it during the test)

V3.0 - June 10, 2020

Accuracy

The updated table can be found here: Updated accuracy table

SDKv3 provides a much higher level of accuracy compared to SDKv2. This includes handling in:
  • challenging light conditions
  • in the event of uncontrolled head movements.
  • The levels of accuracy appear in the table below:
Vital sign Motion/No motion The first result after x seconds From value To value Error level
Heart Rate No motion 8 60 120 ±2 BPM
8 40 60 ±3 BPM
8 120 240 ±3%
SpO2% No motion 8 85 100 ±2%
Respiration No motion 30 8 35 ±3 RPM
HRV No motion 53 n/a n/a n/a

Best Practices For Using The Application

By Face - rPPG In order to get accurate vital-sign readings, follow the below instructions:
  • Device:
    • The mobile device should be in a fixed position during the entire test.
    • The device should be placed within a hand’s reach from the subject (40-50cm away).
    • The device battery level should be not below 50%.
    • Do not use the SDK when the phone is in power-save mode.
  • Subject:
    • Each measurement set is for a single person.
    • The subject must be sitting or standing still during the measurement.
    • The subject should have a fully exposed face.
  • Environmental conditions:
    • The surroundings must be lit.
    • No light source behind the subject face.
    • No direct sunlight.
    • No light changes during the test.
    • No flickering lights reflection on the face.
  • Measurement:
    • Duration – The full test period is 2.5 minutes.
    • Vital signs appearance - each vital sign appears when there is sufficient data. However, there may be cases in which a summary value is not available for some vital signs, see the Partial Summary Report section below.
By Finger - PPG When using the By Finger (PPG) mode, the following recommendations apply:
  • Device:
    • The mobile device should be in a fixed position during the entire testing period.
    • The device should be held by hand.
    • The device’s battery level should not drop below 50%.
    • Do not use the SDK when the phone is in power-save mode.
  • Subject:
    • The subject must be at rest during the measurement.
    • The hand should rest comfortably at heart level.
    • Use the index finger to fully cover both the rear flashlight and the relevant back camera.
    • When placing the finger on the camera, apply moderate pressure.
    • Avoid movement of the finger during the test.
  • Environmental:
    • The surroundings must be lit.
  • Measurement:
    • Duration - The recommended duration for the finger test is 1.5 minutes (90 seconds).

New Features

  • Measure your vital signs - By finger (PPG):

  • A new non-invasive unique method is supported for measuring vital signs by placing your finger on the smartphone’s back camera. It supports the same vital signs as the rPPG method.
    NOTES:
    In order to use the By Finger option, the mobile phone must have:
    • Rear camera.
    • Torch on the backside of the mobile device.
      When should someone choose to use the By Finger option?
      • When environmental conditions are not ideal for achieving high-accuracy measurements such as:
        • Challenging lighting conditions, such as darkness or very bright light.
        • Increased motion conditions, such as walking, public transportation or driving in rough terrain.
      Both Mental Stress and SDNN parameters are available with the summary report and not during the measurement
  • Partial summary report:

    • In order to calculate valid, accurate results for a vital sign, a certain amount of data must be collected.
      The amount of required data is different for each vital sign.
      With SDKv2, the report was available for all vital signs starting after ~1 minute.
      With SDKv3 there is an option to receive a partial summary report within a shorter period of time, as listed in the table below:
Vital sign Minimal time for report (Sec) Recommended time for report (Sec)
HR 20 20
HR, SpO2 30 35
HR, SpO2, respiration 40 50
HR, SpO2, respiration, SDNN, Stress 50 rPPG - 120
PPG - 90
    NOTES:
    • The times listed in the table refer both to By Finger (PPG) and BY Face (rPPG).
    • For each SDK session execution, there is a single summary request.
    • The above numbers refer to a measurement that is taken according to the best practices listed above
  • SDK Licensing

    With SDKv3, Binah added an improved licensing mechanism which also supports remote changes for the SDK license without the need to integrate a new license with your application in case a license update arises.
    As part of this change, it is required that each device will have an internet connection during its first time in use.
    The next time an internet connection is requested depends on the customer-specific needs (Sync).
    An end-user will be able to use the SDK without an internet connection according to the above customer-specific settings (Sync).
    Default Sync is configured to 4 days.

Supported Vital Signs

  • Heart Rate
  • Oxygen Saturation
  • Respiration Rate
  • Stress Level
  • HRV - SDNN

Supported devices

  • iOS:
    iOS devices with version 13 and above.
    iPhone 8 and all devices released afterward. (iPhone SE 1st gen. not supported)
    PPG (By Finger) specifically requires torch existence next to the rear camera
  • Android:
    Android API version 27 and above.
    rPPG requires selfie camera support 30fps.
    CPU instruction set - ARM64-V8a.
    PPG (By Finger) specifically requires torch existence next to the rear camera
Bug Fixes And Improvements
  • Performance improvements
  • Bug fixes

Known Issues and Limitations

  • Wait 4 minutes between tests to avoid device overheating
  • In By-Finger Android PPG mode, the torch may cause low-temperature burns when in prolonged contact with the skin.
  • The SDK supports portrait mode only
  • Android - on some devices, finger is not detected (Pixel 4, Redmi note 7, Xiaomi A1)
Was this article helpful?
0 out of 0 found this helpful

Comments

1 comment
  • How can you know when I have a report ready?

    When you have SDNN, respiration and Stress values you can assume (but not for sure) that you have a report ready for you.

    1

Please sign in to leave a comment.