Skip to content

Commit

Permalink
android docs udpated
Browse files Browse the repository at this point in the history
  • Loading branch information
Erkki Silvola committed Apr 17, 2020
1 parent 3c16267 commit 2bb7e25
Show file tree
Hide file tree
Showing 12 changed files with 214 additions and 134 deletions.
95 changes: 48 additions & 47 deletions polar-sdk-android/docs/html/BDBleApiImpl_8java_source.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
<div class="title">PolarBleApiDefaultImpl.java</div> </div>
</div><!--header-->
<div class="contents">
<a href="PolarBleApiDefaultImpl_8java.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Copyright © 2019 Polar Electro Oy. All rights reserved.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="keyword">package </span>polar.com.sdk.api;</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="keyword">import</span> android.content.Context;</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="keyword">import</span> <a class="code" href="namespacepolar.html">polar</a>.<a class="code" href="namespacepolar_1_1com.html">com</a>.<a class="code" href="namespacepolar_1_1com_1_1sdk.html">sdk</a>.<a class="code" href="namespacepolar_1_1com_1_1sdk_1_1impl.html">impl</a>.<a class="code" href="classpolar_1_1com_1_1sdk_1_1impl_1_1BDBleApiImpl.html">BDBleApiImpl</a>;</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="classpolar_1_1com_1_1sdk_1_1api_1_1PolarBleApiDefaultImpl.html"> 11</a></span>&#160;<span class="keyword">public</span> <span class="keyword">class </span><a class="code" href="classpolar_1_1com_1_1sdk_1_1api_1_1PolarBleApiDefaultImpl.html">PolarBleApiDefaultImpl</a> {</div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="classpolar_1_1com_1_1sdk_1_1api_1_1PolarBleApiDefaultImpl.html#ae9faebaa48b7943c86ac54129b2f25a8"> 18</a></span>&#160; <span class="keyword">public</span> <span class="keyword">static</span> <a class="code" href="classpolar_1_1com_1_1sdk_1_1api_1_1PolarBleApi.html">PolarBleApi</a> <a class="code" href="classpolar_1_1com_1_1sdk_1_1api_1_1PolarBleApiDefaultImpl.html#ae9faebaa48b7943c86ac54129b2f25a8">defaultImplementation</a>(<span class="keyword">final</span> Context context, <span class="keywordtype">int</span> features){</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="keywordflow">return</span> <span class="keyword">new</span> <a class="code" href="classpolar_1_1com_1_1sdk_1_1impl_1_1BDBleApiImpl.html">BDBleApiImpl</a>(context,features);</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; }</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classpolar_1_1com_1_1sdk_1_1api_1_1PolarBleApiDefaultImpl.html#a8ced2a3644832ffd8f3f07bc043bd8ec"> 25</a></span>&#160; <span class="keyword">public</span> <span class="keyword">static</span> String <a class="code" href="classpolar_1_1com_1_1sdk_1_1api_1_1PolarBleApiDefaultImpl.html#a8ced2a3644832ffd8f3f07bc043bd8ec">versionInfo</a>(){</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordflow">return</span> <span class="stringliteral">&quot;2.2.1&quot;</span>;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; }</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;}</div><div class="ttc" id="classpolar_1_1com_1_1sdk_1_1impl_1_1BDBleApiImpl_html"><div class="ttname"><a href="classpolar_1_1com_1_1sdk_1_1impl_1_1BDBleApiImpl.html">polar.com.sdk.impl.BDBleApiImpl</a></div><div class="ttdef"><b>Definition:</b> <a href="BDBleApiImpl_8java_source.html#l00094">BDBleApiImpl.java:94</a></div></div>
<a href="PolarBleApiDefaultImpl_8java.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Copyright © 2019 Polar Electro Oy. All rights reserved.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="keyword">package </span>polar.com.sdk.api;</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="keyword">import</span> android.content.Context;</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="keyword">import</span> <a class="code" href="namespacepolar.html">polar</a>.<a class="code" href="namespacepolar_1_1com.html">com</a>.<a class="code" href="namespacepolar_1_1com_1_1sdk.html">sdk</a>.<a class="code" href="namespacepolar_1_1com_1_1sdk_1_1impl.html">impl</a>.<a class="code" href="classpolar_1_1com_1_1sdk_1_1impl_1_1BDBleApiImpl.html">BDBleApiImpl</a>;</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="classpolar_1_1com_1_1sdk_1_1api_1_1PolarBleApiDefaultImpl.html"> 11</a></span>&#160;<span class="keyword">public</span> <span class="keyword">class </span><a class="code" href="classpolar_1_1com_1_1sdk_1_1api_1_1PolarBleApiDefaultImpl.html">PolarBleApiDefaultImpl</a> {</div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="classpolar_1_1com_1_1sdk_1_1api_1_1PolarBleApiDefaultImpl.html#ae9faebaa48b7943c86ac54129b2f25a8"> 18</a></span>&#160; <span class="keyword">public</span> <span class="keyword">static</span> <a class="code" href="classpolar_1_1com_1_1sdk_1_1api_1_1PolarBleApi.html">PolarBleApi</a> <a class="code" href="classpolar_1_1com_1_1sdk_1_1api_1_1PolarBleApiDefaultImpl.html#ae9faebaa48b7943c86ac54129b2f25a8">defaultImplementation</a>(<span class="keyword">final</span> Context context, <span class="keywordtype">int</span> features){</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="keywordflow">return</span> <span class="keyword">new</span> <a class="code" href="classpolar_1_1com_1_1sdk_1_1impl_1_1BDBleApiImpl.html">BDBleApiImpl</a>(context,features);</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; }</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classpolar_1_1com_1_1sdk_1_1api_1_1PolarBleApiDefaultImpl.html#a8ced2a3644832ffd8f3f07bc043bd8ec"> 25</a></span>&#160; <span class="keyword">public</span> <span class="keyword">static</span> String <a class="code" href="classpolar_1_1com_1_1sdk_1_1api_1_1PolarBleApiDefaultImpl.html#a8ced2a3644832ffd8f3f07bc043bd8ec">versionInfo</a>(){</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordflow">return</span> <span class="stringliteral">&quot;2.2.2&quot;</span>;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; }</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;}</div><div class="ttc" id="classpolar_1_1com_1_1sdk_1_1impl_1_1BDBleApiImpl_html"><div class="ttname"><a href="classpolar_1_1com_1_1sdk_1_1impl_1_1BDBleApiImpl.html">polar.com.sdk.impl.BDBleApiImpl</a></div><div class="ttdef"><b>Definition:</b> <a href="BDBleApiImpl_8java_source.html#l00094">BDBleApiImpl.java:94</a></div></div>
<div class="ttc" id="namespacepolar_html"><div class="ttname"><a href="namespacepolar.html">polar</a></div></div>
<div class="ttc" id="namespacepolar_1_1com_html"><div class="ttname"><a href="namespacepolar_1_1com.html">polar.com</a></div></div>
<div class="ttc" id="classpolar_1_1com_1_1sdk_1_1api_1_1PolarBleApiDefaultImpl_html"><div class="ttname"><a href="classpolar_1_1com_1_1sdk_1_1api_1_1PolarBleApiDefaultImpl.html">polar.com.sdk.api.PolarBleApiDefaultImpl</a></div><div class="ttdef"><b>Definition:</b> <a href="PolarBleApiDefaultImpl_8java_source.html#l00011">PolarBleApiDefaultImpl.java:11</a></div></div>
Expand Down
3 changes: 2 additions & 1 deletion polar-sdk-android/docs/html/PolarBleApi_8java_source.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,8 @@
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a17372e01394efb53e7c8f83cb0e379eb"><td class="memItemLeft" align="right" valign="top">abstract void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpolar_1_1com_1_1sdk_1_1api_1_1PolarBleApi.html#a17372e01394efb53e7c8f83cb0e379eb">setMtu</a> (@IntRange(from=70, to=512) int mtu)</td></tr>
<tr class="separator:a17372e01394efb53e7c8f83cb0e379eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6dec221f95ea5dce6118cadeb362006"><td class="memItemLeft" align="right" valign="top">abstract void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpolar_1_1com_1_1sdk_1_1api_1_1PolarBleApi.html#ab6dec221f95ea5dce6118cadeb362006">shutDown</a> ()</td></tr>
<tr class="separator:ab6dec221f95ea5dce6118cadeb362006"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43c533a7a7011c6d2f56a4497fae04f7"><td class="memItemLeft" align="right" valign="top">abstract void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpolar_1_1com_1_1sdk_1_1api_1_1PolarBleApi.html#a43c533a7a7011c6d2f56a4497fae04f7">cleanup</a> ()</td></tr>
Expand Down Expand Up @@ -976,6 +978,38 @@ <h2 class="memtitle"><span class="permalink"><a href="#ac8923ad69235615e62262a25
</dl>
<dl class="section return"><dt>Returns</dt><dd>Completable stream </dd></dl>

</div>
</div>
<a id="a17372e01394efb53e7c8f83cb0e379eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17372e01394efb53e7c8f83cb0e379eb">&#9670;&nbsp;</a></span>setMtu()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">abstract void polar.com.sdk.api.PolarBleApi.setMtu </td>
<td>(</td>
<td class="paramtype">@IntRange(from=70, to=512) int&#160;</td>
<td class="paramname"><em>mtu</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">abstract</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>set mtu to lower than default(232 is the default for polar devices, minimum for H10 is 70 and for OH1 is 140) to minimize latency </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mtu</td><td>value between 64-512 to be set </td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a id="ae7a6e7c991db4f0fecca383e639cc74c"></a>
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 2bb7e25

Please sign in to comment.