PolarDerivedMeasurementApi

public protocol PolarDerivedMeasurementApi

Derived measurement API.

Derived measurements compute statistical summaries (e.g. min, max, std) over a configurable time window of raw sensor data and store one result per window.


                    
                    
                    requestDerivedMeasurementGroupIds(_:sourceType:)

Asynchronous

Query which Derived Measurement Settings Group IDs are supported for the given source type.

Call this before requestDerivedMeasurementSettingsGroup to discover which group IDs the device advertises for a source type (e.g. ACC).

Throws

PolarErrors for possible errors invoked

Declaration

Swift

func requestDerivedMeasurementGroupIds(
    _ identifier: String,
    sourceType: PolarDeviceDataType
) async throws -> Set<Int>

Parameters

`identifier`	Polar device id found printed on the sensor/device or bt address
`sourceType`	the source measurement type to query (typically `.acc`)

Return Value

set of Derived Measurement Settings Group IDs advertised by the device for this source type


                    
                    
                    requestDerivedMeasurementSettingsGroup(_:groupId:)

Asynchronous

Request the full contents of one Derived Measurement Settings Group from the device.

Use this before starting a derived recording to discover which source types, sample rates, time windows, and computation methods are supported by a group.

Typical flow:

Call requestDerivedMeasurementGroupIds for the source type to get available group IDs.
Call this function for each group ID of interest.
Present supportedMethods to the user for selection.
Build PolarDerivedMeasurementSettings from the user’s choices.
Call startDerivedOfflineRecording.

Throws

PolarErrors for possible errors invoked

Declaration

Swift

func requestDerivedMeasurementSettingsGroup(
    _ identifier: String,
    groupId: Int
) async throws -> PolarDerivedMeasurementSettingsGroup

Parameters

`identifier`	Polar device id found printed on the sensor/device or bt address
`groupId`	the Derived Measurement Settings Group ID to query

Return Value

PolarDerivedMeasurementSettingsGroup describing the available options for this group


                    
                    
                    startDerivedOfflineRecording(_:settings:secret:)

Asynchronous

Start a derived offline recording on the device.

The device computes the selected derived methods over each PolarDerivedMeasurementSettings.timeWindowMs time window of source data and stores one derived sample per window. Fetch results with getOfflineRecord.

Throws

PolarErrors for possible errors invoked

Declaration

Swift

func startDerivedOfflineRecording(
    _ identifier: String,
    settings: PolarDerivedMeasurementSettings,
    secret: PolarRecordingSecret?
) async throws

Parameters

`identifier`	Polar device id found printed on the sensor/device or bt address
`settings`	the derived measurement settings including the chosen methods
`secret`	optional encryption secret; if provided, the recording is encrypted on device


                    
                    
                    stopDerivedOfflineRecording(_:)

Asynchronous

Stop the active derived offline recording on the device.

Throws

PolarErrors for possible errors invoked

Declaration

Swift

func stopDerivedOfflineRecording(_ identifier: String) async throws

Parameters


                                identifier

Polar device id found printed on the sensor/device or bt address