Appearance
BiosenseSignal React Native SDK Developer Portal
Welcome to the BiosenseSignal Developer Portal!
This portal provides information about the API and the steps required for integration with the BiosenseSignal SDK. The BiosenseSignal SDK utilizes PPG technology to compute health indicators either by capturing a short video stream from the user’s face or by analyzing data from external PPG devices.
What's New in This Version - SDK v5.9
1. New Health Indicators
This version includes the new health indicators listed below.
1.1 High Blood Pressure Risk
The High Blood Pressure Risk result indicates whether blood pressure exceeds preset systolic/diastolic values.
The possible results are Low, Medium, or High. Higher results indicate that blood pressure levels are above the preset systolic/diastolic thresholds.
Blood Pressure is the force exerted by blood against artery walls. High blood pressure means this force is consistently higher than the predefined values. Note: This health indicator replaces the legacy “Hypertension Risk” indicator. This version does not require user information to calculate results.
1.2 High HbA1c Risk
The High HbA1c Risk result indicates whether your Hemoglobin A1c level exceeds a preset threshold. The possible results are Low, Medium, or High. Higher results indicate that Hemoglobin A1c levels are above the preset thresholds. HbA1c (glycated hemoglobin) reflects average blood sugar levels over the past 2-3 months. Higher values indicate poor blood sugar control.
Note: This health indicator replaces the legacy "Diabetes Risk" health indicator.
1.3 High Fasting Glucose Risk
The High Fasting Glucose Risk result indicates whether your glucose level exceeds a preset threshold after 8-12 hours of fasting.
The possible results are Low or High. A high result indicates that your fasting glucose level is above the preset threshold.
Glucose is the body’s primary source of energy. High blood glucose levels indicate poor sugar control, potentially signaling pre-diabetes or diabetes mellitus.
1.4 High Total Cholesterol Risk
The High Total Cholesterol Risk result indicates whether your cholesterol level exceeds a preset threshold.
The possible results are Low, Medium, or High. A higher result indicates that your total cholesterol level is above the preset thresholds.
Cholesterol is a lipid (fat-like substance) in the blood. High cholesterol levels can lead to atherosclerosis, a condition where arteries become narrowed and hardened, increasing the risk of cardiovascular diseases.
1.5 Low Hemoglobin Risk
The Low Hemoglobin Risk result indicates whether your hemoglobin level is below a preset threshold.
The possible results are Low or High. A high result indicates that your hemoglobin level is below the preset threshold.
Hemoglobin is a protein in red blood cells responsible for carrying oxygen throughout the body. Low hemoglobin levels indicate lower oxygen-carrying capacity, which may lead to fatigue and other health concerns.
1.6 ASCVD Risk
ASCVD (Atherosclerotic Cardiovascular Disease) risk estimates the risk of having a cardiovascular event within the next 10 years. The ASCVD score is calculated using the SDK's vital signs data combined with user demographic information, including: Age, Sex, BMI, Smoker (Yes/No). This score strongly correlates with the Framingham ASCVD score for predicting 10-year risk. The ASCVD risk score will fall within one of the following categories:
- Below 1%
- Between 1%-30%
- Above 30%
1.7 Heart Age
The Framingham Heart Age estimates your cardiovascular health based on common heart disease risk factors and compares it to your biological age. A heart age closer to, or younger than, your actual age is ideal. A significantly older heart age suggests you may need to make lifestyle changes to improve your heart health.
1.8 Normalized Stress Index
Stress is the body’s reaction to a challenge or demand.
The Normalized Stress Index is calculated based on Baevsky's Stress Index and scaled to a range of 0 to 100. A high value indicates high stress.
The Normalized Stress Index is calculated using Heart Rate Variability (HRV) measurements and derived from physiological conditions. HRV analysis is a globally recognized method for evaluating the body’s functional state, particularly the autonomic nervous system.
2. Reducing The Required Duration of Most Health Indicators to 35 Seconds
The required measurement duration for all indicators, excluding the below list has been updated to 35 seconds. Only the below Advanced Heart Rate Variability indicators still require a minimal duration of 50 seconds:
Sympathetic and Parasympathetic (SNS and PNS, respectfully) Zone and Index
SD1
SD2
LF/HF
RRi
3. Model Updates
The underlying models of the face measurement health indicators listed below have been updated:
3.1 Blood Pressure
The Blood Pressure model was updated in this version.
Note: This version does not require user information for blood pressure measurements.
3.2 HbA1c
The HbA1c model was updated in this version.
3.3 Hemoglobin
The Hemoglobin model was updated in this version.
4. Behavior Changes
- The
Session.terminate()is now an asynchronous method. Make sure you rely on the Session status rather than waiting for this method to complete.
5. Deprecated APIs
- Removed Hypertension Risk health indicator.
- Removed Diabetes Risk health indicator.
6. Apps are now required to add the useLegacyPackaging flag to build.gradle file in the android folder, under the android section as the following example:
android {
packagingOptions {
jniLibs {
useLegacyPackaging = true
}
}
}Known Limitations
- Instruct the user to wait for 3 minutes between face measurements to prevent device overheating.
- Instruct the user to wait for 1 minute between external PPG device measurements to prevent device overheating.
- Android devices with lower Geekbench 6.0 (single-core) benchmark scores might encounter inconsistency when using the SDK.
- The SDK requires a valid internet connection during its first launch to obtain license information. If an issue occurs, instruct the user to check their network connection and restart the SDK session.
- Polar pairing tips:
- During the discovery process, other Polar devices may appear in the device list as Polar Verity Sense. Instruct users to pair only with Polar Verity Sense devices.
- If repeated connections to the same device fail, instruct the user to open the operating system's Bluetooth settings, find the device, open its settings and disconnect the device. If the problem persists, the user should verify the official Polar Flow app successfully pairs with this device and follow the instructions at https://support.polar.com/en/support/pairing_polar_device_with_flow_app_fails_now_what.
Getting the SDK and a License Key
A valid license key is required to activate the SDK and take measurements. Please contact the support team to get a valid license key.
Sample Application
We have 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 serves as a useful starting point for developers, helping to streamline the development process and familiarize them with the API. For more information, please refer to the Sample App page.
Getting Support
Our professional support team is available to assist you throughout the integration process.