Updated SDK Doxygen documentations.

docs/d1/dea/class_gpio.html

@@ -133,12 +133,12 @@
 <tr class="memitem:a46c2e1f0fc7e212f8e7415df769258b0"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dea/class_gpio.html#a46c2e1f0fc7e212f8e7415df769258b0">shift_out</a> (<a class="el" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a> data, <a class="el" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a> clock, <a class="el" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a> bit_order, <a class="el" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a> value)</td></tr>
 <tr class="memdesc:a46c2e1f0fc7e212f8e7415df769258b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shift out data to a digital output pin.  <br /></td></tr>
 <tr class="separator:a46c2e1f0fc7e212f8e7415df769258b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:afb20af73d4a9f27fc55027f950693ab5"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dea/class_gpio.html#afb20af73d4a9f27fc55027f950693ab5">tone</a> (<a class="el" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a> pin, <a class="el" href="../../d9/d49/types_8h.html#a449a74b72ed931d627eca7efcc6f8c9d">u32</a> frequency, <a class="el" href="../../d9/d49/types_8h.html#ad9a16e74d880983f276dce5b0344b8bd">u64</a> duration)</td></tr>
-<tr class="memdesc:afb20af73d4a9f27fc55027f950693ab5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a tone of the specified frequency and duration on a GPIO pin.  <br /></td></tr>
-<tr class="separator:afb20af73d4a9f27fc55027f950693ab5"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a6512bdac9bebb453a3ba9073f24792cf"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dea/class_gpio.html#a6512bdac9bebb453a3ba9073f24792cf">no_tone</a> (<a class="el" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a> pin)</td></tr>
-<tr class="memdesc:a6512bdac9bebb453a3ba9073f24792cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop generating a tone on a GPIO pin.  <br /></td></tr>
-<tr class="separator:a6512bdac9bebb453a3ba9073f24792cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a8a0d3d33137cc027d570b4e22197abe6"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dea/class_gpio.html#a8a0d3d33137cc027d570b4e22197abe6">tone</a> (<a class="el" href="../../d9/d49/types_8h.html#a449a74b72ed931d627eca7efcc6f8c9d">u32</a> frequency, <a class="el" href="../../d9/d49/types_8h.html#ad9a16e74d880983f276dce5b0344b8bd">u64</a> duration)</td></tr>
+<tr class="memdesc:a8a0d3d33137cc027d570b4e22197abe6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a tone of the specified frequency and duration on GPIO25.  <br /></td></tr>
+<tr class="separator:a8a0d3d33137cc027d570b4e22197abe6"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ad2312e2418cd122855b4b73c91baef40"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dea/class_gpio.html#ad2312e2418cd122855b4b73c91baef40">no_tone</a> ()</td></tr>
+<tr class="memdesc:ad2312e2418cd122855b4b73c91baef40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop generating a tone on GPIO25.  <br /></td></tr>
+<tr class="separator:ad2312e2418cd122855b4b73c91baef40"><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 for handling GPIO operations in Rishka applications. </p>
@@ -308,8 +308,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a823fe9134bbf4a359247e801
 
 </div>
 </div>
-<a id="a6512bdac9bebb453a3ba9073f24792cf" name="a6512bdac9bebb453a3ba9073f24792cf"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a6512bdac9bebb453a3ba9073f24792cf">&#9670;&#160;</a></span>no_tone()</h2>
+<a id="ad2312e2418cd122855b4b73c91baef40" name="ad2312e2418cd122855b4b73c91baef40"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ad2312e2418cd122855b4b73c91baef40">&#9670;&#160;</a></span>no_tone()</h2>
 
 <div class="memitem">
 <div class="memproto">
@@ -320,8 +320,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a6512bdac9bebb453a3ba9073
         <tr>
           <td class="memname">void Gpio::no_tone </td>
           <td>(</td>
-          <td class="paramtype"><a class="el" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a>&#160;</td>
-          <td class="paramname"><em>pin</em></td><td>)</td>
+          <td class="paramname"></td><td>)</td>
           <td></td>
         </tr>
       </table>
@@ -332,14 +331,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a6512bdac9bebb453a3ba9073
 </table>
 </div><div class="memdoc">
 
