diff --git a/polar-sdk-android/docs/com/polar/sdk/api/PolarBleApi.html b/polar-sdk-android/docs/com/polar/sdk/api/PolarBleApi.html index b5c48818..dec5f47b 100644 --- a/polar-sdk-android/docs/com/polar/sdk/api/PolarBleApi.html +++ b/polar-sdk-android/docs/com/polar/sdk/api/PolarBleApi.html @@ -879,7 +879,7 @@

getLocalTime

  • startListenForPolarHrBroadcasts

     abstract Flowable<PolarHrBroadcastData> startListenForPolarHrBroadcasts(Set<String> deviceIds)
    -

    Start listening the heart rate from Polar devices when subscribed. This observable listens BLE broadcast and parses heart rate from BLE broadcast. The BLE device is not connected when using this function.

    +

    Start listening the heart rate from Polar devices when subscribed. This observable listens BLE broadcast and parses heart rate from BLE broadcast. The BLE device don't need to be connected when using this function, the heart rate is parsed from the BLE advertisement

    Parameters:
    diff --git a/polar-sdk-ios/docs/Classes.html b/polar-sdk-ios/docs/Classes.html index a47009ee..45ad5b95 100644 --- a/polar-sdk-ios/docs/Classes.html +++ b/polar-sdk-ios/docs/Classes.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -219,7 +219,7 @@

    Classes

    diff --git a/polar-sdk-ios/docs/Classes/PolarBleApiDefaultImpl.html b/polar-sdk-ios/docs/Classes/PolarBleApiDefaultImpl.html index 834f06e6..e79e612b 100644 --- a/polar-sdk-ios/docs/Classes/PolarBleApiDefaultImpl.html +++ b/polar-sdk-ios/docs/Classes/PolarBleApiDefaultImpl.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -237,7 +237,7 @@

    PolarBleApiDefaultImpl

    diff --git a/polar-sdk-ios/docs/Enums.html b/polar-sdk-ios/docs/Enums.html index a2133460..e8a6156a 100644 --- a/polar-sdk-ios/docs/Enums.html +++ b/polar-sdk-ios/docs/Enums.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -258,8 +258,8 @@

    Enumerations

    - - OhrDataType + + PpgDataType
    @@ -267,9 +267,9 @@

    Enumerations

    -

    OHR data source enum

    +

    PPG data source enum

    - See more + See more
    @@ -358,7 +358,7 @@

    Enumerations

    diff --git a/polar-sdk-ios/docs/Enums/Features.html b/polar-sdk-ios/docs/Enums/Features.html index 0f60ddb0..3a043309 100644 --- a/polar-sdk-ios/docs/Enums/Features.html +++ b/polar-sdk-ios/docs/Enums/Features.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -314,7 +314,7 @@

    Features

    diff --git a/polar-sdk-ios/docs/Enums/PolarBleSdkFeature.html b/polar-sdk-ios/docs/Enums/PolarBleSdkFeature.html index de07c28e..577c72ee 100644 --- a/polar-sdk-ios/docs/Enums/PolarBleSdkFeature.html +++ b/polar-sdk-ios/docs/Enums/PolarBleSdkFeature.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -351,7 +351,7 @@

    PolarBleSdkFeature

    diff --git a/polar-sdk-ios/docs/Enums/PolarDeviceDataType.html b/polar-sdk-ios/docs/Enums/PolarDeviceDataType.html index 792c8a61..6e1af40a 100644 --- a/polar-sdk-ios/docs/Enums/PolarDeviceDataType.html +++ b/polar-sdk-ios/docs/Enums/PolarDeviceDataType.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -325,7 +325,7 @@

    PolarDeviceDataType

    diff --git a/polar-sdk-ios/docs/Enums/PolarErrors.html b/polar-sdk-ios/docs/Enums/PolarErrors.html index a419a35a..f31d45c9 100644 --- a/polar-sdk-ios/docs/Enums/PolarErrors.html +++ b/polar-sdk-ios/docs/Enums/PolarErrors.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -446,7 +446,7 @@

    PolarErrors

    diff --git a/polar-sdk-ios/docs/Enums/PolarOfflineRecordingData.html b/polar-sdk-ios/docs/Enums/PolarOfflineRecordingData.html index 9e9a60b3..793f3e70 100644 --- a/polar-sdk-ios/docs/Enums/PolarOfflineRecordingData.html +++ b/polar-sdk-ios/docs/Enums/PolarOfflineRecordingData.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -306,7 +306,7 @@

    PolarOfflineRecordingData

    diff --git a/polar-sdk-ios/docs/Enums/OhrDataType.html b/polar-sdk-ios/docs/Enums/PpgDataType.html similarity index 95% rename from polar-sdk-ios/docs/Enums/OhrDataType.html rename to polar-sdk-ios/docs/Enums/PpgDataType.html index 87143454..e76898dd 100644 --- a/polar-sdk-ios/docs/Enums/OhrDataType.html +++ b/polar-sdk-ios/docs/Enums/PpgDataType.html @@ -1,7 +1,7 @@ - OhrDataType Enumeration Reference + PpgDataType Enumeration Reference @@ -13,8 +13,8 @@ - - + +

    Docs (0% documented)

    @@ -29,7 +29,7 @@
    @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -187,8 +187,8 @@
    -

    OhrDataType

    -

    OHR data source enum

    +

    PpgDataType

    +

    PPG data source enum

    @@ -236,7 +236,7 @@

    OhrDataType

    diff --git a/polar-sdk-ios/docs/Enums/RecordingInterval.html b/polar-sdk-ios/docs/Enums/RecordingInterval.html index e6d0822a..7941cdd6 100644 --- a/polar-sdk-ios/docs/Enums/RecordingInterval.html +++ b/polar-sdk-ios/docs/Enums/RecordingInterval.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -235,7 +235,7 @@

    RecordingInterval

    diff --git a/polar-sdk-ios/docs/Enums/SampleType.html b/polar-sdk-ios/docs/Enums/SampleType.html index ade3be79..f25a4b78 100644 --- a/polar-sdk-ios/docs/Enums/SampleType.html +++ b/polar-sdk-ios/docs/Enums/SampleType.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -237,7 +237,7 @@

    SampleType

    diff --git a/polar-sdk-ios/docs/Extensions.html b/polar-sdk-ios/docs/Extensions.html index 9a501c22..e5a3786c 100644 --- a/polar-sdk-ios/docs/Extensions.html +++ b/polar-sdk-ios/docs/Extensions.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -243,7 +243,7 @@

    Declaration

    diff --git a/polar-sdk-ios/docs/Extensions/PrimitiveSequence.html b/polar-sdk-ios/docs/Extensions/PrimitiveSequence.html index 7a978116..d8612176 100644 --- a/polar-sdk-ios/docs/Extensions/PrimitiveSequence.html +++ b/polar-sdk-ios/docs/Extensions/PrimitiveSequence.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -216,7 +216,7 @@

    PrimitiveSequence

    diff --git a/polar-sdk-ios/docs/Protocols.html b/polar-sdk-ios/docs/Protocols.html index f8abfac0..2bd8cc71 100644 --- a/polar-sdk-ios/docs/Protocols.html +++ b/polar-sdk-ios/docs/Protocols.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -472,7 +472,7 @@

    Protocols

    diff --git a/polar-sdk-ios/docs/Protocols/PolarBleApi.html b/polar-sdk-ios/docs/Protocols/PolarBleApi.html index ae5c2a4c..6638068c 100644 --- a/polar-sdk-ios/docs/Protocols/PolarBleApi.html +++ b/polar-sdk-ios/docs/Protocols/PolarBleApi.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -332,7 +332,10 @@

    PolarBleApi

    -

    Start listening to heart rate broadcasts from one or more Polar devices

    +

    Start listening the heart rate from Polar devices when subscribed. +This observable listens BLE broadcast and parses heart rate from BLE broadcast. The +BLE device don’t need to be connected when using this function, the heart rate is parsed +from the BLE advertisement

    @@ -533,7 +536,7 @@

    PolarBleApi

    diff --git a/polar-sdk-ios/docs/Protocols/PolarBleApiDeviceFeaturesObserver.html b/polar-sdk-ios/docs/Protocols/PolarBleApiDeviceFeaturesObserver.html index cc04d7a1..65a8f5c4 100644 --- a/polar-sdk-ios/docs/Protocols/PolarBleApiDeviceFeaturesObserver.html +++ b/polar-sdk-ios/docs/Protocols/PolarBleApiDeviceFeaturesObserver.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -218,7 +218,7 @@

    PolarBleApiDeviceFeaturesObserver

    diff --git a/polar-sdk-ios/docs/Protocols/PolarBleApiDeviceInfoObserver.html b/polar-sdk-ios/docs/Protocols/PolarBleApiDeviceInfoObserver.html index 7c916948..096c19d4 100644 --- a/polar-sdk-ios/docs/Protocols/PolarBleApiDeviceInfoObserver.html +++ b/polar-sdk-ios/docs/Protocols/PolarBleApiDeviceInfoObserver.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -237,7 +237,7 @@

    PolarBleApiDeviceInfoObserver

    diff --git a/polar-sdk-ios/docs/Protocols/PolarBleApiLogger.html b/polar-sdk-ios/docs/Protocols/PolarBleApiLogger.html index 693b4dbe..88dac98b 100644 --- a/polar-sdk-ios/docs/Protocols/PolarBleApiLogger.html +++ b/polar-sdk-ios/docs/Protocols/PolarBleApiLogger.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -218,7 +218,7 @@

    PolarBleApiLogger

    diff --git a/polar-sdk-ios/docs/Protocols/PolarBleApiObserver.html b/polar-sdk-ios/docs/Protocols/PolarBleApiObserver.html index db0987ea..acd5ef60 100644 --- a/polar-sdk-ios/docs/Protocols/PolarBleApiObserver.html +++ b/polar-sdk-ios/docs/Protocols/PolarBleApiObserver.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -257,7 +257,7 @@

    PolarBleApiObserver

    diff --git a/polar-sdk-ios/docs/Protocols/PolarBleApiPowerStateObserver.html b/polar-sdk-ios/docs/Protocols/PolarBleApiPowerStateObserver.html index 05b17325..cbb0cb3f 100644 --- a/polar-sdk-ios/docs/Protocols/PolarBleApiPowerStateObserver.html +++ b/polar-sdk-ios/docs/Protocols/PolarBleApiPowerStateObserver.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -237,7 +237,7 @@

    PolarBleApiPowerStateObserver

    diff --git a/polar-sdk-ios/docs/Protocols/PolarH10OfflineExerciseApi.html b/polar-sdk-ios/docs/Protocols/PolarH10OfflineExerciseApi.html index 04ac7eb7..3376cede 100644 --- a/polar-sdk-ios/docs/Protocols/PolarH10OfflineExerciseApi.html +++ b/polar-sdk-ios/docs/Protocols/PolarH10OfflineExerciseApi.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -321,7 +321,7 @@

    PolarH10OfflineExerciseApi

    diff --git a/polar-sdk-ios/docs/Protocols/PolarOfflineRecordingApi.html b/polar-sdk-ios/docs/Protocols/PolarOfflineRecordingApi.html index 2f474b5c..1111d64d 100644 --- a/polar-sdk-ios/docs/Protocols/PolarOfflineRecordingApi.html +++ b/polar-sdk-ios/docs/Protocols/PolarOfflineRecordingApi.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -346,8 +346,8 @@

    PolarOfflineRecordingApi

    - - startOfflineRecording(_:feature:settings:) + + startOfflineRecording(_:feature:settings:secret:)
    @@ -385,7 +385,7 @@

    PolarOfflineRecordingApi

    diff --git a/polar-sdk-ios/docs/Protocols/PolarOnlineStreamingApi.html b/polar-sdk-ios/docs/Protocols/PolarOnlineStreamingApi.html index 56b99dee..c4b97669 100644 --- a/polar-sdk-ios/docs/Protocols/PolarOnlineStreamingApi.html +++ b/polar-sdk-ios/docs/Protocols/PolarOnlineStreamingApi.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -402,7 +402,7 @@

    PolarOnlineStreamingApi

    diff --git a/polar-sdk-ios/docs/Protocols/PolarSdkModeApi.html b/polar-sdk-ios/docs/Protocols/PolarSdkModeApi.html index 016cc9dd..ee33e93f 100644 --- a/polar-sdk-ios/docs/Protocols/PolarSdkModeApi.html +++ b/polar-sdk-ios/docs/Protocols/PolarSdkModeApi.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -267,7 +267,7 @@

    PolarSdkModeApi

    diff --git a/polar-sdk-ios/docs/Structs.html b/polar-sdk-ios/docs/Structs.html index 54d04274..25d8ba85 100644 --- a/polar-sdk-ios/docs/Structs.html +++ b/polar-sdk-ios/docs/Structs.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -266,7 +266,7 @@

    Declaration

    diff --git a/polar-sdk-ios/docs/Structs/PolarOfflineRecordingEntry.html b/polar-sdk-ios/docs/Structs/PolarOfflineRecordingEntry.html index a2458a9a..e7c502de 100644 --- a/polar-sdk-ios/docs/Structs/PolarOfflineRecordingEntry.html +++ b/polar-sdk-ios/docs/Structs/PolarOfflineRecordingEntry.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -293,7 +293,7 @@

    PolarOfflineRecordingEntry

    diff --git a/polar-sdk-ios/docs/Structs/PolarRecordingSecret.html b/polar-sdk-ios/docs/Structs/PolarRecordingSecret.html index 8083063e..e8bedc67 100644 --- a/polar-sdk-ios/docs/Structs/PolarRecordingSecret.html +++ b/polar-sdk-ios/docs/Structs/PolarRecordingSecret.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -217,7 +217,7 @@

    PolarRecordingSecret

    diff --git a/polar-sdk-ios/docs/Structs/PolarSensorSetting.html b/polar-sdk-ios/docs/Structs/PolarSensorSetting.html index 7ed0f596..4c13bde0 100644 --- a/polar-sdk-ios/docs/Structs/PolarSensorSetting.html +++ b/polar-sdk-ios/docs/Structs/PolarSensorSetting.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -300,7 +300,7 @@

    PolarSensorSetting

    diff --git a/polar-sdk-ios/docs/Structs/PolarSensorSetting/SettingType.html b/polar-sdk-ios/docs/Structs/PolarSensorSetting/SettingType.html index 34717e65..44e8d025 100644 --- a/polar-sdk-ios/docs/Structs/PolarSensorSetting/SettingType.html +++ b/polar-sdk-ios/docs/Structs/PolarSensorSetting/SettingType.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -313,7 +313,7 @@

    SettingType

    diff --git a/polar-sdk-ios/docs/Typealiases.html b/polar-sdk-ios/docs/Typealiases.html index 199cb885..23c4637d 100644 --- a/polar-sdk-ios/docs/Typealiases.html +++ b/polar-sdk-ios/docs/Typealiases.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -371,8 +371,8 @@

    Type Aliases

    - - PolarOhrData + + PolarPpgData
    @@ -380,9 +380,8 @@

    Type Aliases

    -

    Polar Ohr data

    -
    - Deprecated: Timestamp: Last sample timestamp in nanoseconds. The epoch of timestamp is 1.1.2000
-- type: type of data, which varies based on what is type of optical sensor used in the device
+                        
    Polar PPG data
    
+
    - type: type of data, which varies based on what is type of optical sensor used in the device
 - samples: Photoplethysmography samples
     - timeStamp: moment sample is taken in nanoseconds. The epoch of timestamp is 1.1.2000
     - channelSamples is the PPG (Photoplethysmography) raw value received from the optical sensor. Based on [OhrDataType] the amount of channels varies. Typically ppg(n) channel + n ambient(s).
