SDK for Polar sensors

This is the official repository of Polar's software development kit. With this SDK you are able to develop your own applications for sensors made by Polar.

This SDK uses ReactiveX. You can read more about ReactiveX from their website reactivex

3rd party software lincense listing ThirdPartySoftwareListing

By exploiting the SDK, you indicate your acceptance of License.

If you wish to collaborate with Polar commercially, click here

Quick License Summary / Your rights to use the SDK

You may use, copy and modify the SDK as long as you include the original copyright and license notice in any copy of the software/source and you comply with the license terms. You are allowed to use the SDK for the development of software for your private as well as for commercial use for as long as you use the SDK in compliance with the license terms.

H10 Heart rate sensor

Most accurate Heart rate sensor in the markets. The H10 is used in the Getting started section of this page. Store page

H10 heart rate sensor available data types

• From version 3.0.35 onwards. Available later.
• Heart rate as beats per minute. RR Interval in ms and 1/1024 format.
• Electrocardiography (ECG) data in µV. Default epoch for timestamp is 1.1.2000
• Accelerometer data with samplerates of 25Hz, 50Hz, 100Hz and 200Hz and range of 2G, 4G and 8G. Axis specific acceleration data in mG. Default epoch for timestamp is 1.1.2000
• Start and stop of internal recording and request for internal recording status. Recording supports RR, HR with one second sampletime or HR with five second sampletime.
• List, read and remove for stored internal recording (sensor supports only one recording at the time).

OH1 Optical heart rate sensor

Optical heart rate sensor is a rechargeable device that measures user’s heart rate with LED technology. Store page

OH1 Optical heart rate sensor available data types

• From version 2.0.8 onwards. Available later.
• Heart rate as beats per minute.
• Photoplethysmograpy (PPG) values.
• PP interval (milliseconds) representing cardiac pulse-to-pulse interval extracted from PPG signal.
• Accelerometer data with samplerate of 50Hz and range of 8G. Axis specific acceleration data in mG.
• List, read and remove stored exercise. Recording of exercise requires that sensor is registered to Polar Flow account.

Project structure

• polar-sdk-ios contains compiled iOS sdk, dependencies and documentation
• polar-sdk-android contains compiled Android sdk and documentation
• demos contains both Android and iOS demo applications using various subsets from sdk
• examples contains both android and ios example app utilizing all features from sdk
• gatt specification contains gatt specification for polar measurement data streaming
• H10 ecg technical document

Android proguard-rules

-dontwarn rx.internal.util.**
-dontwarn com.google.protobuf.**
-keep class fi.polar.remote.representation.protobuf.** {public private protected *;}
-keep class protocol.** {public private protected *;}
-keep class data.** {public private protected *;}
-keep class com.androidcommunications.polar.api.ble.model.** {public private protected *;}
-keep class com.androidcommunications.polar.enpoints.ble.bluedroid.host.**

Android: Getting started

Detailed documentation Full Documentation.

Installation

Compiled sdk and dependencies can be found from polar-sdk-android

1. In build.gradle make sure the minSdkVersion is set to 19 or higher.

android {
	...
	defaultConfig {
		...
		minSdkVersion 19
	}
}

2. Copy the contents of polar-sdk-android folder into your project's libs folder e.g YourProjectName/app/libs/ The YourProjectName/app/libs/ should now contain two files

polar-ble-sdk.aar
polar-protobuf-release.aar

3. Add the following dependencies to build.gradle inside the dependencies clause:

dependencies {
	implementation files('libs/polar-ble-sdk.aar')
    // Only needed if FEATURE_POLAR_FILE_TRANSFER used
	implementation files('libs/polar-protobuf-release.aar') 
    // Only needed if FEATURE_POLAR_FILE_TRANSFER used
	implementation group: 'commons-io', name: 'commons-io', version: '2.4'
    // Only needed if FEATURE_POLAR_FILE_TRANSFER used
	implementation 'com.google.protobuf:protobuf-java:3.1.0'
	implementation 'io.reactivex.rxjava2:rxjava:2.1.5'
	implementation 'io.reactivex.rxjava2:rxandroid:2.0.1'
}