-<p>Stop generating a tone on a GPIO pin. </p>
-<p>This method stops generating a tone on the specified GPIO pin.</p>
-<dl class="params"><dt>Parameters</dt><dd>
-  <table class="params">
-    <tr><td class="paramname">pin</td><td>The GPIO pin number. </td></tr>
-  </table>
-  </dd>
-</dl>
+<p>Stop generating a tone on GPIO25. </p>
+<p>This method stops generating a tone on GPIO25. </p>
 
 </div>
 </div>
@@ -611,8 +604,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a46c2e1f0fc7e212f8e7415df
 
 </div>
 </div>
-<a id="afb20af73d4a9f27fc55027f950693ab5" name="afb20af73d4a9f27fc55027f950693ab5"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#afb20af73d4a9f27fc55027f950693ab5">&#9670;&#160;</a></span>tone()</h2>
+<a id="a8a0d3d33137cc027d570b4e22197abe6" name="a8a0d3d33137cc027d570b4e22197abe6"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a8a0d3d33137cc027d570b4e22197abe6">&#9670;&#160;</a></span>tone()</h2>
 
 <div class="memitem">
 <div class="memproto">
@@ -623,12 +616,6 @@ <h2 class="memtitle"><span class="permalink"><a href="#afb20af73d4a9f27fc55027f9
         <tr>
           <td class="memname">void Gpio::tone </td>
           <td>(</td>
-          <td class="paramtype"><a class="el" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a>&#160;</td>
-          <td class="paramname"><em>pin</em>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
           <td class="paramtype"><a class="el" href="../../d9/d49/types_8h.html#a449a74b72ed931d627eca7efcc6f8c9d">u32</a>&#160;</td>
           <td class="paramname"><em>frequency</em>, </td>
         </tr>
@@ -651,11 +638,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#afb20af73d4a9f27fc55027f9
 </table>
 </div><div class="memdoc">
 
-<p>Generate a tone of the specified frequency and duration on a GPIO pin. </p>
-<p>This method generates a tone of the specified frequency and duration on the specified GPIO pin using pulse-width modulation (PWM).</p>
+<p>Generate a tone of the specified frequency and duration on GPIO25. </p>
+<p>This method generates a tone of the specified frequency and duration on the GPIO25 using pulse-width modulation (PWM).</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramname">pin</td><td>The GPIO pin number. </td></tr>
     <tr><td class="paramname">frequency</td><td>The frequency of the tone in Hertz (Hz). </td></tr>
     <tr><td class="paramname">duration</td><td>The duration of the tone in microseconds (0 for continuous). </td></tr>
   </table>

docs/d6/d7c/gpio_8h_source.html

@@ -148,24 +148,24 @@
 <div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span> </div>
 <div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span>    <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="../../d1/dea/class_gpio.html#a46c2e1f0fc7e212f8e7415df769258b0">shift_out</a>(<a class="code hl_typedef" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a> data, <a class="code hl_typedef" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a> clock, <a class="code hl_typedef" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a> bit_order, <a class="code hl_typedef" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a> value);</div>
 <div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span> </div>
-<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span>    <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="../../d1/dea/class_gpio.html#afb20af73d4a9f27fc55027f950693ab5">tone</a>(<a class="code hl_typedef" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a> pin, <a class="code hl_typedef" href="../../d9/d49/types_8h.html#a449a74b72ed931d627eca7efcc6f8c9d">u32</a> frequency, <a class="code hl_typedef" href="../../d9/d49/types_8h.html#ad9a16e74d880983f276dce5b0344b8bd">u64</a> duration);</div>
-<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span> </div>
-<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span>    <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="../../d1/dea/class_gpio.html#a6512bdac9bebb453a3ba9073f24792cf">no_tone</a>(<a class="code hl_typedef" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a> pin);</div>
-<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span>};</div>
-<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span> </div>
-<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><span class="preprocessor">#endif </span><span class="comment">/* LIBRISHKA_GPIO_H */</span><span class="preprocessor"></span></div>
+<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span>    <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="../../d1/dea/class_gpio.html#a8a0d3d33137cc027d570b4e22197abe6">tone</a>(<a class="code hl_typedef" href="../../d9/d49/types_8h.html#a449a74b72ed931d627eca7efcc6f8c9d">u32</a> frequency, <a class="code hl_typedef" href="../../d9/d49/types_8h.html#ad9a16e74d880983f276dce5b0344b8bd">u64</a> duration);</div>
+<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span> </div>
+<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span>    <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="../../d1/dea/class_gpio.html#ad2312e2418cd122855b4b73c91baef40">no_tone</a>();</div>
+<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span>};</div>
+<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span> </div>
+<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span><span class="preprocessor">#endif </span><span class="comment">/* LIBRISHKA_GPIO_H */</span><span class="preprocessor"></span></div>
 <div class="ttc" id="aclass_gpio_html"><div class="ttname"><a href="../../d1/dea/class_gpio.html">Gpio</a></div><div class="ttdoc">Class for handling GPIO operations in Rishka applications.</div><div class="ttdef"><b>Definition</b> gpio.h:67</div></div>
 <div class="ttc" id="aclass_gpio_html_a065fa69ac324fe76e67d47db841c4799"><div class="ttname"><a href="../../d1/dea/class_gpio.html#a065fa69ac324fe76e67d47db841c4799">Gpio::pulse_in_long</a></div><div class="ttdeci">static u64 pulse_in_long(u8 pin, u8 state, u64 timeout)</div><div class="ttdoc">Measure the duration of a long pulse on a GPIO pin.</div><div class="ttdef"><b>Definition</b> librishka_impl.cpp:358</div></div>
 <div class="ttc" id="aclass_gpio_html_a277cdf4dac5cc5304ccc776d76cc7229"><div class="ttname"><a href="../../d1/dea/class_gpio.html#a277cdf4dac5cc5304ccc776d76cc7229">Gpio::shift_in</a></div><div class="ttdeci">static u8 shift_in(u8 data, u8 clock, u8 bit_order)</div><div class="ttdoc">Shift in data from a digital input pin.</div><div class="ttdef"><b>Definition</b> librishka_impl.cpp:362</div></div>
 <div class="ttc" id="aclass_gpio_html_a46c2e1f0fc7e212f8e7415df769258b0"><div class="ttname"><a href="../../d1/dea/class_gpio.html#a46c2e1f0fc7e212f8e7415df769258b0">Gpio::shift_out</a></div><div class="ttdeci">static void shift_out(u8 data, u8 clock, u8 bit_order, u8 value)</div><div class="ttdoc">Shift out data to a digital output pin.</div><div class="ttdef"><b>Definition</b> librishka_impl.cpp:366</div></div>
 <div class="ttc" id="aclass_gpio_html_a56c27badbd92bb18593987e5cdd0fade"><div class="ttname"><a href="../../d1/dea/class_gpio.html#a56c27badbd92bb18593987e5cdd0fade">Gpio::pulse_in</a></div><div class="ttdeci">static u64 pulse_in(u8 pin, u8 state, u64 timeout)</div><div class="ttdoc">Measure the duration of a pulse on a GPIO pin.</div><div class="ttdef"><b>Definition</b> librishka_impl.cpp:354</div></div>