@@ -492,7 +491,7 @@ 
    Type Aliases
    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Classes.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Classes.html index a47009ee..45ad5b95 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Classes.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Classes.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -219,7 +219,7 @@

    Classes

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Classes/PolarBleApiDefaultImpl.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Classes/PolarBleApiDefaultImpl.html index 834f06e6..e79e612b 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Classes/PolarBleApiDefaultImpl.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Classes/PolarBleApiDefaultImpl.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -237,7 +237,7 @@

    PolarBleApiDefaultImpl

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums.html index a2133460..e8a6156a 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -258,8 +258,8 @@

    Enumerations

    - - OhrDataType + + PpgDataType
    @@ -267,9 +267,9 @@

    Enumerations

    -

    OHR data source enum

    +

    PPG data source enum

    - See more + See more
    @@ -358,7 +358,7 @@

    Enumerations

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/Features.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/Features.html index 0f60ddb0..3a043309 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/Features.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/Features.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -314,7 +314,7 @@

    Features

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/PolarBleSdkFeature.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/PolarBleSdkFeature.html index de07c28e..577c72ee 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/PolarBleSdkFeature.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/PolarBleSdkFeature.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -351,7 +351,7 @@

    PolarBleSdkFeature

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/PolarDeviceDataType.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/PolarDeviceDataType.html index 792c8a61..6e1af40a 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/PolarDeviceDataType.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/PolarDeviceDataType.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -325,7 +325,7 @@

    PolarDeviceDataType

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/PolarErrors.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/PolarErrors.html index a419a35a..f31d45c9 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/PolarErrors.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/PolarErrors.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -446,7 +446,7 @@

    PolarErrors

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/PolarOfflineRecordingData.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/PolarOfflineRecordingData.html index 9e9a60b3..793f3e70 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/PolarOfflineRecordingData.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/PolarOfflineRecordingData.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -306,7 +306,7 @@

    PolarOfflineRecordingData

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/OhrDataType.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/PpgDataType.html similarity index 95% rename from polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/OhrDataType.html rename to polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/PpgDataType.html index 87143454..e76898dd 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/OhrDataType.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/PpgDataType.html @@ -1,7 +1,7 @@ - OhrDataType Enumeration Reference + PpgDataType Enumeration Reference @@ -13,8 +13,8 @@ - - + +

    Docs (0% documented)

    @@ -29,7 +29,7 @@
    @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -187,8 +187,8 @@
    -

    OhrDataType

    -

    OHR data source enum

    +

    PpgDataType

    +

    PPG data source enum

    @@ -236,7 +236,7 @@

    OhrDataType

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/RecordingInterval.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/RecordingInterval.html index e6d0822a..7941cdd6 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/RecordingInterval.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/RecordingInterval.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -235,7 +235,7 @@

    RecordingInterval

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/SampleType.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/SampleType.html index ade3be79..f25a4b78 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/SampleType.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Enums/SampleType.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -237,7 +237,7 @@

    SampleType

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Extensions.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Extensions.html index 9a501c22..e5a3786c 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Extensions.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Extensions.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -243,7 +243,7 @@

    Declaration

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Extensions/PrimitiveSequence.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Extensions/PrimitiveSequence.html index 7a978116..d8612176 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Extensions/PrimitiveSequence.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Extensions/PrimitiveSequence.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -216,7 +216,7 @@

    PrimitiveSequence

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols.html index f8abfac0..2bd8cc71 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -472,7 +472,7 @@

    Protocols

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarBleApi.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarBleApi.html index ae5c2a4c..6638068c 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarBleApi.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarBleApi.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -332,7 +332,10 @@

    PolarBleApi

    -

    Start listening to heart rate broadcasts from one or more Polar devices

    +

    Start listening the heart rate from Polar devices when subscribed. +This observable listens BLE broadcast and parses heart rate from BLE broadcast. The +BLE device don’t need to be connected when using this function, the heart rate is parsed +from the BLE advertisement

    @@ -533,7 +536,7 @@

    PolarBleApi

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarBleApiDeviceFeaturesObserver.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarBleApiDeviceFeaturesObserver.html index cc04d7a1..65a8f5c4 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarBleApiDeviceFeaturesObserver.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarBleApiDeviceFeaturesObserver.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -218,7 +218,7 @@

    PolarBleApiDeviceFeaturesObserver

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarBleApiDeviceInfoObserver.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarBleApiDeviceInfoObserver.html index 7c916948..096c19d4 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarBleApiDeviceInfoObserver.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarBleApiDeviceInfoObserver.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -237,7 +237,7 @@

    PolarBleApiDeviceInfoObserver

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarBleApiLogger.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarBleApiLogger.html index 693b4dbe..88dac98b 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarBleApiLogger.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarBleApiLogger.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -218,7 +218,7 @@

    PolarBleApiLogger

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarBleApiObserver.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarBleApiObserver.html index db0987ea..acd5ef60 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarBleApiObserver.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarBleApiObserver.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -257,7 +257,7 @@

    PolarBleApiObserver

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarBleApiPowerStateObserver.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarBleApiPowerStateObserver.html index 05b17325..cbb0cb3f 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarBleApiPowerStateObserver.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarBleApiPowerStateObserver.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -237,7 +237,7 @@

    PolarBleApiPowerStateObserver

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarH10OfflineExerciseApi.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarH10OfflineExerciseApi.html index 04ac7eb7..3376cede 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarH10OfflineExerciseApi.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarH10OfflineExerciseApi.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -321,7 +321,7 @@

    PolarH10OfflineExerciseApi

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarOfflineRecordingApi.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarOfflineRecordingApi.html index 2f474b5c..1111d64d 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarOfflineRecordingApi.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarOfflineRecordingApi.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -346,8 +346,8 @@

    PolarOfflineRecordingApi

    - - startOfflineRecording(_:feature:settings:) + + startOfflineRecording(_:feature:settings:secret:)
    @@ -385,7 +385,7 @@

    PolarOfflineRecordingApi

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarOnlineStreamingApi.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarOnlineStreamingApi.html index 56b99dee..c4b97669 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarOnlineStreamingApi.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarOnlineStreamingApi.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -402,7 +402,7 @@

    PolarOnlineStreamingApi

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarSdkModeApi.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarSdkModeApi.html index 016cc9dd..ee33e93f 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarSdkModeApi.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Protocols/PolarSdkModeApi.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -267,7 +267,7 @@

    PolarSdkModeApi

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Structs.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Structs.html index 54d04274..25d8ba85 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Structs.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Structs.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -266,7 +266,7 @@

    Declaration

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Structs/PolarOfflineRecordingEntry.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Structs/PolarOfflineRecordingEntry.html index a2458a9a..e7c502de 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Structs/PolarOfflineRecordingEntry.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Structs/PolarOfflineRecordingEntry.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -293,7 +293,7 @@

    PolarOfflineRecordingEntry

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Structs/PolarRecordingSecret.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Structs/PolarRecordingSecret.html index 8083063e..e8bedc67 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Structs/PolarRecordingSecret.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Structs/PolarRecordingSecret.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -217,7 +217,7 @@

    PolarRecordingSecret

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Structs/PolarSensorSetting.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Structs/PolarSensorSetting.html index 7ed0f596..4c13bde0 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Structs/PolarSensorSetting.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Structs/PolarSensorSetting.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -300,7 +300,7 @@

    PolarSensorSetting

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Structs/PolarSensorSetting/SettingType.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Structs/PolarSensorSetting/SettingType.html index 34717e65..44e8d025 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Structs/PolarSensorSetting/SettingType.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Structs/PolarSensorSetting/SettingType.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -313,7 +313,7 @@

    SettingType

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Typealiases.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Typealiases.html index 199cb885..23c4637d 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Typealiases.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/Typealiases.html @@ -49,9 +49,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -64,6 +61,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -172,7 +172,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -371,8 +371,8 @@

    Type Aliases

    - - PolarOhrData + + PolarPpgData
    @@ -380,9 +380,8 @@

    Type Aliases

    -

    Polar Ohr data

    -
    - Deprecated: Timestamp: Last sample timestamp in nanoseconds. The epoch of timestamp is 1.1.2000
-- type: type of data, which varies based on what is type of optical sensor used in the device
+                        
    Polar PPG data
    
+
    - type: type of data, which varies based on what is type of optical sensor used in the device
 - samples: Photoplethysmography samples
     - timeStamp: moment sample is taken in nanoseconds. The epoch of timestamp is 1.1.2000
     - channelSamples is the PPG (Photoplethysmography) raw value received from the optical sensor. Based on [OhrDataType] the amount of channels varies. Typically ppg(n) channel + n ambient(s).
