Up-to-date Rishka documentation pages.

docs/d0/d04/class_sys.html

@@ -358,8 +358,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a3cc8c3d6432a431ea7655ddc
 </div><div class="memdoc">
 
 <p>Generate a random integer value. </p>
-<p>The <a class="el" href="#a3cc8c3d6432a431ea7655ddc272d2531" title="Generate a random integer value.">random()</a> function generates a pseudo-random integer value within the range supported by the underlying hardware's random number generator. The generated random value is suitable for various applications such as cryptographic operations, simulation, and randomization tasks.</p>
-<dl class="section return"><dt>Returns</dt><dd>A pseudo-random integer value within the supported range. </dd></dl>
+<p>The <a class="el" href="#a3cc8c3d6432a431ea7655ddc272d2531" title="Generate a random integer value.">random()</a> function generates a random integer value within the range supported by the underlying hardware's random number generator. The generated random value is suitable for various applications such as cryptographic operations, simulation, and randomization tasks.</p>
+<dl class="section return"><dt>Returns</dt><dd>A random integer value within the supported range. </dd></dl>
 
 </div>
 </div>

docs/d1/d31/class_file.html

@@ -118,7 +118,7 @@
 <tr class="memdesc:a037f889ba642432d5565ce09684732cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the object represents a directory.  <br /></td></tr>
 <tr class="separator:a037f889ba642432d5565ce09684732cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a953d743fbf60423ff33bcc6a9ed0f497" id="r_a953d743fbf60423ff33bcc6a9ed0f497"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d9/d49/types_8h.html#a3b1df617247dbb90f86c43c7e5a0504d">i32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a953d743fbf60423ff33bcc6a9ed0f497">available</a> ()</td></tr>
-<tr class="memdesc:a953d743fbf60423ff33bcc6a9ed0f497"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the object represents a directory.  <br /></td></tr>
+<tr class="memdesc:a953d743fbf60423ff33bcc6a9ed0f497"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number of bytes available for reading from the file.  <br /></td></tr>
 <tr class="separator:a953d743fbf60423ff33bcc6a9ed0f497"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a77d372dc30a7787ecf206c03e391ce0f" id="r_a77d372dc30a7787ecf206c03e391ce0f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d9/d49/types_8h.html#a3b1df617247dbb90f86c43c7e5a0504d">i32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a77d372dc30a7787ecf206c03e391ce0f">peek</a> ()</td></tr>
 <tr class="memdesc:a77d372dc30a7787ecf206c03e391ce0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Peek at the next byte in the file without consuming it.  <br /></td></tr>
@@ -169,7 +169,7 @@
 <tr class="memdesc:a83cbce54d6c3b8c2f417b51f6b3f488c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close the file.  <br /></td></tr>
 <tr class="separator:a83cbce54d6c3b8c2f417b51f6b3f488c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a80c6611e0e9e89f45307f7606e643cfa" id="r_a80c6611e0e9e89f45307f7606e643cfa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a80c6611e0e9e89f45307f7606e643cfa">rewind</a> ()</td></tr>
-<tr class="memdesc:a80c6611e0e9e89f45307f7606e643cfa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rewind the file pointer to the beginning of the file.  <br /></td></tr>
+<tr class="memdesc:a80c6611e0e9e89f45307f7606e643cfa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rewind the directory pointer to the beginning of the current working directory.  <br /></td></tr>
 <tr class="separator:a80c6611e0e9e89f45307f7606e643cfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
@@ -229,9 +229,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#a953d743fbf60423ff33bcc6a
       </table>
 </div><div class="memdoc">
 
-<p>Check if the object represents a directory. </p>
-<p>This method checks whether the <a class="el" href="../../d1/d31/class_file.html" title="Class for handling file operations in Rishka applications.">File</a> object represents a directory.</p>
-<dl class="section return"><dt>Returns</dt><dd>True if the object represents a directory, false otherwise. </dd></dl>
+<p>Get the number of bytes available for reading from the file. </p>
+<p>This method returns the number of bytes available for reading from the file.</p>
+<dl class="section return"><dt>Returns</dt><dd>The number of bytes available for reading. </dd></dl>
 
 </div>
 </div>