-<div class="ttc" id="aclass_gpio_html_a6512bdac9bebb453a3ba9073f24792cf"><div class="ttname"><a href="../../d1/dea/class_gpio.html#a6512bdac9bebb453a3ba9073f24792cf">Gpio::no_tone</a></div><div class="ttdeci">static void no_tone(u8 pin)</div><div class="ttdoc">Stop generating a tone on a GPIO pin.</div><div class="ttdef"><b>Definition</b> librishka_impl.cpp:374</div></div>
 <div class="ttc" id="aclass_gpio_html_a6cbd8fc2e5dabfd76389f78155643a39"><div class="ttname"><a href="../../d1/dea/class_gpio.html#a6cbd8fc2e5dabfd76389f78155643a39">Gpio::digital_read</a></div><div class="ttdeci">static gpio_mode_t digital_read(u8 pin)</div><div class="ttdoc">Read the digital value of a GPIO pin.</div><div class="ttdef"><b>Definition</b> librishka_impl.cpp:338</div></div>
 <div class="ttc" id="aclass_gpio_html_a823fe9134bbf4a359247e8018d01ff23"><div class="ttname"><a href="../../d1/dea/class_gpio.html#a823fe9134bbf4a359247e8018d01ff23">Gpio::digital_write</a></div><div class="ttdeci">static void digital_write(u8 pin, gpio_mode_t mode)</div><div class="ttdoc">Write a digital value to a GPIO pin.</div><div class="ttdef"><b>Definition</b> librishka_impl.cpp:342</div></div>
 <div class="ttc" id="aclass_gpio_html_a894cacb6cfe49f762692407f14bd13ab"><div class="ttname"><a href="../../d1/dea/class_gpio.html#a894cacb6cfe49f762692407f14bd13ab">Gpio::analog_read</a></div><div class="ttdeci">static u16 analog_read(u8 pin)</div><div class="ttdoc">Read the analog value of a GPIO pin.</div><div class="ttdef"><b>Definition</b> librishka_impl.cpp:346</div></div>
