Files
Fr-ssspindel_HNP/libs/LibRTOSConsole/doc/html/Console_8c.html
T
2026-10-16 18:25:42 +02:00

641 lines
45 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>LibRTOSConsole-C-Library: C:/HomeGit/STM32/libs/LibRTOSConsole/src/Console.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="banner.png"/></td>
<td id="projectalign">
<div id="projectname">LibRTOSConsole-C-Library<span id="projectnumber">&#160;1.0</span>
</div>
<div id="projectbrief">Library Code documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('Console_8c.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">Console.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;FreeRTOS.h&quot;</code><br />
<code>#include &quot;task.h&quot;</code><br />
<code>#include &quot;semphr.h&quot;</code><br />
<code>#include &lt;stdio.h&gt;</code><br />
<code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &lt;malloc.h&gt;</code><br />
<code>#include &lt;string.h&gt;</code><br />
<code>#include &lt;math.h&gt;</code><br />
<code>#include &lt;sys/queue.h&gt;</code><br />
<code>#include &quot;main.h&quot;</code><br />
<code>#include &quot;<a class="el" href="Console_8h_source.html">Console.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="ConsoleConfig_8h_source.html">ConsoleConfig.h</a>&quot;</code><br />
</div><div class="textblock"><div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Include dependency graph for Console.c:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="Console_8c__incl.png" border="0" usemap="#aC_1_2HomeGit_2STM32_2libs_2LibRTOSConsole_2src_2Console_8c" alt=""/></div>
<map name="aC_1_2HomeGit_2STM32_2libs_2LibRTOSConsole_2src_2Console_8c" id="aC_1_2HomeGit_2STM32_2libs_2LibRTOSConsole_2src_2Console_8c">
<area shape="rect" title=" " alt="" coords="451,5,662,48"/>
<area shape="rect" title=" " alt="" coords="5,96,100,123"/>
<area shape="poly" title=" " alt="" coords="451,45,115,98,114,93,450,40"/>
<area shape="rect" title=" " alt="" coords="124,96,181,123"/>
<area shape="poly" title=" " alt="" coords="451,48,333,69,197,98,196,93,332,64,450,42"/>
<area shape="rect" title=" " alt="" coords="206,96,281,123"/>
<area shape="poly" title=" " alt="" coords="476,51,296,97,295,92,475,46"/>
<area shape="rect" title=" " alt="" coords="305,96,365,123"/>
<area shape="poly" title=" " alt="" coords="500,51,381,94,379,89,499,46"/>
<area shape="rect" title=" " alt="" coords="389,96,452,123"/>
<area shape="poly" title=" " alt="" coords="523,51,456,90,454,85,520,46"/>
<area shape="rect" title=" " alt="" coords="476,96,546,123"/>
<area shape="poly" title=" " alt="" coords="547,50,528,84,523,81,543,47"/>
<area shape="rect" title=" " alt="" coords="571,96,635,123"/>
<area shape="poly" title=" " alt="" coords="571,47,591,81,586,84,566,50"/>
<area shape="rect" title=" " alt="" coords="659,96,720,123"/>
<area shape="poly" title=" " alt="" coords="592,46,657,85,655,90,589,51"/>
<area shape="rect" title=" " alt="" coords="745,96,837,123"/>
<area shape="poly" title=" " alt="" coords="618,46,741,88,739,93,616,51"/>
<area shape="rect" title=" " alt="" coords="861,96,921,123"/>
<area shape="poly" title=" " alt="" coords="652,46,846,92,845,98,651,51"/>
<area shape="rect" href="Console_8h.html" title=" " alt="" coords="946,96,1026,123"/>
<area shape="poly" title=" " alt="" coords="663,43,932,93,931,98,662,48"/>
<area shape="rect" href="ConsoleConfig_8h.html" title=" " alt="" coords="1051,96,1169,123"/>
<area shape="poly" title=" " alt="" coords="663,40,1036,93,1035,98,662,45"/>
</map>
</div>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcmdEntry.html">cmdEntry</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcmdState.html">cmdState</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcspState__t.html">cspState_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structConsoleHandle.html">ConsoleHandle</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:aa3d431b051e986e4518ba06a66b0bec4" id="r_aa3d431b051e986e4518ba06a66b0bec4"><td class="memItemLeft" align="right" valign="top"><a id="aa3d431b051e986e4518ba06a66b0bec4" name="aa3d431b051e986e4518ba06a66b0bec4"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CONSOLE_SAFETY_SPACE</b>&#160;&#160;&#160;4</td></tr>
<tr class="separator:aa3d431b051e986e4518ba06a66b0bec4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1440e493d41b692bcdad7f6a7961fd33" id="r_a1440e493d41b692bcdad7f6a7961fd33"><td class="memItemLeft" align="right" valign="top"><a id="a1440e493d41b692bcdad7f6a7961fd33" name="a1440e493d41b692bcdad7f6a7961fd33"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CONSOLE_MAX_NUM_ARGS</b>&#160;&#160;&#160;((<a class="el" href="ConsoleConfig_8h.html#ab02822a57aca549a5f56f57a51495276">CONSOLE_LINE_SIZE</a> / 3) + 4)</td></tr>
<tr class="separator:a1440e493d41b692bcdad7f6a7961fd33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23bf578bf5eb519cbc63b9488a76b6b2" id="r_a23bf578bf5eb519cbc63b9488a76b6b2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a23bf578bf5eb519cbc63b9488a76b6b2">CHECK_FOR_OVERFLOW</a>(x)</td></tr>
<tr class="separator:a23bf578bf5eb519cbc63b9488a76b6b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff6b53dd58cea43d24393a9a2f79e772" id="r_aff6b53dd58cea43d24393a9a2f79e772"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aff6b53dd58cea43d24393a9a2f79e772">xstr</a>(a)</td></tr>
<tr class="separator:aff6b53dd58cea43d24393a9a2f79e772"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6cf19e40e97afb5a7c29f7b439d091d" id="r_af6cf19e40e97afb5a7c29f7b439d091d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af6cf19e40e97afb5a7c29f7b439d091d">str</a>(a)</td></tr>
<tr class="separator:af6cf19e40e97afb5a7c29f7b439d091d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84d6e88d5f5a2262cab85f7b01da308c" id="r_a84d6e88d5f5a2262cab85f7b01da308c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a84d6e88d5f5a2262cab85f7b01da308c">ON_NULL_GOTO_ERROR</a>(x)</td></tr>
<tr class="separator:a84d6e88d5f5a2262cab85f7b01da308c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ad1b9c506c65f39619aae596fadaeff6d" id="r_ad1b9c506c65f39619aae596fadaeff6d"><td class="memItemLeft" align="right" valign="top"><a id="ad1b9c506c65f39619aae596fadaeff6d" name="ad1b9c506c65f39619aae596fadaeff6d"></a>
typedef struct <a class="el" href="structcmdEntry.html">cmdEntry</a>&#160;</td><td class="memItemRight" valign="bottom"><b>cmdEntry_t</b></td></tr>
<tr class="separator:ad1b9c506c65f39619aae596fadaeff6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a649fe4d2ad05ed83ff2c95215b1a69d1" id="r_a649fe4d2ad05ed83ff2c95215b1a69d1"><td class="memItemLeft" align="right" valign="top"><a id="a649fe4d2ad05ed83ff2c95215b1a69d1" name="a649fe4d2ad05ed83ff2c95215b1a69d1"></a>
typedef struct <a class="el" href="structcmdState.html">cmdState</a>&#160;</td><td class="memItemRight" valign="bottom"><b>cmdState_t</b></td></tr>
<tr class="separator:a649fe4d2ad05ed83ff2c95215b1a69d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a33d69e0b7ccbd2781a27b29b0fca8f6f" id="r_a33d69e0b7ccbd2781a27b29b0fca8f6f"><td class="memItemLeft" align="right" valign="top"><a id="a33d69e0b7ccbd2781a27b29b0fca8f6f" name="a33d69e0b7ccbd2781a27b29b0fca8f6f"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>cspTYPE</b> { <b>csptNONE</b>
, <b>csptCHARACTER</b>
, <b>csptCONTROL</b>
}</td></tr>
<tr class="separator:a33d69e0b7ccbd2781a27b29b0fca8f6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05ace7ec43eaba4b75f491cf3a390227" id="r_a05ace7ec43eaba4b75f491cf3a390227"><td class="memItemLeft" align="right" valign="top"><a id="a05ace7ec43eaba4b75f491cf3a390227" name="a05ace7ec43eaba4b75f491cf3a390227"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>ctrlCodes_t</b> { <br />
&#160;&#160;<b>ctrlC0_NUL</b> = 0x00
, <b>ctrlC0_SOH</b> = 0x01
, <b>ctrlC0_STX</b> = 0x02
, <b>ctrlC0_ETX</b> = 0x03
, <br />
&#160;&#160;<b>ctrlC0_EOT</b> = 0x04
, <b>ctrlC0_ENQ</b> = 0x05
, <b>ctrlC0_ACK</b> = 0x06
, <b>ctrlC0_BEL</b> = 0x07
, <br />
&#160;&#160;<b>ctrlC0_BS</b> = 0x08
, <b>ctrlC0_TAB</b> = 0x09
, <b>ctrlC0_LF</b> = 0x0A
, <b>ctrlC0_VT</b> = 0x0B
, <br />
&#160;&#160;<b>ctrlC0_FF</b> = 0x0C
, <b>ctrlC0_CR</b> = 0x0D
, <b>ctrlC0_SO</b> = 0x0E
, <b>ctrlC0_SI</b> = 0x0F
, <br />
&#160;&#160;<b>ctrlC0_DLE</b> = 0x10
, <b>ctrlC0_DC1</b> = 0x11
, <b>ctrlC0_DC2</b> = 0x12
, <b>ctrlC0_DC3</b> = 0x13
, <br />
&#160;&#160;<b>ctrlC0_DC4</b> = 0x14
, <b>ctrlC0_NAK</b> = 0x15
, <b>ctrlC0_SYN</b> = 0x16
, <b>ctrlC0_ETB</b> = 0x17
, <br />
&#160;&#160;<b>ctrlC0_CAN</b> = 0x18
, <b>ctrlC0_EM</b> = 0x19
, <b>ctrlC0_SUB</b> = 0x1A
, <b>ctrlC0_ESC</b> = 0x1B
, <br />
&#160;&#160;<b>ctrlC0_FS</b> = 0x1C
, <b>ctrlC0_GS</b> = 0x1D
, <b>ctrlC0_RS</b> = 0x1E
, <b>ctrlC0_US</b> = 0x1F
, <br />
&#160;&#160;<b>ctrlC0_DEL</b> = 0x7F
, <b>ctrlC1_MASK</b> = 0x100
, <b>ctrlC1_DCS</b> = 0x101
, <b>ctrlC1_CSI</b> = 0x102
, <br />
&#160;&#160;<b>ctrlC1_SOS</b> = 0x103
, <b>ctrlC1_PM</b> = 0x104
, <b>ctrlC1_APC</b> = 0x105
, <b>ctrlC1_ST</b> = 0x106
, <br />
&#160;&#160;<b>ctrlUNKNOWN</b> = 0x1000
, <b>ctrlOVERFLOW</b> = 0x1001
<br />
}</td></tr>
<tr class="separator:a05ace7ec43eaba4b75f491cf3a390227"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e782915205c755718877bb544e46162" id="r_a9e782915205c755718877bb544e46162"><td class="memItemLeft" align="right" valign="top"><a id="a9e782915205c755718877bb544e46162" name="a9e782915205c755718877bb544e46162"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>ctrlpStates_t</b> { <br />
&#160;&#160;<b>ctrlpsIDLE_DETECT</b> = 0
, <b>ctrlpsSTART_C1</b> = 1
, <b>ctrlpsHANDLE_CSI</b> = 2
, <b>ctrlpsHANDLE_ST_1</b> = 3
, <br />
&#160;&#160;<b>ctrlpsHANDLE_ST_2</b> = 4
<br />
}</td></tr>
<tr class="separator:a9e782915205c755718877bb544e46162"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a8c11a89326c85b9a812b0beadf148a8c" id="r_a8c11a89326c85b9a812b0beadf148a8c"><td class="memItemLeft" align="right" valign="top"><a id="a8c11a89326c85b9a812b0beadf148a8c" name="a8c11a89326c85b9a812b0beadf148a8c"></a>
cspTYPE&#160;</td><td class="memItemRight" valign="bottom"><b>ControlSequenceParserConsume</b> (char input, <a class="el" href="structcspState__t.html">cspState_t</a> *s)</td></tr>
<tr class="separator:a8c11a89326c85b9a812b0beadf148a8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58766aee5fdbeb523f8757bf98aa6844" id="r_a58766aee5fdbeb523f8757bf98aa6844"><td class="memItemLeft" align="right" valign="top"><a id="a58766aee5fdbeb523f8757bf98aa6844" name="a58766aee5fdbeb523f8757bf98aa6844"></a>
static int&#160;</td><td class="memItemRight" valign="bottom"><b>ProcessCommand</b> (char *command, int cmdLen, char **args, int numArgs, <a class="el" href="structcmdState.html">cmdState_t</a> *c, int *isAlias, char *inputBuffer, int inbuffsz)</td></tr>
<tr class="separator:a58766aee5fdbeb523f8757bf98aa6844"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b5e4b9c02a5ea281392a8a77a2ffc1e" id="r_a9b5e4b9c02a5ea281392a8a77a2ffc1e"><td class="memItemLeft" align="right" valign="top"><a id="a9b5e4b9c02a5ea281392a8a77a2ffc1e" name="a9b5e4b9c02a5ea281392a8a77a2ffc1e"></a>
static int&#160;</td><td class="memItemRight" valign="bottom"><b>TransformAndProcessTheCommand</b> (char *lineBuff, int line_size, <a class="el" href="structcmdState.html">cmdState_t</a> *cState)</td></tr>
<tr class="separator:a9b5e4b9c02a5ea281392a8a77a2ffc1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3e828bf17a72e64759d8ebe0b3230af" id="r_aa3e828bf17a72e64759d8ebe0b3230af"><td class="memItemLeft" align="right" valign="top"><a id="aa3e828bf17a72e64759d8ebe0b3230af" name="aa3e828bf17a72e64759d8ebe0b3230af"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>PrintConsoleControl</b> (<a class="el" href="structcspState__t.html">cspState_t</a> *s)</td></tr>
<tr class="separator:aa3e828bf17a72e64759d8ebe0b3230af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a667d61cbcd822690a57f44c2d35aa4b2" id="r_a667d61cbcd822690a57f44c2d35aa4b2"><td class="memItemLeft" align="right" valign="top"><a id="a667d61cbcd822690a57f44c2d35aa4b2" name="a667d61cbcd822690a57f44c2d35aa4b2"></a>
static int&#160;</td><td class="memItemRight" valign="bottom"><b>ConsoleIsArrowLeft</b> (<a class="el" href="structcspState__t.html">cspState_t</a> *s)</td></tr>
<tr class="separator:a667d61cbcd822690a57f44c2d35aa4b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27c484aa56c469da72d7f3ad60d01217" id="r_a27c484aa56c469da72d7f3ad60d01217"><td class="memItemLeft" align="right" valign="top"><a id="a27c484aa56c469da72d7f3ad60d01217" name="a27c484aa56c469da72d7f3ad60d01217"></a>
static int&#160;</td><td class="memItemRight" valign="bottom"><b>ConsoleIsArrowRight</b> (<a class="el" href="structcspState__t.html">cspState_t</a> *s)</td></tr>
<tr class="separator:a27c484aa56c469da72d7f3ad60d01217"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ad7fccfc6583cd393196048a395a6e3" id="r_a1ad7fccfc6583cd393196048a395a6e3"><td class="memItemLeft" align="right" valign="top"><a id="a1ad7fccfc6583cd393196048a395a6e3" name="a1ad7fccfc6583cd393196048a395a6e3"></a>
static int&#160;</td><td class="memItemRight" valign="bottom"><b>ConsoleIsArrowUp</b> (<a class="el" href="structcspState__t.html">cspState_t</a> *s)</td></tr>
<tr class="separator:a1ad7fccfc6583cd393196048a395a6e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79c55a01c2cee08fb056f28f9e61703a" id="r_a79c55a01c2cee08fb056f28f9e61703a"><td class="memItemLeft" align="right" valign="top"><a id="a79c55a01c2cee08fb056f28f9e61703a" name="a79c55a01c2cee08fb056f28f9e61703a"></a>
static int&#160;</td><td class="memItemRight" valign="bottom"><b>ConsoleIsArrowDown</b> (<a class="el" href="structcspState__t.html">cspState_t</a> *s)</td></tr>
<tr class="separator:a79c55a01c2cee08fb056f28f9e61703a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ed7f0548d3e13fd373496954bced9fc" id="r_a4ed7f0548d3e13fd373496954bced9fc"><td class="memItemLeft" align="right" valign="top"><a id="a4ed7f0548d3e13fd373496954bced9fc" name="a4ed7f0548d3e13fd373496954bced9fc"></a>
static int&#160;</td><td class="memItemRight" valign="bottom"><b>ConsoleIsEntf</b> (<a class="el" href="structcspState__t.html">cspState_t</a> *s)</td></tr>
<tr class="separator:a4ed7f0548d3e13fd373496954bced9fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61a562b7f041ba72933c0a2932f4f443" id="r_a61a562b7f041ba72933c0a2932f4f443"><td class="memItemLeft" align="right" valign="top"><a id="a61a562b7f041ba72933c0a2932f4f443" name="a61a562b7f041ba72933c0a2932f4f443"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>PrintConsoleArrowLeft</b> (void)</td></tr>
<tr class="separator:a61a562b7f041ba72933c0a2932f4f443"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad421602256c464d09af01e0ccf942935" id="r_ad421602256c464d09af01e0ccf942935"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad421602256c464d09af01e0ccf942935">CONSOLE_RedirectStreams</a> (<a class="el" href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed">ConsoleHandle_t</a> h, <a class="el" href="Console_8h.html#a12c3effabac4f86fdade6a4bf60c5f21">ConsoleReadStream_t</a> rdFunc, <a class="el" href="Console_8h.html#a6b0ace0f789c7b3dd7e0d33b5b60ec42">ConsoleWriteStream_t</a> wrFunc, void *rdContext, void *wrContext)</td></tr>
<tr class="separator:ad421602256c464d09af01e0ccf942935"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48760e552b01ef0f67b6907863b2160e" id="r_a48760e552b01ef0f67b6907863b2160e"><td class="memItemLeft" align="right" valign="top"><a id="a48760e552b01ef0f67b6907863b2160e" name="a48760e552b01ef0f67b6907863b2160e"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>ConsoleFunction</b> (void *arg)</td></tr>
<tr class="separator:a48760e552b01ef0f67b6907863b2160e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9ac4edc001478fa98649695d0cdf435" id="r_aa9ac4edc001478fa98649695d0cdf435"><td class="memItemLeft" align="right" valign="top"><a id="aa9ac4edc001478fa98649695d0cdf435" name="aa9ac4edc001478fa98649695d0cdf435"></a>
static int&#160;</td><td class="memItemRight" valign="bottom"><b>ConsolePrintHelp</b> (int argc, char **argv, void *context)</td></tr>
<tr class="separator:aa9ac4edc001478fa98649695d0cdf435"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65173f1baaafad193a55f608ff2664d4" id="r_a65173f1baaafad193a55f608ff2664d4"><td class="memItemLeft" align="right" valign="top"><a id="a65173f1baaafad193a55f608ff2664d4" name="a65173f1baaafad193a55f608ff2664d4"></a>
static int&#160;</td><td class="memItemRight" valign="bottom"><b>ConsoleExecReset</b> (int argc, char **argv, void *context)</td></tr>
<tr class="separator:a65173f1baaafad193a55f608ff2664d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13c346d262d7b9a5c73414fea0727d20" id="r_a13c346d262d7b9a5c73414fea0727d20"><td class="memItemLeft" align="right" valign="top"><a id="a13c346d262d7b9a5c73414fea0727d20" name="a13c346d262d7b9a5c73414fea0727d20"></a>
static int&#160;</td><td class="memItemRight" valign="bottom"><b>ConsolePrintKernelTicks</b> (int argc, char **argv, void *context)</td></tr>
<tr class="separator:a13c346d262d7b9a5c73414fea0727d20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad559ed92401464a27c8047d0e4d7b4ff" id="r_ad559ed92401464a27c8047d0e4d7b4ff"><td class="memItemLeft" align="right" valign="top"><a id="ad559ed92401464a27c8047d0e4d7b4ff" name="ad559ed92401464a27c8047d0e4d7b4ff"></a>
static int&#160;</td><td class="memItemRight" valign="bottom"><b>ConsolePrintKernelVersion</b> (int argc, char **argv, void *context)</td></tr>
<tr class="separator:ad559ed92401464a27c8047d0e4d7b4ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9984ce0be19917be9f4354f7f6175cd9" id="r_a9984ce0be19917be9f4354f7f6175cd9"><td class="memItemLeft" align="right" valign="top"><a id="a9984ce0be19917be9f4354f7f6175cd9" name="a9984ce0be19917be9f4354f7f6175cd9"></a>
static int&#160;</td><td class="memItemRight" valign="bottom"><b>ConsoleWhoAmI</b> (int argc, char **argv, void *context)</td></tr>
<tr class="separator:a9984ce0be19917be9f4354f7f6175cd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6083667e30c07931f8bac397a758eb4" id="r_ab6083667e30c07931f8bac397a758eb4"><td class="memItemLeft" align="right" valign="top"><a id="ab6083667e30c07931f8bac397a758eb4" name="ab6083667e30c07931f8bac397a758eb4"></a>
static int&#160;</td><td class="memItemRight" valign="bottom"><b>ConsoleExit</b> (int argc, char **argv, void *context)</td></tr>
<tr class="separator:ab6083667e30c07931f8bac397a758eb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d3500a9e174b06aef4634657280991a" id="r_a6d3500a9e174b06aef4634657280991a"><td class="memItemLeft" align="right" valign="top"><a id="a6d3500a9e174b06aef4634657280991a" name="a6d3500a9e174b06aef4634657280991a"></a>
static int&#160;</td><td class="memItemRight" valign="bottom"><b>ConsoleMallInfo</b> (int argc, char **argv, void *context)</td></tr>
<tr class="separator:a6d3500a9e174b06aef4634657280991a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ed5d066c983bfbc30ded46ecb06dd16" id="r_a7ed5d066c983bfbc30ded46ecb06dd16"><td class="memItemLeft" align="right" valign="top"><a id="a7ed5d066c983bfbc30ded46ecb06dd16" name="a7ed5d066c983bfbc30ded46ecb06dd16"></a>
static int&#160;</td><td class="memItemRight" valign="bottom"><b>ConsoleGetEnv</b> (int argc, char **argv, void *context)</td></tr>
<tr class="separator:a7ed5d066c983bfbc30ded46ecb06dd16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af259b146a811199fc3b4915033a3a1cb" id="r_af259b146a811199fc3b4915033a3a1cb"><td class="memItemLeft" align="right" valign="top"><a id="af259b146a811199fc3b4915033a3a1cb" name="af259b146a811199fc3b4915033a3a1cb"></a>
static int&#160;</td><td class="memItemRight" valign="bottom"><b>ConsoleSetEnv</b> (int argc, char **argv, void *context)</td></tr>
<tr class="separator:af259b146a811199fc3b4915033a3a1cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6a29575d7d80bc1aa4cfb6c80b6c394" id="r_ab6a29575d7d80bc1aa4cfb6c80b6c394"><td class="memItemLeft" align="right" valign="top"><a id="ab6a29575d7d80bc1aa4cfb6c80b6c394" name="ab6a29575d7d80bc1aa4cfb6c80b6c394"></a>
static int&#160;</td><td class="memItemRight" valign="bottom"><b>ConsoleAliasConfig</b> (int argc, char **argv, void *context)</td></tr>
<tr class="separator:ab6a29575d7d80bc1aa4cfb6c80b6c394"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09184568f2552bd78368afe6782348e6" id="r_a09184568f2552bd78368afe6782348e6"><td class="memItemLeft" align="right" valign="top"><a id="a09184568f2552bd78368afe6782348e6" name="a09184568f2552bd78368afe6782348e6"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>ConsoleRegisterBasicCommands</b> (<a class="el" href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed">ConsoleHandle_t</a> h)</td></tr>
<tr class="separator:a09184568f2552bd78368afe6782348e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1cc9e1f1895ce147a8402a545f431af0" id="r_a1cc9e1f1895ce147a8402a545f431af0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed">ConsoleHandle_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1cc9e1f1895ce147a8402a545f431af0">CONSOLE_CreateInstance</a> (unsigned int uxStackDepth, int xPrio)</td></tr>
<tr class="separator:a1cc9e1f1895ce147a8402a545f431af0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:addfc73ef0ae78e22f0ce2cfb9ea1858e" id="r_addfc73ef0ae78e22f0ce2cfb9ea1858e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#addfc73ef0ae78e22f0ce2cfb9ea1858e">CONSOLE_RegisterCommand</a> (<a class="el" href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed">ConsoleHandle_t</a> h, char *cmd, char *help, <a class="el" href="Console_8h.html#a46ebef7f89bcb306abadd6f600b8929f">CONSOLE_CommandFunc</a> func, void *context)</td></tr>
<tr class="separator:addfc73ef0ae78e22f0ce2cfb9ea1858e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f2d2d6d16197db3343378f8015be902" id="r_a9f2d2d6d16197db3343378f8015be902"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9f2d2d6d16197db3343378f8015be902">CONSOLE_RegisterAlias</a> (<a class="el" href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed">ConsoleHandle_t</a> h, char *cmd, char *aliasCmd)</td></tr>
<tr class="separator:a9f2d2d6d16197db3343378f8015be902"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0138abed767bbe0731ccbe18c0166295" id="r_a0138abed767bbe0731ccbe18c0166295"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0138abed767bbe0731ccbe18c0166295">CONSOLE_RemoveAliasOrCommand</a> (<a class="el" href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed">ConsoleHandle_t</a> h, char *cmd)</td></tr>
<tr class="separator:a0138abed767bbe0731ccbe18c0166295"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae795dfef72286b292ad0e8a5436b7d72" id="r_ae795dfef72286b292ad0e8a5436b7d72"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae795dfef72286b292ad0e8a5436b7d72">CONSOLE_DestroyInstance</a> (<a class="el" href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed">ConsoleHandle_t</a> h)</td></tr>
<tr class="separator:ae795dfef72286b292ad0e8a5436b7d72"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a23bf578bf5eb519cbc63b9488a76b6b2" name="a23bf578bf5eb519cbc63b9488a76b6b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23bf578bf5eb519cbc63b9488a76b6b2">&#9670;&#160;</a></span>CHECK_FOR_OVERFLOW</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CHECK_FOR_OVERFLOW</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>x</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">do</span> { <span class="keywordflow">if</span> ( ((x)+1) &gt; s-&gt;maxLength ) \</div>
<div class="line"> { s-&gt;type = ctrlOVERFLOW; s-&gt;length = 0; s-&gt;state = ctrlpsIDLE_DETECT; \</div>
<div class="line"> <span class="keywordflow">return</span> csptCONTROL; } } <span class="keywordflow">while</span>(0)</div>
</div><!-- fragment -->
</div>
</div>
<a id="a84d6e88d5f5a2262cab85f7b01da308c" name="a84d6e88d5f5a2262cab85f7b01da308c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84d6e88d5f5a2262cab85f7b01da308c">&#9670;&#160;</a></span>ON_NULL_GOTO_ERROR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ON_NULL_GOTO_ERROR</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>x</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> { <span class="keywordflow">if</span> ((x) == NULL) <span class="keywordflow">goto</span> error; } <span class="keywordflow">while</span>(0);</div>
</div><!-- fragment -->
</div>
</div>
<a id="af6cf19e40e97afb5a7c29f7b439d091d" name="af6cf19e40e97afb5a7c29f7b439d091d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6cf19e40e97afb5a7c29f7b439d091d">&#9670;&#160;</a></span>str</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define str</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>a</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="preprocessor">#a</span></div>
</div><!-- fragment -->
</div>
</div>
<a id="aff6b53dd58cea43d24393a9a2f79e772" name="aff6b53dd58cea43d24393a9a2f79e772"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff6b53dd58cea43d24393a9a2f79e772">&#9670;&#160;</a></span>xstr</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define xstr</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>a</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">str(a)</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a1cc9e1f1895ce147a8402a545f431af0" name="a1cc9e1f1895ce147a8402a545f431af0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1cc9e1f1895ce147a8402a545f431af0">&#9670;&#160;</a></span>CONSOLE_CreateInstance()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed">ConsoleHandle_t</a> CONSOLE_CreateInstance </td>
<td>(</td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>uxStackDepth</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>xPrio</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The CONSOLE_CreateInstance function is used to create the console processor. There is no singleton pattern implemented for the console but as there is no stream abstraction for the console processor, it only makes sense to have one instance at runtime!</p>
<p>The return value of a console function is a null pointer in case an error occured or a pointer of type <a class="el" href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed">ConsoleHandle_t</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uxStackDepth</td><td>is the stack depth of the console processor thread in words </td></tr>
<tr><td class="paramname">xPrio</td><td>is the console processor priority. This should always be on a low level because the stdlib function may not block and so the processor always runs whenever it can. In case the reception of the newlib is blocking and interrupt based, the priority could be higher! </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae795dfef72286b292ad0e8a5436b7d72" name="ae795dfef72286b292ad0e8a5436b7d72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae795dfef72286b292ad0e8a5436b7d72">&#9670;&#160;</a></span>CONSOLE_DestroyInstance()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CONSOLE_DestroyInstance </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed">ConsoleHandle_t</a></td> <td class="paramname"><span class="paramname"><em>h</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The CONSOLE_DestroyInstance function is used to cleanup all used ressources which then stops the console processor. This leads to the case that no console functionallity is provided in the design anymore </p>
</div>
</div>
<a id="ad421602256c464d09af01e0ccf942935" name="ad421602256c464d09af01e0ccf942935"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad421602256c464d09af01e0ccf942935">&#9670;&#160;</a></span>CONSOLE_RedirectStreams()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CONSOLE_RedirectStreams </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed">ConsoleHandle_t</a></td> <td class="paramname"><span class="paramname"><em>h</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="Console_8h.html#a12c3effabac4f86fdade6a4bf60c5f21">ConsoleReadStream_t</a></td> <td class="paramname"><span class="paramname"><em>rdFunc</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="Console_8h.html#a6b0ace0f789c7b3dd7e0d33b5b60ec42">ConsoleWriteStream_t</a></td> <td class="paramname"><span class="paramname"><em>wrFunc</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>rdContext</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>wrContext</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The CONSOLE_RedirectStreams function is used to change stdin or stdout as default streams for the console functions. In case one or both stream function pointers are NULL, it will be set back to stdin respectively stdout. In case of an error, the last stream configuration is kept and -1 is returned, otherwise 0</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">h</td><td>is of type <a class="el" href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed">ConsoleHandle_t</a> which is created by a call of CONSOLE_CreateInstance </td></tr>
<tr><td class="paramname">rdFunc</td><td>is of type <a class="el" href="Console_8h.html#a12c3effabac4f86fdade6a4bf60c5f21">ConsoleReadStream_t</a> which is the new stream read function for the command processor </td></tr>
<tr><td class="paramname">wrFunc</td><td>is of type <a class="el" href="Console_8h.html#a6b0ace0f789c7b3dd7e0d33b5b60ec42">ConsoleWriteStream_t</a> which is the new stream write function for the command processor</td></tr>
</table>
</dd>
</dl>
<p>NOTE it might be that not on all platforms it is possible to use this function, it then returns -2 if it is not implemented properly. So far only newlib stdlib is supported! </p>
</div>
</div>
<a id="a9f2d2d6d16197db3343378f8015be902" name="a9f2d2d6d16197db3343378f8015be902"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f2d2d6d16197db3343378f8015be902">&#9670;&#160;</a></span>CONSOLE_RegisterAlias()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CONSOLE_RegisterAlias </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed">ConsoleHandle_t</a></td> <td class="paramname"><span class="paramname"><em>h</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>cmd</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>aliasCmd</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The CONSOLE_RegisterAlias function is used to register custom commands which can be mapped to other commands when the user enters the given alias command string. Arguments will not be passed from an alias command to the mapped command, so the alias should be specified with the required commands accordingly</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">h</td><td>is of type <a class="el" href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed">ConsoleHandle_t</a> which is created by a call of CONSOLE_CreateInstance </td></tr>
<tr><td class="paramname">cmd</td><td>is of type char* which is the case sensitive name of the alias command </td></tr>
<tr><td class="paramname">aliasCmd</td><td>is of type char* which is the mapped command and its args and is visible when the user types help </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="addfc73ef0ae78e22f0ce2cfb9ea1858e" name="addfc73ef0ae78e22f0ce2cfb9ea1858e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#addfc73ef0ae78e22f0ce2cfb9ea1858e">&#9670;&#160;</a></span>CONSOLE_RegisterCommand()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CONSOLE_RegisterCommand </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed">ConsoleHandle_t</a></td> <td class="paramname"><span class="paramname"><em>h</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>cmd</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>help</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="Console_8h.html#a46ebef7f89bcb306abadd6f600b8929f">CONSOLE_CommandFunc</a></td> <td class="paramname"><span class="paramname"><em>func</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>context</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The CONSOLE_RegisterCommand function is used to register custom commands which can be called by the console processor when the user enters the given command string. The arguments and an additional context pointer are passed by the console processor to the function as well.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">h</td><td>is of type <a class="el" href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed">ConsoleHandle_t</a> which is created by a call of CONSOLE_CreateInstance </td></tr>
<tr><td class="paramname">cmd</td><td>is of type char* which is the case sensitive name of the command </td></tr>
<tr><td class="paramname">help</td><td>is of type char* which is the help text or description of the command when the user types help </td></tr>
<tr><td class="paramname">func</td><td>is of type <a class="el" href="Console_8h.html#a46ebef7f89bcb306abadd6f600b8929f">CONSOLE_CommandFunc</a> which is the function pointer to the command </td></tr>
<tr><td class="paramname">context</td><td>is of type void* which is an optional data pointer which is passed to the function when called </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0138abed767bbe0731ccbe18c0166295" name="a0138abed767bbe0731ccbe18c0166295"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0138abed767bbe0731ccbe18c0166295">&#9670;&#160;</a></span>CONSOLE_RemoveAliasOrCommand()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CONSOLE_RemoveAliasOrCommand </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed">ConsoleHandle_t</a></td> <td class="paramname"><span class="paramname"><em>h</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>cmd</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The CONSOLE_RemoveAliasOrCommand function is used to remove custom commands or alias entries which are mapped in the console processor.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">h</td><td>is of type <a class="el" href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed">ConsoleHandle_t</a> which is created by a call of CONSOLE_CreateInstance </td></tr>
<tr><td class="paramname">cmd</td><td>is of type char* which is the case sensitive name of the alias or command </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="Console_8c.html">Console.c</a></li>
<li class="footer">Generated on Mon Apr 14 2025 21:44:52 for LibRTOSConsole-C-Library by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
</ul>
</div>
</body>
</html>