TeslasuitDocumentation
APIs

Biometry

Interfaces#

IBiometry#

TsSDK::IBiometry

Provides functions to access PPG functionality.

Properties

Ppg — IPpg (read-only)

Provides PPG sensor control functionality, access to raw and processed PPG data and events.


IPpg#

TsSDK::IPpg

Provides PPG sensor control functionality, access to raw and processed PPG data and events.

Properties

RawData — IRawPpgData (read-only)

Returns raw PPG data containing raw PPG sensor values, such as infrared | red | green | blue sensor data.

ProcessedData — IProcessedPpgData (read-only)

Processed PPG data containing high-level values such as oxygen percent and heart rate.

IsRunning — bool (read-only)

Gets state of PPG data streaming and processing.

Methods

Start#

void Start();

Starts PPG data streaming and processing.


Stop#

void Stop();

Stops PPG data processing and streaming.



IProcessedPpgData#

TsSDK::IProcessedPpgData

Processed PPG data from all sensors containing high-level values such as oxygen percent and heart rate.

Properties

NodesData — IEnumerable< ProcessedPpgNodeData > (read-only)

List of processed PPG data from sensors that attached to different nodes.


IRawPpgData#

TsSDK::IRawPpgData

Raw PPG data from all sensors containing raw PPG sensor values, such as infrared | red | green | blue sensor data.

Properties

NodesData — IEnumerable< RawPpgNodeData > (read-only)

List of raw PPG data from sensors that attached to different nodes.


Data structures#

ProcessedPpgNodeData#

Processed PPG data from sensor.

Fields

nodeIndex int

Index of the node that PPG sensor attached to.

heartRate int

Heart rate calculated in BPM.

isHeartrateValid bool

Is calculated heart rate valid.

timestamp ulong

Time point that set when the last raw PPG data sample was processed.


RawPpgNodeData#

Raw PPG data from sensor.

Fields

nodeIndex int

Index of the node that PPG sensor attached to.

infrared_data long[]

Infrared sensor values sample.

red_data long[]

Red sensor values sample.

blue_data long[]

Blue sensor values sample.

green_data long[]

Green sensor values sample.

timestamp ulong

Time point that set when the last value from sample was captured.


TsComplex#

Complex integer value representation.

Fields

realValue int

imValue int


TsEmgOptions#

EMG options.


TsHrv#

Processed HRV data struct.

Fields

meanRr float

sdnn float

sdsd float

rmssd float

sd1 float

sd2 float

countedHlf float


Enumerations#

TsPpgSensorType#

PPG sensor type.

Members

Undefined 0 Max30102 1 Max86916 2


TsTemperatureSensorType#

Temperature sensor type.

Members

Undefined 0 Si7051 1 Tmp117 2