+<div class="ttc" id="aclass_gpio_html_a8a0d3d33137cc027d570b4e22197abe6"><div class="ttname"><a href="../../d1/dea/class_gpio.html#a8a0d3d33137cc027d570b4e22197abe6">Gpio::tone</a></div><div class="ttdeci">static void tone(u32 frequency, u64 duration)</div><div class="ttdoc">Generate a tone of the specified frequency and duration on GPIO25.</div><div class="ttdef"><b>Definition</b> librishka_impl.cpp:370</div></div>
 <div class="ttc" id="aclass_gpio_html_a956f98807a132fe5be3b6abc6555ff57"><div class="ttname"><a href="../../d1/dea/class_gpio.html#a956f98807a132fe5be3b6abc6555ff57">Gpio::pin_mode</a></div><div class="ttdeci">static void pin_mode(u8 pin, gpio_pin_mode_t mode)</div><div class="ttdoc">Set the mode of a GPIO pin.</div><div class="ttdef"><b>Definition</b> librishka_impl.cpp:334</div></div>
+<div class="ttc" id="aclass_gpio_html_ad2312e2418cd122855b4b73c91baef40"><div class="ttname"><a href="../../d1/dea/class_gpio.html#ad2312e2418cd122855b4b73c91baef40">Gpio::no_tone</a></div><div class="ttdeci">static void no_tone()</div><div class="ttdoc">Stop generating a tone on GPIO25.</div><div class="ttdef"><b>Definition</b> librishka_impl.cpp:374</div></div>
 <div class="ttc" id="aclass_gpio_html_aedb83f44dcb7832a7f2f3e81babfa246"><div class="ttname"><a href="../../d1/dea/class_gpio.html#aedb83f44dcb7832a7f2f3e81babfa246">Gpio::analog_write</a></div><div class="ttdeci">static void analog_write(u8 pin, u16 value)</div><div class="ttdoc">Write an analog value to a GPIO pin.</div><div class="ttdef"><b>Definition</b> librishka_impl.cpp:350</div></div>
-<div class="ttc" id="aclass_gpio_html_afb20af73d4a9f27fc55027f950693ab5"><div class="ttname"><a href="../../d1/dea/class_gpio.html#afb20af73d4a9f27fc55027f950693ab5">Gpio::tone</a></div><div class="ttdeci">static void tone(u8 pin, u32 frequency, u64 duration)</div><div class="ttdoc">Generate a tone of the specified frequency and duration on a GPIO pin.</div><div class="ttdef"><b>Definition</b> librishka_impl.cpp:370</div></div>
 <div class="ttc" id="agpio_8h_html_a491a2cbfb4e94f2afcc0d5bdef2dc454"><div class="ttname"><a href="../../d6/d7c/gpio_8h.html#a491a2cbfb4e94f2afcc0d5bdef2dc454">gpio_mode_t</a></div><div class="ttdeci">gpio_mode_t</div><div class="ttdoc">Enum representing the digital modes for GPIO pins.</div><div class="ttdef"><b>Definition</b> gpio.h:53</div></div>
 <div class="ttc" id="agpio_8h_html_a491a2cbfb4e94f2afcc0d5bdef2dc454ab05c5a854da4602143b6bd6096d86c4d"><div class="ttname"><a href="../../d6/d7c/gpio_8h.html#a491a2cbfb4e94f2afcc0d5bdef2dc454ab05c5a854da4602143b6bd6096d86c4d">GPIO_HIGH</a></div><div class="ttdeci">@ GPIO_HIGH</div><div class="ttdef"><b>Definition</b> gpio.h:55</div></div>
 <div class="ttc" id="agpio_8h_html_a491a2cbfb4e94f2afcc0d5bdef2dc454ad41cdd897d9b8714ef45ed6e9eba0dfa"><div class="ttname"><a href="../../d6/d7c/gpio_8h.html#a491a2cbfb4e94f2afcc0d5bdef2dc454ad41cdd897d9b8714ef45ed6e9eba0dfa">GPIO_LOW</a></div><div class="ttdeci">@ GPIO_LOW</div><div class="ttdef"><b>Definition</b> gpio.h:54</div></div>