docs updated

polar-sdk-android/docs/html/PolarBleApiDefaultImpl_8java_source.html

@@ -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> com.androidcommunications.polar.api.ble.BleRefApiVersion;</div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno">    8</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="l00009"></a><span class="lineno">    9</span>&#160;</div><div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="classpolar_1_1com_1_1sdk_1_1api_1_1PolarBleApiDefaultImpl.html">   13</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="l00020"></a><span class="lineno"><a class="line" href="classpolar_1_1com_1_1sdk_1_1api_1_1PolarBleApiDefaultImpl.html#ae9faebaa48b7943c86ac54129b2f25a8">   20</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="l00021"></a><span class="lineno">   21</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="l00022"></a><span class="lineno">   22</span>&#160;    }</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classpolar_1_1com_1_1sdk_1_1api_1_1PolarBleApiDefaultImpl.html#a8ced2a3644832ffd8f3f07bc043bd8ec">   27</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="l00028"></a><span class="lineno">   28</span>&#160;        <span class="keywordflow">return</span> <span class="stringliteral">&quot;2.1.0&quot;</span>;</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;    }</div><div class="line"><a name="l00030"></a><span class="lineno">   30</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#l00090">BDBleApiImpl.java:90</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> com.androidcommunications.polar.api.ble.BleRefApiVersion;</div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno">    8</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="l00009"></a><span class="lineno">    9</span>&#160;</div><div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="classpolar_1_1com_1_1sdk_1_1api_1_1PolarBleApiDefaultImpl.html">   13</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="l00020"></a><span class="lineno"><a class="line" href="classpolar_1_1com_1_1sdk_1_1api_1_1PolarBleApiDefaultImpl.html#ae9faebaa48b7943c86ac54129b2f25a8">   20</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="l00021"></a><span class="lineno">   21</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="l00022"></a><span class="lineno">   22</span>&#160;    }</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classpolar_1_1com_1_1sdk_1_1api_1_1PolarBleApiDefaultImpl.html#a8ced2a3644832ffd8f3f07bc043bd8ec">   27</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="l00028"></a><span class="lineno">   28</span>&#160;        <span class="keywordflow">return</span> <span class="stringliteral">&quot;2.1.0&quot;</span>;</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;    }</div><div class="line"><a name="l00030"></a><span class="lineno">   30</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#l00092">BDBleApiImpl.java:92</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#l00013">PolarBleApiDefaultImpl.java:13</a></div></div>

polar-sdk-android/docs/html/PolarInvalidArgument_8java_source.html

@@ -66,7 +66,9 @@
 <div class="title">PolarInvalidArgument.java</div>  </div>
 </div><!--header-->
 <div class="contents">