@@ -492,7 +491,7 @@ 
    Type Aliases
    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/index.html b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/index.html index 51b7c45e..4398fb04 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/index.html +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/index.html @@ -48,9 +48,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -63,6 +60,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -171,7 +171,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -206,7 +206,7 @@

    Update dependency

    diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/search.json b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/search.json index 20fa6bef..c2ff323a 100644 --- a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/search.json +++ b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/Documents/search.json @@ -1 +1 @@ -{"Typealiases.html#/PolarDeviceInfo":{"name":"PolarDeviceInfo","abstract":"

    Polar device info

    "},"Typealiases.html#/PolarHrBroadcastData":{"name":"PolarHrBroadcastData","abstract":"

    deviceInfo: see #PolarDeviceInfo ,

    "},"Typealiases.html#/PolarHrData":{"name":"PolarHrData","abstract":"

    Polar hr data

    "},"Typealiases.html#/PolarEcgData":{"name":"PolarEcgData","abstract":"

    Polar Ecg data

    "},"Typealiases.html#/PolarAccData":{"name":"PolarAccData","abstract":"

    Polar acc data

    "},"Typealiases.html#/PolarGyroData":{"name":"PolarGyroData","abstract":"

    Polar gyro data

    "},"Typealiases.html#/PolarMagnetometerData":{"name":"PolarMagnetometerData","abstract":"

    Polar magnetometer data

    "},"Typealiases.html#/PolarOhrData":{"name":"PolarOhrData","abstract":"

    Polar Ohr data

    "},"Typealiases.html#/PolarPpiData":{"name":"PolarPpiData","abstract":"

    Polar ppi data

    "},"Typealiases.html#/PolarExerciseEntry":{"name":"PolarExerciseEntry","abstract":"

    Polar exercise entry

    "},"Typealiases.html#/PolarExerciseData":{"name":"PolarExerciseData","abstract":"

    Polar Exercise Data

    "},"Typealiases.html#/PolarRecordingStatus":{"name":"PolarRecordingStatus","abstract":"

    Polar Recording status

    "},"Structs/PolarSensorSetting/SettingType.html#/sampleRate":{"name":"sampleRate","abstract":"

    sample rate in hz

    ","parent_name":"SettingType"},"Structs/PolarSensorSetting/SettingType.html#/resolution":{"name":"resolution","abstract":"

    resolution in bits

    ","parent_name":"SettingType"},"Structs/PolarSensorSetting/SettingType.html#/range":{"name":"range","abstract":"

    range

    ","parent_name":"SettingType"},"Structs/PolarSensorSetting/SettingType.html#/rangeMilliunit":{"name":"rangeMilliunit","abstract":"

    range with min and max allowed values

    ","parent_name":"SettingType"},"Structs/PolarSensorSetting/SettingType.html#/channels":{"name":"channels","abstract":"

    amount of channels available

    ","parent_name":"SettingType"},"Structs/PolarSensorSetting/SettingType.html#/unknown":{"name":"unknown","abstract":"

    type is unknown

    ","parent_name":"SettingType"},"Structs/PolarSensorSetting/SettingType.html":{"name":"SettingType","abstract":"

    settings type

    ","parent_name":"PolarSensorSetting"},"Structs/PolarSensorSetting.html#/settings":{"name":"settings","abstract":"

    current settings available / set

    ","parent_name":"PolarSensorSetting"},"Structs/PolarSensorSetting.html#/init(_:)":{"name":"init(_:)","abstract":"

    constructor with desired settings

    ","parent_name":"PolarSensorSetting"},"Structs/PolarSensorSetting.html#/maxSettings()":{"name":"maxSettings()","abstract":"

    helper to retrieve max settings available

    ","parent_name":"PolarSensorSetting"},"Structs/PolarSensorSetting.html#/description":{"name":"description","parent_name":"PolarSensorSetting"},"Structs/PolarRecordingSecret.html#/init(key:)":{"name":"init(key:)","parent_name":"PolarRecordingSecret"},"Structs/PolarOfflineRecordingEntry.html#/path":{"name":"path","abstract":"

    Recording entry path in device.

    ","parent_name":"PolarOfflineRecordingEntry"},"Structs/PolarOfflineRecordingEntry.html#/size":{"name":"size","abstract":"

    Recording size in bytes.

    ","parent_name":"PolarOfflineRecordingEntry"},"Structs/PolarOfflineRecordingEntry.html#/date":{"name":"date","abstract":"

    The date and time of the recording entry i.e. the moment recording is started

    ","parent_name":"PolarOfflineRecordingEntry"},"Structs/PolarOfflineRecordingEntry.html#/type":{"name":"type","abstract":"

    data type of the recording

    ","parent_name":"PolarOfflineRecordingEntry"},"Structs/PolarOfflineRecordingEntry.html#/init(path:size:date:type:)":{"name":"init(path:size:date:type:)","parent_name":"PolarOfflineRecordingEntry"},"Structs/PolarOfflineRecordingEntry.html":{"name":"PolarOfflineRecordingEntry","abstract":"

    Polar offline recording entry container.

    "},"Structs/PolarRecordingSecret.html":{"name":"PolarRecordingSecret","abstract":"

    Polar recording secret is used to encrypt the recording.

    "},"Structs/PolarSensorSetting.html":{"name":"PolarSensorSetting","abstract":"

    polar sensor settings class

    "},"Protocols/PolarSdkModeApi.html#/enableSDKMode(_:)":{"name":"enableSDKMode(_:)","abstract":"

    Enables SDK mode.

    ","parent_name":"PolarSdkModeApi"},"Protocols/PolarSdkModeApi.html#/disableSDKMode(_:)":{"name":"disableSDKMode(_:)","abstract":"

    Disables SDK mode.

    ","parent_name":"PolarSdkModeApi"},"Protocols/PolarSdkModeApi.html#/isSDKModeEnabled(_:)":{"name":"isSDKModeEnabled(_:)","abstract":"

    Check if SDK mode currently enabled.

    ","parent_name":"PolarSdkModeApi"},"Protocols/PolarOnlineStreamingApi.html#/getAvailableOnlineStreamDataTypes(_:)":{"name":"getAvailableOnlineStreamDataTypes(_:)","abstract":"

    Get the data types available in this device for online streaming

    ","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/requestStreamSettings(_:feature:)":{"name":"requestStreamSettings(_:feature:)","abstract":"

    Request the stream settings available in current operation mode. This request shall be used before the stream is started","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/requestFullStreamSettings(_:feature:)":{"name":"requestFullStreamSettings(_:feature:)","abstract":"

    Request full steam settings capabilities. The request returns the all capabilities of the requested streaming feature not limited by the current operation mode.","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startHrStreaming(_:)":{"name":"startHrStreaming(_:)","abstract":"

    Start heart rate stream. Heart rate stream is stopped if the connection is closed,","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startEcgStreaming(_:settings:)":{"name":"startEcgStreaming(_:settings:)","abstract":"

    Start the ECG (Electrocardiography) stream. ECG stream is stopped if the connection is closed, error occurs or stream is disposed.

    ","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startAccStreaming(_:settings:)":{"name":"startAccStreaming(_:settings:)","abstract":"

    Start ACC (Accelerometer) stream. ACC stream is stopped if the connection is closed, error occurs or stream is disposed.

    ","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startGyroStreaming(_:settings:)":{"name":"startGyroStreaming(_:settings:)","abstract":"

    Start Gyro stream. Gyro stream is stopped if the connection is closed, error occurs during start or stream is disposed.

    ","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startMagnetometerStreaming(_:settings:)":{"name":"startMagnetometerStreaming(_:settings:)","abstract":"

    Start magnetometer stream. Magnetometer stream is stopped if the connection is closed, error occurs or stream is disposed.

    ","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startPpgStreaming(_:settings:)":{"name":"startPpgStreaming(_:settings:)","abstract":"

    Start optical sensor PPG (Photoplethysmography) stream. PPG stream is stopped if the connection is closed, error occurs or stream is disposed.

    ","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startOhrPPIStreaming(_:)":{"name":"startOhrPPIStreaming(_:)","abstract":"

    Start OHR (Optical heart rate) PPI (Pulse to Pulse interval) stream.","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOfflineRecordingApi.html#/getAvailableOfflineRecordingDataTypes(_:)":{"name":"getAvailableOfflineRecordingDataTypes(_:)","abstract":"

    Get the data types available in this device for offline recording

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/requestOfflineRecordingSettings(_:feature:)":{"name":"requestOfflineRecordingSettings(_:feature:)","abstract":"

    Request the offline recording settings available in current operation mode. This request shall be used before the offline recording is started","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/requestFullOfflineRecordingSettings(_:feature:)":{"name":"requestFullOfflineRecordingSettings(_:feature:)","abstract":"

    Request all the settings available in the device. The request returns the all capabilities of the requested streaming feature not limited by the current operation mode.

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/getOfflineRecordingStatus(_:)":{"name":"getOfflineRecordingStatus(_:)","abstract":"

    Get status of offline recordings.

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/listOfflineRecordings(_:)":{"name":"listOfflineRecordings(_:)","abstract":"

    List offline recordings stored in the device.

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/getOfflineRecord(_:entry:secret:)":{"name":"getOfflineRecord(_:entry:secret:)","abstract":"

    Fetch recording from the device.

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/removeOfflineRecord(_:entry:)":{"name":"removeOfflineRecord(_:entry:)","abstract":"

    Removes offline recording from the device

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/startOfflineRecording(_:feature:settings:)":{"name":"startOfflineRecording(_:feature:settings:)","abstract":"

    Start offline recording.

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/stopOfflineRecording(_:feature:)":{"name":"stopOfflineRecording(_:feature:)","abstract":"

    Request to stop offline recording.

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarH10OfflineExerciseApi.html#/startRecording(_:exerciseId:interval:sampleType:)":{"name":"startRecording(_:exerciseId:interval:sampleType:)","abstract":"

    Request start recording. Supported only by Polar H10. Requires polarFileTransfer feature.

    ","parent_name":"PolarH10OfflineExerciseApi"},"Protocols/PolarH10OfflineExerciseApi.html#/stopRecording(_:)":{"name":"stopRecording(_:)","abstract":"

    Request stop for current recording. Supported only by Polar H10. Requires polarFileTransfer feature.

    ","parent_name":"PolarH10OfflineExerciseApi"},"Protocols/PolarH10OfflineExerciseApi.html#/requestRecordingStatus(_:)":{"name":"requestRecordingStatus(_:)","abstract":"

    Request current recording status. Supported only by Polar H10. Requires polarFileTransfer feature.

    ","parent_name":"PolarH10OfflineExerciseApi"},"Protocols/PolarH10OfflineExerciseApi.html#/fetchStoredExerciseList(_:)":{"name":"fetchStoredExerciseList(_:)","abstract":"

    Api for fetching stored exercises list from Polar H10 device. Requires polarFileTransfer feature. This API is working for Polar OH1 and Polar Verity Sense devices too, however in those devices recording of exercise requires that sensor is registered to Polar Flow account.

    ","parent_name":"PolarH10OfflineExerciseApi"},"Protocols/PolarH10OfflineExerciseApi.html#/fetchExercise(_:entry:)":{"name":"fetchExercise(_:entry:)","abstract":"

    Api for fetching a single exercise from Polar H10 device. Requires polarFileTransfer feature. This API is working for Polar OH1 and Polar Verity Sense devices too, however in those devices recording of exercise requires that sensor is registered to Polar Flow account.

    ","parent_name":"PolarH10OfflineExerciseApi"},"Protocols/PolarH10OfflineExerciseApi.html#/removeExercise(_:entry:)":{"name":"removeExercise(_:entry:)","abstract":"

    Api for removing single exercise from Polar H10 device. Requires polarFileTransfer feature. This API is working for Polar OH1 and Polar Verity Sense devices too, however in those devices recording of exercise requires that sensor is registered to Polar Flow account.

    ","parent_name":"PolarH10OfflineExerciseApi"},"Protocols/PolarBleApiLogger.html#/message(_:)":{"name":"message(_:)","abstract":"

    log message from sdk

    ","parent_name":"PolarBleApiLogger"},"Protocols/PolarBleApiDeviceFeaturesObserver.html#/bleSdkFeatureReady(_:feature:)":{"name":"bleSdkFeatureReady(_:feature:)","abstract":"

    The feature is available in this device and it is ready. Called only for the features which are specified in [PolarBleApi] construction.

    ","parent_name":"PolarBleApiDeviceFeaturesObserver"},"Protocols/PolarBleApiDeviceInfoObserver.html#/batteryLevelReceived(_:batteryLevel:)":{"name":"batteryLevelReceived(_:batteryLevel:)","abstract":"

    Battery level received from device.

    ","parent_name":"PolarBleApiDeviceInfoObserver"},"Protocols/PolarBleApiDeviceInfoObserver.html#/disInformationReceived(_:uuid:value:)":{"name":"disInformationReceived(_:uuid:value:)","abstract":"

    Received DIS info.

    ","parent_name":"PolarBleApiDeviceInfoObserver"},"Protocols/PolarBleApiPowerStateObserver.html#/blePowerOn()":{"name":"blePowerOn()","abstract":"

    Ble powered on event.

    ","parent_name":"PolarBleApiPowerStateObserver"},"Protocols/PolarBleApiPowerStateObserver.html#/blePowerOff()":{"name":"blePowerOff()","abstract":"

    Ble powered off event, no further actions are needed from the application.

    ","parent_name":"PolarBleApiPowerStateObserver"},"Protocols/PolarBleApiObserver.html#/deviceConnecting(_:)":{"name":"deviceConnecting(_:)","abstract":"

    Callback when connection attempt is started to device

    ","parent_name":"PolarBleApiObserver"},"Protocols/PolarBleApiObserver.html#/deviceConnected(_:)":{"name":"deviceConnected(_:)","abstract":"

    Device connnection has been established.

    ","parent_name":"PolarBleApiObserver"},"Protocols/PolarBleApiObserver.html#/deviceDisconnected(_:)":{"name":"deviceDisconnected(_:)","abstract":"

    Connection lost to device.","parent_name":"PolarBleApiObserver"},"Protocols/PolarBleApi.html#/cleanup()":{"name":"cleanup()","abstract":"

    remove all known devices, which are not in use

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/polarFilter(_:)":{"name":"polarFilter(_:)","abstract":"

    Enable or disable polar filter.

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/startAutoConnectToDevice(_:service:polarDeviceType:)":{"name":"startAutoConnectToDevice(_:service:polarDeviceType:)","abstract":"

    Start connecting to a nearby device. PolarBleApiObservers polarDeviceConnected is","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/connectToDevice(_:)":{"name":"connectToDevice(_:)","abstract":"

    Request a connection to a Polar device. Invokes PolarBleApiObservers polarDeviceConnected.

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/disconnectFromDevice(_:)":{"name":"disconnectFromDevice(_:)","abstract":"

    Disconnect from the current Polar device.

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/searchForDevice()":{"name":"searchForDevice()","abstract":"

    Start searching for Polar device(s)

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/startListenForPolarHrBroadcasts(_:)":{"name":"startListenForPolarHrBroadcasts(_:)","abstract":"

    Start listening to heart rate broadcasts from one or more Polar devices

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/isFeatureReady(_:feature:)":{"name":"isFeatureReady(_:feature:)","abstract":"

    helper to check is feature ready

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/setLocalTime(_:time:zone:)":{"name":"setLocalTime(_:time:zone:)","abstract":"

    Set local time to device. Requires polarFileTransfer feature.

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/getLocalTime(_:)":{"name":"getLocalTime(_:)","abstract":"

    Get current time in device. Requires polarFileTransfer feature. Not supported by Polar H10.

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/observer":{"name":"observer","abstract":"

    Common GAP (Generic access profile) observer

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/deviceInfoObserver":{"name":"deviceInfoObserver","abstract":"

    Device info observer for DIS (Device information service) and BAS (Battery service) GATT (Generic attributes) client

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/powerStateObserver":{"name":"powerStateObserver","abstract":"

    Bluetooth power state observer

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/deviceFeaturesObserver":{"name":"deviceFeaturesObserver","abstract":"

    Device features ready observer

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/isBlePowered":{"name":"isBlePowered","abstract":"

    Helper to check if Ble is currently powered

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/logger":{"name":"logger","abstract":"

    optional logger set to get traces from sdk

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/automaticReconnection":{"name":"automaticReconnection","abstract":"

    optional disable or enable automatic reconnection, by default it is enabled

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html":{"name":"PolarBleApi","abstract":"

    API.

    "},"Protocols/PolarBleApiObserver.html":{"name":"PolarBleApiObserver","abstract":"

    Polar Ble API connection observer.

    "},"Protocols/PolarBleApiPowerStateObserver.html":{"name":"PolarBleApiPowerStateObserver","abstract":"

    Bluetooth state observer.

    "},"Protocols/PolarBleApiDeviceInfoObserver.html":{"name":"PolarBleApiDeviceInfoObserver","abstract":"

    Device info observer.

    "},"Protocols.html#/PolarBleApiDeviceHrObserver":{"name":"PolarBleApiDeviceHrObserver","abstract":"

    Heart rate observer

    "},"Protocols/PolarBleApiDeviceFeaturesObserver.html":{"name":"PolarBleApiDeviceFeaturesObserver","abstract":"

    Data client observer

    "},"Protocols.html#/PolarBleApiSdkModeFeatureObserver":{"name":"PolarBleApiSdkModeFeatureObserver","abstract":"

    SDK Mode observer

    "},"Protocols/PolarBleApiLogger.html":{"name":"PolarBleApiLogger","abstract":"

    logger observer

    "},"Protocols/PolarH10OfflineExerciseApi.html":{"name":"PolarH10OfflineExerciseApi","abstract":"

    H10 Exercise recording API.

    "},"Protocols/PolarOfflineRecordingApi.html":{"name":"PolarOfflineRecordingApi","abstract":"

    Offline recording API.

    "},"Protocols/PolarOnlineStreamingApi.html":{"name":"PolarOnlineStreamingApi","abstract":"

    Online steaming API.

    "},"Protocols/PolarSdkModeApi.html":{"name":"PolarSdkModeApi","abstract":"

    Polar SDK mode API

    "},"Extensions/PrimitiveSequence.html#/asCompletable()":{"name":"asCompletable()","parent_name":"PrimitiveSequence"},"Extensions.html#/PolarBleApiImpl":{"name":"PolarBleApiImpl"},"Extensions/PrimitiveSequence.html":{"name":"PrimitiveSequence"},"Enums/PolarOfflineRecordingData.html#/accOfflineRecordingData(_:startTime:settings:)":{"name":"accOfflineRecordingData(_:startTime:settings:)","parent_name":"PolarOfflineRecordingData"},"Enums/PolarOfflineRecordingData.html#/gyroOfflineRecordingData(_:startTime:settings:)":{"name":"gyroOfflineRecordingData(_:startTime:settings:)","parent_name":"PolarOfflineRecordingData"},"Enums/PolarOfflineRecordingData.html#/magOfflineRecordingData(_:startTime:settings:)":{"name":"magOfflineRecordingData(_:startTime:settings:)","parent_name":"PolarOfflineRecordingData"},"Enums/PolarOfflineRecordingData.html#/ppgOfflineRecordingData(_:startTime:settings:)":{"name":"ppgOfflineRecordingData(_:startTime:settings:)","parent_name":"PolarOfflineRecordingData"},"Enums/PolarOfflineRecordingData.html#/ppiOfflineRecordingData(_:startTime:)":{"name":"ppiOfflineRecordingData(_:startTime:)","parent_name":"PolarOfflineRecordingData"},"Enums/PolarOfflineRecordingData.html#/hrOfflineRecordingData(_:startTime:)":{"name":"hrOfflineRecordingData(_:startTime:)","parent_name":"PolarOfflineRecordingData"},"Enums/PolarErrors.html#/notificationNotEnabled":{"name":"notificationNotEnabled","abstract":"

    GATT characteristic notification not enabled

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/serviceNotFound":{"name":"serviceNotFound","abstract":"

    GATT service not found

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/deviceNotConnected":{"name":"deviceNotConnected","abstract":"

    Device state != Connected

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/deviceNotFound":{"name":"deviceNotFound","abstract":"

    Device not found

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/operationNotSupported":{"name":"operationNotSupported","abstract":"

    Requested operation is not supported

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/messageEncodeFailed":{"name":"messageEncodeFailed","abstract":"

    Google protocol buffers encode failed

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/messageDecodeFailed":{"name":"messageDecodeFailed","abstract":"

    Google protocol buffers decode failed

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/dateTimeFormatFailed(description:)":{"name":"dateTimeFormatFailed(description:)","abstract":"

    String to date time formatting failed

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/unableToStartStreaming":{"name":"unableToStartStreaming","abstract":"

    Failed to start streaming

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/invalidArgument(description:)":{"name":"invalidArgument(description:)","abstract":"

    invalid argument

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/polarBleSdkInternalException(description:)":{"name":"polarBleSdkInternalException(description:)","abstract":"

    Polar BLE SDK internal exception indicating something went wrong in SDK internal logic

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/deviceError(description:)":{"name":"deviceError(description:)","abstract":"

    Error on device operation

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/polarOfflineRecordingError(description:)":{"name":"polarOfflineRecordingError(description:)","abstract":"

    Error related to offline recording

    ","parent_name":"PolarErrors"},"Enums/SampleType.html#/hr":{"name":"hr","abstract":"

    recording type to use is hr in BPM

    ","parent_name":"SampleType"},"Enums/SampleType.html#/rr":{"name":"rr","abstract":"

    recording type to use is rr interval

    ","parent_name":"SampleType"},"Enums/RecordingInterval.html#/interval_1s":{"name":"interval_1s","parent_name":"RecordingInterval"},"Enums/RecordingInterval.html#/interval_5s":{"name":"interval_5s","parent_name":"RecordingInterval"},"Enums/OhrDataType.html#/ppg3_ambient1":{"name":"ppg3_ambient1","abstract":"

    3 ppg + 1 ambient

    ","parent_name":"OhrDataType"},"Enums/OhrDataType.html#/unknown":{"name":"unknown","parent_name":"OhrDataType"},"Enums/PolarBleSdkFeature.html#/feature_hr":{"name":"feature_hr","abstract":"

    Hr feature to receive hr and rr data from Polar or any other BLE device via standard HR BLE service

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_device_info":{"name":"feature_device_info","abstract":"

    Device information feature to receive sw information from Polar or any other BLE device

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_battery_info":{"name":"feature_battery_info","abstract":"

    Feature to receive battery level info from Polar or any other BLE device

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_polar_online_streaming":{"name":"feature_polar_online_streaming","abstract":"

    Polar sensor streaming feature to stream live online data. For example hr, ecg, acc, ppg, ppi, etc…

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_polar_offline_recording":{"name":"feature_polar_offline_recording","abstract":"

    Polar offline recording feature to record offline data to Polar device without continuous BLE connection.

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_polar_h10_exercise_recording":{"name":"feature_polar_h10_exercise_recording","abstract":"

    H10 exercise recording feature to record exercise data to Polar H10 device without continuous BLE connection.

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_polar_device_time_setup":{"name":"feature_polar_device_time_setup","abstract":"

    Feature to read and set device time in Polar device

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_polar_sdk_mode":{"name":"feature_polar_sdk_mode","abstract":"

    In SDK mode the wider range of capabilities are available for the online stream or offline recoding than in normal operation mode.

    ","parent_name":"PolarBleSdkFeature"},"Enums/Features.html#/hr":{"name":"hr","abstract":"

    hr feature enables hr client to receive hr and rr data from device

    ","parent_name":"Features"},"Enums/Features.html#/deviceInfo":{"name":"deviceInfo","abstract":"

    deviceInfo enables dis client to receive fw information from device

    ","parent_name":"Features"},"Enums/Features.html#/batteryStatus":{"name":"batteryStatus","abstract":"

    batteryStatus enables bas client to receive battery level info from device

    ","parent_name":"Features"},"Enums/Features.html#/polarSensorStreaming":{"name":"polarSensorStreaming","abstract":"

    polarSensorStreaming enables stream client to start acc, ppg, ecg, ppi streams

    ","parent_name":"Features"},"Enums/Features.html#/polarFileTransfer":{"name":"polarFileTransfer","abstract":"

    polarFileTransfer enables the listing, read stored exercises and setup of local time to device.","parent_name":"Features"},"Enums/Features.html#/allFeatures":{"name":"allFeatures","abstract":"

    allFeatures enables all features available

    ","parent_name":"Features"},"Enums/PolarDeviceDataType.html#/ecg":{"name":"ecg","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html#/acc":{"name":"acc","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html#/ppg":{"name":"ppg","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html#/ppi":{"name":"ppi","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html#/gyro":{"name":"gyro","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html#/magnetometer":{"name":"magnetometer","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html#/hr":{"name":"hr","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html":{"name":"PolarDeviceDataType","abstract":"

    Data types available in Polar devices for online streaming or offline recording.

    "},"Enums/Features.html":{"name":"Features","abstract":"

    features available

    "},"Enums/PolarBleSdkFeature.html":{"name":"PolarBleSdkFeature","abstract":"

    Features available in Polar BLE SDK library

    "},"Enums/OhrDataType.html":{"name":"OhrDataType","abstract":"

    OHR data source enum

    "},"Enums/RecordingInterval.html":{"name":"RecordingInterval","abstract":"

    Recoding intervals for H10 recording start

    "},"Enums/SampleType.html":{"name":"SampleType","abstract":"

    Sample types for H10 recording start

    "},"Enums/PolarErrors.html":{"name":"PolarErrors","abstract":"

    Polar SDK errors

    "},"Enums/PolarOfflineRecordingData.html":{"name":"PolarOfflineRecordingData"},"Classes/PolarBleApiDefaultImpl.html#/polarImplementation(_:features:)":{"name":"polarImplementation(_:features:)","abstract":"

    New instance of Polar Ble API implementation

    ","parent_name":"PolarBleApiDefaultImpl"},"Classes/PolarBleApiDefaultImpl.html#/versionInfo()":{"name":"versionInfo()","abstract":"

    Return current version

    ","parent_name":"PolarBleApiDefaultImpl"},"Classes/PolarBleApiDefaultImpl.html":{"name":"PolarBleApiDefaultImpl","abstract":"

    Class to provide the default implementation of the Polar Ble API

    "},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Extensions.html":{"name":"Extensions","abstract":"

    The following extensions are available globally.

    "},"Protocols.html":{"name":"Protocols","abstract":"

    The following protocols are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "},"Typealiases.html":{"name":"Type Aliases","abstract":"

    The following type aliases are available globally.

    "}} \ No newline at end of file +{"Typealiases.html#/PolarDeviceInfo":{"name":"PolarDeviceInfo","abstract":"

    Polar device info

    "},"Typealiases.html#/PolarHrBroadcastData":{"name":"PolarHrBroadcastData","abstract":"

    deviceInfo: see #PolarDeviceInfo ,

    "},"Typealiases.html#/PolarHrData":{"name":"PolarHrData","abstract":"

    Polar hr data

    "},"Typealiases.html#/PolarEcgData":{"name":"PolarEcgData","abstract":"

    Polar Ecg data

    "},"Typealiases.html#/PolarAccData":{"name":"PolarAccData","abstract":"

    Polar acc data

    "},"Typealiases.html#/PolarGyroData":{"name":"PolarGyroData","abstract":"

    Polar gyro data

    "},"Typealiases.html#/PolarMagnetometerData":{"name":"PolarMagnetometerData","abstract":"

    Polar magnetometer data

    "},"Typealiases.html#/PolarPpgData":{"name":"PolarPpgData","abstract":"

    Polar PPG data

    "},"Typealiases.html#/PolarPpiData":{"name":"PolarPpiData","abstract":"

    Polar ppi data

    "},"Typealiases.html#/PolarExerciseEntry":{"name":"PolarExerciseEntry","abstract":"

    Polar exercise entry

    "},"Typealiases.html#/PolarExerciseData":{"name":"PolarExerciseData","abstract":"

    Polar Exercise Data

    "},"Typealiases.html#/PolarRecordingStatus":{"name":"PolarRecordingStatus","abstract":"

    Polar Recording status

    "},"Structs/PolarSensorSetting/SettingType.html#/sampleRate":{"name":"sampleRate","abstract":"

    sample rate in hz

    ","parent_name":"SettingType"},"Structs/PolarSensorSetting/SettingType.html#/resolution":{"name":"resolution","abstract":"

    resolution in bits

    ","parent_name":"SettingType"},"Structs/PolarSensorSetting/SettingType.html#/range":{"name":"range","abstract":"

    range

    ","parent_name":"SettingType"},"Structs/PolarSensorSetting/SettingType.html#/rangeMilliunit":{"name":"rangeMilliunit","abstract":"

    range with min and max allowed values

    ","parent_name":"SettingType"},"Structs/PolarSensorSetting/SettingType.html#/channels":{"name":"channels","abstract":"

    amount of channels available

    ","parent_name":"SettingType"},"Structs/PolarSensorSetting/SettingType.html#/unknown":{"name":"unknown","abstract":"

    type is unknown

    ","parent_name":"SettingType"},"Structs/PolarSensorSetting/SettingType.html":{"name":"SettingType","abstract":"

    settings type

    ","parent_name":"PolarSensorSetting"},"Structs/PolarSensorSetting.html#/settings":{"name":"settings","abstract":"

    current settings available / set

    ","parent_name":"PolarSensorSetting"},"Structs/PolarSensorSetting.html#/init(_:)":{"name":"init(_:)","abstract":"

    constructor with desired settings

    ","parent_name":"PolarSensorSetting"},"Structs/PolarSensorSetting.html#/maxSettings()":{"name":"maxSettings()","abstract":"

    helper to retrieve max settings available

    ","parent_name":"PolarSensorSetting"},"Structs/PolarSensorSetting.html#/description":{"name":"description","parent_name":"PolarSensorSetting"},"Structs/PolarRecordingSecret.html#/init(key:)":{"name":"init(key:)","parent_name":"PolarRecordingSecret"},"Structs/PolarOfflineRecordingEntry.html#/path":{"name":"path","abstract":"

    Recording entry path in device.

    ","parent_name":"PolarOfflineRecordingEntry"},"Structs/PolarOfflineRecordingEntry.html#/size":{"name":"size","abstract":"

    Recording size in bytes.

    ","parent_name":"PolarOfflineRecordingEntry"},"Structs/PolarOfflineRecordingEntry.html#/date":{"name":"date","abstract":"

    The date and time of the recording entry i.e. the moment recording is started

    ","parent_name":"PolarOfflineRecordingEntry"},"Structs/PolarOfflineRecordingEntry.html#/type":{"name":"type","abstract":"

    data type of the recording

    ","parent_name":"PolarOfflineRecordingEntry"},"Structs/PolarOfflineRecordingEntry.html#/init(path:size:date:type:)":{"name":"init(path:size:date:type:)","parent_name":"PolarOfflineRecordingEntry"},"Structs/PolarOfflineRecordingEntry.html":{"name":"PolarOfflineRecordingEntry","abstract":"

    Polar offline recording entry container.

    "},"Structs/PolarRecordingSecret.html":{"name":"PolarRecordingSecret","abstract":"

    Polar recording secret is used to encrypt the recording.

    "},"Structs/PolarSensorSetting.html":{"name":"PolarSensorSetting","abstract":"

    polar sensor settings class

    "},"Protocols/PolarSdkModeApi.html#/enableSDKMode(_:)":{"name":"enableSDKMode(_:)","abstract":"

    Enables SDK mode.

    ","parent_name":"PolarSdkModeApi"},"Protocols/PolarSdkModeApi.html#/disableSDKMode(_:)":{"name":"disableSDKMode(_:)","abstract":"

    Disables SDK mode.

    ","parent_name":"PolarSdkModeApi"},"Protocols/PolarSdkModeApi.html#/isSDKModeEnabled(_:)":{"name":"isSDKModeEnabled(_:)","abstract":"

    Check if SDK mode currently enabled.

    ","parent_name":"PolarSdkModeApi"},"Protocols/PolarOnlineStreamingApi.html#/getAvailableOnlineStreamDataTypes(_:)":{"name":"getAvailableOnlineStreamDataTypes(_:)","abstract":"

    Get the data types available in this device for online streaming

    ","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/requestStreamSettings(_:feature:)":{"name":"requestStreamSettings(_:feature:)","abstract":"

    Request the stream settings available in current operation mode. This request shall be used before the stream is started","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/requestFullStreamSettings(_:feature:)":{"name":"requestFullStreamSettings(_:feature:)","abstract":"

    Request full steam settings capabilities. The request returns the all capabilities of the requested streaming feature not limited by the current operation mode.","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startHrStreaming(_:)":{"name":"startHrStreaming(_:)","abstract":"

    Start heart rate stream. Heart rate stream is stopped if the connection is closed,","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startEcgStreaming(_:settings:)":{"name":"startEcgStreaming(_:settings:)","abstract":"

    Start the ECG (Electrocardiography) stream. ECG stream is stopped if the connection is closed, error occurs or stream is disposed.

    ","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startAccStreaming(_:settings:)":{"name":"startAccStreaming(_:settings:)","abstract":"

    Start ACC (Accelerometer) stream. ACC stream is stopped if the connection is closed, error occurs or stream is disposed.

    ","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startGyroStreaming(_:settings:)":{"name":"startGyroStreaming(_:settings:)","abstract":"

    Start Gyro stream. Gyro stream is stopped if the connection is closed, error occurs during start or stream is disposed.

    ","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startMagnetometerStreaming(_:settings:)":{"name":"startMagnetometerStreaming(_:settings:)","abstract":"

    Start magnetometer stream. Magnetometer stream is stopped if the connection is closed, error occurs or stream is disposed.

    ","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startPpgStreaming(_:settings:)":{"name":"startPpgStreaming(_:settings:)","abstract":"

    Start optical sensor PPG (Photoplethysmography) stream. PPG stream is stopped if the connection is closed, error occurs or stream is disposed.

    ","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startOhrPPIStreaming(_:)":{"name":"startOhrPPIStreaming(_:)","abstract":"

    Start OHR (Optical heart rate) PPI (Pulse to Pulse interval) stream.","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOfflineRecordingApi.html#/getAvailableOfflineRecordingDataTypes(_:)":{"name":"getAvailableOfflineRecordingDataTypes(_:)","abstract":"

    Get the data types available in this device for offline recording

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/requestOfflineRecordingSettings(_:feature:)":{"name":"requestOfflineRecordingSettings(_:feature:)","abstract":"

    Request the offline recording settings available in current operation mode. This request shall be used before the offline recording is started","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/requestFullOfflineRecordingSettings(_:feature:)":{"name":"requestFullOfflineRecordingSettings(_:feature:)","abstract":"

    Request all the settings available in the device. The request returns the all capabilities of the requested streaming feature not limited by the current operation mode.

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/getOfflineRecordingStatus(_:)":{"name":"getOfflineRecordingStatus(_:)","abstract":"

    Get status of offline recordings.

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/listOfflineRecordings(_:)":{"name":"listOfflineRecordings(_:)","abstract":"

    List offline recordings stored in the device.

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/getOfflineRecord(_:entry:secret:)":{"name":"getOfflineRecord(_:entry:secret:)","abstract":"

    Fetch recording from the device.

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/removeOfflineRecord(_:entry:)":{"name":"removeOfflineRecord(_:entry:)","abstract":"

    Removes offline recording from the device

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/startOfflineRecording(_:feature:settings:secret:)":{"name":"startOfflineRecording(_:feature:settings:secret:)","abstract":"

    Start offline recording.

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/stopOfflineRecording(_:feature:)":{"name":"stopOfflineRecording(_:feature:)","abstract":"

    Request to stop offline recording.

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarH10OfflineExerciseApi.html#/startRecording(_:exerciseId:interval:sampleType:)":{"name":"startRecording(_:exerciseId:interval:sampleType:)","abstract":"

    Request start recording. Supported only by Polar H10. Requires polarFileTransfer feature.

    ","parent_name":"PolarH10OfflineExerciseApi"},"Protocols/PolarH10OfflineExerciseApi.html#/stopRecording(_:)":{"name":"stopRecording(_:)","abstract":"

    Request stop for current recording. Supported only by Polar H10. Requires polarFileTransfer feature.

    ","parent_name":"PolarH10OfflineExerciseApi"},"Protocols/PolarH10OfflineExerciseApi.html#/requestRecordingStatus(_:)":{"name":"requestRecordingStatus(_:)","abstract":"

    Request current recording status. Supported only by Polar H10. Requires polarFileTransfer feature.

    ","parent_name":"PolarH10OfflineExerciseApi"},"Protocols/PolarH10OfflineExerciseApi.html#/fetchStoredExerciseList(_:)":{"name":"fetchStoredExerciseList(_:)","abstract":"

    Api for fetching stored exercises list from Polar H10 device. Requires polarFileTransfer feature. This API is working for Polar OH1 and Polar Verity Sense devices too, however in those devices recording of exercise requires that sensor is registered to Polar Flow account.

    ","parent_name":"PolarH10OfflineExerciseApi"},"Protocols/PolarH10OfflineExerciseApi.html#/fetchExercise(_:entry:)":{"name":"fetchExercise(_:entry:)","abstract":"

    Api for fetching a single exercise from Polar H10 device. Requires polarFileTransfer feature. This API is working for Polar OH1 and Polar Verity Sense devices too, however in those devices recording of exercise requires that sensor is registered to Polar Flow account.

    ","parent_name":"PolarH10OfflineExerciseApi"},"Protocols/PolarH10OfflineExerciseApi.html#/removeExercise(_:entry:)":{"name":"removeExercise(_:entry:)","abstract":"

    Api for removing single exercise from Polar H10 device. Requires polarFileTransfer feature. This API is working for Polar OH1 and Polar Verity Sense devices too, however in those devices recording of exercise requires that sensor is registered to Polar Flow account.

    ","parent_name":"PolarH10OfflineExerciseApi"},"Protocols/PolarBleApiLogger.html#/message(_:)":{"name":"message(_:)","abstract":"

    log message from sdk

    ","parent_name":"PolarBleApiLogger"},"Protocols/PolarBleApiDeviceFeaturesObserver.html#/bleSdkFeatureReady(_:feature:)":{"name":"bleSdkFeatureReady(_:feature:)","abstract":"

    The feature is available in this device and it is ready. Called only for the features which are specified in [PolarBleApi] construction.

    ","parent_name":"PolarBleApiDeviceFeaturesObserver"},"Protocols/PolarBleApiDeviceInfoObserver.html#/batteryLevelReceived(_:batteryLevel:)":{"name":"batteryLevelReceived(_:batteryLevel:)","abstract":"

    Battery level received from device.

    ","parent_name":"PolarBleApiDeviceInfoObserver"},"Protocols/PolarBleApiDeviceInfoObserver.html#/disInformationReceived(_:uuid:value:)":{"name":"disInformationReceived(_:uuid:value:)","abstract":"

    Received DIS info.

    ","parent_name":"PolarBleApiDeviceInfoObserver"},"Protocols/PolarBleApiPowerStateObserver.html#/blePowerOn()":{"name":"blePowerOn()","abstract":"

    Ble powered on event.

    ","parent_name":"PolarBleApiPowerStateObserver"},"Protocols/PolarBleApiPowerStateObserver.html#/blePowerOff()":{"name":"blePowerOff()","abstract":"

    Ble powered off event, no further actions are needed from the application.

    ","parent_name":"PolarBleApiPowerStateObserver"},"Protocols/PolarBleApiObserver.html#/deviceConnecting(_:)":{"name":"deviceConnecting(_:)","abstract":"

    Callback when connection attempt is started to device

    ","parent_name":"PolarBleApiObserver"},"Protocols/PolarBleApiObserver.html#/deviceConnected(_:)":{"name":"deviceConnected(_:)","abstract":"

    Device connnection has been established.

    ","parent_name":"PolarBleApiObserver"},"Protocols/PolarBleApiObserver.html#/deviceDisconnected(_:)":{"name":"deviceDisconnected(_:)","abstract":"

    Connection lost to device.","parent_name":"PolarBleApiObserver"},"Protocols/PolarBleApi.html#/cleanup()":{"name":"cleanup()","abstract":"

    remove all known devices, which are not in use

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/polarFilter(_:)":{"name":"polarFilter(_:)","abstract":"

    Enable or disable polar filter.

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/startAutoConnectToDevice(_:service:polarDeviceType:)":{"name":"startAutoConnectToDevice(_:service:polarDeviceType:)","abstract":"

    Start connecting to a nearby device. PolarBleApiObservers polarDeviceConnected is","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/connectToDevice(_:)":{"name":"connectToDevice(_:)","abstract":"

    Request a connection to a Polar device. Invokes PolarBleApiObservers polarDeviceConnected.

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/disconnectFromDevice(_:)":{"name":"disconnectFromDevice(_:)","abstract":"

    Disconnect from the current Polar device.

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/searchForDevice()":{"name":"searchForDevice()","abstract":"

    Start searching for Polar device(s)

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/startListenForPolarHrBroadcasts(_:)":{"name":"startListenForPolarHrBroadcasts(_:)","abstract":"

    Start listening the heart rate from Polar devices when subscribed.","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/isFeatureReady(_:feature:)":{"name":"isFeatureReady(_:feature:)","abstract":"

    helper to check is feature ready

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/setLocalTime(_:time:zone:)":{"name":"setLocalTime(_:time:zone:)","abstract":"

    Set local time to device. Requires polarFileTransfer feature.

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/getLocalTime(_:)":{"name":"getLocalTime(_:)","abstract":"

    Get current time in device. Requires polarFileTransfer feature. Not supported by Polar H10.

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/observer":{"name":"observer","abstract":"

    Common GAP (Generic access profile) observer

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/deviceInfoObserver":{"name":"deviceInfoObserver","abstract":"

    Device info observer for DIS (Device information service) and BAS (Battery service) GATT (Generic attributes) client

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/powerStateObserver":{"name":"powerStateObserver","abstract":"

    Bluetooth power state observer

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/deviceFeaturesObserver":{"name":"deviceFeaturesObserver","abstract":"

    Device features ready observer

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/isBlePowered":{"name":"isBlePowered","abstract":"

    Helper to check if Ble is currently powered

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/logger":{"name":"logger","abstract":"

    optional logger set to get traces from sdk

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/automaticReconnection":{"name":"automaticReconnection","abstract":"

    optional disable or enable automatic reconnection, by default it is enabled

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html":{"name":"PolarBleApi","abstract":"

    API.

    "},"Protocols/PolarBleApiObserver.html":{"name":"PolarBleApiObserver","abstract":"

    Polar Ble API connection observer.

    "},"Protocols/PolarBleApiPowerStateObserver.html":{"name":"PolarBleApiPowerStateObserver","abstract":"

    Bluetooth state observer.

    "},"Protocols/PolarBleApiDeviceInfoObserver.html":{"name":"PolarBleApiDeviceInfoObserver","abstract":"

    Device info observer.

    "},"Protocols.html#/PolarBleApiDeviceHrObserver":{"name":"PolarBleApiDeviceHrObserver","abstract":"

    Heart rate observer

    "},"Protocols/PolarBleApiDeviceFeaturesObserver.html":{"name":"PolarBleApiDeviceFeaturesObserver","abstract":"

    Data client observer

    "},"Protocols.html#/PolarBleApiSdkModeFeatureObserver":{"name":"PolarBleApiSdkModeFeatureObserver","abstract":"

    SDK Mode observer

    "},"Protocols/PolarBleApiLogger.html":{"name":"PolarBleApiLogger","abstract":"

    logger observer

    "},"Protocols/PolarH10OfflineExerciseApi.html":{"name":"PolarH10OfflineExerciseApi","abstract":"

    H10 Exercise recording API.

    "},"Protocols/PolarOfflineRecordingApi.html":{"name":"PolarOfflineRecordingApi","abstract":"

    Offline recording API.

    "},"Protocols/PolarOnlineStreamingApi.html":{"name":"PolarOnlineStreamingApi","abstract":"

    Online steaming API.

    "},"Protocols/PolarSdkModeApi.html":{"name":"PolarSdkModeApi","abstract":"

    Polar SDK mode API

    "},"Extensions/PrimitiveSequence.html#/asCompletable()":{"name":"asCompletable()","parent_name":"PrimitiveSequence"},"Extensions.html#/PolarBleApiImpl":{"name":"PolarBleApiImpl"},"Extensions/PrimitiveSequence.html":{"name":"PrimitiveSequence"},"Enums/PolarOfflineRecordingData.html#/accOfflineRecordingData(_:startTime:settings:)":{"name":"accOfflineRecordingData(_:startTime:settings:)","parent_name":"PolarOfflineRecordingData"},"Enums/PolarOfflineRecordingData.html#/gyroOfflineRecordingData(_:startTime:settings:)":{"name":"gyroOfflineRecordingData(_:startTime:settings:)","parent_name":"PolarOfflineRecordingData"},"Enums/PolarOfflineRecordingData.html#/magOfflineRecordingData(_:startTime:settings:)":{"name":"magOfflineRecordingData(_:startTime:settings:)","parent_name":"PolarOfflineRecordingData"},"Enums/PolarOfflineRecordingData.html#/ppgOfflineRecordingData(_:startTime:settings:)":{"name":"ppgOfflineRecordingData(_:startTime:settings:)","parent_name":"PolarOfflineRecordingData"},"Enums/PolarOfflineRecordingData.html#/ppiOfflineRecordingData(_:startTime:)":{"name":"ppiOfflineRecordingData(_:startTime:)","parent_name":"PolarOfflineRecordingData"},"Enums/PolarOfflineRecordingData.html#/hrOfflineRecordingData(_:startTime:)":{"name":"hrOfflineRecordingData(_:startTime:)","parent_name":"PolarOfflineRecordingData"},"Enums/PolarErrors.html#/notificationNotEnabled":{"name":"notificationNotEnabled","abstract":"

    GATT characteristic notification not enabled

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/serviceNotFound":{"name":"serviceNotFound","abstract":"

    GATT service not found

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/deviceNotConnected":{"name":"deviceNotConnected","abstract":"

    Device state != Connected

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/deviceNotFound":{"name":"deviceNotFound","abstract":"

    Device not found

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/operationNotSupported":{"name":"operationNotSupported","abstract":"

    Requested operation is not supported

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/messageEncodeFailed":{"name":"messageEncodeFailed","abstract":"

    Google protocol buffers encode failed

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/messageDecodeFailed":{"name":"messageDecodeFailed","abstract":"

    Google protocol buffers decode failed

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/dateTimeFormatFailed(description:)":{"name":"dateTimeFormatFailed(description:)","abstract":"

    String to date time formatting failed

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/unableToStartStreaming":{"name":"unableToStartStreaming","abstract":"

    Failed to start streaming

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/invalidArgument(description:)":{"name":"invalidArgument(description:)","abstract":"

    invalid argument

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/polarBleSdkInternalException(description:)":{"name":"polarBleSdkInternalException(description:)","abstract":"

    Polar BLE SDK internal exception indicating something went wrong in SDK internal logic

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/deviceError(description:)":{"name":"deviceError(description:)","abstract":"

    Error on device operation

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/polarOfflineRecordingError(description:)":{"name":"polarOfflineRecordingError(description:)","abstract":"

    Error related to offline recording

    ","parent_name":"PolarErrors"},"Enums/SampleType.html#/hr":{"name":"hr","abstract":"

    recording type to use is hr in BPM

    ","parent_name":"SampleType"},"Enums/SampleType.html#/rr":{"name":"rr","abstract":"

    recording type to use is rr interval

    ","parent_name":"SampleType"},"Enums/RecordingInterval.html#/interval_1s":{"name":"interval_1s","parent_name":"RecordingInterval"},"Enums/RecordingInterval.html#/interval_5s":{"name":"interval_5s","parent_name":"RecordingInterval"},"Enums/PpgDataType.html#/ppg3_ambient1":{"name":"ppg3_ambient1","abstract":"

    3 ppg + 1 ambient

    ","parent_name":"PpgDataType"},"Enums/PpgDataType.html#/unknown":{"name":"unknown","parent_name":"PpgDataType"},"Enums/PolarBleSdkFeature.html#/feature_hr":{"name":"feature_hr","abstract":"

    Hr feature to receive hr and rr data from Polar or any other BLE device via standard HR BLE service

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_device_info":{"name":"feature_device_info","abstract":"

    Device information feature to receive sw information from Polar or any other BLE device

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_battery_info":{"name":"feature_battery_info","abstract":"

    Feature to receive battery level info from Polar or any other BLE device

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_polar_online_streaming":{"name":"feature_polar_online_streaming","abstract":"

    Polar sensor streaming feature to stream live online data. For example hr, ecg, acc, ppg, ppi, etc…

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_polar_offline_recording":{"name":"feature_polar_offline_recording","abstract":"

    Polar offline recording feature to record offline data to Polar device without continuous BLE connection.

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_polar_h10_exercise_recording":{"name":"feature_polar_h10_exercise_recording","abstract":"

    H10 exercise recording feature to record exercise data to Polar H10 device without continuous BLE connection.

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_polar_device_time_setup":{"name":"feature_polar_device_time_setup","abstract":"

    Feature to read and set device time in Polar device

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_polar_sdk_mode":{"name":"feature_polar_sdk_mode","abstract":"

    In SDK mode the wider range of capabilities are available for the online stream or offline recoding than in normal operation mode.

    ","parent_name":"PolarBleSdkFeature"},"Enums/Features.html#/hr":{"name":"hr","abstract":"

    hr feature enables hr client to receive hr and rr data from device

    ","parent_name":"Features"},"Enums/Features.html#/deviceInfo":{"name":"deviceInfo","abstract":"

    deviceInfo enables dis client to receive fw information from device

    ","parent_name":"Features"},"Enums/Features.html#/batteryStatus":{"name":"batteryStatus","abstract":"

    batteryStatus enables bas client to receive battery level info from device

    ","parent_name":"Features"},"Enums/Features.html#/polarSensorStreaming":{"name":"polarSensorStreaming","abstract":"

    polarSensorStreaming enables stream client to start acc, ppg, ecg, ppi streams

    ","parent_name":"Features"},"Enums/Features.html#/polarFileTransfer":{"name":"polarFileTransfer","abstract":"

    polarFileTransfer enables the listing, read stored exercises and setup of local time to device.","parent_name":"Features"},"Enums/Features.html#/allFeatures":{"name":"allFeatures","abstract":"

    allFeatures enables all features available

    ","parent_name":"Features"},"Enums/PolarDeviceDataType.html#/ecg":{"name":"ecg","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html#/acc":{"name":"acc","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html#/ppg":{"name":"ppg","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html#/ppi":{"name":"ppi","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html#/gyro":{"name":"gyro","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html#/magnetometer":{"name":"magnetometer","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html#/hr":{"name":"hr","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html":{"name":"PolarDeviceDataType","abstract":"

    Data types available in Polar devices for online streaming or offline recording.

    "},"Enums/Features.html":{"name":"Features","abstract":"

    features available

    "},"Enums/PolarBleSdkFeature.html":{"name":"PolarBleSdkFeature","abstract":"

    Features available in Polar BLE SDK library

    "},"Enums/PpgDataType.html":{"name":"PpgDataType","abstract":"

    PPG data source enum

    "},"Enums/RecordingInterval.html":{"name":"RecordingInterval","abstract":"

    Recoding intervals for H10 recording start

    "},"Enums/SampleType.html":{"name":"SampleType","abstract":"

    Sample types for H10 recording start

    "},"Enums/PolarErrors.html":{"name":"PolarErrors","abstract":"

    Polar SDK errors

    "},"Enums/PolarOfflineRecordingData.html":{"name":"PolarOfflineRecordingData"},"Classes/PolarBleApiDefaultImpl.html#/polarImplementation(_:features:)":{"name":"polarImplementation(_:features:)","abstract":"

    New instance of Polar Ble API implementation

    ","parent_name":"PolarBleApiDefaultImpl"},"Classes/PolarBleApiDefaultImpl.html#/versionInfo()":{"name":"versionInfo()","abstract":"

    Return current version

    ","parent_name":"PolarBleApiDefaultImpl"},"Classes/PolarBleApiDefaultImpl.html":{"name":"PolarBleApiDefaultImpl","abstract":"

    Class to provide the default implementation of the Polar Ble API

    "},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Extensions.html":{"name":"Extensions","abstract":"

    The following extensions are available globally.

    "},"Protocols.html":{"name":"Protocols","abstract":"

    The following protocols are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "},"Typealiases.html":{"name":"Type Aliases","abstract":"

    The following type aliases are available globally.

    "}} \ No newline at end of file diff --git a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/docSet.dsidx b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/docSet.dsidx index 58c5871b..1c764bd0 100644 Binary files a/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/docSet.dsidx and b/polar-sdk-ios/docs/docsets/.docset/Contents/Resources/docSet.dsidx differ diff --git a/polar-sdk-ios/docs/docsets/.tgz b/polar-sdk-ios/docs/docsets/.tgz index bd561276..49bdda63 100644 Binary files a/polar-sdk-ios/docs/docsets/.tgz and b/polar-sdk-ios/docs/docsets/.tgz differ diff --git a/polar-sdk-ios/docs/index.html b/polar-sdk-ios/docs/index.html index 51b7c45e..4398fb04 100644 --- a/polar-sdk-ios/docs/index.html +++ b/polar-sdk-ios/docs/index.html @@ -48,9 +48,6 @@
  • Features
    • -
  • - OhrDataType -
  • PolarBleSdkFeature
    • @@ -63,6 +60,9 @@
  • PolarOfflineRecordingData
    • +
  • + PpgDataType +
  • RecordingInterval
    • @@ -171,7 +171,7 @@ PolarMagnetometerData
  • - PolarOhrData + PolarPpgData
  • PolarPpiData @@ -206,7 +206,7 @@

    Update dependency

    diff --git a/polar-sdk-ios/docs/search.json b/polar-sdk-ios/docs/search.json index 20fa6bef..c2ff323a 100644 --- a/polar-sdk-ios/docs/search.json +++ b/polar-sdk-ios/docs/search.json @@ -1 +1 @@ -{"Typealiases.html#/PolarDeviceInfo":{"name":"PolarDeviceInfo","abstract":"

    Polar device info

    "},"Typealiases.html#/PolarHrBroadcastData":{"name":"PolarHrBroadcastData","abstract":"

    deviceInfo: see #PolarDeviceInfo ,

    "},"Typealiases.html#/PolarHrData":{"name":"PolarHrData","abstract":"

    Polar hr data

    "},"Typealiases.html#/PolarEcgData":{"name":"PolarEcgData","abstract":"

    Polar Ecg data

    "},"Typealiases.html#/PolarAccData":{"name":"PolarAccData","abstract":"

    Polar acc data

    "},"Typealiases.html#/PolarGyroData":{"name":"PolarGyroData","abstract":"

    Polar gyro data

    "},"Typealiases.html#/PolarMagnetometerData":{"name":"PolarMagnetometerData","abstract":"

    Polar magnetometer data

    "},"Typealiases.html#/PolarOhrData":{"name":"PolarOhrData","abstract":"

    Polar Ohr data

    "},"Typealiases.html#/PolarPpiData":{"name":"PolarPpiData","abstract":"

    Polar ppi data

    "},"Typealiases.html#/PolarExerciseEntry":{"name":"PolarExerciseEntry","abstract":"

    Polar exercise entry

    "},"Typealiases.html#/PolarExerciseData":{"name":"PolarExerciseData","abstract":"

    Polar Exercise Data

    "},"Typealiases.html#/PolarRecordingStatus":{"name":"PolarRecordingStatus","abstract":"

    Polar Recording status

    "},"Structs/PolarSensorSetting/SettingType.html#/sampleRate":{"name":"sampleRate","abstract":"

    sample rate in hz

    ","parent_name":"SettingType"},"Structs/PolarSensorSetting/SettingType.html#/resolution":{"name":"resolution","abstract":"

    resolution in bits

    ","parent_name":"SettingType"},"Structs/PolarSensorSetting/SettingType.html#/range":{"name":"range","abstract":"

    range

    ","parent_name":"SettingType"},"Structs/PolarSensorSetting/SettingType.html#/rangeMilliunit":{"name":"rangeMilliunit","abstract":"

    range with min and max allowed values

    ","parent_name":"SettingType"},"Structs/PolarSensorSetting/SettingType.html#/channels":{"name":"channels","abstract":"

    amount of channels available

    ","parent_name":"SettingType"},"Structs/PolarSensorSetting/SettingType.html#/unknown":{"name":"unknown","abstract":"

    type is unknown

    ","parent_name":"SettingType"},"Structs/PolarSensorSetting/SettingType.html":{"name":"SettingType","abstract":"

    settings type

    ","parent_name":"PolarSensorSetting"},"Structs/PolarSensorSetting.html#/settings":{"name":"settings","abstract":"

    current settings available / set

    ","parent_name":"PolarSensorSetting"},"Structs/PolarSensorSetting.html#/init(_:)":{"name":"init(_:)","abstract":"

    constructor with desired settings

    ","parent_name":"PolarSensorSetting"},"Structs/PolarSensorSetting.html#/maxSettings()":{"name":"maxSettings()","abstract":"

    helper to retrieve max settings available

    ","parent_name":"PolarSensorSetting"},"Structs/PolarSensorSetting.html#/description":{"name":"description","parent_name":"PolarSensorSetting"},"Structs/PolarRecordingSecret.html#/init(key:)":{"name":"init(key:)","parent_name":"PolarRecordingSecret"},"Structs/PolarOfflineRecordingEntry.html#/path":{"name":"path","abstract":"

    Recording entry path in device.

    ","parent_name":"PolarOfflineRecordingEntry"},"Structs/PolarOfflineRecordingEntry.html#/size":{"name":"size","abstract":"

    Recording size in bytes.

    ","parent_name":"PolarOfflineRecordingEntry"},"Structs/PolarOfflineRecordingEntry.html#/date":{"name":"date","abstract":"

    The date and time of the recording entry i.e. the moment recording is started

    ","parent_name":"PolarOfflineRecordingEntry"},"Structs/PolarOfflineRecordingEntry.html#/type":{"name":"type","abstract":"

    data type of the recording

    ","parent_name":"PolarOfflineRecordingEntry"},"Structs/PolarOfflineRecordingEntry.html#/init(path:size:date:type:)":{"name":"init(path:size:date:type:)","parent_name":"PolarOfflineRecordingEntry"},"Structs/PolarOfflineRecordingEntry.html":{"name":"PolarOfflineRecordingEntry","abstract":"

    Polar offline recording entry container.

    "},"Structs/PolarRecordingSecret.html":{"name":"PolarRecordingSecret","abstract":"

    Polar recording secret is used to encrypt the recording.

    "},"Structs/PolarSensorSetting.html":{"name":"PolarSensorSetting","abstract":"

    polar sensor settings class

    "},"Protocols/PolarSdkModeApi.html#/enableSDKMode(_:)":{"name":"enableSDKMode(_:)","abstract":"

    Enables SDK mode.

    ","parent_name":"PolarSdkModeApi"},"Protocols/PolarSdkModeApi.html#/disableSDKMode(_:)":{"name":"disableSDKMode(_:)","abstract":"

    Disables SDK mode.

    ","parent_name":"PolarSdkModeApi"},"Protocols/PolarSdkModeApi.html#/isSDKModeEnabled(_:)":{"name":"isSDKModeEnabled(_:)","abstract":"

    Check if SDK mode currently enabled.

    ","parent_name":"PolarSdkModeApi"},"Protocols/PolarOnlineStreamingApi.html#/getAvailableOnlineStreamDataTypes(_:)":{"name":"getAvailableOnlineStreamDataTypes(_:)","abstract":"

    Get the data types available in this device for online streaming

    ","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/requestStreamSettings(_:feature:)":{"name":"requestStreamSettings(_:feature:)","abstract":"

    Request the stream settings available in current operation mode. This request shall be used before the stream is started","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/requestFullStreamSettings(_:feature:)":{"name":"requestFullStreamSettings(_:feature:)","abstract":"

    Request full steam settings capabilities. The request returns the all capabilities of the requested streaming feature not limited by the current operation mode.","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startHrStreaming(_:)":{"name":"startHrStreaming(_:)","abstract":"

    Start heart rate stream. Heart rate stream is stopped if the connection is closed,","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startEcgStreaming(_:settings:)":{"name":"startEcgStreaming(_:settings:)","abstract":"

    Start the ECG (Electrocardiography) stream. ECG stream is stopped if the connection is closed, error occurs or stream is disposed.

    ","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startAccStreaming(_:settings:)":{"name":"startAccStreaming(_:settings:)","abstract":"

    Start ACC (Accelerometer) stream. ACC stream is stopped if the connection is closed, error occurs or stream is disposed.

    ","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startGyroStreaming(_:settings:)":{"name":"startGyroStreaming(_:settings:)","abstract":"

    Start Gyro stream. Gyro stream is stopped if the connection is closed, error occurs during start or stream is disposed.

    ","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startMagnetometerStreaming(_:settings:)":{"name":"startMagnetometerStreaming(_:settings:)","abstract":"

    Start magnetometer stream. Magnetometer stream is stopped if the connection is closed, error occurs or stream is disposed.

    ","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startPpgStreaming(_:settings:)":{"name":"startPpgStreaming(_:settings:)","abstract":"

    Start optical sensor PPG (Photoplethysmography) stream. PPG stream is stopped if the connection is closed, error occurs or stream is disposed.

    ","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startOhrPPIStreaming(_:)":{"name":"startOhrPPIStreaming(_:)","abstract":"

    Start OHR (Optical heart rate) PPI (Pulse to Pulse interval) stream.","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOfflineRecordingApi.html#/getAvailableOfflineRecordingDataTypes(_:)":{"name":"getAvailableOfflineRecordingDataTypes(_:)","abstract":"

    Get the data types available in this device for offline recording

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/requestOfflineRecordingSettings(_:feature:)":{"name":"requestOfflineRecordingSettings(_:feature:)","abstract":"

    Request the offline recording settings available in current operation mode. This request shall be used before the offline recording is started","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/requestFullOfflineRecordingSettings(_:feature:)":{"name":"requestFullOfflineRecordingSettings(_:feature:)","abstract":"

    Request all the settings available in the device. The request returns the all capabilities of the requested streaming feature not limited by the current operation mode.

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/getOfflineRecordingStatus(_:)":{"name":"getOfflineRecordingStatus(_:)","abstract":"

    Get status of offline recordings.

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/listOfflineRecordings(_:)":{"name":"listOfflineRecordings(_:)","abstract":"

    List offline recordings stored in the device.

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/getOfflineRecord(_:entry:secret:)":{"name":"getOfflineRecord(_:entry:secret:)","abstract":"

    Fetch recording from the device.

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/removeOfflineRecord(_:entry:)":{"name":"removeOfflineRecord(_:entry:)","abstract":"

    Removes offline recording from the device

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/startOfflineRecording(_:feature:settings:)":{"name":"startOfflineRecording(_:feature:settings:)","abstract":"

    Start offline recording.

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/stopOfflineRecording(_:feature:)":{"name":"stopOfflineRecording(_:feature:)","abstract":"

    Request to stop offline recording.

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarH10OfflineExerciseApi.html#/startRecording(_:exerciseId:interval:sampleType:)":{"name":"startRecording(_:exerciseId:interval:sampleType:)","abstract":"

    Request start recording. Supported only by Polar H10. Requires polarFileTransfer feature.

    ","parent_name":"PolarH10OfflineExerciseApi"},"Protocols/PolarH10OfflineExerciseApi.html#/stopRecording(_:)":{"name":"stopRecording(_:)","abstract":"

    Request stop for current recording. Supported only by Polar H10. Requires polarFileTransfer feature.

    ","parent_name":"PolarH10OfflineExerciseApi"},"Protocols/PolarH10OfflineExerciseApi.html#/requestRecordingStatus(_:)":{"name":"requestRecordingStatus(_:)","abstract":"

    Request current recording status. Supported only by Polar H10. Requires polarFileTransfer feature.

    ","parent_name":"PolarH10OfflineExerciseApi"},"Protocols/PolarH10OfflineExerciseApi.html#/fetchStoredExerciseList(_:)":{"name":"fetchStoredExerciseList(_:)","abstract":"

    Api for fetching stored exercises list from Polar H10 device. Requires polarFileTransfer feature. This API is working for Polar OH1 and Polar Verity Sense devices too, however in those devices recording of exercise requires that sensor is registered to Polar Flow account.

    ","parent_name":"PolarH10OfflineExerciseApi"},"Protocols/PolarH10OfflineExerciseApi.html#/fetchExercise(_:entry:)":{"name":"fetchExercise(_:entry:)","abstract":"

    Api for fetching a single exercise from Polar H10 device. Requires polarFileTransfer feature. This API is working for Polar OH1 and Polar Verity Sense devices too, however in those devices recording of exercise requires that sensor is registered to Polar Flow account.

    ","parent_name":"PolarH10OfflineExerciseApi"},"Protocols/PolarH10OfflineExerciseApi.html#/removeExercise(_:entry:)":{"name":"removeExercise(_:entry:)","abstract":"

    Api for removing single exercise from Polar H10 device. Requires polarFileTransfer feature. This API is working for Polar OH1 and Polar Verity Sense devices too, however in those devices recording of exercise requires that sensor is registered to Polar Flow account.

    ","parent_name":"PolarH10OfflineExerciseApi"},"Protocols/PolarBleApiLogger.html#/message(_:)":{"name":"message(_:)","abstract":"

    log message from sdk

    ","parent_name":"PolarBleApiLogger"},"Protocols/PolarBleApiDeviceFeaturesObserver.html#/bleSdkFeatureReady(_:feature:)":{"name":"bleSdkFeatureReady(_:feature:)","abstract":"

    The feature is available in this device and it is ready. Called only for the features which are specified in [PolarBleApi] construction.

    ","parent_name":"PolarBleApiDeviceFeaturesObserver"},"Protocols/PolarBleApiDeviceInfoObserver.html#/batteryLevelReceived(_:batteryLevel:)":{"name":"batteryLevelReceived(_:batteryLevel:)","abstract":"

    Battery level received from device.

    ","parent_name":"PolarBleApiDeviceInfoObserver"},"Protocols/PolarBleApiDeviceInfoObserver.html#/disInformationReceived(_:uuid:value:)":{"name":"disInformationReceived(_:uuid:value:)","abstract":"

    Received DIS info.

    ","parent_name":"PolarBleApiDeviceInfoObserver"},"Protocols/PolarBleApiPowerStateObserver.html#/blePowerOn()":{"name":"blePowerOn()","abstract":"

    Ble powered on event.

    ","parent_name":"PolarBleApiPowerStateObserver"},"Protocols/PolarBleApiPowerStateObserver.html#/blePowerOff()":{"name":"blePowerOff()","abstract":"

    Ble powered off event, no further actions are needed from the application.

    ","parent_name":"PolarBleApiPowerStateObserver"},"Protocols/PolarBleApiObserver.html#/deviceConnecting(_:)":{"name":"deviceConnecting(_:)","abstract":"

    Callback when connection attempt is started to device

    ","parent_name":"PolarBleApiObserver"},"Protocols/PolarBleApiObserver.html#/deviceConnected(_:)":{"name":"deviceConnected(_:)","abstract":"

    Device connnection has been established.

    ","parent_name":"PolarBleApiObserver"},"Protocols/PolarBleApiObserver.html#/deviceDisconnected(_:)":{"name":"deviceDisconnected(_:)","abstract":"

    Connection lost to device.","parent_name":"PolarBleApiObserver"},"Protocols/PolarBleApi.html#/cleanup()":{"name":"cleanup()","abstract":"

    remove all known devices, which are not in use

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/polarFilter(_:)":{"name":"polarFilter(_:)","abstract":"

    Enable or disable polar filter.

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/startAutoConnectToDevice(_:service:polarDeviceType:)":{"name":"startAutoConnectToDevice(_:service:polarDeviceType:)","abstract":"

    Start connecting to a nearby device. PolarBleApiObservers polarDeviceConnected is","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/connectToDevice(_:)":{"name":"connectToDevice(_:)","abstract":"

    Request a connection to a Polar device. Invokes PolarBleApiObservers polarDeviceConnected.

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/disconnectFromDevice(_:)":{"name":"disconnectFromDevice(_:)","abstract":"

    Disconnect from the current Polar device.

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/searchForDevice()":{"name":"searchForDevice()","abstract":"

    Start searching for Polar device(s)

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/startListenForPolarHrBroadcasts(_:)":{"name":"startListenForPolarHrBroadcasts(_:)","abstract":"

    Start listening to heart rate broadcasts from one or more Polar devices

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/isFeatureReady(_:feature:)":{"name":"isFeatureReady(_:feature:)","abstract":"

    helper to check is feature ready

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/setLocalTime(_:time:zone:)":{"name":"setLocalTime(_:time:zone:)","abstract":"

    Set local time to device. Requires polarFileTransfer feature.

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/getLocalTime(_:)":{"name":"getLocalTime(_:)","abstract":"

    Get current time in device. Requires polarFileTransfer feature. Not supported by Polar H10.

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/observer":{"name":"observer","abstract":"

    Common GAP (Generic access profile) observer

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/deviceInfoObserver":{"name":"deviceInfoObserver","abstract":"

    Device info observer for DIS (Device information service) and BAS (Battery service) GATT (Generic attributes) client

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/powerStateObserver":{"name":"powerStateObserver","abstract":"

    Bluetooth power state observer

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/deviceFeaturesObserver":{"name":"deviceFeaturesObserver","abstract":"

    Device features ready observer

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/isBlePowered":{"name":"isBlePowered","abstract":"

    Helper to check if Ble is currently powered

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/logger":{"name":"logger","abstract":"

    optional logger set to get traces from sdk

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/automaticReconnection":{"name":"automaticReconnection","abstract":"

    optional disable or enable automatic reconnection, by default it is enabled

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html":{"name":"PolarBleApi","abstract":"

    API.

    "},"Protocols/PolarBleApiObserver.html":{"name":"PolarBleApiObserver","abstract":"

    Polar Ble API connection observer.

    "},"Protocols/PolarBleApiPowerStateObserver.html":{"name":"PolarBleApiPowerStateObserver","abstract":"

    Bluetooth state observer.

    "},"Protocols/PolarBleApiDeviceInfoObserver.html":{"name":"PolarBleApiDeviceInfoObserver","abstract":"

    Device info observer.

    "},"Protocols.html#/PolarBleApiDeviceHrObserver":{"name":"PolarBleApiDeviceHrObserver","abstract":"

    Heart rate observer

    "},"Protocols/PolarBleApiDeviceFeaturesObserver.html":{"name":"PolarBleApiDeviceFeaturesObserver","abstract":"

    Data client observer

    "},"Protocols.html#/PolarBleApiSdkModeFeatureObserver":{"name":"PolarBleApiSdkModeFeatureObserver","abstract":"

    SDK Mode observer

    "},"Protocols/PolarBleApiLogger.html":{"name":"PolarBleApiLogger","abstract":"

    logger observer

    "},"Protocols/PolarH10OfflineExerciseApi.html":{"name":"PolarH10OfflineExerciseApi","abstract":"

    H10 Exercise recording API.

    "},"Protocols/PolarOfflineRecordingApi.html":{"name":"PolarOfflineRecordingApi","abstract":"

    Offline recording API.

    "},"Protocols/PolarOnlineStreamingApi.html":{"name":"PolarOnlineStreamingApi","abstract":"

    Online steaming API.

    "},"Protocols/PolarSdkModeApi.html":{"name":"PolarSdkModeApi","abstract":"

    Polar SDK mode API

    "},"Extensions/PrimitiveSequence.html#/asCompletable()":{"name":"asCompletable()","parent_name":"PrimitiveSequence"},"Extensions.html#/PolarBleApiImpl":{"name":"PolarBleApiImpl"},"Extensions/PrimitiveSequence.html":{"name":"PrimitiveSequence"},"Enums/PolarOfflineRecordingData.html#/accOfflineRecordingData(_:startTime:settings:)":{"name":"accOfflineRecordingData(_:startTime:settings:)","parent_name":"PolarOfflineRecordingData"},"Enums/PolarOfflineRecordingData.html#/gyroOfflineRecordingData(_:startTime:settings:)":{"name":"gyroOfflineRecordingData(_:startTime:settings:)","parent_name":"PolarOfflineRecordingData"},"Enums/PolarOfflineRecordingData.html#/magOfflineRecordingData(_:startTime:settings:)":{"name":"magOfflineRecordingData(_:startTime:settings:)","parent_name":"PolarOfflineRecordingData"},"Enums/PolarOfflineRecordingData.html#/ppgOfflineRecordingData(_:startTime:settings:)":{"name":"ppgOfflineRecordingData(_:startTime:settings:)","parent_name":"PolarOfflineRecordingData"},"Enums/PolarOfflineRecordingData.html#/ppiOfflineRecordingData(_:startTime:)":{"name":"ppiOfflineRecordingData(_:startTime:)","parent_name":"PolarOfflineRecordingData"},"Enums/PolarOfflineRecordingData.html#/hrOfflineRecordingData(_:startTime:)":{"name":"hrOfflineRecordingData(_:startTime:)","parent_name":"PolarOfflineRecordingData"},"Enums/PolarErrors.html#/notificationNotEnabled":{"name":"notificationNotEnabled","abstract":"

    GATT characteristic notification not enabled

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/serviceNotFound":{"name":"serviceNotFound","abstract":"

    GATT service not found

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/deviceNotConnected":{"name":"deviceNotConnected","abstract":"

    Device state != Connected

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/deviceNotFound":{"name":"deviceNotFound","abstract":"

    Device not found

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/operationNotSupported":{"name":"operationNotSupported","abstract":"

    Requested operation is not supported

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/messageEncodeFailed":{"name":"messageEncodeFailed","abstract":"

    Google protocol buffers encode failed

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/messageDecodeFailed":{"name":"messageDecodeFailed","abstract":"

    Google protocol buffers decode failed

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/dateTimeFormatFailed(description:)":{"name":"dateTimeFormatFailed(description:)","abstract":"

    String to date time formatting failed

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/unableToStartStreaming":{"name":"unableToStartStreaming","abstract":"

    Failed to start streaming

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/invalidArgument(description:)":{"name":"invalidArgument(description:)","abstract":"

    invalid argument

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/polarBleSdkInternalException(description:)":{"name":"polarBleSdkInternalException(description:)","abstract":"

    Polar BLE SDK internal exception indicating something went wrong in SDK internal logic

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/deviceError(description:)":{"name":"deviceError(description:)","abstract":"

    Error on device operation

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/polarOfflineRecordingError(description:)":{"name":"polarOfflineRecordingError(description:)","abstract":"

    Error related to offline recording

    ","parent_name":"PolarErrors"},"Enums/SampleType.html#/hr":{"name":"hr","abstract":"

    recording type to use is hr in BPM

    ","parent_name":"SampleType"},"Enums/SampleType.html#/rr":{"name":"rr","abstract":"

    recording type to use is rr interval

    ","parent_name":"SampleType"},"Enums/RecordingInterval.html#/interval_1s":{"name":"interval_1s","parent_name":"RecordingInterval"},"Enums/RecordingInterval.html#/interval_5s":{"name":"interval_5s","parent_name":"RecordingInterval"},"Enums/OhrDataType.html#/ppg3_ambient1":{"name":"ppg3_ambient1","abstract":"

    3 ppg + 1 ambient

    ","parent_name":"OhrDataType"},"Enums/OhrDataType.html#/unknown":{"name":"unknown","parent_name":"OhrDataType"},"Enums/PolarBleSdkFeature.html#/feature_hr":{"name":"feature_hr","abstract":"

    Hr feature to receive hr and rr data from Polar or any other BLE device via standard HR BLE service

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_device_info":{"name":"feature_device_info","abstract":"

    Device information feature to receive sw information from Polar or any other BLE device

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_battery_info":{"name":"feature_battery_info","abstract":"

    Feature to receive battery level info from Polar or any other BLE device

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_polar_online_streaming":{"name":"feature_polar_online_streaming","abstract":"

    Polar sensor streaming feature to stream live online data. For example hr, ecg, acc, ppg, ppi, etc…

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_polar_offline_recording":{"name":"feature_polar_offline_recording","abstract":"

    Polar offline recording feature to record offline data to Polar device without continuous BLE connection.

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_polar_h10_exercise_recording":{"name":"feature_polar_h10_exercise_recording","abstract":"

    H10 exercise recording feature to record exercise data to Polar H10 device without continuous BLE connection.

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_polar_device_time_setup":{"name":"feature_polar_device_time_setup","abstract":"

    Feature to read and set device time in Polar device

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_polar_sdk_mode":{"name":"feature_polar_sdk_mode","abstract":"

    In SDK mode the wider range of capabilities are available for the online stream or offline recoding than in normal operation mode.

    ","parent_name":"PolarBleSdkFeature"},"Enums/Features.html#/hr":{"name":"hr","abstract":"

    hr feature enables hr client to receive hr and rr data from device

    ","parent_name":"Features"},"Enums/Features.html#/deviceInfo":{"name":"deviceInfo","abstract":"

    deviceInfo enables dis client to receive fw information from device

    ","parent_name":"Features"},"Enums/Features.html#/batteryStatus":{"name":"batteryStatus","abstract":"

    batteryStatus enables bas client to receive battery level info from device

    ","parent_name":"Features"},"Enums/Features.html#/polarSensorStreaming":{"name":"polarSensorStreaming","abstract":"

    polarSensorStreaming enables stream client to start acc, ppg, ecg, ppi streams

    ","parent_name":"Features"},"Enums/Features.html#/polarFileTransfer":{"name":"polarFileTransfer","abstract":"

    polarFileTransfer enables the listing, read stored exercises and setup of local time to device.","parent_name":"Features"},"Enums/Features.html#/allFeatures":{"name":"allFeatures","abstract":"

    allFeatures enables all features available

    ","parent_name":"Features"},"Enums/PolarDeviceDataType.html#/ecg":{"name":"ecg","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html#/acc":{"name":"acc","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html#/ppg":{"name":"ppg","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html#/ppi":{"name":"ppi","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html#/gyro":{"name":"gyro","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html#/magnetometer":{"name":"magnetometer","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html#/hr":{"name":"hr","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html":{"name":"PolarDeviceDataType","abstract":"

    Data types available in Polar devices for online streaming or offline recording.

    "},"Enums/Features.html":{"name":"Features","abstract":"

    features available

    "},"Enums/PolarBleSdkFeature.html":{"name":"PolarBleSdkFeature","abstract":"

    Features available in Polar BLE SDK library

    "},"Enums/OhrDataType.html":{"name":"OhrDataType","abstract":"

    OHR data source enum

    "},"Enums/RecordingInterval.html":{"name":"RecordingInterval","abstract":"

    Recoding intervals for H10 recording start

    "},"Enums/SampleType.html":{"name":"SampleType","abstract":"

    Sample types for H10 recording start

    "},"Enums/PolarErrors.html":{"name":"PolarErrors","abstract":"

    Polar SDK errors

    "},"Enums/PolarOfflineRecordingData.html":{"name":"PolarOfflineRecordingData"},"Classes/PolarBleApiDefaultImpl.html#/polarImplementation(_:features:)":{"name":"polarImplementation(_:features:)","abstract":"

    New instance of Polar Ble API implementation

    ","parent_name":"PolarBleApiDefaultImpl"},"Classes/PolarBleApiDefaultImpl.html#/versionInfo()":{"name":"versionInfo()","abstract":"

    Return current version

    ","parent_name":"PolarBleApiDefaultImpl"},"Classes/PolarBleApiDefaultImpl.html":{"name":"PolarBleApiDefaultImpl","abstract":"

    Class to provide the default implementation of the Polar Ble API

    "},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Extensions.html":{"name":"Extensions","abstract":"

    The following extensions are available globally.

    "},"Protocols.html":{"name":"Protocols","abstract":"

    The following protocols are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "},"Typealiases.html":{"name":"Type Aliases","abstract":"

    The following type aliases are available globally.

    "}} \ No newline at end of file +{"Typealiases.html#/PolarDeviceInfo":{"name":"PolarDeviceInfo","abstract":"

    Polar device info

    "},"Typealiases.html#/PolarHrBroadcastData":{"name":"PolarHrBroadcastData","abstract":"

    deviceInfo: see #PolarDeviceInfo ,

    "},"Typealiases.html#/PolarHrData":{"name":"PolarHrData","abstract":"

    Polar hr data

    "},"Typealiases.html#/PolarEcgData":{"name":"PolarEcgData","abstract":"

    Polar Ecg data

    "},"Typealiases.html#/PolarAccData":{"name":"PolarAccData","abstract":"

    Polar acc data

    "},"Typealiases.html#/PolarGyroData":{"name":"PolarGyroData","abstract":"

    Polar gyro data

    "},"Typealiases.html#/PolarMagnetometerData":{"name":"PolarMagnetometerData","abstract":"

    Polar magnetometer data

    "},"Typealiases.html#/PolarPpgData":{"name":"PolarPpgData","abstract":"

    Polar PPG data

    "},"Typealiases.html#/PolarPpiData":{"name":"PolarPpiData","abstract":"

    Polar ppi data

    "},"Typealiases.html#/PolarExerciseEntry":{"name":"PolarExerciseEntry","abstract":"

    Polar exercise entry

    "},"Typealiases.html#/PolarExerciseData":{"name":"PolarExerciseData","abstract":"

    Polar Exercise Data

    "},"Typealiases.html#/PolarRecordingStatus":{"name":"PolarRecordingStatus","abstract":"

    Polar Recording status

    "},"Structs/PolarSensorSetting/SettingType.html#/sampleRate":{"name":"sampleRate","abstract":"

    sample rate in hz

    ","parent_name":"SettingType"},"Structs/PolarSensorSetting/SettingType.html#/resolution":{"name":"resolution","abstract":"

    resolution in bits

    ","parent_name":"SettingType"},"Structs/PolarSensorSetting/SettingType.html#/range":{"name":"range","abstract":"

    range

    ","parent_name":"SettingType"},"Structs/PolarSensorSetting/SettingType.html#/rangeMilliunit":{"name":"rangeMilliunit","abstract":"

    range with min and max allowed values

    ","parent_name":"SettingType"},"Structs/PolarSensorSetting/SettingType.html#/channels":{"name":"channels","abstract":"

    amount of channels available

    ","parent_name":"SettingType"},"Structs/PolarSensorSetting/SettingType.html#/unknown":{"name":"unknown","abstract":"

    type is unknown

    ","parent_name":"SettingType"},"Structs/PolarSensorSetting/SettingType.html":{"name":"SettingType","abstract":"

    settings type

    ","parent_name":"PolarSensorSetting"},"Structs/PolarSensorSetting.html#/settings":{"name":"settings","abstract":"

    current settings available / set

    ","parent_name":"PolarSensorSetting"},"Structs/PolarSensorSetting.html#/init(_:)":{"name":"init(_:)","abstract":"

    constructor with desired settings

    ","parent_name":"PolarSensorSetting"},"Structs/PolarSensorSetting.html#/maxSettings()":{"name":"maxSettings()","abstract":"

    helper to retrieve max settings available

    ","parent_name":"PolarSensorSetting"},"Structs/PolarSensorSetting.html#/description":{"name":"description","parent_name":"PolarSensorSetting"},"Structs/PolarRecordingSecret.html#/init(key:)":{"name":"init(key:)","parent_name":"PolarRecordingSecret"},"Structs/PolarOfflineRecordingEntry.html#/path":{"name":"path","abstract":"

    Recording entry path in device.

    ","parent_name":"PolarOfflineRecordingEntry"},"Structs/PolarOfflineRecordingEntry.html#/size":{"name":"size","abstract":"

    Recording size in bytes.

    ","parent_name":"PolarOfflineRecordingEntry"},"Structs/PolarOfflineRecordingEntry.html#/date":{"name":"date","abstract":"

    The date and time of the recording entry i.e. the moment recording is started

    ","parent_name":"PolarOfflineRecordingEntry"},"Structs/PolarOfflineRecordingEntry.html#/type":{"name":"type","abstract":"

    data type of the recording

    ","parent_name":"PolarOfflineRecordingEntry"},"Structs/PolarOfflineRecordingEntry.html#/init(path:size:date:type:)":{"name":"init(path:size:date:type:)","parent_name":"PolarOfflineRecordingEntry"},"Structs/PolarOfflineRecordingEntry.html":{"name":"PolarOfflineRecordingEntry","abstract":"

    Polar offline recording entry container.

    "},"Structs/PolarRecordingSecret.html":{"name":"PolarRecordingSecret","abstract":"

    Polar recording secret is used to encrypt the recording.

    "},"Structs/PolarSensorSetting.html":{"name":"PolarSensorSetting","abstract":"

    polar sensor settings class

    "},"Protocols/PolarSdkModeApi.html#/enableSDKMode(_:)":{"name":"enableSDKMode(_:)","abstract":"

    Enables SDK mode.

    ","parent_name":"PolarSdkModeApi"},"Protocols/PolarSdkModeApi.html#/disableSDKMode(_:)":{"name":"disableSDKMode(_:)","abstract":"

    Disables SDK mode.

    ","parent_name":"PolarSdkModeApi"},"Protocols/PolarSdkModeApi.html#/isSDKModeEnabled(_:)":{"name":"isSDKModeEnabled(_:)","abstract":"

    Check if SDK mode currently enabled.

    ","parent_name":"PolarSdkModeApi"},"Protocols/PolarOnlineStreamingApi.html#/getAvailableOnlineStreamDataTypes(_:)":{"name":"getAvailableOnlineStreamDataTypes(_:)","abstract":"

    Get the data types available in this device for online streaming

    ","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/requestStreamSettings(_:feature:)":{"name":"requestStreamSettings(_:feature:)","abstract":"

    Request the stream settings available in current operation mode. This request shall be used before the stream is started","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/requestFullStreamSettings(_:feature:)":{"name":"requestFullStreamSettings(_:feature:)","abstract":"

    Request full steam settings capabilities. The request returns the all capabilities of the requested streaming feature not limited by the current operation mode.","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startHrStreaming(_:)":{"name":"startHrStreaming(_:)","abstract":"

    Start heart rate stream. Heart rate stream is stopped if the connection is closed,","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startEcgStreaming(_:settings:)":{"name":"startEcgStreaming(_:settings:)","abstract":"

    Start the ECG (Electrocardiography) stream. ECG stream is stopped if the connection is closed, error occurs or stream is disposed.

    ","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startAccStreaming(_:settings:)":{"name":"startAccStreaming(_:settings:)","abstract":"

    Start ACC (Accelerometer) stream. ACC stream is stopped if the connection is closed, error occurs or stream is disposed.

    ","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startGyroStreaming(_:settings:)":{"name":"startGyroStreaming(_:settings:)","abstract":"

    Start Gyro stream. Gyro stream is stopped if the connection is closed, error occurs during start or stream is disposed.

    ","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startMagnetometerStreaming(_:settings:)":{"name":"startMagnetometerStreaming(_:settings:)","abstract":"

    Start magnetometer stream. Magnetometer stream is stopped if the connection is closed, error occurs or stream is disposed.

    ","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startPpgStreaming(_:settings:)":{"name":"startPpgStreaming(_:settings:)","abstract":"

    Start optical sensor PPG (Photoplethysmography) stream. PPG stream is stopped if the connection is closed, error occurs or stream is disposed.

    ","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOnlineStreamingApi.html#/startOhrPPIStreaming(_:)":{"name":"startOhrPPIStreaming(_:)","abstract":"

    Start OHR (Optical heart rate) PPI (Pulse to Pulse interval) stream.","parent_name":"PolarOnlineStreamingApi"},"Protocols/PolarOfflineRecordingApi.html#/getAvailableOfflineRecordingDataTypes(_:)":{"name":"getAvailableOfflineRecordingDataTypes(_:)","abstract":"

    Get the data types available in this device for offline recording

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/requestOfflineRecordingSettings(_:feature:)":{"name":"requestOfflineRecordingSettings(_:feature:)","abstract":"

    Request the offline recording settings available in current operation mode. This request shall be used before the offline recording is started","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/requestFullOfflineRecordingSettings(_:feature:)":{"name":"requestFullOfflineRecordingSettings(_:feature:)","abstract":"

    Request all the settings available in the device. The request returns the all capabilities of the requested streaming feature not limited by the current operation mode.

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/getOfflineRecordingStatus(_:)":{"name":"getOfflineRecordingStatus(_:)","abstract":"

    Get status of offline recordings.

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/listOfflineRecordings(_:)":{"name":"listOfflineRecordings(_:)","abstract":"

    List offline recordings stored in the device.

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/getOfflineRecord(_:entry:secret:)":{"name":"getOfflineRecord(_:entry:secret:)","abstract":"

    Fetch recording from the device.

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/removeOfflineRecord(_:entry:)":{"name":"removeOfflineRecord(_:entry:)","abstract":"

    Removes offline recording from the device

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/startOfflineRecording(_:feature:settings:secret:)":{"name":"startOfflineRecording(_:feature:settings:secret:)","abstract":"

    Start offline recording.

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarOfflineRecordingApi.html#/stopOfflineRecording(_:feature:)":{"name":"stopOfflineRecording(_:feature:)","abstract":"

    Request to stop offline recording.

    ","parent_name":"PolarOfflineRecordingApi"},"Protocols/PolarH10OfflineExerciseApi.html#/startRecording(_:exerciseId:interval:sampleType:)":{"name":"startRecording(_:exerciseId:interval:sampleType:)","abstract":"

    Request start recording. Supported only by Polar H10. Requires polarFileTransfer feature.

    ","parent_name":"PolarH10OfflineExerciseApi"},"Protocols/PolarH10OfflineExerciseApi.html#/stopRecording(_:)":{"name":"stopRecording(_:)","abstract":"

    Request stop for current recording. Supported only by Polar H10. Requires polarFileTransfer feature.

    ","parent_name":"PolarH10OfflineExerciseApi"},"Protocols/PolarH10OfflineExerciseApi.html#/requestRecordingStatus(_:)":{"name":"requestRecordingStatus(_:)","abstract":"

    Request current recording status. Supported only by Polar H10. Requires polarFileTransfer feature.

    ","parent_name":"PolarH10OfflineExerciseApi"},"Protocols/PolarH10OfflineExerciseApi.html#/fetchStoredExerciseList(_:)":{"name":"fetchStoredExerciseList(_:)","abstract":"

    Api for fetching stored exercises list from Polar H10 device. Requires polarFileTransfer feature. This API is working for Polar OH1 and Polar Verity Sense devices too, however in those devices recording of exercise requires that sensor is registered to Polar Flow account.

    ","parent_name":"PolarH10OfflineExerciseApi"},"Protocols/PolarH10OfflineExerciseApi.html#/fetchExercise(_:entry:)":{"name":"fetchExercise(_:entry:)","abstract":"

    Api for fetching a single exercise from Polar H10 device. Requires polarFileTransfer feature. This API is working for Polar OH1 and Polar Verity Sense devices too, however in those devices recording of exercise requires that sensor is registered to Polar Flow account.

    ","parent_name":"PolarH10OfflineExerciseApi"},"Protocols/PolarH10OfflineExerciseApi.html#/removeExercise(_:entry:)":{"name":"removeExercise(_:entry:)","abstract":"

    Api for removing single exercise from Polar H10 device. Requires polarFileTransfer feature. This API is working for Polar OH1 and Polar Verity Sense devices too, however in those devices recording of exercise requires that sensor is registered to Polar Flow account.

    ","parent_name":"PolarH10OfflineExerciseApi"},"Protocols/PolarBleApiLogger.html#/message(_:)":{"name":"message(_:)","abstract":"

    log message from sdk

    ","parent_name":"PolarBleApiLogger"},"Protocols/PolarBleApiDeviceFeaturesObserver.html#/bleSdkFeatureReady(_:feature:)":{"name":"bleSdkFeatureReady(_:feature:)","abstract":"

    The feature is available in this device and it is ready. Called only for the features which are specified in [PolarBleApi] construction.

    ","parent_name":"PolarBleApiDeviceFeaturesObserver"},"Protocols/PolarBleApiDeviceInfoObserver.html#/batteryLevelReceived(_:batteryLevel:)":{"name":"batteryLevelReceived(_:batteryLevel:)","abstract":"

    Battery level received from device.

    ","parent_name":"PolarBleApiDeviceInfoObserver"},"Protocols/PolarBleApiDeviceInfoObserver.html#/disInformationReceived(_:uuid:value:)":{"name":"disInformationReceived(_:uuid:value:)","abstract":"

    Received DIS info.

    ","parent_name":"PolarBleApiDeviceInfoObserver"},"Protocols/PolarBleApiPowerStateObserver.html#/blePowerOn()":{"name":"blePowerOn()","abstract":"

    Ble powered on event.

    ","parent_name":"PolarBleApiPowerStateObserver"},"Protocols/PolarBleApiPowerStateObserver.html#/blePowerOff()":{"name":"blePowerOff()","abstract":"

    Ble powered off event, no further actions are needed from the application.

    ","parent_name":"PolarBleApiPowerStateObserver"},"Protocols/PolarBleApiObserver.html#/deviceConnecting(_:)":{"name":"deviceConnecting(_:)","abstract":"

    Callback when connection attempt is started to device

    ","parent_name":"PolarBleApiObserver"},"Protocols/PolarBleApiObserver.html#/deviceConnected(_:)":{"name":"deviceConnected(_:)","abstract":"

    Device connnection has been established.

    ","parent_name":"PolarBleApiObserver"},"Protocols/PolarBleApiObserver.html#/deviceDisconnected(_:)":{"name":"deviceDisconnected(_:)","abstract":"

    Connection lost to device.","parent_name":"PolarBleApiObserver"},"Protocols/PolarBleApi.html#/cleanup()":{"name":"cleanup()","abstract":"

    remove all known devices, which are not in use

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/polarFilter(_:)":{"name":"polarFilter(_:)","abstract":"

    Enable or disable polar filter.

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/startAutoConnectToDevice(_:service:polarDeviceType:)":{"name":"startAutoConnectToDevice(_:service:polarDeviceType:)","abstract":"

    Start connecting to a nearby device. PolarBleApiObservers polarDeviceConnected is","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/connectToDevice(_:)":{"name":"connectToDevice(_:)","abstract":"

    Request a connection to a Polar device. Invokes PolarBleApiObservers polarDeviceConnected.

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/disconnectFromDevice(_:)":{"name":"disconnectFromDevice(_:)","abstract":"

    Disconnect from the current Polar device.

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/searchForDevice()":{"name":"searchForDevice()","abstract":"

    Start searching for Polar device(s)

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/startListenForPolarHrBroadcasts(_:)":{"name":"startListenForPolarHrBroadcasts(_:)","abstract":"

    Start listening the heart rate from Polar devices when subscribed.","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/isFeatureReady(_:feature:)":{"name":"isFeatureReady(_:feature:)","abstract":"

    helper to check is feature ready

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/setLocalTime(_:time:zone:)":{"name":"setLocalTime(_:time:zone:)","abstract":"

    Set local time to device. Requires polarFileTransfer feature.

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/getLocalTime(_:)":{"name":"getLocalTime(_:)","abstract":"

    Get current time in device. Requires polarFileTransfer feature. Not supported by Polar H10.

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/observer":{"name":"observer","abstract":"

    Common GAP (Generic access profile) observer

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/deviceInfoObserver":{"name":"deviceInfoObserver","abstract":"

    Device info observer for DIS (Device information service) and BAS (Battery service) GATT (Generic attributes) client

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/powerStateObserver":{"name":"powerStateObserver","abstract":"

    Bluetooth power state observer

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/deviceFeaturesObserver":{"name":"deviceFeaturesObserver","abstract":"

    Device features ready observer

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/isBlePowered":{"name":"isBlePowered","abstract":"

    Helper to check if Ble is currently powered

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/logger":{"name":"logger","abstract":"

    optional logger set to get traces from sdk

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html#/automaticReconnection":{"name":"automaticReconnection","abstract":"

    optional disable or enable automatic reconnection, by default it is enabled

    ","parent_name":"PolarBleApi"},"Protocols/PolarBleApi.html":{"name":"PolarBleApi","abstract":"

    API.

    "},"Protocols/PolarBleApiObserver.html":{"name":"PolarBleApiObserver","abstract":"

    Polar Ble API connection observer.

    "},"Protocols/PolarBleApiPowerStateObserver.html":{"name":"PolarBleApiPowerStateObserver","abstract":"

    Bluetooth state observer.

    "},"Protocols/PolarBleApiDeviceInfoObserver.html":{"name":"PolarBleApiDeviceInfoObserver","abstract":"

    Device info observer.

    "},"Protocols.html#/PolarBleApiDeviceHrObserver":{"name":"PolarBleApiDeviceHrObserver","abstract":"

    Heart rate observer

    "},"Protocols/PolarBleApiDeviceFeaturesObserver.html":{"name":"PolarBleApiDeviceFeaturesObserver","abstract":"

    Data client observer

    "},"Protocols.html#/PolarBleApiSdkModeFeatureObserver":{"name":"PolarBleApiSdkModeFeatureObserver","abstract":"

    SDK Mode observer

    "},"Protocols/PolarBleApiLogger.html":{"name":"PolarBleApiLogger","abstract":"

    logger observer

    "},"Protocols/PolarH10OfflineExerciseApi.html":{"name":"PolarH10OfflineExerciseApi","abstract":"

    H10 Exercise recording API.

    "},"Protocols/PolarOfflineRecordingApi.html":{"name":"PolarOfflineRecordingApi","abstract":"

    Offline recording API.

    "},"Protocols/PolarOnlineStreamingApi.html":{"name":"PolarOnlineStreamingApi","abstract":"

    Online steaming API.

    "},"Protocols/PolarSdkModeApi.html":{"name":"PolarSdkModeApi","abstract":"

    Polar SDK mode API

    "},"Extensions/PrimitiveSequence.html#/asCompletable()":{"name":"asCompletable()","parent_name":"PrimitiveSequence"},"Extensions.html#/PolarBleApiImpl":{"name":"PolarBleApiImpl"},"Extensions/PrimitiveSequence.html":{"name":"PrimitiveSequence"},"Enums/PolarOfflineRecordingData.html#/accOfflineRecordingData(_:startTime:settings:)":{"name":"accOfflineRecordingData(_:startTime:settings:)","parent_name":"PolarOfflineRecordingData"},"Enums/PolarOfflineRecordingData.html#/gyroOfflineRecordingData(_:startTime:settings:)":{"name":"gyroOfflineRecordingData(_:startTime:settings:)","parent_name":"PolarOfflineRecordingData"},"Enums/PolarOfflineRecordingData.html#/magOfflineRecordingData(_:startTime:settings:)":{"name":"magOfflineRecordingData(_:startTime:settings:)","parent_name":"PolarOfflineRecordingData"},"Enums/PolarOfflineRecordingData.html#/ppgOfflineRecordingData(_:startTime:settings:)":{"name":"ppgOfflineRecordingData(_:startTime:settings:)","parent_name":"PolarOfflineRecordingData"},"Enums/PolarOfflineRecordingData.html#/ppiOfflineRecordingData(_:startTime:)":{"name":"ppiOfflineRecordingData(_:startTime:)","parent_name":"PolarOfflineRecordingData"},"Enums/PolarOfflineRecordingData.html#/hrOfflineRecordingData(_:startTime:)":{"name":"hrOfflineRecordingData(_:startTime:)","parent_name":"PolarOfflineRecordingData"},"Enums/PolarErrors.html#/notificationNotEnabled":{"name":"notificationNotEnabled","abstract":"

    GATT characteristic notification not enabled

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/serviceNotFound":{"name":"serviceNotFound","abstract":"

    GATT service not found

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/deviceNotConnected":{"name":"deviceNotConnected","abstract":"

    Device state != Connected

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/deviceNotFound":{"name":"deviceNotFound","abstract":"

    Device not found

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/operationNotSupported":{"name":"operationNotSupported","abstract":"

    Requested operation is not supported

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/messageEncodeFailed":{"name":"messageEncodeFailed","abstract":"

    Google protocol buffers encode failed

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/messageDecodeFailed":{"name":"messageDecodeFailed","abstract":"

    Google protocol buffers decode failed

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/dateTimeFormatFailed(description:)":{"name":"dateTimeFormatFailed(description:)","abstract":"

    String to date time formatting failed

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/unableToStartStreaming":{"name":"unableToStartStreaming","abstract":"

    Failed to start streaming

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/invalidArgument(description:)":{"name":"invalidArgument(description:)","abstract":"

    invalid argument

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/polarBleSdkInternalException(description:)":{"name":"polarBleSdkInternalException(description:)","abstract":"

    Polar BLE SDK internal exception indicating something went wrong in SDK internal logic

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/deviceError(description:)":{"name":"deviceError(description:)","abstract":"

    Error on device operation

    ","parent_name":"PolarErrors"},"Enums/PolarErrors.html#/polarOfflineRecordingError(description:)":{"name":"polarOfflineRecordingError(description:)","abstract":"

    Error related to offline recording

    ","parent_name":"PolarErrors"},"Enums/SampleType.html#/hr":{"name":"hr","abstract":"

    recording type to use is hr in BPM

    ","parent_name":"SampleType"},"Enums/SampleType.html#/rr":{"name":"rr","abstract":"

    recording type to use is rr interval

    ","parent_name":"SampleType"},"Enums/RecordingInterval.html#/interval_1s":{"name":"interval_1s","parent_name":"RecordingInterval"},"Enums/RecordingInterval.html#/interval_5s":{"name":"interval_5s","parent_name":"RecordingInterval"},"Enums/PpgDataType.html#/ppg3_ambient1":{"name":"ppg3_ambient1","abstract":"

    3 ppg + 1 ambient

    ","parent_name":"PpgDataType"},"Enums/PpgDataType.html#/unknown":{"name":"unknown","parent_name":"PpgDataType"},"Enums/PolarBleSdkFeature.html#/feature_hr":{"name":"feature_hr","abstract":"

    Hr feature to receive hr and rr data from Polar or any other BLE device via standard HR BLE service

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_device_info":{"name":"feature_device_info","abstract":"

    Device information feature to receive sw information from Polar or any other BLE device

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_battery_info":{"name":"feature_battery_info","abstract":"

    Feature to receive battery level info from Polar or any other BLE device

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_polar_online_streaming":{"name":"feature_polar_online_streaming","abstract":"

    Polar sensor streaming feature to stream live online data. For example hr, ecg, acc, ppg, ppi, etc…

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_polar_offline_recording":{"name":"feature_polar_offline_recording","abstract":"

    Polar offline recording feature to record offline data to Polar device without continuous BLE connection.

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_polar_h10_exercise_recording":{"name":"feature_polar_h10_exercise_recording","abstract":"

    H10 exercise recording feature to record exercise data to Polar H10 device without continuous BLE connection.

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_polar_device_time_setup":{"name":"feature_polar_device_time_setup","abstract":"

    Feature to read and set device time in Polar device

    ","parent_name":"PolarBleSdkFeature"},"Enums/PolarBleSdkFeature.html#/feature_polar_sdk_mode":{"name":"feature_polar_sdk_mode","abstract":"

    In SDK mode the wider range of capabilities are available for the online stream or offline recoding than in normal operation mode.

    ","parent_name":"PolarBleSdkFeature"},"Enums/Features.html#/hr":{"name":"hr","abstract":"

    hr feature enables hr client to receive hr and rr data from device

    ","parent_name":"Features"},"Enums/Features.html#/deviceInfo":{"name":"deviceInfo","abstract":"

    deviceInfo enables dis client to receive fw information from device

    ","parent_name":"Features"},"Enums/Features.html#/batteryStatus":{"name":"batteryStatus","abstract":"

    batteryStatus enables bas client to receive battery level info from device

    ","parent_name":"Features"},"Enums/Features.html#/polarSensorStreaming":{"name":"polarSensorStreaming","abstract":"

    polarSensorStreaming enables stream client to start acc, ppg, ecg, ppi streams

    ","parent_name":"Features"},"Enums/Features.html#/polarFileTransfer":{"name":"polarFileTransfer","abstract":"

    polarFileTransfer enables the listing, read stored exercises and setup of local time to device.","parent_name":"Features"},"Enums/Features.html#/allFeatures":{"name":"allFeatures","abstract":"

    allFeatures enables all features available

    ","parent_name":"Features"},"Enums/PolarDeviceDataType.html#/ecg":{"name":"ecg","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html#/acc":{"name":"acc","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html#/ppg":{"name":"ppg","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html#/ppi":{"name":"ppi","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html#/gyro":{"name":"gyro","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html#/magnetometer":{"name":"magnetometer","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html#/hr":{"name":"hr","parent_name":"PolarDeviceDataType"},"Enums/PolarDeviceDataType.html":{"name":"PolarDeviceDataType","abstract":"

    Data types available in Polar devices for online streaming or offline recording.

    "},"Enums/Features.html":{"name":"Features","abstract":"

    features available

    "},"Enums/PolarBleSdkFeature.html":{"name":"PolarBleSdkFeature","abstract":"

    Features available in Polar BLE SDK library

    "},"Enums/PpgDataType.html":{"name":"PpgDataType","abstract":"

    PPG data source enum

    "},"Enums/RecordingInterval.html":{"name":"RecordingInterval","abstract":"

    Recoding intervals for H10 recording start

    "},"Enums/SampleType.html":{"name":"SampleType","abstract":"

    Sample types for H10 recording start

    "},"Enums/PolarErrors.html":{"name":"PolarErrors","abstract":"

    Polar SDK errors

    "},"Enums/PolarOfflineRecordingData.html":{"name":"PolarOfflineRecordingData"},"Classes/PolarBleApiDefaultImpl.html#/polarImplementation(_:features:)":{"name":"polarImplementation(_:features:)","abstract":"

    New instance of Polar Ble API implementation

    ","parent_name":"PolarBleApiDefaultImpl"},"Classes/PolarBleApiDefaultImpl.html#/versionInfo()":{"name":"versionInfo()","abstract":"

    Return current version

    ","parent_name":"PolarBleApiDefaultImpl"},"Classes/PolarBleApiDefaultImpl.html":{"name":"PolarBleApiDefaultImpl","abstract":"

    Class to provide the default implementation of the Polar Ble API

    "},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Extensions.html":{"name":"Extensions","abstract":"

    The following extensions are available globally.

    "},"Protocols.html":{"name":"Protocols","abstract":"

    The following protocols are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "},"Typealiases.html":{"name":"Type Aliases","abstract":"

    The following type aliases are available globally.

    "}} \ No newline at end of file diff --git a/sources/Android/android-communications/library/src/sdk/java/com/polar/sdk/api/PolarBleApi.kt b/sources/Android/android-communications/library/src/sdk/java/com/polar/sdk/api/PolarBleApi.kt index c0a737bb..eee489de 100644 --- a/sources/Android/android-communications/library/src/sdk/java/com/polar/sdk/api/PolarBleApi.kt +++ b/sources/Android/android-communications/library/src/sdk/java/com/polar/sdk/api/PolarBleApi.kt @@ -219,8 +219,8 @@ abstract class PolarBleApi(val features: Set) : PolarOnlineS /** * Start listening the heart rate from Polar devices when subscribed. This observable listens BLE - * broadcast and parses heart rate from BLE broadcast. The BLE device is not connected when - * using this function. + * broadcast and parses heart rate from BLE broadcast. The BLE device don't need to be connected when + * using this function, the heart rate is parsed from the BLE advertisement * * @param deviceIds set of Polar device ids to filter or null for a any Polar device * @return Flowable stream of [PolarHrBroadcastData] diff --git a/sources/Android/android-communications/library/src/sdk/java/com/polar/sdk/api/PolarBleApiDefaultImpl.kt b/sources/Android/android-communications/library/src/sdk/java/com/polar/sdk/api/PolarBleApiDefaultImpl.kt index 36eb1e80..fabd24cb 100644 --- a/sources/Android/android-communications/library/src/sdk/java/com/polar/sdk/api/PolarBleApiDefaultImpl.kt +++ b/sources/Android/android-communications/library/src/sdk/java/com/polar/sdk/api/PolarBleApiDefaultImpl.kt @@ -25,6 +25,6 @@ object PolarBleApiDefaultImpl { */ @JvmStatic fun versionInfo(): String { - return "5.0.0-beta1" + return "5.0.0-beta2" } } \ No newline at end of file diff --git a/sources/Android/android-communications/library/src/sdk/java/com/polar/sdk/api/PolarH10OfflineExerciseApi.kt b/sources/Android/android-communications/library/src/sdk/java/com/polar/sdk/api/PolarH10OfflineExerciseApi.kt index 72846fbe..a79aa2b5 100644 --- a/sources/Android/android-communications/library/src/sdk/java/com/polar/sdk/api/PolarH10OfflineExerciseApi.kt +++ b/sources/Android/android-communications/library/src/sdk/java/com/polar/sdk/api/PolarH10OfflineExerciseApi.kt @@ -20,7 +20,6 @@ import io.reactivex.rxjava3.core.Single * * Note, API is working only with Polar H10 device */ - interface PolarH10OfflineExerciseApi { /** diff --git a/sources/iOS/ios-communications/Sources/PolarBleSdk/sdk/api/PolarBleApiDefaultImpl.swift b/sources/iOS/ios-communications/Sources/PolarBleSdk/sdk/api/PolarBleApiDefaultImpl.swift index 2395cf30..331bfee5 100644 --- a/sources/iOS/ios-communications/Sources/PolarBleSdk/sdk/api/PolarBleApiDefaultImpl.swift +++ b/sources/iOS/ios-communications/Sources/PolarBleSdk/sdk/api/PolarBleApiDefaultImpl.swift @@ -18,6 +18,6 @@ public class PolarBleApiDefaultImpl { /// /// - Returns: version in format major.minor.patch public static func versionInfo() -> String { - return "5.0.0-beta1" + return "5.0.0-beta2" } }