4. Finally, add the following permissions to AndroidManifest.xml:

<uses-permission android:name="android.permission.BLUETOOTH"/>
<uses-permission android:name="android.permission.BLUETOOTH_ADMIN" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />

Code example: Heart rate

See the example folder for the full project.

Key things

String DEVICE_ID is your Polar device's id. This is not required if you are using automatic connection.

1. Import following packages.

import io.reactivex.CompletableObserver;
import io.reactivex.android.schedulers.AndroidSchedulers;
import io.reactivex.disposables.Disposable;
import io.reactivex.functions.Action;
import io.reactivex.functions.Consumer;
import io.reactivex.functions.Function;
import polar.com.sdk.api.PolarBleApi;
import polar.com.sdk.api.PolarBleApiCallback;
import polar.com.sdk.api.PolarBleApiDefaultImpl;
import polar.com.sdk.api.model.PolarAccelerometerData;
import polar.com.sdk.api.model.PolarDeviceInfo;
import polar.com.sdk.api.model.PolarEcgData;
import polar.com.sdk.api.model.PolarExerciseData;
import polar.com.sdk.api.model.PolarExerciseEntry;
import polar.com.sdk.api.model.PolarHrBroadcastData;
import polar.com.sdk.api.model.PolarHrData;
import polar.com.sdk.api.model.PolarOhrPPGData;
import polar.com.sdk.api.model.PolarOhrPPIData;
import polar.com.sdk.api.model.PolarSensorSetting;

2. Load the default api implementation and add callback.

// NOTICE only FEATURE_HR is enabled, to enable more features like battery info
// e.g. PolarBleApiDefaultImpl.defaultImplementation(this, PolarBleApi.FEATURE_HR |
// PolarBleApi.FEATURE_BATTERY_INFO); 
// batteryLevelReceived callback is invoked after connection
PolarBleApi api = PolarBleApiDefaultImpl.defaultImplementation(this, PolarBleApi.FEATURE_HR);

api.setApiCallback(new PolarBleApiCallback() {
    @Override
    public void blePowerStateChanged(boolean powered) {
        Log.d("MyApp","BLE power: " + powered);
    }

    @Override
    public void polarDeviceConnected(PolarDeviceInfo polarDeviceInfo) {
        Log.d("MyApp","CONNECTED: " + polarDeviceInfo.deviceId);
    }

    @Override
    public void polarDeviceConnecting(PolarDeviceInfo polarDeviceInfo) {
        Log.d("MyApp","CONNECTING: " + polarDeviceInfo.deviceId);
    }

    @Override
    public void polarDeviceDisconnected(PolarDeviceInfo polarDeviceInfo) {
        Log.d("MyApp","DISCONNECTED: " + polarDeviceInfo.deviceId);
    }

    @Override
    public void ecgFeatureReady(String identifier) {
    }

    @Override
    public void accelerometerFeatureReady(String identifier) {
    }

    @Override
    public void ppgFeatureReady(String identifier) {
    }

    @Override
    public void ppiFeatureReady(String identifier) {
    }

    @Override
    public void biozFeatureReady(String identifier) {
    }

    @Override
    public void hrFeatureReady(String identifier) {
        Log.d("MyApp","HR READY: " + identifier);
    }

    @Override
    public void fwInformationReceived(String identifier, String fwVersion) {
    }

    @Override
    public void batteryLevelReceived(String identifier, int level) {
    }

    @Override
    public void hrNotificationReceived(String identifier, PolarHrData data) {
        Log.d("MyApp","HR: " + data.hr);
    }

    @Override
    public void polarFtpFeatureReady(String s) {
    }
});

3. Request permissions if needed

if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
    this.requestPermissions(new String[]{Manifest.permission.ACCESS_COARSE_LOCATION, Manifest.permission.ACCESS_FINE_LOCATION}, 1);
}
// callback is invoked after granted or denied permissions
@Override
public void onRequestPermissionsResult(int requestCode, String permissions[], int[] grantResults) {
}

