Skip to content

Commit

Permalink
SDK release 5.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Samuli Määttä committed May 8, 2023
1 parent 45f92e1 commit d54bc93
Show file tree
Hide file tree
Showing 107 changed files with 3,371 additions and 113 deletions.
2 changes: 2 additions & 0 deletions polar-sdk-android/docs/allclasses.html
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,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/PolarDiskSpaceData.html>PolarDiskSpaceData</a></li>

<li><a href=com/polar/sdk/api/model/PolarEcgData.html>PolarEcgData</a></li>

<li><a href=com/polar/sdk/api/model/PolarExerciseData.html>PolarExerciseData</a></li>
Expand Down
34 changes: 33 additions & 1 deletion polar-sdk-android/docs/com/polar/sdk/api/PolarBleApi.html
Original file line number Diff line number Diff line change
Expand Up @@ -432,6 +432,14 @@ <h3>Method Summary</h3>
<td class="colLast">Start listening the heart rate from Polar devices when subscribed.</td>
</tr>

<tr id="i18" class="altColor">
<td class="colFirst"><code>abstract Single&lt;<a href=model/PolarDiskSpaceData.html>PolarDiskSpaceData</a>&gt;</code>
</td>
<th class="colSecond" scope="row"><code><a href=PolarBleApi.html#getDiskSpace(String)>getDiskSpace</a>(<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> identifier) </code>
</th>
<td class="colLast">Get <a href=model/PolarDiskSpaceData.html>PolarDiskSpaceData</a> from device.</td>
</tr>

</tbody>
</table>
</div>
Expand Down Expand Up @@ -874,7 +882,7 @@ <h4>getLocalTime</h4>
<!-- -->
</a>
<ul class=
"blockListLast"
"blockList"
>
<li class="blockList">
<h4>startListenForPolarHrBroadcasts</h4>
Expand All @@ -894,6 +902,30 @@ <h4>startListenForPolarHrBroadcasts</h4>
</li>
</ul>

<a id="getDiskSpace(String)">
<!-- -->
</a>
<ul class=
"blockListLast"
>
<li class="blockList">
<h4>getDiskSpace</h4>
<pre class="methodSignature"> abstract Single&lt;<a href=model/PolarDiskSpaceData.html>PolarDiskSpaceData</a>&gt; <a href=PolarBleApi.html#getDiskSpace(String)>getDiskSpace</a>(<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> identifier)</pre>
<div class="block"><p>Get <a href=model/PolarDiskSpaceData.html>PolarDiskSpaceData</a> from device.</p></div>

<dl>
<dt><span class="paramLabel">Parameters:</span></dt>


<dd><code>identifier</code> - Polar device ID or BT address</dd>


</dl>

<!-- TODO missing return annotation -->
</li>
</ul>

</li>
</ul>
</section>
Expand Down

Large diffs are not rendered by default.

428 changes: 428 additions & 0 deletions polar-sdk-android/docs/com/polar/sdk/api/model/PolarDiskSpaceData.html

Large diffs are not rendered by default.

86 changes: 56 additions & 30 deletions polar-sdk-android/docs/com/polar/sdk/api/model/package-summary.html
Original file line number Diff line number Diff line change
Expand Up @@ -121,65 +121,91 @@ <h1 title="Package" class="title">Package com.polar.sdk.api.model </h1>

<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarDeviceInfo.html>PolarDeviceInfo</a></th><td class="colLast">Contains information about the current Device.</td></tr>

<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarEcgData.PolarEcgDataSample.html>PolarEcgDataSample</a></th><td class="colLast">Polar ecg data sample</td></tr>
<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarDiskSpaceData.html>PolarDiskSpaceData</a></th><td class="colLast">Disk space data in bytes.</td></tr>

<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarEcgData.html>PolarEcgData</a></th><td class="colLast">For electrocardiography data.</td></tr>
<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarEcgData.PolarEcgDataSample.html>PolarEcgDataSample</a></th><td class="colLast">Polar ecg data sample</td></tr>

