Protocols
The following protocols are available globally.
-
Protocol defining methods to get steps for a given period.
See moreDeclaration
Swift
public protocol PolarActivityApi -
API.
See moreDeclaration
Swift
public protocol PolarBleApi : PolarActivityApi, PolarBleLowLevelApi, PolarDeviceToHostNotificationsApi, PolarFirmwareUpdateApi, PolarH10OfflineExerciseApi, PolarOfflineExerciseV2Api, PolarOfflineRecordingApi, PolarOnlineStreamingApi, PolarRestServiceApi, PolarSdkModeApi, PolarSleepApi, PolarTemperatureApi, PolarTrainingSessionApi -
Polar Ble API connection observer.
See moreDeclaration
Swift
public protocol PolarBleApiObserver : AnyObject -
Bluetooth state observer.
See moreDeclaration
Swift
public protocol PolarBleApiPowerStateObserver : AnyObject -
Device info observer.
See moreDeclaration
Swift
public protocol PolarBleApiDeviceInfoObserver : AnyObject -
Heart rate observer
See moreDeclaration
Swift
public protocol PolarBleApiDeviceHrObserver : AnyObject -
Data client observer
See moreDeclaration
Swift
public protocol PolarBleApiDeviceFeaturesObserver : AnyObject -
logger observer
See moreDeclaration
Swift
public protocol PolarBleApiLogger : AnyObject -
Undocumented
See moreDeclaration
Swift
public protocol PolarBleLowLevelApi -
Device to host notifications. Device notifications are used to inform client apps of important device state changes, such as negotiating data syncing.
See moreDeclaration
Swift
public protocol PolarDeviceToHostNotificationsApi -
Undocumented
See moreDeclaration
Swift
public protocol PolarFirmwareUpdateApi -
H10 Exercise recording API.
H10 Exercise recording makes it possible to record Hr or Rr data to H10 device memory. With H10 Exercise recording the H10 and phone don’t need to be connected all the time, as H10 exercise recording continues in Polar device even the BLE disconnects.
Requires
Requires SDK feature(s):PolarBleSdkFeature.feature_polar_h10_exercise_recordingNote, API is working only with Polar H10 device
See moreDeclaration
Swift
public protocol PolarH10OfflineExerciseApi -
Offline Exercise V2 API.
Allows managing offline exercise sessions on supported Polar devices. This API supports devices that use the Data Merge protocol for offline exercise recording, enabling recording of exercise data even when the device is not connected.
All methods require the SDK feature
PolarBleSdkFeature.FEATURE_POLAR_OFFLINE_EXERCISE_V2and the device must have thedm_exercisecapability.All operations are asynchronous and return RxSwift primitives.
See moreDeclaration
Swift
public protocol PolarOfflineExerciseV2Api -
Offline recording API.
Offline recording makes it possible to record
PolarBleApi.PolarDeviceDataTypedata to device memory. With Offline recording the Polar device and phone don’t need to be connected all the time, as offline recording continues in Polar device even the BLE disconnects.Offline records saved into the device can be encrypted. The
PolarRecordingSecretis provided forstartOfflineRecordingandsetOfflineRecordingTriggerwhen encryption is wanted. ThePolarRecordingSecretwith same key must be provided ingetOfflineRecordto correctly decrypt the data in the device.Requires
Requires SDK feature(s):PolarBleSdkFeature.feature_polar_offline_recordingNote, offline recording is supported in Polar Verity Sense device (starting from firmware version 2.1.0)
See moreDeclaration
Swift
public protocol PolarOfflineRecordingApi -
Online steaming API.
Online streaming makes it possible to stream live online data from Polar device.
See moreRequires
Requires SDK feature(s):PolarBleSdkFeature.feature_polar_online_streamingorPolarBleSdkFeature.feature_hrDeclaration
Swift
public protocol PolarOnlineStreamingApi -
Polar SDK mode API
In SDK mode the wider range of capabilities is available for the online streaming or for the offline recording than in normal operation mode. The available capabilities can be asked from device using
PolarOnlineStreamingApi.requestFullStreamSettingsorPolarOfflineRecordingApi.requestFullOfflineRecordingSettingsRequires
Requires SDK feature(s):PolarBleSdkFeature.feature_polar_sdk_modeNote, SDK mode supported by VeritySense starting from firmware 1.1.5
See moreDeclaration
Swift
public protocol PolarSdkModeApi -
Protocol defining methods to get Polar Sleep Data
See moreDeclaration
Swift
public protocol PolarSleepApi -
Polar temperature API.
See moreRequires
Requires SDK feature(s):PolarBleSdkFeature.feature_polar_temperature_dataDeclaration
Swift
public protocol PolarTemperatureApi -
Protocol defining methods to access training session data.
See moreDeclaration
Swift
public protocol PolarTrainingSessionApi -
Methods related to working with services conforming to SAGRFC95 Service discovery over PFTP
See moreDeclaration
Swift
public protocol PolarRestServiceApi
Protocols Reference