Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
239 lines
12 KiB
HTML
239 lines
12 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/conf/ConsoleConfig.h 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"> 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&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&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&dn=expat.txt MIT */
|
|
$(function(){initNavTree('ConsoleConfig_8h.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="#define-members">Macros</a> </div>
|
|
<div class="headertitle"><div class="title">ConsoleConfig.h File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<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="+"/> This graph shows which files directly or indirectly include this file:</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="ConsoleConfig_8h__dep__incl.png" border="0" usemap="#aC_1_2HomeGit_2STM32_2libs_2LibRTOSConsole_2conf_2ConsoleConfig_8hdep" alt=""/></div>
|
|
<map name="aC_1_2HomeGit_2STM32_2libs_2LibRTOSConsole_2conf_2ConsoleConfig_8hdep" id="aC_1_2HomeGit_2STM32_2libs_2LibRTOSConsole_2conf_2ConsoleConfig_8hdep">
|
|
<area shape="rect" title=" " alt="" coords="30,5,192,64"/>
|
|
<area shape="rect" href="Console_8c.html" title=" " alt="" coords="5,112,217,155"/>
|
|
<area shape="poly" title=" " alt="" coords="114,79,114,112,108,112,108,79"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
<p><a href="ConsoleConfig_8h_source.html">Go to the source code of this file.</a></p>
|
|
<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:a650a5765c2fa67e26b1117b4da0cc37d" id="r_a650a5765c2fa67e26b1117b4da0cc37d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a650a5765c2fa67e26b1117b4da0cc37d">CONSOLE_USERNAME</a>   "STM32"</td></tr>
|
|
<tr class="separator:a650a5765c2fa67e26b1117b4da0cc37d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a291d1d9efdeeb97be9768193bffc4862" id="r_a291d1d9efdeeb97be9768193bffc4862"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a291d1d9efdeeb97be9768193bffc4862">CONSOLE_USE_DYNAMIC_USERNAME</a>   1</td></tr>
|
|
<tr class="separator:a291d1d9efdeeb97be9768193bffc4862"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a29976db9c3ace4c52d3a1c1c27008cbe" id="r_a29976db9c3ace4c52d3a1c1c27008cbe"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a29976db9c3ace4c52d3a1c1c27008cbe">CONSOLE_LINE_HISTORY</a>   8</td></tr>
|
|
<tr class="separator:a29976db9c3ace4c52d3a1c1c27008cbe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab02822a57aca549a5f56f57a51495276" id="r_ab02822a57aca549a5f56f57a51495276"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab02822a57aca549a5f56f57a51495276">CONSOLE_LINE_SIZE</a>   120</td></tr>
|
|
<tr class="separator:ab02822a57aca549a5f56f57a51495276"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a453741d332a8da6f8627c6f6c6c1e8fd" id="r_a453741d332a8da6f8627c6f6c6c1e8fd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a453741d332a8da6f8627c6f6c6c1e8fd">CONSOLE_COMMAND_MAX_LENGTH</a>   64</td></tr>
|
|
<tr class="separator:a453741d332a8da6f8627c6f6c6c1e8fd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adad1e9a68ad618b9200c66f7e5c918f9" id="r_adad1e9a68ad618b9200c66f7e5c918f9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#adad1e9a68ad618b9200c66f7e5c918f9">CONSOLE_HELP_MAX_LENGTH</a>   512</td></tr>
|
|
<tr class="separator:adad1e9a68ad618b9200c66f7e5c918f9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="a453741d332a8da6f8627c6f6c6c1e8fd" name="a453741d332a8da6f8627c6f6c6c1e8fd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a453741d332a8da6f8627c6f6c6c1e8fd">◆ </a></span>CONSOLE_COMMAND_MAX_LENGTH</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define CONSOLE_COMMAND_MAX_LENGTH   64</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Specifies the maximum number of chars per command </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adad1e9a68ad618b9200c66f7e5c918f9" name="adad1e9a68ad618b9200c66f7e5c918f9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adad1e9a68ad618b9200c66f7e5c918f9">◆ </a></span>CONSOLE_HELP_MAX_LENGTH</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define CONSOLE_HELP_MAX_LENGTH   512</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Specifies the maximum number of chars per command help text </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a29976db9c3ace4c52d3a1c1c27008cbe" name="a29976db9c3ace4c52d3a1c1c27008cbe"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a29976db9c3ace4c52d3a1c1c27008cbe">◆ </a></span>CONSOLE_LINE_HISTORY</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define CONSOLE_LINE_HISTORY   8</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>specifies the maximum number of entries of the "last commands" buffer </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab02822a57aca549a5f56f57a51495276" name="ab02822a57aca549a5f56f57a51495276"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab02822a57aca549a5f56f57a51495276">◆ </a></span>CONSOLE_LINE_SIZE</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define CONSOLE_LINE_SIZE   120</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Specifies the number of chars per line. When exceeding this number without a newline, the console prints a buffer overflow and clears the input. All inputs are then invalidated within this line </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a291d1d9efdeeb97be9768193bffc4862" name="a291d1d9efdeeb97be9768193bffc4862"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a291d1d9efdeeb97be9768193bffc4862">◆ </a></span>CONSOLE_USE_DYNAMIC_USERNAME</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define CONSOLE_USE_DYNAMIC_USERNAME   1</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The username ^can be changed on runtime which is enabled with this DEFINE </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a650a5765c2fa67e26b1117b4da0cc37d" name="a650a5765c2fa67e26b1117b4da0cc37d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a650a5765c2fa67e26b1117b4da0cc37d">◆ </a></span>CONSOLE_USERNAME</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define CONSOLE_USERNAME   "STM32"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>ATTENTION, this header is only a template, the user must provide its own implementation in the user project</p>
|
|
<p>The username in the console which is printed at least on power up before changing the username </p>
|
|
|
|
</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_60c1e009daff386049faf4e676bb6db8.html">conf</a></li><li class="navelem"><a class="el" href="ConsoleConfig_8h.html">ConsoleConfig.h</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>
|