@@ -573,8 +573,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a80c6611e0e9e89f45307f760
       </table>
 </div><div class="memdoc">
 
-<p>Rewind the file pointer to the beginning of the file. </p>
-<p>This method rewinds the file pointer to the beginning of the file. </p>
+<p>Rewind the directory pointer to the beginning of the current working directory. </p>
+<p>This method rewinds the directory pointer to the beginning of the current working directory. </p>
 
 </div>
 </div>

docs/d1/dea/class_gpio.html

@@ -112,18 +112,18 @@
 <tr class="memitem:a956f98807a132fe5be3b6abc6555ff57" id="r_a956f98807a132fe5be3b6abc6555ff57"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a956f98807a132fe5be3b6abc6555ff57">pin_mode</a> (<a class="el" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a> pin, <a class="el" href="../../d6/d7c/gpio_8h.html#aa6beef903816a7ec928c22905e54dc08">gpio_pin_mode_t</a> mode)</td></tr>
 <tr class="memdesc:a956f98807a132fe5be3b6abc6555ff57"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the mode of a GPIO pin.  <br /></td></tr>
 <tr class="separator:a956f98807a132fe5be3b6abc6555ff57"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ab2de693ecd9de713143242bf6004901e" id="r_ab2de693ecd9de713143242bf6004901e"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../d9/d49/types_8h.html#a3b1df617247dbb90f86c43c7e5a0504d">i32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab2de693ecd9de713143242bf6004901e">digital_read</a> (<a class="el" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a> pin)</td></tr>
-<tr class="memdesc:ab2de693ecd9de713143242bf6004901e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read the digital value of a GPIO pin.  <br /></td></tr>
-<tr class="separator:ab2de693ecd9de713143242bf6004901e"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a6cbd8fc2e5dabfd76389f78155643a39" id="r_a6cbd8fc2e5dabfd76389f78155643a39"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../d6/d7c/gpio_8h.html#a491a2cbfb4e94f2afcc0d5bdef2dc454">gpio_mode_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6cbd8fc2e5dabfd76389f78155643a39">digital_read</a> (<a class="el" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a> pin)</td></tr>
+<tr class="memdesc:a6cbd8fc2e5dabfd76389f78155643a39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read the digital value of a GPIO pin.  <br /></td></tr>
+<tr class="separator:a6cbd8fc2e5dabfd76389f78155643a39"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a823fe9134bbf4a359247e8018d01ff23" id="r_a823fe9134bbf4a359247e8018d01ff23"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a823fe9134bbf4a359247e8018d01ff23">digital_write</a> (<a class="el" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a> pin, <a class="el" href="../../d6/d7c/gpio_8h.html#a491a2cbfb4e94f2afcc0d5bdef2dc454">gpio_mode_t</a> mode)</td></tr>
 <tr class="memdesc:a823fe9134bbf4a359247e8018d01ff23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a digital value to a GPIO pin.  <br /></td></tr>
 <tr class="separator:a823fe9134bbf4a359247e8018d01ff23"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:afb99a16a7b89010ed652eee947329614" id="r_afb99a16a7b89010ed652eee947329614"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../d9/d49/types_8h.html#a3b1df617247dbb90f86c43c7e5a0504d">i32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afb99a16a7b89010ed652eee947329614">analog_read</a> (<a class="el" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a> pin)</td></tr>
