PolarBleApi Protocol Reference


                    
                    
                    cleanup()

remove all known devices, which are not in use

Requires

Requires SDK feature(s): None (core API).

Declaration

Swift

func cleanup()


                    
                    
                    polarFilter(_:)

Enable or disable polar filter.

Requires

Requires SDK feature(s): None (core API).

Declaration

Swift

func polarFilter(_ enable: Bool)

Parameters


                                enable

false disable polar filter


                    
                    
                    startAutoConnectToDevice(_:service:polarDeviceType:)

Start connecting to a nearby device. PolarBleApiObservers polarDeviceConnected is invoked when a connection is established.

Requires

Requires SDK feature(s): None (core API).

Declaration

Swift

func startAutoConnectToDevice(_ rssi: Int, service: CBUUID?, polarDeviceType: String?) -> Completable

Parameters

`rssi`	(Received Signal Strength Indicator) value is typically between -40 to -55 dBm.
`service`	optional service to contain in device advertisement prior to connection attempt
`polarDeviceType`	like H10, OH1 etc… or nil for any polar device

Return Value

Completable. Complete called when scan for nearby device has ended and connection attempt is started and deviceConnecting callback will be invoked.


                    
                    
                    connectToDevice(_:)

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

Requires

Requires SDK feature(s): None (core API).

Throws

InvalidArgument if identifier is invalid polar device id or invalid uuid

Declaration

Swift

func connectToDevice(_ identifier: String) throws

Parameters


                                identifier

Polar device id printed on the sensor/device or UUID.


                    
                    
                    disconnectFromDevice(_:)

Disconnect from the current Polar device.

Requires

Requires SDK feature(s): None (core API).

Throws

InvalidArgument if identifier is invalid polar device id or invalid uuid

Declaration

Swift

func disconnectFromDevice(_ identifier: String) throws

Parameters


                                identifier

Polar device id


                    
                    
                    searchForDevice()

Start searching for Polar device(s)

Requires

Requires SDK feature(s): None (core API).

Declaration

Swift

func searchForDevice() -> Observable<PolarDeviceInfo>

Parameters


                                onNext

for every new Polar device found

Return Value

Observable stream

onNext: for every new Polar device found


                    
                    
                    searchForDevice(withRequiredDeviceNamePrefix:)

Start searching for compatible device(s) with given device name prefix

Requires

Requires SDK feature(s): None (core API).

Declaration

Swift

func searchForDevice(withRequiredDeviceNamePrefix: String?) -> Observable<PolarDeviceInfo>

Parameters


                                requiredDeviceNamePrefix

returned devices are filtered based on given device name prefix string. Default: “Polar”

Return Value

Observable stream

onNext: for every new device found


                    
                    
                    startListenForPolarHrBroadcasts(_:)

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

Requires

Requires SDK feature(s): None (core API).

Declaration

Swift

func startListenForPolarHrBroadcasts(_ identifiers: Set<String>?) -> Observable<PolarHrBroadcastData>

Parameters


                                identifiers

set of Polar device ids to filter or null for a any Polar device

Return Value

Observable stream


                    
                    
                    isFeatureReady(_:feature:)

Check if the feature is ready.

Requires

Requires SDK feature(s): None (core API).

Declaration

Swift

func isFeatureReady(_ identifier: String, feature: PolarBleSdkFeature) -> Bool

Parameters

`identifier`	the identifier of the device to check.
`feature`	the feature to check for readiness.

Return Value

a boolean indicating whether a specific feature is ready for use on a given device.


                    
                    
                    setLocalTime(_:time:zone:)

Set local time to device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_time_setup

Declaration

Swift

func setLocalTime(_ identifier: String, time: Date, zone: TimeZone) -> Completable

Parameters

`identifier`	polar device id or UUID
`time`	time to set
`zone`	time zone to set

Return Value

Completable stream

success: when time has been set to device
onError: see PolarErrors for possible errors invoked


                    
                    
                    getLocalTime(_:)

Get current time in device. Note, the H10 is not supporting time read.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_time_setup

Declaration

Swift

@available(*, deprecated, message: "Use getLocalTimeWithZone(﹚ instead to also get timezone")
func getLocalTime(_ identifier: String) -> Single<Date>

Parameters

`identifier`	polar device id or UUID
`time`	time to set
`zone`	time zone to set

Return Value

Single stream