4. Add background, foreground and cleanup functionality on desired callbacks e.g.

@Override
public void onPause() {
    super.onPause();
    api.backgroundEntered();
}

@Override
public void onResume() {
    super.onResume();
    api.foregroundEntered();
}

@Override
public void onDestroy() {
    super.onDestroy();
    api.shutDown();
}

5. Connect to a Polar device using api.connectToPolarDevice(DEVICE_ID) ,
   api.autoConnectToPolarDevice(-50, null).subscribe() to connect nearby device or api.searchForPolarDevice() to scan and select the device

iOS: Getting started

Detailed documentation Full Documentation. Minimum iOS version is 10.

Installation

Compiled Sdk and dependencys can be found from polar-sdk-ios Precompiled 4.4.0 RxSwift and RxAtomic is added to sdk package. All iOS demos and examples contains Cartfile if you desire to compile dependencies yourself.

1. In the project properties General tab, add PolarBleSdk.framework , RxSwift.framework and RxAtomic.framework to Embedded binaries and Linked Frameworks and Libraries.

2. In project target settings enable Background Modes, add Uses Bluetooth LE accessories

Code example: Heart rate

See the example folder for the full project

Key things

deviceId is your Polar device's id. This is not required if you are using automatic connection.

1. Import needed packages.

import PolarBleSdk
import RxSwift

2. Load the default api implementation and implement desired protocols.

class MyController: UIViewController,
                      PolarBleApiObserver,
                      PolarBleApiPowerStateObserver,
                      PolarBleApiDeviceFeaturesObserver,
                      PolarBleApiDeviceHrObserver {
    // NOTICE only FEATURE_HR is enabled, to enable more features like battery info
    // e.g. PolarBleApiDefaultImpl.polarImplementation(DispatchQueue.main, features: Features.hr.rawValue | 
    // Features.batteryStatus.rawValue)
    // batteryLevelReceived callback is invoked after connection                   
    var api = PolarBleApiDefaultImpl.polarImplementation(DispatchQueue.main, features: Features.hr.rawValue)
    var deviceId = "0A3BA92B" // TODO replace this with your device id

    override func viewDidLoad() {
        super.viewDidLoad()
        api.observer = self
        api.deviceHrObserver = self
        api.powerStateObserver = self
        api.deviceFeaturesObserver = self
    }

    func polarDeviceConnecting(_ polarDeviceInfo: PolarDeviceInfo) {
        print("DEVICE CONNECTING: \(polarDeviceInfo)")
    }
    
    func polarDeviceConnected(_ polarDeviceInfo: PolarDeviceInfo) {
        print("DEVICE CONNECTED: \(polarDeviceInfo)")
        deviceId = polarDeviceInfo.deviceId
    }
    
    func polarDeviceDisconnected(_ polarDeviceInfo: PolarDeviceInfo) {
        print("DISCONNECTED: \(polarDeviceInfo)")
    }
    
    func batteryLevelReceived(_ identifier: String, batteryLevel: UInt) {
        print("battery level updated: \(batteryLevel)")
    }
    
    func hrValueReceived(_ identifier: String, data: PolarHrData) {
        print("HR notification: \(data.hr) rrs: \(data.rrs)")
    }
    
    func hrFeatureReady(_ identifier: String) {
        print("HR READY")
    }
    
    func ecgFeatureReady(_ identifier: String) {
    }
    
    func accFeatureReady(_ identifier: String) {
    }
    
    func ohrPPGFeatureReady(_ identifier: String) {
    }
    
    func blePowerOn() {
        print("BLE ON")
    }
    
    func blePowerOff() {
        print("BLE OFF")
    }
    
    func ohrPPIFeatureReady(_ identifier: String) {
    }
    
    func ftpFeatureReady(_ identifier: String) {
    }
}

3. Connect to a Polar device using api.connectToPolarDevice(id) , api.startAutoConnectToPolarDevice(_ rssi: Int, polarDeviceType: String?) to connect nearby device or api.searchForPolarDevice() to scan and select the device