deploy: d3aff07

Author: kmilo17pet

classq_o_s_1_1core.html

@@ -181,7 +181,7 @@
 <tr class="memdesc:ga2cf5af2256df982e17035559ab177a93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a task to the scheduling scheme running an AT Command Line Interface. Task will be scheduled as event-triggered task. The parser address will be stored in the <a class="el" href="classq_o_s_1_1event__t.html#a44c21a4201ab6c42ce8a36ec91742787" title="Task arguments defined at the time of its creation. (Storage-Pointer)">event_t::TaskData</a> storage-Pointer.  <br /></td></tr>
 <tr class="separator:ga2cf5af2256df982e17035559ab177a93"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a426aade1d561f1f0e2f292acd0ece51c" id="r_a426aade1d561f1f0e2f292acd0ece51c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a426aade1d561f1f0e2f292acd0ece51c">add</a> (<a class="el" href="classq_o_s_1_1task.html">task</a> &amp;Task, <a class="el" href="classq_o_s_1_1input_1_1watcher.html">input::watcher</a> &amp;w, const <a class="el" href="group__qtypes.html#gafa40141ce2de5f15a1d9b1558466311a">priority_t</a> p=<a class="el" href="#a9b090820d0612980def0501f89653020">HIGHEST_PRIORITY</a>, const <a class="el" href="group__qtaskmanip.html#ga8eb83d12746447d118e970f385fef5a8">taskState</a> s=<a class="el" href="group__qtaskmanip.html#gga8eb83d12746447d118e970f385fef5a8af384a000870accb89c5c1f3bba962fe0">taskState::ENABLED_STATE</a>, void *arg=nullptr) noexcept</td></tr>
-<tr class="memdesc:a426aade1d561f1f0e2f292acd0ece51c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add an input-watcher so that its function is executed by the kernel.  <br /></td></tr>
+<tr class="memdesc:a426aade1d561f1f0e2f292acd0ece51c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add an input-watcher as a task so that its function is executed by the kernel.  <br /></td></tr>
 <tr class="separator:a426aade1d561f1f0e2f292acd0ece51c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a4991fda84316e63029be7e200dff6aa0" id="r_a4991fda84316e63029be7e200dff6aa0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4991fda84316e63029be7e200dff6aa0">setIdleTask</a> (<a class="el" href="group__qtaskmanip.html#ga0570508d64e1001573d1910d89cec472">taskFcn_t</a> callback) noexcept</td></tr>
 <tr class="memdesc:a4991fda84316e63029be7e200dff6aa0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set/Change the callback for the Idle-task.  <br /></td></tr>
@@ -302,11 +302,15 @@ <h2 class="memtitle"><span class="permalink"><a href="#a426aade1d561f1f0e2f292ac
 </table>
 </div><div class="memdoc">
 
-<p>Add an input-watcher so that its function is executed by the kernel. </p>
+<p>Add an input-watcher as a task so that its function is executed by the kernel. </p>
 <dl class="section note"><dt>Note</dt><dd>The input-watcher is considered as an always-active task </dd></dl>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
+    <tr><td class="paramdir">[in]</td><td class="paramname">Task</td><td>The task node. </td></tr>
     <tr><td class="paramdir">[in]</td><td class="paramname">w</td><td>The input watcher. </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">p</td><td>Task priority Value. [0(min) - <code>Q_PRIORITY_LEVELS</code> (max)] </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>Specifies the initial operational state of the task (<a class="el" href="group__qtaskmanip.html#gga8eb83d12746447d118e970f385fef5a8af384a000870accb89c5c1f3bba962fe0" title="The task can catch all the events. This operational state is available when the ENABLE bit is set.">taskState::ENABLED_STATE</a>, <a class="el" href="group__qtaskmanip.html#gga8eb83d12746447d118e970f385fef5a8ac30da079e916ce6def242ed46fac12c5" title="In this state, the time events will be discarded. This operational state is available when the ENABLE...">taskState::DISABLED_STATE</a>, <a class="el" href="group__qtaskmanip.html#gga8eb83d12746447d118e970f385fef5a8af113e1ff40cec2242040e71786e7bfd1" title="In this state, the task is conceptually in an alert mode, handling most of the available events....">taskState::AWAKE_STATE</a> or <a class="el" href="group__qtaskmanip.html#gga8eb83d12746447d118e970f385fef5a8af113e1ff40cec2242040e71786e7bfd1" title="In this state, the task is conceptually in an alert mode, handling most of the available events....">taskState::AWAKE_STATE(implies taskState::ENABLED_STATE,)</a>). </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">arg</td><td>The task arguments. </td></tr>
   </table>
   </dd>
 </dl>

classq_o_s_1_1input_1_1watcher-members.html