success: once after settings received from device
onError: see PolarErrors for possible errors invoked


                    
                    
                    getLocalTimeWithZone(_:)

Get current time and timezone from device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_time_setup

Declaration

Swift

func getLocalTimeWithZone(_ identifier: String) -> Single<(Date, TimeZone)>

Parameters


                                identifier

Polar device id or UUID

Return Value

Single stream

success: once after settings received from device, emits (Date, TimeZone)
onError: see PolarErrors for possible errors invoked


                    
                    
                    getDiskSpace(_:)

Get PolarDiskSpaceData from device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_control

Declaration

Swift

func getDiskSpace(_ identifier: String) -> Single<PolarDiskSpaceData>

Parameters


                                identifier

polar device id or UUID

Return Value

Single stream

success: once after disk space received from device
onError: see PolarErrors for possible errors invoked


                    
                    
                    setLedConfig(_:ledConfig:)

Set [LedConfig] to enable or disable blinking LEDs (Verity Sense 2.2.1+).

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_led_animation

Declaration

Swift

func setLedConfig(_ identifier: String, ledConfig: LedConfig) -> Completable

Parameters

`identifier`	polar device id or UUID
`ledConfig`	to enable or disable LEDs blinking

Return Value

Completable stream

success: when enable or disable sent to device
onError: see PolarErrors for possible errors invoked


                    
                    
                    setTelemetryEnabled(_:enabled:)

Enable or disable telemetry (trace logging / diagnostics) on the device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_control

Declaration

Swift

func setTelemetryEnabled(_ identifier: String, enabled: Bool) -> Completable

Parameters

`identifier`	Polar device ID or BT address
`enabled`	true = telemetry on, false = off

Return Value

Completable (success or error)


                    
                    
                    doFactoryReset(_:preservePairingInformation:)

Perform factory reset to given device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_control

Declaration

Swift

@available(*, deprecated, message: "Use doFactoryReset(_ identifier: String﹚ instead.")
func doFactoryReset(_ identifier: String, preservePairingInformation: Bool) -> Completable

Parameters

`identifier`	polar device id or UUID
`preservePairingInformation`	preserve pairing information during factory reset

Return Value

Completable stream

success: when factory reset notification sent to device
onError: see PolarErrors for possible errors invoked


                    
                    
                    doFactoryReset(_:)

Perform factory reset to given device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_control

Declaration

Swift

func doFactoryReset(_ identifier: String) -> Completable

Parameters


                                identifier

polar device id or UUID

Return Value

Completable stream

success: when factory reset notification sent to device
onError: see PolarErrors for possible errors invoked


                    
                    
                    doRestart(_:preservePairingInformation:)

Perform restart to given device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_control

Declaration

Swift

@available(*, deprecated, message: "Use doRestart(_ identifier: String﹚ instead.")
func doRestart(_ identifier: String, preservePairingInformation: Bool) -> Completable

Parameters

`identifier`	polar device id or UUID
`preservePairingInformation`	preserve pairing information during restart

Return Value

Completable stream

success: when restart notification sent to device
onError: see PolarErrors for possible errors invoked


                    
                    
                    doRestart(_:)

Perform restart to given device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_control

Declaration

Swift

func doRestart(_ identifier: String) -> Completable

Parameters


                                identifier

polar device id or UUID

Return Value

Completable stream

success: when restart notification sent to device
onError: see PolarErrors for possible errors invoked


                    
                    
                    getSDLogConfiguration(_:)

Get SD log configuration from a device (SDLOGS.BPB)

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_control

Declaration

Swift

func getSDLogConfiguration(_ identifier: String) -> Single<SDLogConfig>

Parameters


                                identifier

polar device id or UUID

Return Value

Single stream

success: A motley crew of boolean values describing the SD log configuration
onError: see PolarErrors for possible errors invoked


                    
                    
                    setSDLogConfiguration(_:logConfiguration:)

Set SD log configuration to a device (SDLOGS.BPB)

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_control

Declaration

Swift

func setSDLogConfiguration(_ identifier: String, logConfiguration: SDLogConfig) -> Completable

Parameters

`identifier`	polar device id or UUID
`logConfiguration`	A motley crew of boolean values describing the SD log configuration

Return Value

Completable stream

success: When SD log configuration has been written to the device
onError: see PolarErrors for possible errors invoked


                    
                    
                    doFirstTimeUse(_:ftuConfig:)