-<a href="PolarInvalidArgument_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="keyword">package </span>polar.com.sdk.api.errors;</div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;</div><div class="line"><a name="l00003"></a><span class="lineno"><a class="line" href="classpolar_1_1com_1_1sdk_1_1api_1_1errors_1_1PolarInvalidArgument.html">    3</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_1errors_1_1PolarInvalidArgument.html">PolarInvalidArgument</a> <span class="keyword">extends</span> Exception {</div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;}</div><div class="ttc" id="classpolar_1_1com_1_1sdk_1_1api_1_1errors_1_1PolarInvalidArgument_html"><div class="ttname"><a href="classpolar_1_1com_1_1sdk_1_1api_1_1errors_1_1PolarInvalidArgument.html">polar.com.sdk.api.errors.PolarInvalidArgument</a></div><div class="ttdef"><b>Definition:</b> <a href="PolarInvalidArgument_8java_source.html#l00003">PolarInvalidArgument.java:3</a></div></div>
+<a href="PolarInvalidArgument_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="keyword">package </span>polar.com.sdk.api.errors;</div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;</div><div class="line"><a name="l00003"></a><span class="lineno"><a class="line" href="classpolar_1_1com_1_1sdk_1_1api_1_1errors_1_1PolarInvalidArgument.html">    3</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_1errors_1_1PolarInvalidArgument.html">PolarInvalidArgument</a> <span class="keyword">extends</span> Exception {</div><div class="line"><a name="l00004"></a><span class="lineno"><a class="line" href="classpolar_1_1com_1_1sdk_1_1api_1_1errors_1_1PolarInvalidArgument.html#a50c572e87ea2de686c775efbc1083cdf">    4</a></span>&#160;    <span class="keyword">public</span> <a class="code" href="classpolar_1_1com_1_1sdk_1_1api_1_1errors_1_1PolarInvalidArgument.html#a50c572e87ea2de686c775efbc1083cdf">PolarInvalidArgument</a>(String s) {</div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;        super(s);</div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;    }</div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="classpolar_1_1com_1_1sdk_1_1api_1_1errors_1_1PolarInvalidArgument.html#aeec81334def71742b85fb449386cfb4c">    8</a></span>&#160;    <span class="keyword">public</span> <a class="code" href="classpolar_1_1com_1_1sdk_1_1api_1_1errors_1_1PolarInvalidArgument.html#aeec81334def71742b85fb449386cfb4c">PolarInvalidArgument</a>() {</div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;    }</div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;}</div><div class="ttc" id="classpolar_1_1com_1_1sdk_1_1api_1_1errors_1_1PolarInvalidArgument_html"><div class="ttname"><a href="classpolar_1_1com_1_1sdk_1_1api_1_1errors_1_1PolarInvalidArgument.html">polar.com.sdk.api.errors.PolarInvalidArgument</a></div><div class="ttdef"><b>Definition:</b> <a href="PolarInvalidArgument_8java_source.html#l00003">PolarInvalidArgument.java:3</a></div></div>
+<div class="ttc" id="classpolar_1_1com_1_1sdk_1_1api_1_1errors_1_1PolarInvalidArgument_html_a50c572e87ea2de686c775efbc1083cdf"><div class="ttname"><a href="classpolar_1_1com_1_1sdk_1_1api_1_1errors_1_1PolarInvalidArgument.html#a50c572e87ea2de686c775efbc1083cdf">polar.com.sdk.api.errors.PolarInvalidArgument.PolarInvalidArgument</a></div><div class="ttdeci">PolarInvalidArgument(String s)</div><div class="ttdef"><b>Definition:</b> <a href="PolarInvalidArgument_8java_source.html#l00004">PolarInvalidArgument.java:4</a></div></div>
+<div class="ttc" id="classpolar_1_1com_1_1sdk_1_1api_1_1errors_1_1PolarInvalidArgument_html_aeec81334def71742b85fb449386cfb4c"><div class="ttname"><a href="classpolar_1_1com_1_1sdk_1_1api_1_1errors_1_1PolarInvalidArgument.html#aeec81334def71742b85fb449386cfb4c">polar.com.sdk.api.errors.PolarInvalidArgument.PolarInvalidArgument</a></div><div class="ttdeci">PolarInvalidArgument()</div><div class="ttdef"><b>Definition:</b> <a href="PolarInvalidArgument_8java_source.html#l00008">PolarInvalidArgument.java:8</a></div></div>
 </div><!-- fragment --></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->

polar-sdk-android/docs/html/classpolar_1_1com_1_1sdk_1_1api_1_1PolarBleApi.html

@@ -275,13 +275,14 @@ <h2 class="memtitle"><span class="permalink"><a href="#a3a0692503cb3f8ebd94bd393
 <p>Start connecting to a nearby Polar device. PolarBleApiCallback::polarDeviceConnected callback is invoked when connection to a nearby device is established. </p><dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">rssiLimit</td><td>RSSI (Received Signal Strength Indication) value is typically from -40 to -60 (dBm), depends on the used Bluetooth chipset and/or antenna tuning </td></tr>
+    <tr><td class="paramname">service</td><td>in hex string format like "180D" PolarInvalidArgument invoked if not in correct format </td></tr>
     <tr><td class="paramname">timeout</td><td>min time to search nearby device default = 2s </td></tr>
     <tr><td class="paramname">unit</td><td>time unit to be used </td></tr>
     <tr><td class="paramname">polarDeviceType</td><td>like H10, OH1 etc... or null for any polar device </td></tr>
   </table>
   </dd>
 </dl>
-<dl class="section return"><dt>Returns</dt><dd>rx Completable, complete invoked when nearby device found, and connection attempt started. polarDeviceConnectionAttemptStarted callback invoked to inform connection attempt </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd>rx Completable, complete invoked when nearby device found, and connection attempt started. deviceConnecting callback invoked to inform connection attempt </dd></dl>
 
 </div>
 </div>
@@ -404,7 +405,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#af5e518b8f1ef6ca3c4b1c95f
 </div><div class="memdoc">
 <p>Request a connection to a Polar device. Invokes PolarBleApiCallback::polarDeviceConnected callback. </p><dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramname">identifier</td><td>Polar device id found printed on the sensor/device or bt address </td></tr>
+    <tr><td class="paramname">identifier</td><td>Polar device id found printed on the sensor/device (in format "12345678") or bt address (in format "00:11:22:33:44:55") </td></tr>
   </table>
   </dd>
 </dl>

polar-sdk-android/docs/html/classpolar_1_1com_1_1sdk_1_1api_1_1errors_1_1PolarInvalidArgument.html

@@ -62,6 +62,8 @@
 </script>
 <div id="doc-content">
 <div class="header">
+  <div class="summary">
+<a href="#pub-methods">Public Member Functions</a>  </div>
   <div class="headertitle">
 <div class="title">polar.com.sdk.api.errors.PolarInvalidArgument Class Reference</div>  </div>
 </div><!--header-->
@@ -72,10 +74,74 @@
  <div class="center">
   <img src="classpolar_1_1com_1_1sdk_1_1api_1_1errors_1_1PolarInvalidArgument.png" alt=""/>
  </div></div>
+<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:a50c572e87ea2de686c775efbc1083cdf"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpolar_1_1com_1_1sdk_1_1api_1_1errors_1_1PolarInvalidArgument.html#a50c572e87ea2de686c775efbc1083cdf">PolarInvalidArgument</a> (String s)</td></tr>
+<tr class="separator:a50c572e87ea2de686c775efbc1083cdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aeec81334def71742b85fb449386cfb4c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpolar_1_1com_1_1sdk_1_1api_1_1errors_1_1PolarInvalidArgument.html#aeec81334def71742b85fb449386cfb4c">PolarInvalidArgument</a> ()</td></tr>
+<tr class="separator:aeec81334def71742b85fb449386cfb4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock">
 <p class="definition">Definition at line <a class="el" href="PolarInvalidArgument_8java_source.html#l00003">3</a> of file <a class="el" href="PolarInvalidArgument_8java_source.html">PolarInvalidArgument.java</a>.</p>
-</div><hr/>The documentation for this class was generated from the following file:<ul>
+</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
+<a id="a50c572e87ea2de686c775efbc1083cdf"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a50c572e87ea2de686c775efbc1083cdf">&#9670;&nbsp;</a></span>PolarInvalidArgument() <span class="overload">[1/2]</span></h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">polar.com.sdk.api.errors.PolarInvalidArgument.PolarInvalidArgument </td>
+          <td>(</td>
+          <td class="paramtype">String&#160;</td>
+          <td class="paramname"><em>s</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="PolarInvalidArgument_8java_source.html#l00004">4</a> of file <a class="el" href="PolarInvalidArgument_8java_source.html">PolarInvalidArgument.java</a>.</p>
+
+</div>
+</div>
+<a id="aeec81334def71742b85fb449386cfb4c"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aeec81334def71742b85fb449386cfb4c">&#9670;&nbsp;</a></span>PolarInvalidArgument() <span class="overload">[2/2]</span></h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">polar.com.sdk.api.errors.PolarInvalidArgument.PolarInvalidArgument </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="PolarInvalidArgument_8java_source.html#l00008">8</a> of file <a class="el" href="PolarInvalidArgument_8java_source.html">PolarInvalidArgument.java</a>.</p>
+
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following file:<ul>
 <li><a class="el" href="PolarInvalidArgument_8java_source.html">PolarInvalidArgument.java</a></li>
 </ul>
 </div><!-- contents -->