<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarExerciseData.html>PolarExerciseData</a></th><td class="colLast">Polar exercise data container.</td></tr>
<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarEcgData.html>PolarEcgData</a></th><td class="colLast">For electrocardiography data.</td></tr>

<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarExerciseEntry.html>PolarExerciseEntry</a></th><td class="colLast">Polar exercise entry container.</td></tr>
<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarExerciseData.html>PolarExerciseData</a></th><td class="colLast">Polar exercise data container.</td></tr>

<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarGyroData.PolarGyroDataSample.html>PolarGyroDataSample</a></th><td class="colLast">Polar gyroscope data sample</td></tr>
<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarExerciseEntry.html>PolarExerciseEntry</a></th><td class="colLast">Polar exercise entry container.</td></tr>

<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarGyroData.html>PolarGyroData</a></th><td class="colLast">Polar gyro data</td></tr>
<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarGyroData.PolarGyroDataSample.html>PolarGyroDataSample</a></th><td class="colLast">Polar gyroscope data sample</td></tr>

<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarHrBroadcastData.html>PolarHrBroadcastData</a></th><td class="colLast">For broadcasting heart rate data with signal strength and device info.</td></tr>
<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarGyroData.html>PolarGyroData</a></th><td class="colLast">Polar gyro data</td></tr>

<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarHrData.PolarHrSample.html>PolarHrSample</a></th><td class="colLast">Polar heart rate sample</td></tr>
<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarHrBroadcastData.html>PolarHrBroadcastData</a></th><td class="colLast">For broadcasting heart rate data with signal strength and device info.</td></tr>

<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarHrData.html>PolarHrData</a></th><td class="colLast"></td></tr>
<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarHrData.PolarHrSample.html>PolarHrSample</a></th><td class="colLast">Polar heart rate sample</td></tr>

<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarMagnetometerData.PolarMagnetometerDataSample.html>PolarMagnetometerDataSample</a></th><td class="colLast">Polar magnetometer data sample</td></tr>
<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarHrData.html>PolarHrData</a></th><td class="colLast"></td></tr>

<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarMagnetometerData.html>PolarMagnetometerData</a></th><td class="colLast">Polar magnetometer data</td></tr>
<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarMagnetometerData.PolarMagnetometerDataSample.html>PolarMagnetometerDataSample</a></th><td class="colLast">Polar magnetometer data sample</td></tr>

<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarOfflineRecordingData.AccOfflineRecording.html>AccOfflineRecording</a></th><td class="colLast">Accelerometer offline recording data</td></tr>
<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarMagnetometerData.html>PolarMagnetometerData</a></th><td class="colLast">Polar magnetometer data</td></tr>

<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarOfflineRecordingData.GyroOfflineRecording.html>GyroOfflineRecording</a></th><td class="colLast">Gyroscope Offline recording data</td></tr>
<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarOfflineRecordingData.AccOfflineRecording.html>AccOfflineRecording</a></th><td class="colLast">Accelerometer offline recording data</td></tr>

<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarOfflineRecordingData.MagOfflineRecording.html>MagOfflineRecording</a></th><td class="colLast">Magnetometer offline recording data</td></tr>
<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarOfflineRecordingData.GyroOfflineRecording.html>GyroOfflineRecording</a></th><td class="colLast">Gyroscope Offline recording data</td></tr>

<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarOfflineRecordingData.PpgOfflineRecording.html>PpgOfflineRecording</a></th><td class="colLast">PPG (Photoplethysmography) offline recording data</td></tr>
<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarOfflineRecordingData.MagOfflineRecording.html>MagOfflineRecording</a></th><td class="colLast">Magnetometer offline recording data</td></tr>

<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarOfflineRecordingData.PpiOfflineRecording.html>PpiOfflineRecording</a></th><td class="colLast">PPI (Peak-to-peak interval) offline recording data</td></tr>
<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarOfflineRecordingData.PpgOfflineRecording.html>PpgOfflineRecording</a></th><td class="colLast">PPG (Photoplethysmography) offline recording data</td></tr>