Set [FtuConfig] for device

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_control

[PolarFirstTimeUseConfig] class enforces specific ranges and valid values for each parameter:
- Gender: “Male” or “Female”
- Height: 90 to 240 cm
- Weight: 15 to 300 kg
- Max heart rate: 100 to 240 bpm
- Resting heart rate: 20 to 120 bpm
- VO2 max: 10 to 95
- Training background: One of the predefined levels (10, 20, 30, 40, 50, 60)
- Typical day: One of [TypicalDay] values
- Sleep goal: Minutes, valid range [300-660]

Declaration

Swift

func doFirstTimeUse(_ identifier: String, ftuConfig: PolarFirstTimeUseConfig) -> Completable

Parameters

`identifier`	polar device id or UUID
`ftuConfig`	Configuration data for the first-time use, encapsulated in [PolarFirstTimeUseConfig].

Return Value

Completable stream

success: when enable or disable sent to device
onError: see PolarErrors for possible errors invoked


                    
                    
                    isFtuDone(_:)

Check if the First Time Use has been done for the given Polar device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_control

Declaration

Swift

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

Parameters


                                identifier

Polar device id or UUID

Return Value

Boolean

success: true when FTU has been done, false otherwise
onError: see PolarErrors for possible errors invoked


                    
                    
                    getUserPhysicalConfiguration(_:)

Get the user¨s physical data from the given Polar device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_control

Declaration

Swift

func getUserPhysicalConfiguration(_ identifier: String) -> Maybe<PolarPhysicalConfiguration?>

Parameters


                                identifier

Polar device ID or UUID

Return Value

Maybe<PolarPhysicalConfiguration?>

Emits the PolarPhysicalConfiguration if available
Emits nil if not available
Errors are propagated as PolarErrors


                    
                    
                    setWarehouseSleep(_:)

Set the device to warehouse sleep state. Factory reset will be performed in order to enable the setting.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_control

Declaration

Swift

func setWarehouseSleep(_ identifier: String) -> Completable

Parameters


                                identifier

polar device id or UUID

Return Value

Completable stream

success: when warehouse sleep has been set together with factory reset
onError: see PolarErrors for possible errors invoked


                    
                    
                    turnDeviceOff(_:)

Turn of device by setting the device to sleep state.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_control

Declaration

Swift

func turnDeviceOff(_ identifier: String) -> Completable

Parameters


                                identifier

polar device id or UUID

Return Value

Completable stream

success: when device has successfully set to sleep
onError: see PolarErrors for possible errors invoked


                    
                    
                    getPolarUserDeviceSettings(identifier:)

Get Device User Settings to a device from proto in device (UDEVSET.BPB)

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_control

Declaration

Swift

func getPolarUserDeviceSettings(identifier: String) -> Single<PolarUserDeviceSettings.PolarUserDeviceSettingsResult>

Parameters


                                identifier

polar device id or UUID

Return Value

Single stream

success: Collection of user device settings, like device location on user.
onError: see PolarErrors for possible errors invoked


                    
                    
                    setPolarUserDeviceSettings(_:polarUserDeviceSettings:)

Set Device User Settings to a device (UDEVSET.BPB)

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_control

Declaration

Swift

func setPolarUserDeviceSettings(_ identifier: String, polarUserDeviceSettings: PolarUserDeviceSettings) -> Completable

Parameters

`identifier`	Polar device id or UUID
`polarUserDeviceSettings`	Collection of user device settings, like device location on user.

Return Value

Completable stream

success: When Device User Settings configuration has been written to the device
onError: see PolarErrors for possible errors invoked


                    
                    
                    deleteStoredDeviceData(_:dataType:until:)

Delete data [PolarStoredDataType] from a device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_control

Declaration

Swift

func deleteStoredDeviceData(_ identifier: String, dataType: PolarStoredDataType.StoredDataType, until: Date?) -> Completable

Parameters

`identifier`	Polar device ID or BT address
`dataType`	`PolarStoredDataType` — a specific data type that shall be deleted
`until`	Data will be deleted from device from history until this date.

Return Value

Completable emitting success or error


                    
                    
                    deleteDeviceDateFolders(_:fromDate:toDate:)

Delete device date folders from a device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_control

Declaration

Swift

func deleteDeviceDateFolders(_ identifier: String, fromDate: Date?, toDate: Date?) -> Completable

Parameters