-<tr class="memdesc:afb99a16a7b89010ed652eee947329614"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read the analog value of a GPIO pin.  <br /></td></tr>
-<tr class="separator:afb99a16a7b89010ed652eee947329614"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a5ef755ff0063d3194144de6132ec62ac" id="r_a5ef755ff0063d3194144de6132ec62ac"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5ef755ff0063d3194144de6132ec62ac">analog_write</a> (<a class="el" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a> pin, <a class="el" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a> value)</td></tr>
-<tr class="memdesc:a5ef755ff0063d3194144de6132ec62ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write an analog value to a GPIO pin.  <br /></td></tr>
-<tr class="separator:a5ef755ff0063d3194144de6132ec62ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a894cacb6cfe49f762692407f14bd13ab" id="r_a894cacb6cfe49f762692407f14bd13ab"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../d9/d49/types_8h.html#a8aa9149a22317014c683c48cebd8cfef">u16</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a894cacb6cfe49f762692407f14bd13ab">analog_read</a> (<a class="el" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a> pin)</td></tr>
+<tr class="memdesc:a894cacb6cfe49f762692407f14bd13ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read the analog value of a GPIO pin.  <br /></td></tr>
+<tr class="separator:a894cacb6cfe49f762692407f14bd13ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aedb83f44dcb7832a7f2f3e81babfa246" id="r_aedb83f44dcb7832a7f2f3e81babfa246"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aedb83f44dcb7832a7f2f3e81babfa246">analog_write</a> (<a class="el" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a> pin, <a class="el" href="../../d9/d49/types_8h.html#a8aa9149a22317014c683c48cebd8cfef">u16</a> value)</td></tr>
+<tr class="memdesc:aedb83f44dcb7832a7f2f3e81babfa246"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write an analog value to a GPIO pin.  <br /></td></tr>
+<tr class="separator:aedb83f44dcb7832a7f2f3e81babfa246"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a56c27badbd92bb18593987e5cdd0fade" id="r_a56c27badbd92bb18593987e5cdd0fade"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../d9/d49/types_8h.html#ad9a16e74d880983f276dce5b0344b8bd">u64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a56c27badbd92bb18593987e5cdd0fade">pulse_in</a> (<a class="el" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a> pin, <a class="el" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a> state, <a class="el" href="../../d9/d49/types_8h.html#ad9a16e74d880983f276dce5b0344b8bd">u64</a> timeout)</td></tr>
 <tr class="memdesc:a56c27badbd92bb18593987e5cdd0fade"><td class="mdescLeft">&#160;</td><td class="mdescRight">Measure the duration of a pulse on a GPIO pin.  <br /></td></tr>
 <tr class="separator:a56c27badbd92bb18593987e5cdd0fade"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -147,8 +147,8 @@
 <div class="textblock"><p>Class for handling GPIO operations in Rishka applications. </p>
 <p>The <a class="el" href="../../d1/dea/class_gpio.html" title="Class for handling GPIO operations in Rishka applications.">Gpio</a> class provides static methods for configuring and manipulating General Purpose Input/Output (GPIO) pins on ESP32-WROVER microcontrollers. It includes functionalities for setting pin modes, reading digital and analog values, generating pulses, and controlling digital communication protocols. </p>
 </div><h2 class="groupheader">Member Function Documentation</h2>
-<a id="afb99a16a7b89010ed652eee947329614" name="afb99a16a7b89010ed652eee947329614"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#afb99a16a7b89010ed652eee947329614">&#9670;&#160;</a></span>analog_read()</h2>
+<a id="a894cacb6cfe49f762692407f14bd13ab" name="a894cacb6cfe49f762692407f14bd13ab"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a894cacb6cfe49f762692407f14bd13ab">&#9670;&#160;</a></span>analog_read()</h2>
 
 <div class="memitem">
 <div class="memproto">
@@ -157,7 +157,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#afb99a16a7b89010ed652eee9
   <td class="mlabels-left">
       <table class="memname">
         <tr>
-          <td class="memname"><a class="el" href="../../d9/d49/types_8h.html#a3b1df617247dbb90f86c43c7e5a0504d">i32</a> Gpio::analog_read </td>
+          <td class="memname"><a class="el" href="../../d9/d49/types_8h.html#a8aa9149a22317014c683c48cebd8cfef">u16</a> Gpio::analog_read </td>
           <td>(</td>
           <td class="paramtype"><a class="el" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a></td>          <td class="paramname"><span class="paramname"><em>pin</em></span></td><td>)</td>
           <td></td>
