SDK release 5.7.0

polarofficial · Sep 4, 2024 · 7c821ca · 7c821ca
1 parent bae2528
commit 7c821ca
Show file tree

Hide file tree

Showing 343 changed files with 87,063 additions and 3,069 deletions.
diff --git a/PolarBleSdk.podspec b/PolarBleSdk.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|  
     s.name              = 'PolarBleSdk'
-    s.version           = '5.6.0'
+    s.version           = '5.7.0'
     s.summary           = 'SDK for Polar sensors'
     s.homepage          = 'https://github.com/polarofficial/polar-ble-sdk'
     s.license           = { :type => 'Custom', :file => 'Polar_SDK_License.txt' }
@@ -15,4 +15,6 @@ Pod::Spec.new do |s|
 
     s.dependency 'RxSwift', '~> 6.5.0'
     s.dependency 'SwiftProtobuf', '~> 1.0'
-end 
+    s.dependency 'Alamofire', '~> 5.8.1'
+    s.dependency 'Zip', '~> 2.1.2'
+end
diff --git a/README.md b/README.md
@@ -196,6 +196,9 @@ dependencies {
         android:name="android.permission.ACCESS_COARSE_LOCATION"
         android:maxSdkVersion="30" />
 
+      <!-- Allow Polar SDK to check and download firmware updates. -->
+    <uses-permission android:name="android.permission.INTERNET" />
+
 ```
 
 On your application you must request for the [permissions](https://developer.android.com/guide/topics/permissions). Here is the example how could you request the needed permissions for the SDK:

diff --git a/polar-sdk-android/docs/allclasses.html b/polar-sdk-android/docs/allclasses.html
@@ -31,6 +31,8 @@ <h1 class="bar">All Classes</h1>
 
             <li><a href=com/polar/sdk/api/PolarBleApiDefaultImpl.html>PolarBleApiDefaultImpl</a></li>
 
+            <li><a href=com/polar/sdk/api/PolarFirmwareUpdateApi.html>PolarFirmwareUpdateApi</a></li>
+
             <li><a href=com/polar/sdk/api/PolarH10OfflineExerciseApi.html>PolarH10OfflineExerciseApi</a></li>
 
             <li><a href=com/polar/sdk/api/PolarOfflineRecordingApi.html>PolarOfflineRecordingApi</a></li>
@@ -69,6 +71,8 @@ <h1 class="bar">All Classes</h1>
 
             <li><a href=com/polar/sdk/api/model/PolarDeviceInfo.html>PolarDeviceInfo</a></li>
 
+            <li><a href=com/polar/sdk/api/model/PolarDeviceUuid.html>PolarDeviceUuid</a></li>
+
             <li><a href=com/polar/sdk/api/model/PolarDiskSpaceData.html>PolarDiskSpaceData</a></li>
 
             <li><a href=com/polar/sdk/api/model/PolarEcgData.html>PolarEcgData</a></li>
@@ -77,6 +81,10 @@ <h1 class="bar">All Classes</h1>
 
             <li><a href=com/polar/sdk/api/model/PolarExerciseEntry.html>PolarExerciseEntry</a></li>
 
+            <li><a href=com/polar/sdk/api/model/FirmwareUpdateStatus.html>FirmwareUpdateStatus</a></li>
+
+            <li><a href=com/polar/sdk/api/model/PolarFirmwareVersionInfo.html>PolarFirmwareVersionInfo</a></li>
+
             <li><a href=com/polar/sdk/api/model/PolarFirstTimeUseConfig.html>PolarFirstTimeUseConfig</a></li>
 
             <li><a href=com/polar/sdk/api/model/PolarGyroData.html>PolarGyroData</a></li>
@@ -109,6 +117,34 @@ <h1 class="bar">All Classes</h1>
 
             <li><a href=com/polar/sdk/api/model/PolarTemperatureData.html>PolarTemperatureData</a></li>
 
+            <li><a href=com/polar/sdk/api/model/Errorlog.html>Errorlog</a></li>
+
+            <li><a href=com/polar/sdk/api/model/LogConfig.html>LogConfig</a></li>
+
+            <li><a href=com/polar/sdk/api/model/PolarEcgDataSample.html>PolarEcgDataSample</a></li>
+
+            <li><a href=com/polar/sdk/api/model/EcgSample.html>EcgSample</a></li>
+
+            <li><a href=com/polar/sdk/api/model/FecgSample.html>FecgSample</a></li>
+
+            <li><a href=com/polar/sdk/api/model/PolarHealthThermometerData.html>PolarHealthThermometerData</a></li>
+
+            <li><a href=com/polar/sdk/api/model/PolarLocationData.html>PolarLocationData</a></li>
+
+            <li><a href=com/polar/sdk/api/model/PolarLocationDataSample.html>PolarLocationDataSample</a></li>
+
+            <li><a href=com/polar/sdk/api/model/GpsCoordinatesSample.html>GpsCoordinatesSample</a></li>
+
+            <li><a href=com/polar/sdk/api/model/GpsSatelliteDilutionSample.html>GpsSatelliteDilutionSample</a></li>
+
+            <li><a href=com/polar/sdk/api/model/SatelliteSummary.html>SatelliteSummary</a></li>
+
+            <li><a href=com/polar/sdk/api/model/GpsSatelliteSummarySample.html>GpsSatelliteSummarySample</a></li>
+
+            <li><a href=com/polar/sdk/api/model/GpsNMEASample.html>GpsNMEASample</a></li>
+
+            <li><a href=com/polar/sdk/api/model/PolarPressureData.html>PolarPressureData</a></li>
+
             <li><a href=com/polar/sdk/api/model/PolarFirstTimeUseConfigKt.html>PolarFirstTimeUseConfigKt</a></li>
 
             <li><a href=com/polar/sdk/api/model/activity/PolarActiveTimeData.html>PolarActiveTimeData</a></li>
@@ -134,6 +170,8 @@ <h1 class="bar">All Classes</h1>
             <li><a href=com/polar/sdk/api/model/sleep/PolarSleepAnalysisResult.html>PolarSleepAnalysisResult</a></li>
 
             <li><a href=com/polar/sdk/api/model/sleep/PolarSleepDataKt.html>PolarSleepDataKt</a></li>
+
+            <li><a href=com/polar/sdk/impl/utils/PolarBackupManager.html>PolarBackupManager</a></li>
         </ul>
 </main>
 </body>

diff --git a/polar-sdk-android/docs/com/polar/sdk/api/PolarBleApi.PolarBleSdkFeature.html b/polar-sdk-android/docs/com/polar/sdk/api/PolarBleApi.PolarBleSdkFeature.html
@@ -244,54 +244,60 @@ <h3>Enum Constant Summary</h3>
                                     </tr>
 
                                     <tr class="altColor">
+                                        <th class="colFirst" scope="row"><code><span class="memberNameLink"><a
+                                                href="TODO"><a href=PolarBleApi.PolarBleSdkFeature.html#FEATURE_POLAR_FIRMWARE_UPDATE>FEATURE_POLAR_FIRMWARE_UPDATE</a></a></span></code></th>
+                                        <td class="colLast"><p>Firmware update for Polar device.</p></td>
+                                    </tr>
+
+                                    <tr class="rowColor">
                                         <th class="colFirst" scope="row"><code><span class="memberNameLink"><a
                                                 href="TODO"><a href=PolarBleApi.PolarBleSdkFeature.html#FEATURE_POLAR_LED_ANIMATION>FEATURE_POLAR_LED_ANIMATION</a></a></span></code></th>
                                         <td class="colLast"><p>Feature to enable or disable SDK mode blinking LED animation.</p></td>
                                     </tr>
 
-                                    <tr class="rowColor">
+                                    <tr class="altColor">
                                         <th class="colFirst" scope="row"><code><span class="memberNameLink"><a
                                                 href="TODO"><a href=PolarBleApi.PolarBleSdkFeature.html#FEATURE_POLAR_SDK_MODE>FEATURE_POLAR_SDK_MODE</a></a></span></code></th>
                                         <td class="colLast"><p>In SDK mode the wider range of capabilities are available for the online stream or offline recoding than in normal operation mode.</p></td>
                                     </tr>
 
-                                    <tr class="altColor">
+                                    <tr class="rowColor">
                                         <th class="colFirst" scope="row"><code><span class="memberNameLink"><a
                                                 href="TODO"><a href=PolarBleApi.PolarBleSdkFeature.html#FEATURE_POLAR_DEVICE_TIME_SETUP>FEATURE_POLAR_DEVICE_TIME_SETUP</a></a></span></code></th>
                                         <td class="colLast"><p>Feature to read and set device time in Polar device</p></td>
                                     </tr>
 
-                                    <tr class="rowColor">
+                                    <tr class="altColor">
                                         <th class="colFirst" scope="row"><code><span class="memberNameLink"><a
                                                 href="TODO"><a href=PolarBleApi.PolarBleSdkFeature.html#FEATURE_POLAR_H10_EXERCISE_RECORDING>FEATURE_POLAR_H10_EXERCISE_RECORDING</a></a></span></code></th>
                                         <td class="colLast"><p>H10 exercise recording feature to record exercise data to Polar H10 device without continuous BLE connection.</p></td>
                                     </tr>
 
-                                    <tr class="altColor">
+                                    <tr class="rowColor">
                                         <th class="colFirst" scope="row"><code><span class="memberNameLink"><a
                                                 href="TODO"><a href=PolarBleApi.PolarBleSdkFeature.html#FEATURE_POLAR_OFFLINE_RECORDING>FEATURE_POLAR_OFFLINE_RECORDING</a></a></span></code></th>
                                         <td class="colLast"><p>Polar offline recording feature to record offline data to Polar device without continuous BLE connection.</p></td>
                                     </tr>
 
-                                    <tr class="rowColor">
+                                    <tr class="altColor">
                                         <th class="colFirst" scope="row"><code><span class="memberNameLink"><a
                                                 href="TODO"><a href=PolarBleApi.PolarBleSdkFeature.html#FEATURE_POLAR_ONLINE_STREAMING>FEATURE_POLAR_ONLINE_STREAMING</a></a></span></code></th>
                                         <td class="colLast"><p>Polar sensor streaming feature to stream live online data. For example hr, ecg, acc, ppg, ppi, etc...</p></td>
                                     </tr>
 
-                                    <tr class="altColor">
+                                    <tr class="rowColor">
                                         <th class="colFirst" scope="row"><code><span class="memberNameLink"><a
                                                 href="TODO"><a href=PolarBleApi.PolarBleSdkFeature.html#FEATURE_BATTERY_INFO>FEATURE_BATTERY_INFO</a></a></span></code></th>
                                         <td class="colLast"><p>Feature to receive battery level info from Polar or any other BLE device</p></td>
                                     </tr>
 
-                                    <tr class="rowColor">
+                                    <tr class="altColor">
                                         <th class="colFirst" scope="row"><code><span class="memberNameLink"><a
                                                 href="TODO"><a href=PolarBleApi.PolarBleSdkFeature.html#FEATURE_DEVICE_INFO>FEATURE_DEVICE_INFO</a></a></span></code></th>
                                         <td class="colLast"><p>Device information feature to receive sw information from Polar or any other BLE device</p></td>
                                     </tr>
 
-                                    <tr class="altColor">
+                                    <tr class="rowColor">
                                         <th class="colFirst" scope="row"><code><span class="memberNameLink"><a
                                                 href="TODO"><a href=PolarBleApi.PolarBleSdkFeature.html#FEATURE_HR>FEATURE_HR</a></a></span></code></th>
                                         <td class="colLast"><p>Hr feature to receive hr and rr data from Polar or any other BLE device via standard HR BLE service</p></td>

diff --git a/polar-sdk-android/docs/com/polar/sdk/api/PolarBleApi.html b/polar-sdk-android/docs/com/polar/sdk/api/PolarBleApi.html
@@ -113,6 +113,11 @@ <h2 title="Class PolarBleApi" class="title">Class PolarBleApi</h2>
                             ,
 
 
+                            <code>com.polar.sdk.api.PolarFirmwareUpdateApi</code>
+
+                            ,
+
+
                             <code>com.polar.sdk.api.PolarH10OfflineExerciseApi</code>
 
                             ,
@@ -143,7 +148,7 @@ <h2 title="Class PolarBleApi" class="title">Class PolarBleApi</h2>
                     <pre class="wrap-overflow">
 
 public abstract class <span class="typeNameLabel"><a href=PolarBleApi.html>PolarBleApi</a></span>
- implements <a href=PolarOnlineStreamingApi.html>PolarOnlineStreamingApi</a>, <a href=PolarOfflineRecordingApi.html>PolarOfflineRecordingApi</a>, <a href=PolarH10OfflineExerciseApi.html>PolarH10OfflineExerciseApi</a>, <a href=PolarSdkModeApi.html>PolarSdkModeApi</a>, <a href=PolarActivityApi.html>PolarActivityApi</a>, <a href=PolarSleepApi.html>PolarSleepApi</a>
+ implements <a href=PolarOnlineStreamingApi.html>PolarOnlineStreamingApi</a>, <a href=PolarOfflineRecordingApi.html>PolarOfflineRecordingApi</a>, <a href=PolarH10OfflineExerciseApi.html>PolarH10OfflineExerciseApi</a>, <a href=PolarSdkModeApi.html>PolarSdkModeApi</a>, <a href=PolarFirmwareUpdateApi.html>PolarFirmwareUpdateApi</a>, <a href=PolarActivityApi.html>PolarActivityApi</a>, <a href=PolarSleepApi.html>PolarSleepApi</a>
                     </pre>
                     <div class="block"><p>Polar BLE API.</p></div>
                 </li>
@@ -506,7 +511,7 @@ <h3>Method Summary</h3>
                                             <!--   -->
                                         </a>
                                             <h3>Methods inherited from class&nbsp;com.polar.sdk.api.PolarBleApi</h3>
-                                            <code>disableSDKMode, enableSDKMode, fetchExercise, getActiveTime, getAvailableOfflineRecordingDataTypes, getAvailableOnlineStreamDataTypes, getDistance, getOfflineRecord, getOfflineRecordingStatus, getOfflineRecordingTriggerSetup, getSleep, getSplitOfflineRecord, getSteps, isSDKModeEnabled, listExercises, listOfflineRecordings, listSplitOfflineRecordings, removeExercise, removeOfflineRecord, requestFullOfflineRecordingSettings, requestFullStreamSettings, requestOfflineRecordingSettings, requestRecordingStatus, requestStreamSettings, setOfflineRecordingTrigger, startAccStreaming, startEcgStreaming, startGyroStreaming, startHrStreaming, startMagnetometerStreaming, startOfflineRecording, startOhrPPIStreaming, startOhrStreaming, startPpgStreaming, startPpiStreaming, startRecording, startTemperatureStreaming, stopOfflineRecording, stopRecording</code></li>
+                                            <code>disableSDKMode, enableSDKMode, fetchExercise, getActiveTime, getAvailableOfflineRecordingDataTypes, getAvailableOnlineStreamDataTypes, getDistance, getOfflineRecord, getOfflineRecordingStatus, getOfflineRecordingTriggerSetup, getSleep, getSplitOfflineRecord, getSteps, isSDKModeEnabled, listExercises, listOfflineRecordings, listSplitOfflineRecordings, removeExercise, removeOfflineRecord, requestFullOfflineRecordingSettings, requestFullStreamSettings, requestOfflineRecordingSettings, requestRecordingStatus, requestStreamSettings, setOfflineRecordingTrigger, startAccStreaming, startEcgStreaming, startGyroStreaming, startHrStreaming, startMagnetometerStreaming, startOfflineRecording, startOhrPPIStreaming, startOhrStreaming, startPpgStreaming, startPpiStreaming, startRecording, startTemperatureStreaming, stopOfflineRecording, stopRecording, updateFirmware</code></li>
 
                                     <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
                                         <!--   -->