`identifier`	Polar device id or UUID
`fromDate`	The starting date to delete date folders from
`toDate`	The ending date of last date to delete folders from

Return Value

Completable stream

success: when date folders successfully deleted
onError: see PolarErrors for possible errors invoked


                    
                    
                    deleteTelemetryData(_:)

Delete telemetry data files from a device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_control

Declaration

Swift

func deleteTelemetryData(_ identifier: String) -> Completable

Parameters


                                identifier

Polar device id or UUID

Return Value

Completable stream

success: when date folders successfully deleted
onError: see PolarErrors for possible errors invoked


                    
                    
                    waitForConnection(_:)

Waits for the device to establish a connection.

Requires

Requires SDK feature(s): None (core API).

Declaration

Swift

func waitForConnection(_ identifier: String) -> Completable

Return Value

Completable stream

success: When connection is established
onError: see PolarErrors for possible errors invoked


                    
                    
                    setUserDeviceLocation(_:location:)

Set user device location on a device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_control

Declaration

Swift

func setUserDeviceLocation(_ identifier: String, location: Int) -> Completable

Parameters

`identifier`	Polar device id or UUID
`location`	Device location as an integer value (see `PolarUserDeviceSettings.DeviceLocation`)

Return Value

Completable stream

success: when location is set successfully
onError: see PolarErrors for possible errors invoked


                    
                    
                    setUsbConnectionMode(_:enabled:)

Set USB connection mode on a device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_control

Declaration

Swift

func setUsbConnectionMode(_ identifier: String, enabled: Bool) -> Completable

Parameters

`identifier`	Polar device id or UUID
`enabled`	Boolean flag to enable or disable USB connection mode

Return Value

Completable stream

success: when USB mode is set successfully
onError: see PolarErrors for possible errors invoked


                    
                    
                    setAutomaticTrainingDetectionSettings(_:mode:sensitivity:minimumDuration:)

Set automatic training detection settings on a device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_control

Declaration

Swift

func setAutomaticTrainingDetectionSettings(
    _ identifier: String,
    mode: Bool,
    sensitivity: Int,
    minimumDuration: Int
 ) -> Completable

Parameters

`identifier`	Polar device id or UUID
`mode`	Boolean flag to enable or disable automatic training detection
`sensitivity`	Sensitivity level as integer, range [0, 100]. Higher values cause training to trigger more easily
`minimumDuration`	Minimum training duration in seconds

Return Value

Completable stream

success: when settings are applied successfully
onError: see PolarErrors for possible errors invoked


                    
                    
                    setDaylightSavingTime(_:)

Set the next Daylight Saving Time (DST) settings on the device in the current timezone. Gets the current timezone from the device and sets DST value based on that.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_control

Declaration

Swift

func setDaylightSavingTime(_ identifier: String) -> Completable

Parameters


                                identifier

Polar device id or UUID

Return Value

Completable stream

success: when DST has been successfully set to the device
onError: see PolarErrors for possible errors invoked


                    
                    
                    getMultiBLEConnectionMode(identifier:)

Request multi BLE connection mode status from device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_features_configuration_service

Declaration

Swift

func getMultiBLEConnectionMode(identifier: String) -> Single<Bool>

Parameters


                                identifier

Polar device id or UUID

Return Value

Single stream

success: Boolean: true if multi BLE connection has been enabled, false otherwise.
onError: see PolarErrors for possible errors invoked


                    
                    
                    setMultiBLEConnectionMode(identifier:enable:)

Enable multi BLE connection mode on a given device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_features_configuration_service

Declaration

Swift

func setMultiBLEConnectionMode(identifier: String, enable: Bool) -> Completable

Parameters

`identifier`	Polar device id or UUID
`enable`	Boolean flag to enable or disable multi BLE connection mode

Return Value

Completable stream

success: when multi BLE connection mode has been successfully set
onError: see PolarErrors for possible errors invoked


                    
                    
                    sendInitializationAndStartSyncNotifications(identifier:)

Notify device of the incoming data transfer operation(s). By using this method the device will handle data transfer operations more efficiently by setting it to faster data transfer mode. It also will cause the device to flush the latest data to files giving you the most up-to-date data.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_control

Declaration

Swift

func sendInitializationAndStartSyncNotifications(identifier: String) -> Completable

Parameters


                                identifier

Polar device id or UUID

Return Value

Completable stream