@@ -155,7 +155,7 @@
   <tr class="odd"><td class="entry"><a class="el" href="classq_o_s_1_1input_1_1watcher.html#a1edca438c66a4197a8e7296782dbfebb">remove</a>(channel &amp;c) noexcept</td><td class="entry"><a class="el" href="classq_o_s_1_1input_1_1watcher.html">qOS::input::watcher</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classq_o_s_1_1input_1_1watcher.html#a0703b4fef051351cd863d303dade48cb">watch</a>(void) noexcept</td><td class="entry"><a class="el" href="classq_o_s_1_1input_1_1watcher.html">qOS::input::watcher</a></td><td class="entry"></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classq_o_s_1_1input_1_1watcher.html#ae91a14fcccc429a4c88e09950930cc3c">watcher</a>(const qOS::duration_t dt=100_ms)</td><td class="entry"><a class="el" href="classq_o_s_1_1input_1_1watcher.html">qOS::input::watcher</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">explicit</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classq_o_s_1_1input_1_1watcher.html#ac2a0a54239cfaee6503b1b0a9d22761c">watcher</a>(const digitalReaderFcn_t &amp;rDigital, const analogReaderFcn_t &amp;rAnalog, const qOS::duration_t timeDebounce=100_ms)</td><td class="entry"><a class="el" href="classq_o_s_1_1input_1_1watcher.html">qOS::input::watcher</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classq_o_s_1_1input_1_1watcher.html#aee6790595d3cb8511a52fcac5c9facb8">watcher</a>(const digitalReaderFcn_t &amp;rDigital, const analogReaderFcn_t &amp;rAnalog, const qOS::duration_t dt=100_ms)</td><td class="entry"><a class="el" href="classq_o_s_1_1input_1_1watcher.html">qOS::input::watcher</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
 </table></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->

classq_o_s_1_1input_1_1watcher.html

@@ -166,9 +166,9 @@
 <tr class="memitem:ae91a14fcccc429a4c88e09950930cc3c" id="r_ae91a14fcccc429a4c88e09950930cc3c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae91a14fcccc429a4c88e09950930cc3c">watcher</a> (const <a class="el" href="group__qclock.html#ga23120959288587741e4741198212c8e9">qOS::duration_t</a> dt=100_ms)</td></tr>
 <tr class="memdesc:ae91a14fcccc429a4c88e09950930cc3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for the input-watcher instance.  <br /></td></tr>
 <tr class="separator:ae91a14fcccc429a4c88e09950930cc3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ac2a0a54239cfaee6503b1b0a9d22761c" id="r_ac2a0a54239cfaee6503b1b0a9d22761c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac2a0a54239cfaee6503b1b0a9d22761c">watcher</a> (const <a class="el" href="group__qinput.html#ga3b6e44648c5f6be1a0cc5c27138f771a">digitalReaderFcn_t</a> &amp;rDigital, const <a class="el" href="group__qinput.html#ga4d54566c9f0a347e22be79e1be218319">analogReaderFcn_t</a> &amp;rAnalog, const <a class="el" href="group__qclock.html#ga23120959288587741e4741198212c8e9">qOS::duration_t</a> timeDebounce=100_ms)</td></tr>
-<tr class="memdesc:ac2a0a54239cfaee6503b1b0a9d22761c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for the input-watcher instance.  <br /></td></tr>
-<tr class="separator:ac2a0a54239cfaee6503b1b0a9d22761c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aee6790595d3cb8511a52fcac5c9facb8" id="r_aee6790595d3cb8511a52fcac5c9facb8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aee6790595d3cb8511a52fcac5c9facb8">watcher</a> (const <a class="el" href="group__qinput.html#ga3b6e44648c5f6be1a0cc5c27138f771a">digitalReaderFcn_t</a> &amp;rDigital, const <a class="el" href="group__qinput.html#ga4d54566c9f0a347e22be79e1be218319">analogReaderFcn_t</a> &amp;rAnalog, const <a class="el" href="group__qclock.html#ga23120959288587741e4741198212c8e9">qOS::duration_t</a> dt=100_ms)</td></tr>
+<tr class="memdesc:aee6790595d3cb8511a52fcac5c9facb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for the input-watcher instance.  <br /></td></tr>
+<tr class="separator:aee6790595d3cb8511a52fcac5c9facb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a94e0fda2802a8a5cb07892d2e960ab1a" id="r_a94e0fda2802a8a5cb07892d2e960ab1a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a94e0fda2802a8a5cb07892d2e960ab1a">add</a> (<a class="el" href="classq_o_s_1_1input_1_1channel.html">channel</a> &amp;c) noexcept</td></tr>
 <tr class="memdesc:a94e0fda2802a8a5cb07892d2e960ab1a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a channel to the watcher instance.  <br /></td></tr>
 <tr class="separator:a94e0fda2802a8a5cb07892d2e960ab1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -226,15 +226,15 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae91a14fcccc429a4c88e0995
 <p>Constructor for the input-watcher instance. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">timeDebounce</td><td>The specified time to bypass the bounce of the digital input channels </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">dt</td><td>The specified time to bypass the bounce of the digital input channels </td></tr>
   </table>
   </dd>
 </dl>
 
 </div>
 </div>
