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 features PolarBleSdkFeature.feature_polar_sdk_mode

Note, SDK mode supported by VeritySense starting from firmware 1.1.5

  • Enables SDK mode.

    Declaration

    Swift

    func enableSDKMode(_ identifier: String) -> Completable

    Parameters

    identifier

    Polar device id or device address

    Return Value

    Completable stream

    • success: if SDK mode is enabled or device is already in SDK mode
    • onError: if SDK mode enable failed

  • Disables SDK mode.

    Declaration

    Swift

    func disableSDKMode(_ identifier: String) -> Completable

    Parameters

    identifier

    Polar device id or device address

    Return Value

    Completable stream

    • success: if SDK mode is disabled or SDK mode was already disabled
    • onError: if SDK mode disable failed

  • Check if SDK mode currently enabled.

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

    Declaration

    Swift

    func isSDKModeEnabled(_ identifier: String) -> Single<Bool>

    Parameters

    identifier

    Polar device id or device address

    Return Value

    Single stream

    • success: emits true, if the SDK mode is currently enabled
    • onError: see PolarErrors for possible errors invoked