PolarSdkModeApi

public protocol PolarSdkModeApi

Polar SDK mode API

In SDK mode the wider range of capabilities is available for the online streaming or for the offline recording than in normal operation mode. The available capabilities can be asked from device using PolarOnlineStreamingApi.requestFullStreamSettings or PolarOfflineRecordingApi.requestFullOfflineRecordingSettings

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_sdk_mode

Note, SDK mode supported by VeritySense starting from firmware 1.1.5

  • enableSDKMode(_:) Asynchronous

    Enables SDK mode.

    Requires

    Requires SDK feature(s): PolarBleSdkFeature.feature_polar_sdk_mode

    Declaration

    Swift

    func enableSDKMode(_ identifier: String) async throws

    Parameters

    identifier

    Polar device id or device address

    Return Value

    Publisher stream

  • disableSDKMode(_:) Asynchronous

    Disables SDK mode.

    Requires

    Requires SDK feature(s): PolarBleSdkFeature.feature_polar_sdk_mode

    Declaration

    Swift

    func disableSDKMode(_ identifier: String) async throws

    Parameters

    identifier

    Polar device id or device address

    Return Value

    Publisher stream

  • isSDKModeEnabled(_:) Asynchronous

    Check if SDK mode currently enabled.

    Note, SDK status check is supported by VeritySense starting from firmware 2.1.0

    Requires

    Requires SDK feature(s): PolarBleSdkFeature.feature_polar_sdk_mode

    Declaration

    Swift

    func isSDKModeEnabled(_ identifier: String) async throws -> Bool

    Parameters

    identifier

    Polar device id or device address

    Return Value

    Publisher emitting true if SDK mode is currently enabled