success: Initialization and synchronization start nofifications have been successfully sent
onError: see PolarErrors for possible errors invoked


                    
                    
                    sendTerminateAndStopSyncNotifications(identifier:)

Notify device that data transfer operations are completed. By calling this API device will set itself back to normal data transfer mode that will use less battery.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_control

Declaration

Swift

func sendTerminateAndStopSyncNotifications(identifier: String) -> Completable

Parameters


                                identifier

Polar device id or UUID

Return Value

Completable stream

success: Initialization and synchronization stop nofifications have been successfully sent
onError: see PolarErrors for possible errors invoked


                    
                    
                    setAutomaticOHRMeasurementEnabled(_:enabled:)

Enable or disable AUTOS file generation on the device. AUTOS files contain 24/7 OHR data. Status of this setting can be read with getUserDeviceSettings().

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_device_control

Declaration

Swift

func setAutomaticOHRMeasurementEnabled(_ identifier: String, enabled: Bool) -> Completable

Parameters

`identifier`	Polar device ID or BT address
`enabled`	true = AUTOS files enabled, false = disabled

Return Value

Completable (success or error)


                    
                    
                    getRSSIValue(_:)

Get last received RSSI (Received Signal Strength Indicator) value for the connected device. The value is obtained from iOS BLE in 1 second interval. The value is typically between -40 to -55 dBm when the device is nearby.

Requires

Requires SDK feature(s): None (core API).

Declaration

Swift

func getRSSIValue(_ identifier: String) throws -> Int

Parameters


                                identifier

Polar device ID or BT address

Return Value

Integer value of the last received RSSI or error if the device is not connected or identifier is invalid.


                    
                    
                    checkIfDeviceDisconnectedDueRemovedPairing(_:)

Check if the device did disconnect from BLE due to removed pairing. If the device did disconnect due to removed pairing, the device will not be available for connection until it is paired again. It may be required to forget the device from iOS Bluetooth settings and pair it again.

Requires

Requires SDK feature(s): None (core API).

Declaration

Swift

func checkIfDeviceDisconnectedDueRemovedPairing(_ identifier: String) throws -> Bool

Parameters


                                identifier

Polar device ID or BT address

Return Value

True if was disconnected due to removed pairing, false otherwise (BLE connection is OK).


                    
                    
                    observer

Common GAP (Generic access profile) observer

Declaration

Swift

var observer: PolarBleApiObserver? { get set }


                    
                    
                    deviceInfoObserver

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

Declaration

Swift

var deviceInfoObserver: PolarBleApiDeviceInfoObserver? { get set }


                    
                    
                    deviceHrObserver

Device observer for HR GATT client

Declaration

Swift

@available(*, deprecated, message: "The functionality has changed. Please use the startHrStreaming API to get the heart rate data ")
var deviceHrObserver: PolarBleApiDeviceHrObserver? { get set }


                    
                    
                    powerStateObserver

Bluetooth power state observer

Declaration

Swift

var powerStateObserver: PolarBleApiPowerStateObserver? { get set }


                    
                    
                    deviceFeaturesObserver

Device features ready observer

Declaration

Swift

var deviceFeaturesObserver: PolarBleApiDeviceFeaturesObserver? { get set }


                    
                    
                    isBlePowered

Helper to check if Ble is currently powered

Declaration

Swift

var isBlePowered: Bool { get }

Return Value

current power state


                    
                    
                    logger

Optional logger set to get traces from sdk

Declaration

Swift

var logger: PolarBleApiLogger? { get set }


                    
                    
                    automaticReconnection

Optional disable or enable automatic reconnection, by default it is enabled.

Note that firmware update (FWU) turns on automatic reconnection automatically, and restores the setting automatically when operation completes. One should not change this setting during FWU.

Declaration

Swift

var automaticReconnection: Bool { get set }


                    
                    
                    getBatteryLevel(identifier:)

Request last observed battery level value from device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_battery_info

Declaration

Swift

func getBatteryLevel(identifier: String) throws -> Int

Return Value

Returns the level of battery charging percentage 0 - 100% Will return -1 if battery battery level is not available.


                    
                    
                    getChargerState(identifier:)

Request last observed charging status value from device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_battery_info

Declaration

Swift

func getChargerState(identifier: String) throws -> BleBasClient.ChargeState

Return Value

Returns ChargeState value indicating the last observed charging status of the device. Will return -1 if battery battery charging percentage level is not available.