⚙️Properties

When you want to override the default settings, you can adjust some of the module's default parameters.

Measurement properties

Property	Default	Description
sampleTime	60	The duration of the measurement in seconds. Default is set to 1 minute. ` Note that the sampleTime must be at least 35 seconds to perform a correct analysis.
flashEnabled	true	When enabled and supported by the device the SDK will turn on the camera flashlight while measuring. Note that an (external) light source is necessary to perform a good measurement.
gravEnabled	false	When enabled and supported by the device, gravitational data will be included in the measurement.
gyroEnabled	false	When enabled and supported by the device, gyroscope data will be included in the measurement.
accEnabled	false	When enabled and supported by the device, accelerometer data will be included in the measurement.
rotationEnabled	false	When enabled and supported by the device, rotational data will be included in the measurement.
movementDetectionEnabled	true	When enabled the onMovementDetected() event will be thrown when movement is detected.
fingerDetectionExpiryTime	-1	The time until the finger detection will trigger the onFingerDetectionTimeExpired() event. By default this value is -1, which indicates that it will keep waiting until a finger is detected.
pulseDetectionExpiryTime	10	The time until the pulse detection will trigger the onPulseDetectionTimeExpired() event.
waitForStartRecordingSignal	false	By default the measurement will start automatically after calibration is ready. When this flag is enabled, the measurement will wait until the startRecording() command has been given.

Take a look at the following platform-specific code snippets to see how to change the default measurement settings for each platform. It's only necessary to provide values for non-default properties. These values should only be changed in exceptional cases.

Flutter

FibriCheckView(
    fibriCheckViewProperties: FibriCheckViewProperties(
        sampleTime: 60,
        flashEnabled: true,
        gravEnabled: false,
        gyroEnabled: false,
        accEnabled: false,
        rotationEnabled: false,
        movementDetectionEnabled: true,
        fingerDetectionExpiryTime: -1, 
        waitForStartRecordingSignal: false,
        ...,
    ),
    ...
)

React Native

<RNFibriCheckView
    ...
    sampleTime={60}
    flashEnabled={true}
    gravEnabled={false}
    gyroEnabled={false}
    accEnabled={false}
    rotationEnabled={false}
    movementDetectionEnabled={true}
    fingerDetectionExpiryTime={-1}
    pulseDetectionExpiryTime={10}
    waitForStartRecordingSignal={false}
    ...
/>

iOS

import FibriCheckCameraSDK


let fc = FibriChecker()

fc.sampleTime = 60
fc.flashEnabled = true
fc.gravEnabled = false
fc.gyroEnabled = false
fc.accEnabled = false
fc.rotationEnabled = false
fc.movementDetectionEnabled = true
fc.fingerDetectionExpiryTime = -1
fc.pulseDetectionExpiryTime = 10
fc.waitForStartRecordingSignal = false

Android

fc = new FibriChecker.FibriBuilder(ctx, viewGroup).build();

fc.sampleTime = 60
fc.flashEnabled = true
fc.gravEnabled = false
fc.gyroEnabled = false
fc.accEnabled = false
fc.rotationEnabled = false
fc.movementDetectionEnabled = true
fc.fingerDetectionExpiryTime = -1
fc.pulseDetectionExpiryTime = 10
fc.waitForStartRecordingSignal = false

Cordova

const { FibriCheckCordovaSDK: fc } = cordova.plugins;

// The full configuration can be updated at once
await fc.updateConfiguration({
    sampleTime: 60,
    flashEnabled: true,
    gravEnabled: false,
    gyroEnabled: false,
    accEnabled: false,
    rotationEnabled: false,
    movementDetectionEnabled: true,
    fingerDetectionExpiryTime: -1,
    pulseDetectionExpiryTime: 10,
    waitForStartRecordingSignal: false
});

// Or a subset of configuration values can be updated 
await fc.updateConfiguration({
    sampleTime: 60,
    flashEnabled: true
});

Platform-specific properties

Flutter

Graph Settings

graphBackgroundColor

Determines the graphBackground color. By default there is no background color

graphBackgroundColor: "";

drawGraph

When enabled the component draws a graph of the recorded PPG signal.

drawGraph: true;

lineColor

Determines the color of the graph line.

lineColor: "#63b3a6";

lineThickness

Determines the thickness of the graph line.

lineThickness: 8;

drawBackground

When enabled, the component will draw a background for the graph

drawBackground: true;

React Native

Styling

Add custom styling to the component. As a default, { flex: 1, backgroundColor: '#ffffff' } is used.

When customizing this, make sure to always add a backgroundColor!

<RNFibriCheckView
    ...
    style = {{ flex: 1, backgroundColor: '#ffffff' }}
    ...
/>

Graph Settings

graphBackgroundColor

Determines the color of the area under the graph. By default, this color is omitted. The backgroundColor is thus displayed under the graph.

<RNFibriCheckView
    ...
    //graphBackgroundColor={''};
    ...
/>

drawGraph

When enabled the component draws a graph of the recorded PPG signal.

<RNFibriCheckView
    ...
    drawGraph={true};
    ...
/>

lineColor

Determines the color of the graph line.

<RNFibriCheckView
    ...
    lineColor={'#63b3a6'};
    ...
/>

lineThickness

Determines the thickness of the graph line.

<RNFibriCheckView
    ...
    lineThickness={8}
    ...
/>

drawBackground

When enabled, the component will draw a background for the graph

<RNFibriCheckView
    ...
    drawBackground={true}
    ...
/>