@@ -182,8 +182,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#afb99a16a7b89010ed652eee9
 
 </div>
 </div>
-<a id="a5ef755ff0063d3194144de6132ec62ac" name="a5ef755ff0063d3194144de6132ec62ac"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a5ef755ff0063d3194144de6132ec62ac">&#9670;&#160;</a></span>analog_write()</h2>
+<a id="aedb83f44dcb7832a7f2f3e81babfa246" name="aedb83f44dcb7832a7f2f3e81babfa246"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aedb83f44dcb7832a7f2f3e81babfa246">&#9670;&#160;</a></span>analog_write()</h2>
 
 <div class="memitem">
 <div class="memproto">
@@ -199,7 +199,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a5ef755ff0063d3194144de61
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype"><a class="el" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a></td>          <td class="paramname"><span class="paramname"><em>value</em></span>&#160;)</td>
+          <td class="paramtype"><a class="el" href="../../d9/d49/types_8h.html#a8aa9149a22317014c683c48cebd8cfef">u16</a></td>          <td class="paramname"><span class="paramname"><em>value</em></span>&#160;)</td>
         </tr>
       </table>
   </td>
@@ -221,8 +221,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a5ef755ff0063d3194144de61
 
 </div>
 </div>
-<a id="ab2de693ecd9de713143242bf6004901e" name="ab2de693ecd9de713143242bf6004901e"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#ab2de693ecd9de713143242bf6004901e">&#9670;&#160;</a></span>digital_read()</h2>
+<a id="a6cbd8fc2e5dabfd76389f78155643a39" name="a6cbd8fc2e5dabfd76389f78155643a39"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a6cbd8fc2e5dabfd76389f78155643a39">&#9670;&#160;</a></span>digital_read()</h2>
 
 <div class="memitem">
 <div class="memproto">
@@ -231,7 +231,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab2de693ecd9de713143242bf
   <td class="mlabels-left">
       <table class="memname">
         <tr>
-          <td class="memname"><a class="el" href="../../d9/d49/types_8h.html#a3b1df617247dbb90f86c43c7e5a0504d">i32</a> Gpio::digital_read </td>
+          <td class="memname"><a class="el" href="../../d6/d7c/gpio_8h.html#a491a2cbfb4e94f2afcc0d5bdef2dc454">gpio_mode_t</a> Gpio::digital_read </td>
           <td>(</td>
           <td class="paramtype"><a class="el" href="../../d9/d49/types_8h.html#ab9f930ae0484417a1883fd3f7cdb490e">u8</a></td>          <td class="paramname"><span class="paramname"><em>pin</em></span></td><td>)</td>
           <td></td>

docs/d3/d51/runtime_8h.html

@@ -115,7 +115,7 @@
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>Provides utilities for managing runtime operations within Rishka applications. </p>
 <dl class="section author"><dt>Author</dt><dd><a href="https://github.com/nthnn">Nathanne Isip</a> </dd></dl>
-<p>The <a class="el" href="../../d3/df6/class_runtime.html" title="The Runtime class provides utilities for managing runtime operations.">Runtime</a> class encapsulates functionality related to runtime management and control flow within Rishka applications. It serves as a central hub for coordinating runtime activities, such as task scheduling, event processing, and resource management. Developers can leverage the <a class="el" href="../../d3/df6/class_runtime.html" title="The Runtime class provides utilities for managing runtime operations.">Runtime</a> class to orchestrate the execution flow of their applications, ensuring efficient utilization of system resources and optimal performance. </p>
+<p>The <a class="el" href="../../d3/df6/class_runtime.html" title="The Runtime class provides utilities for managing runtime operations.">Runtime</a> class encapsulates functionality related to runtime management and control flow within Rishka applications. It serves as a central hub for coordinating runtime activities, such as task scheduling, event processing, and resource management. </p>
 </div></div><!-- contents -->
 </div><!-- doc-content -->
 <div id="nav-path" class="navpath">