<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarOfflineRecordingData.HrOfflineRecording.html>HrOfflineRecording</a></th><td class="colLast">Heart rate offline recording data</td></tr>
<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarOfflineRecordingData.PpiOfflineRecording.html>PpiOfflineRecording</a></th><td class="colLast">PPI (Peak-to-peak interval) offline recording data</td></tr>

<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarOfflineRecordingData.html>PolarOfflineRecordingData</a></th><td class="colLast">Polar Offline recording data</td></tr>
<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarOfflineRecordingData.HrOfflineRecording.html>HrOfflineRecording</a></th><td class="colLast">Heart rate offline recording data</td></tr>

<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarOfflineRecordingEntry.html>PolarOfflineRecordingEntry</a></th><td class="colLast">Polar offline recording entry container.</td></tr>
<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarOfflineRecordingData.html>PolarOfflineRecordingData</a></th><td class="colLast">Polar Offline recording data</td></tr>

<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarOfflineRecordingTrigger.html>PolarOfflineRecordingTrigger</a></th><td class="colLast">Polar offline recording trigger</td></tr>
<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarOfflineRecordingEntry.html>PolarOfflineRecordingEntry</a></th><td class="colLast">Polar offline recording entry container.</td></tr>

<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarOhrData.PolarOhrSample.html>PolarOhrSample</a></th><td class="colLast">Polar optical sensor raw data sample</td></tr>
<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarOfflineRecordingTrigger.html>PolarOfflineRecordingTrigger</a></th><td class="colLast">Polar offline recording trigger</td></tr>

<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarOhrData.html>PolarOhrData</a></th><td class="colLast">Polar optical sensor raw data</td></tr>
<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarOhrData.PolarOhrSample.html>PolarOhrSample</a></th><td class="colLast">Polar optical sensor raw data sample</td></tr>

<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarOhrPPIData.PolarOhrPPISample.html>PolarOhrPPISample</a></th><td class="colLast">Polar PPI data sample</td></tr>
<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarOhrData.html>PolarOhrData</a></th><td class="colLast">Polar optical sensor raw data</td></tr>

<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarOhrPPIData.html>PolarOhrPPIData</a></th><td class="colLast">Polar Peak-to-Peak interval (PPI) data measured by the optical heart rate sensor</td></tr>
<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarOhrPPIData.PolarOhrPPISample.html>PolarOhrPPISample</a></th><td class="colLast">Polar PPI data sample</td></tr>

<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarPpgData.PolarPpgSample.html>PolarPpgSample</a></th><td class="colLast">Polar optical sensor raw data sample</td></tr>
<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarOhrPPIData.html>PolarOhrPPIData</a></th><td class="colLast">Polar Peak-to-Peak interval (PPI) data measured by the optical heart rate sensor</td></tr>

<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarPpgData.html>PolarPpgData</a></th><td class="colLast">Polar optical sensor raw data</td></tr>
<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarPpgData.PolarPpgSample.html>PolarPpgSample</a></th><td class="colLast">Polar optical sensor raw data sample</td></tr>

<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarPpiData.PolarPpiSample.html>PolarPpiSample</a></th><td class="colLast">Polar PPI data sample</td></tr>
<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarPpgData.html>PolarPpgData</a></th><td class="colLast">Polar optical sensor raw data</td></tr>

<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarPpiData.html>PolarPpiData</a></th><td class="colLast">Polar Peak-to-Peak interval (PPI) data measured by the optical heart rate sensor</td></tr>
<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarPpiData.PolarPpiSample.html>PolarPpiSample</a></th><td class="colLast">Polar PPI data sample</td></tr>