-<a id="ac2a0a54239cfaee6503b1b0a9d22761c" name="ac2a0a54239cfaee6503b1b0a9d22761c"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#ac2a0a54239cfaee6503b1b0a9d22761c">&#9670;&#160;</a></span>watcher() <span class="overload">[2/2]</span></h2>
+<a id="aee6790595d3cb8511a52fcac5c9facb8" name="aee6790595d3cb8511a52fcac5c9facb8"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aee6790595d3cb8511a52fcac5c9facb8">&#9670;&#160;</a></span>watcher() <span class="overload">[2/2]</span></h2>
 
 <div class="memitem">
 <div class="memproto">
@@ -255,7 +255,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ac2a0a54239cfaee6503b1b0a
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype">const <a class="el" href="group__qclock.html#ga23120959288587741e4741198212c8e9">qOS::duration_t</a></td>          <td class="paramname"><span class="paramname"><em>timeDebounce</em></span><span class="paramdefsep"> = </span><span class="paramdefval">100_ms</span>&#160;)</td>
+          <td class="paramtype">const <a class="el" href="group__qclock.html#ga23120959288587741e4741198212c8e9">qOS::duration_t</a></td>          <td class="paramname"><span class="paramname"><em>dt</em></span><span class="paramdefsep"> = </span><span class="paramdefval">100_ms</span>&#160;)</td>
         </tr>
       </table>
   </td>

classq_o_s_1_1input_1_1watcher.js

@@ -1,7 +1,7 @@
 var classq_o_s_1_1input_1_1watcher =
 [
     [ "watcher", "classq_o_s_1_1input_1_1watcher.html#ae91a14fcccc429a4c88e09950930cc3c", null ],
-    [ "watcher", "classq_o_s_1_1input_1_1watcher.html#ac2a0a54239cfaee6503b1b0a9d22761c", null ],
+    [ "watcher", "classq_o_s_1_1input_1_1watcher.html#aee6790595d3cb8511a52fcac5c9facb8", null ],
     [ "add", "classq_o_s_1_1input_1_1watcher.html#a94e0fda2802a8a5cb07892d2e960ab1a", null ],
     [ "add", "classq_o_s_1_1input_1_1watcher.html#a7603e2fc1c9afcb1e8dfec0875c73ee7", null ],
     [ "add", "classq_o_s_1_1input_1_1watcher.html#ad25b4fc7a579e07d18701a9ac90d9199", null ],

doxygen_crawl.html

@@ -177,10 +177,10 @@
 <a href="classq_o_s_1_1input_1_1watcher.html#a7603e2fc1c9afcb1e8dfec0875c73ee7"/>
 <a href="classq_o_s_1_1input_1_1watcher.html#a94e0fda2802a8a5cb07892d2e960ab1a"/>
 <a href="classq_o_s_1_1input_1_1watcher.html#aa88c98c4b8ddc101c3e3900a6c439463"/>
-<a href="classq_o_s_1_1input_1_1watcher.html#ac2a0a54239cfaee6503b1b0a9d22761c"/>
 <a href="classq_o_s_1_1input_1_1watcher.html#ad25b4fc7a579e07d18701a9ac90d9199"/>
 <a href="classq_o_s_1_1input_1_1watcher.html#ad74b9fdd7335eb00f6b6f647135219d3"/>
 <a href="classq_o_s_1_1input_1_1watcher.html#ae91a14fcccc429a4c88e09950930cc3c"/>
+<a href="classq_o_s_1_1input_1_1watcher.html#aee6790595d3cb8511a52fcac5c9facb8"/>
 <a href="classq_o_s_1_1list-members.html"/>
 <a href="classq_o_s_1_1list.html"/>
 <a href="classq_o_s_1_1list.html#a084fde89ef2d870fd89807ba6d31aba0"/>

group__qinput.js

@@ -39,7 +39,7 @@ var group__qinput =
     ] ],
     [ "qOS::input::watcher", "classq_o_s_1_1input_1_1watcher.html", [
       [ "watcher", "classq_o_s_1_1input_1_1watcher.html#ae91a14fcccc429a4c88e09950930cc3c", null ],
-      [ "watcher", "classq_o_s_1_1input_1_1watcher.html#ac2a0a54239cfaee6503b1b0a9d22761c", null ],
+      [ "watcher", "classq_o_s_1_1input_1_1watcher.html#aee6790595d3cb8511a52fcac5c9facb8", null ],
       [ "add", "classq_o_s_1_1input_1_1watcher.html#a94e0fda2802a8a5cb07892d2e960ab1a", null ],
       [ "add", "classq_o_s_1_1input_1_1watcher.html#a7603e2fc1c9afcb1e8dfec0875c73ee7", null ],
       [ "add", "classq_o_s_1_1input_1_1watcher.html#ad25b4fc7a579e07d18701a9ac90d9199", null ],