<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarRecordingSecret.html>PolarRecordingSecret</a></th><td class="colLast">Polar recording secret is used to encrypt the recording.</td></tr>
<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarPpiData.html>PolarPpiData</a></th><td class="colLast">Polar Peak-to-Peak interval (PPI) data measured by the optical heart rate sensor</td></tr>

<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarSensorSetting.html>PolarSensorSetting</a></th><td class="colLast"></td></tr>
<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarRecordingSecret.html>PolarRecordingSecret</a></th><td class="colLast">Polar recording secret is used to encrypt the recording.</td></tr>

<tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarSensorSetting.html>PolarSensorSetting</a></th><td class="colLast"></td></tr>
</tbody>
</table>

</div>

</li>

<li class="blockList">





<div class="typeSummary">

<table>
<caption><span>Object Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Object</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>

<tr class="altColor"><th class="colFirst" scope="row"><a href=PolarDiskSpaceData.Companion.html>Companion</a></th><td class="colLast"></td></tr>
</tbody>
</table>

Expand Down
1 change: 1 addition & 0 deletions polar-sdk-android/docs/element-list
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
$dokka.format:javadoc-v1
$dokka.linkExtension:html
$dokka.location:com.polar.sdk.api.model/PolarAccelerometerData.PolarAccelerometerDataSample///PointingToDeclaration/com/polar/sdk/api/model/PolarAccelerometerData.PolarAccelerometerDataSample.html
$dokka.location:com.polar.sdk.api.model/PolarDiskSpaceData.Companion///PointingToDeclaration/com/polar/sdk/api/model/PolarDiskSpaceData.Companion.html
$dokka.location:com.polar.sdk.api.model/PolarEcgData.PolarEcgDataSample///PointingToDeclaration/com/polar/sdk/api/model/PolarEcgData.PolarEcgDataSample.html
$dokka.location:com.polar.sdk.api.model/PolarGyroData.PolarGyroDataSample///PointingToDeclaration/com/polar/sdk/api/model/PolarGyroData.PolarGyroDataSample.html
$dokka.location:com.polar.sdk.api.model/PolarHrData.PolarHrSample///PointingToDeclaration/com/polar/sdk/api/model/PolarHrData.PolarHrSample.html
Expand Down
26 changes: 26 additions & 0 deletions polar-sdk-android/docs/index-files/index-12.html
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,32 @@ <h2 class="title">P</h2>
<dd>Polar device is not known</dd>


<dt>

<span class="memberNameLink">

<a href="../com/polar/sdk/api/model/PolarDiskSpaceData.html">PolarDiskSpaceData</a>

</span> - class in com.polar.sdk.api.model


</dt>
<dd>Disk space data in bytes.</dd>


<dt>

<span class="memberNameLink">

<a href="../com/polar/sdk/api/model/PolarDiskSpaceData.Companion.html">PolarDiskSpaceData.Companion</a>

</span> - class in com.polar.sdk.api.model.<a href=../com/polar/sdk/api/model/PolarDiskSpaceData.html>PolarDiskSpaceData</a>


</dt>
<dd>&nbsp;</dd>


<dt>

<span class="memberNameLink">
Expand Down
13 changes: 13 additions & 0 deletions polar-sdk-android/docs/index-files/index-6.html
Original file line number Diff line number Diff line change
Expand Up @@ -405,6 +405,19 @@ <h2 class="title">F</h2>
<dd>Optionally call when application enters to the foreground.</dd>


<dt>

<span class="memberNameLink">

<a href="../com/polar/sdk/api/model/PolarDiskSpaceData.Companion.html#fromProto(&lt;ERROR CLASS&gt;)">fromProto(&lt;ERROR CLASS&gt;)</a>

</span> - function in com.polar.sdk.api.model.<a href=../com/polar/sdk/api/model/PolarDiskSpaceData.Companion.html>PolarDiskSpaceData.Companion</a>


</dt>
<dd>&nbsp;</dd>


</dl>

<a href="index-1.html">A</a>&nbsp;
Expand Down
Loading

0 comments on commit d54bc93

Please sign in to comment.