mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
846 lines
82 KiB
HTML
846 lines
82 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.6"/>
|
|
<title>ArduinoLibs: Shell Class 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>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</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 style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">ArduinoLibs
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.6 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#friends">Friends</a> |
|
|
<a href="#related">Related Functions</a> |
|
|
<a href="classShell-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Shell Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Command-line shell access.
|
|
<a href="classShell.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="Shell_8h_source.html">Shell.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for Shell:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classShell.png" usemap="#Shell_map" alt=""/>
|
|
<map id="Shell_map" name="Shell_map">
|
|
<area href="classTerminal.html" title="Extended stream interface for terminal operations. " alt="Terminal" shape="rect" coords="0,56,71,80"/>
|
|
<area href="classLoginShell.html" title="Command-line shell access via a login shell. " alt="LoginShell" shape="rect" coords="0,168,71,192"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:ad613444a902075e8fd26b1f51c4d3b63"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classShell.html#ad613444a902075e8fd26b1f51c4d3b63">Shell</a> ()</td></tr>
|
|
<tr class="memdesc:ad613444a902075e8fd26b1f51c4d3b63"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new <a class="el" href="classShell.html" title="Command-line shell access. ">Shell</a> instance. <a href="#ad613444a902075e8fd26b1f51c4d3b63">More...</a><br/></td></tr>
|
|
<tr class="separator:ad613444a902075e8fd26b1f51c4d3b63"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a95f78f499b3dfd9c83f4099cf90ef3df"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a95f78f499b3dfd9c83f4099cf90ef3df"></a>
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classShell.html#a95f78f499b3dfd9c83f4099cf90ef3df">~Shell</a> ()</td></tr>
|
|
<tr class="memdesc:a95f78f499b3dfd9c83f4099cf90ef3df"><td class="mdescLeft"> </td><td class="mdescRight">Destroys this <a class="el" href="classShell.html" title="Command-line shell access. ">Shell</a> object. <br/></td></tr>
|
|
<tr class="separator:a95f78f499b3dfd9c83f4099cf90ef3df"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad9acba905b6e0b661cce19d57c067990"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classShell.html#ad9acba905b6e0b661cce19d57c067990">begin</a> (Stream &<a class="el" href="classTerminal.html#a18f46590476d5231e9480b5f69a68f63">stream</a>, size_t maxHistory=0, <a class="el" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364">Terminal::Mode</a> <a class="el" href="classTerminal.html#acbf591c7371acba52bcd84ba4a0ce5c8">mode</a>=<a class="el" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364a7efe0e37dae166c00d913190cd8f55f6">Serial</a>)</td></tr>
|
|
<tr class="memdesc:ad9acba905b6e0b661cce19d57c067990"><td class="mdescLeft"> </td><td class="mdescRight">Begin shell handling on an underlying character stream. <a href="#ad9acba905b6e0b661cce19d57c067990">More...</a><br/></td></tr>
|
|
<tr class="separator:ad9acba905b6e0b661cce19d57c067990"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3ff0cc86725388d4fe92520e5a18ad92"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classShell.html#a3ff0cc86725388d4fe92520e5a18ad92">begin</a> (Client &client, size_t maxHistory=0, <a class="el" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364">Terminal::Mode</a> <a class="el" href="classTerminal.html#acbf591c7371acba52bcd84ba4a0ce5c8">mode</a>=<a class="el" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364a71eb4637496b7a884384c4250f3289a7">Telnet</a>)</td></tr>
|
|
<tr class="memdesc:a3ff0cc86725388d4fe92520e5a18ad92"><td class="mdescLeft"> </td><td class="mdescRight">Begin shell handling on a connected TCP client. <a href="#a3ff0cc86725388d4fe92520e5a18ad92">More...</a><br/></td></tr>
|
|
<tr class="separator:a3ff0cc86725388d4fe92520e5a18ad92"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8a654aadd0b6a379309bb1007749e41d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classShell.html#a8a654aadd0b6a379309bb1007749e41d">end</a> ()</td></tr>
|
|
<tr class="memdesc:a8a654aadd0b6a379309bb1007749e41d"><td class="mdescLeft"> </td><td class="mdescRight">Ends shell processing on the underlying stream. <a href="#a8a654aadd0b6a379309bb1007749e41d">More...</a><br/></td></tr>
|
|
<tr class="separator:a8a654aadd0b6a379309bb1007749e41d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afc45cae4ccfc76321a254bb617dce08c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classShell.html#afc45cae4ccfc76321a254bb617dce08c">loop</a> ()</td></tr>
|
|
<tr class="memdesc:afc45cae4ccfc76321a254bb617dce08c"><td class="mdescLeft"> </td><td class="mdescRight">Performs regular activities on the shell. <a href="#afc45cae4ccfc76321a254bb617dce08c">More...</a><br/></td></tr>
|
|
<tr class="separator:afc45cae4ccfc76321a254bb617dce08c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af4a335f97bc888a25f7e54f2a025c11c"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classShell.html#af4a335f97bc888a25f7e54f2a025c11c">prompt</a> () const </td></tr>
|
|
<tr class="memdesc:af4a335f97bc888a25f7e54f2a025c11c"><td class="mdescLeft"> </td><td class="mdescRight">Gets the prompt string to display in the shell. <a href="#af4a335f97bc888a25f7e54f2a025c11c">More...</a><br/></td></tr>
|
|
<tr class="separator:af4a335f97bc888a25f7e54f2a025c11c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a89d802eae5b716e80b2c4dfbce0a0a75"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classShell.html#a89d802eae5b716e80b2c4dfbce0a0a75">setPrompt</a> (const char *<a class="el" href="classShell.html#af4a335f97bc888a25f7e54f2a025c11c">prompt</a>)</td></tr>
|
|
<tr class="memdesc:a89d802eae5b716e80b2c4dfbce0a0a75"><td class="mdescLeft"> </td><td class="mdescRight">Sets the prompt string to display in the shell. <a href="#a89d802eae5b716e80b2c4dfbce0a0a75">More...</a><br/></td></tr>
|
|
<tr class="separator:a89d802eae5b716e80b2c4dfbce0a0a75"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6ae6e1af0a7f6116e6a9a1e658fb9a84"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classShell.html#a6ae6e1af0a7f6116e6a9a1e658fb9a84">userid</a> () const </td></tr>
|
|
<tr class="memdesc:a6ae6e1af0a7f6116e6a9a1e658fb9a84"><td class="mdescLeft"> </td><td class="mdescRight">Gets the user identifier for the currently logged in user, or -1 if there is no user logged in currently. <a href="#a6ae6e1af0a7f6116e6a9a1e658fb9a84">More...</a><br/></td></tr>
|
|
<tr class="separator:a6ae6e1af0a7f6116e6a9a1e658fb9a84"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5db7316a4feb9829beea11dfe65462d2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classShell.html#a5db7316a4feb9829beea11dfe65462d2">setUserid</a> (int <a class="el" href="classShell.html#a6ae6e1af0a7f6116e6a9a1e658fb9a84">userid</a>)</td></tr>
|
|
<tr class="memdesc:a5db7316a4feb9829beea11dfe65462d2"><td class="mdescLeft"> </td><td class="mdescRight">Sets the user identifier for the currently logged in user. <a href="#a5db7316a4feb9829beea11dfe65462d2">More...</a><br/></td></tr>
|
|
<tr class="separator:a5db7316a4feb9829beea11dfe65462d2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a58b0e9104d1f6c7ec7d1663c69cd03dd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a58b0e9104d1f6c7ec7d1663c69cd03dd"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classShell.html#a58b0e9104d1f6c7ec7d1663c69cd03dd">help</a> ()</td></tr>
|
|
<tr class="memdesc:a58b0e9104d1f6c7ec7d1663c69cd03dd"><td class="mdescLeft"> </td><td class="mdescRight">Displays help for all supported commands. <br/></td></tr>
|
|
<tr class="separator:a58b0e9104d1f6c7ec7d1663c69cd03dd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab9dab65bc0757ce3bb0ac926bbefcee3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classShell.html#ab9dab65bc0757ce3bb0ac926bbefcee3">exit</a> ()</td></tr>
|
|
<tr class="memdesc:ab9dab65bc0757ce3bb0ac926bbefcee3"><td class="mdescLeft"> </td><td class="mdescRight">Exit from the shell back to the login prompt. <a href="#ab9dab65bc0757ce3bb0ac926bbefcee3">More...</a><br/></td></tr>
|
|
<tr class="separator:ab9dab65bc0757ce3bb0ac926bbefcee3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classTerminal"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classTerminal')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classTerminal.html">Terminal</a></td></tr>
|
|
<tr class="memitem:aa448509b5aa1ece53c3d86385655be0e inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#aa448509b5aa1ece53c3d86385655be0e">Terminal</a> ()</td></tr>
|
|
<tr class="memdesc:aa448509b5aa1ece53c3d86385655be0e inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a terminal object. <a href="#aa448509b5aa1ece53c3d86385655be0e">More...</a><br/></td></tr>
|
|
<tr class="separator:aa448509b5aa1ece53c3d86385655be0e inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:add5a7d4dd45b68af9a0afb1cc845af2f inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="add5a7d4dd45b68af9a0afb1cc845af2f"></a>
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#add5a7d4dd45b68af9a0afb1cc845af2f">~Terminal</a> ()</td></tr>
|
|
<tr class="memdesc:add5a7d4dd45b68af9a0afb1cc845af2f inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Destroys this terminal object. <br/></td></tr>
|
|
<tr class="separator:add5a7d4dd45b68af9a0afb1cc845af2f inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6bf417195a7d2a2fab6b3518f25764a2 inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a6bf417195a7d2a2fab6b3518f25764a2">begin</a> (Stream &<a class="el" href="classTerminal.html#a18f46590476d5231e9480b5f69a68f63">stream</a>, <a class="el" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364">Mode</a> <a class="el" href="classTerminal.html#acbf591c7371acba52bcd84ba4a0ce5c8">mode</a>=<a class="el" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364a7efe0e37dae166c00d913190cd8f55f6">Serial</a>)</td></tr>
|
|
<tr class="memdesc:a6bf417195a7d2a2fab6b3518f25764a2 inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Begins terminal operations on an underlying stream. <a href="#a6bf417195a7d2a2fab6b3518f25764a2">More...</a><br/></td></tr>
|
|
<tr class="separator:a6bf417195a7d2a2fab6b3518f25764a2 inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9e4c08d43a1a1c039e385d63aca049c0 inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a9e4c08d43a1a1c039e385d63aca049c0">end</a> ()</td></tr>
|
|
<tr class="memdesc:a9e4c08d43a1a1c039e385d63aca049c0 inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Ends terminal operations on an underlying stream. <a href="#a9e4c08d43a1a1c039e385d63aca049c0">More...</a><br/></td></tr>
|
|
<tr class="separator:a9e4c08d43a1a1c039e385d63aca049c0 inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a18f46590476d5231e9480b5f69a68f63 inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">Stream * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a18f46590476d5231e9480b5f69a68f63">stream</a> () const </td></tr>
|
|
<tr class="memdesc:a18f46590476d5231e9480b5f69a68f63 inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the underlying Stream, or NULL if the stream has not been set with <a class="el" href="classTerminal.html#a6bf417195a7d2a2fab6b3518f25764a2" title="Begins terminal operations on an underlying stream. ">begin()</a> yet. <a href="#a18f46590476d5231e9480b5f69a68f63">More...</a><br/></td></tr>
|
|
<tr class="separator:a18f46590476d5231e9480b5f69a68f63 inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acbf591c7371acba52bcd84ba4a0ce5c8 inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364">Terminal::Mode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#acbf591c7371acba52bcd84ba4a0ce5c8">mode</a> () const </td></tr>
|
|
<tr class="memdesc:acbf591c7371acba52bcd84ba4a0ce5c8 inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Returns the mode this terminal is operating in, Serial or Telnet. <a href="#acbf591c7371acba52bcd84ba4a0ce5c8">More...</a><br/></td></tr>
|
|
<tr class="separator:acbf591c7371acba52bcd84ba4a0ce5c8 inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a111698c496d601ef7fe0ce4de8a6de9a inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a111698c496d601ef7fe0ce4de8a6de9a">available</a> ()</td></tr>
|
|
<tr class="memdesc:a111698c496d601ef7fe0ce4de8a6de9a inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of bytes that are available for reading. <a href="#a111698c496d601ef7fe0ce4de8a6de9a">More...</a><br/></td></tr>
|
|
<tr class="separator:a111698c496d601ef7fe0ce4de8a6de9a inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a49f6aa694fae8a9ff8a526350dd8f8fc inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a49f6aa694fae8a9ff8a526350dd8f8fc">peek</a> ()</td></tr>
|
|
<tr class="memdesc:a49f6aa694fae8a9ff8a526350dd8f8fc inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Peeks at the next byte from the underlying stream. <a href="#a49f6aa694fae8a9ff8a526350dd8f8fc">More...</a><br/></td></tr>
|
|
<tr class="separator:a49f6aa694fae8a9ff8a526350dd8f8fc inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a14dfd6dc5c4a30acfb47ab24c22d1cd5 inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a14dfd6dc5c4a30acfb47ab24c22d1cd5">read</a> ()</td></tr>
|
|
<tr class="memdesc:a14dfd6dc5c4a30acfb47ab24c22d1cd5 inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Reads the next byte from the underlying stream. <a href="#a14dfd6dc5c4a30acfb47ab24c22d1cd5">More...</a><br/></td></tr>
|
|
<tr class="separator:a14dfd6dc5c4a30acfb47ab24c22d1cd5 inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a908cdfa64167279ed565d43b45470c3d inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a908cdfa64167279ed565d43b45470c3d"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a908cdfa64167279ed565d43b45470c3d">flush</a> ()</td></tr>
|
|
<tr class="memdesc:a908cdfa64167279ed565d43b45470c3d inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Flushes all data in the underlying stream. <br/></td></tr>
|
|
<tr class="separator:a908cdfa64167279ed565d43b45470c3d inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae723f16d4f97954fb45550fa05d600bb inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#ae723f16d4f97954fb45550fa05d600bb">write</a> (uint8_t c)</td></tr>
|
|
<tr class="memdesc:ae723f16d4f97954fb45550fa05d600bb inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Writes a single byte to the underlying stream. <a href="#ae723f16d4f97954fb45550fa05d600bb">More...</a><br/></td></tr>
|
|
<tr class="separator:ae723f16d4f97954fb45550fa05d600bb inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a134b9131e18b35af18c53eabec49186d inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a134b9131e18b35af18c53eabec49186d">write</a> (const uint8_t *buffer, size_t size)</td></tr>
|
|
<tr class="memdesc:a134b9131e18b35af18c53eabec49186d inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Writes a buffer of data to the underlying stream. <a href="#a134b9131e18b35af18c53eabec49186d">More...</a><br/></td></tr>
|
|
<tr class="separator:a134b9131e18b35af18c53eabec49186d inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae0b908585ec355e0f299579a015c1170 inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#ae0b908585ec355e0f299579a015c1170">writeProgMem</a> (const char *str)</td></tr>
|
|
<tr class="memdesc:ae0b908585ec355e0f299579a015c1170 inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Writes a static string that is stored in program memory. <a href="#ae0b908585ec355e0f299579a015c1170">More...</a><br/></td></tr>
|
|
<tr class="separator:ae0b908585ec355e0f299579a015c1170 inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa82621ea174422601cc7384c8185eb96 inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#aa82621ea174422601cc7384c8185eb96">readKey</a> ()</td></tr>
|
|
<tr class="memdesc:aa82621ea174422601cc7384c8185eb96 inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Reads the next key that was typed on this terminal. <a href="#aa82621ea174422601cc7384c8185eb96">More...</a><br/></td></tr>
|
|
<tr class="separator:aa82621ea174422601cc7384c8185eb96 inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a33e5eb60d69e4ccf6e3c90f7428b4961 inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a33e5eb60d69e4ccf6e3c90f7428b4961">unicodeKey</a> () const </td></tr>
|
|
<tr class="memdesc:a33e5eb60d69e4ccf6e3c90f7428b4961 inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Gets the Unicode version of the last key returned by <a class="el" href="classTerminal.html#aa82621ea174422601cc7384c8185eb96" title="Reads the next key that was typed on this terminal. ">readKey()</a>. <a href="#a33e5eb60d69e4ccf6e3c90f7428b4961">More...</a><br/></td></tr>
|
|
<tr class="separator:a33e5eb60d69e4ccf6e3c90f7428b4961 inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a25308d6b2a3d18820d8a0e641c7be937 inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a25308d6b2a3d18820d8a0e641c7be937">writeUnicode</a> (long code)</td></tr>
|
|
<tr class="memdesc:a25308d6b2a3d18820d8a0e641c7be937 inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Writes a Unicode code point to the output in UTF-8 encoding. <a href="#a25308d6b2a3d18820d8a0e641c7be937">More...</a><br/></td></tr>
|
|
<tr class="separator:a25308d6b2a3d18820d8a0e641c7be937 inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aed25b5a884f89dcd2bb269a8e356e5d6 inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#aed25b5a884f89dcd2bb269a8e356e5d6">columns</a> () const </td></tr>
|
|
<tr class="memdesc:aed25b5a884f89dcd2bb269a8e356e5d6 inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of columns in the window; defaults to 80. <a href="#aed25b5a884f89dcd2bb269a8e356e5d6">More...</a><br/></td></tr>
|
|
<tr class="separator:aed25b5a884f89dcd2bb269a8e356e5d6 inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac01cf545938eff14f8e249e072b82357 inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#ac01cf545938eff14f8e249e072b82357">rows</a> () const </td></tr>
|
|
<tr class="memdesc:ac01cf545938eff14f8e249e072b82357 inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of rows in the window; defaults to 24. <a href="#ac01cf545938eff14f8e249e072b82357">More...</a><br/></td></tr>
|
|
<tr class="separator:ac01cf545938eff14f8e249e072b82357 inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af8957afd199718a809114dc5236f1a62 inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#af8957afd199718a809114dc5236f1a62">setWindowSize</a> (int <a class="el" href="classTerminal.html#aed25b5a884f89dcd2bb269a8e356e5d6">columns</a>, int <a class="el" href="classTerminal.html#ac01cf545938eff14f8e249e072b82357">rows</a>)</td></tr>
|
|
<tr class="memdesc:af8957afd199718a809114dc5236f1a62 inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Sets the number of columns and rows in the window. <a href="#af8957afd199718a809114dc5236f1a62">More...</a><br/></td></tr>
|
|
<tr class="separator:af8957afd199718a809114dc5236f1a62 inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4be741767b27739eec98901477e1c3d4 inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4be741767b27739eec98901477e1c3d4"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a4be741767b27739eec98901477e1c3d4">clear</a> ()</td></tr>
|
|
<tr class="memdesc:a4be741767b27739eec98901477e1c3d4 inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Move the cursor to the top-left position and clear the screen. <br/></td></tr>
|
|
<tr class="separator:a4be741767b27739eec98901477e1c3d4 inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb93d71925cdfb17065e7f1ef2e83414 inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb93d71925cdfb17065e7f1ef2e83414"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#aeb93d71925cdfb17065e7f1ef2e83414">clearToEOL</a> ()</td></tr>
|
|
<tr class="memdesc:aeb93d71925cdfb17065e7f1ef2e83414 inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Clears from the current cursor position to the end of the line. <br/></td></tr>
|
|
<tr class="separator:aeb93d71925cdfb17065e7f1ef2e83414 inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7f60537603bd91df3ff1371a895054ea inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a7f60537603bd91df3ff1371a895054ea">cursorMove</a> (int x, int y)</td></tr>
|
|
<tr class="memdesc:a7f60537603bd91df3ff1371a895054ea inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Moves the cursor to a specific location in the window. <a href="#a7f60537603bd91df3ff1371a895054ea">More...</a><br/></td></tr>
|
|
<tr class="separator:a7f60537603bd91df3ff1371a895054ea inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2b8434f44885beabb668b70565bfbebe inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a2b8434f44885beabb668b70565bfbebe">cursorLeft</a> ()</td></tr>
|
|
<tr class="memdesc:a2b8434f44885beabb668b70565bfbebe inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Moves the cursor left by one character. <a href="#a2b8434f44885beabb668b70565bfbebe">More...</a><br/></td></tr>
|
|
<tr class="separator:a2b8434f44885beabb668b70565bfbebe inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adba29515f7a2f7e3a8038cd583bd28dc inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#adba29515f7a2f7e3a8038cd583bd28dc">cursorRight</a> ()</td></tr>
|
|
<tr class="memdesc:adba29515f7a2f7e3a8038cd583bd28dc inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Moves the cursor right by one character. <a href="#adba29515f7a2f7e3a8038cd583bd28dc">More...</a><br/></td></tr>
|
|
<tr class="separator:adba29515f7a2f7e3a8038cd583bd28dc inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae5259872812d674e1fda215ddd18ee70 inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#ae5259872812d674e1fda215ddd18ee70">cursorUp</a> ()</td></tr>
|
|
<tr class="memdesc:ae5259872812d674e1fda215ddd18ee70 inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Moves the cursor up by one line. <a href="#ae5259872812d674e1fda215ddd18ee70">More...</a><br/></td></tr>
|
|
<tr class="separator:ae5259872812d674e1fda215ddd18ee70 inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4068f1fd6087ff865b169da0a3d61ec5 inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a4068f1fd6087ff865b169da0a3d61ec5">cursorDown</a> ()</td></tr>
|
|
<tr class="memdesc:a4068f1fd6087ff865b169da0a3d61ec5 inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Moves the cursor down by one line. <a href="#a4068f1fd6087ff865b169da0a3d61ec5">More...</a><br/></td></tr>
|
|
<tr class="separator:a4068f1fd6087ff865b169da0a3d61ec5 inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae4aec627f980fe0d26653401785d41bc inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#ae4aec627f980fe0d26653401785d41bc">backspace</a> ()</td></tr>
|
|
<tr class="memdesc:ae4aec627f980fe0d26653401785d41bc inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Backspaces over the last character. <a href="#ae4aec627f980fe0d26653401785d41bc">More...</a><br/></td></tr>
|
|
<tr class="separator:ae4aec627f980fe0d26653401785d41bc inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9109858612082ffd3d91a88713b7448a inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a9109858612082ffd3d91a88713b7448a">insertLine</a> ()</td></tr>
|
|
<tr class="memdesc:a9109858612082ffd3d91a88713b7448a inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Inserts a line at the cursor position. <a href="#a9109858612082ffd3d91a88713b7448a">More...</a><br/></td></tr>
|
|
<tr class="separator:a9109858612082ffd3d91a88713b7448a inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af79ea5335f73762828087f5c813feafd inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#af79ea5335f73762828087f5c813feafd">insertChar</a> ()</td></tr>
|
|
<tr class="memdesc:af79ea5335f73762828087f5c813feafd inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Inserts a blank character at the cursor position. <a href="#af79ea5335f73762828087f5c813feafd">More...</a><br/></td></tr>
|
|
<tr class="separator:af79ea5335f73762828087f5c813feafd inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae2f95592f13a1a5fe8464176a2b10298 inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#ae2f95592f13a1a5fe8464176a2b10298">deleteLine</a> ()</td></tr>
|
|
<tr class="memdesc:ae2f95592f13a1a5fe8464176a2b10298 inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Deletes a line at the cursor position. <a href="#ae2f95592f13a1a5fe8464176a2b10298">More...</a><br/></td></tr>
|
|
<tr class="separator:ae2f95592f13a1a5fe8464176a2b10298 inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7daffb0fe91d76678c5a9f22fe16e2c5 inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a7daffb0fe91d76678c5a9f22fe16e2c5">deleteChar</a> ()</td></tr>
|
|
<tr class="memdesc:a7daffb0fe91d76678c5a9f22fe16e2c5 inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Deletes the character at the cursor position. <a href="#a7daffb0fe91d76678c5a9f22fe16e2c5">More...</a><br/></td></tr>
|
|
<tr class="separator:a7daffb0fe91d76678c5a9f22fe16e2c5 inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a30d8d69fd84cafc6c2c94ae6fc65b690 inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a30d8d69fd84cafc6c2c94ae6fc65b690">scrollUp</a> ()</td></tr>
|
|
<tr class="memdesc:a30d8d69fd84cafc6c2c94ae6fc65b690 inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Scrolls the contents of the window up one line. <a href="#a30d8d69fd84cafc6c2c94ae6fc65b690">More...</a><br/></td></tr>
|
|
<tr class="separator:a30d8d69fd84cafc6c2c94ae6fc65b690 inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a661474bb4790aa82178b3ce9a85e5dea inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a661474bb4790aa82178b3ce9a85e5dea">scrollDown</a> ()</td></tr>
|
|
<tr class="memdesc:a661474bb4790aa82178b3ce9a85e5dea inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Scrolls the contents of the window down one line. <a href="#a661474bb4790aa82178b3ce9a85e5dea">More...</a><br/></td></tr>
|
|
<tr class="separator:a661474bb4790aa82178b3ce9a85e5dea inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a928023c8125f226ab0851f8b4bb6302f inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a928023c8125f226ab0851f8b4bb6302f">normal</a> ()</td></tr>
|
|
<tr class="memdesc:a928023c8125f226ab0851f8b4bb6302f inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Selects normal text with all attributes and colors off. <a href="#a928023c8125f226ab0851f8b4bb6302f">More...</a><br/></td></tr>
|
|
<tr class="separator:a928023c8125f226ab0851f8b4bb6302f inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2e8dd341fc1ce63aa120be6066a89bea inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a2e8dd341fc1ce63aa120be6066a89bea">bold</a> ()</td></tr>
|
|
<tr class="memdesc:a2e8dd341fc1ce63aa120be6066a89bea inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Enables bold text. <a href="#a2e8dd341fc1ce63aa120be6066a89bea">More...</a><br/></td></tr>
|
|
<tr class="separator:a2e8dd341fc1ce63aa120be6066a89bea inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0e23c452353e7fdf0881d37521f3d105 inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e23c452353e7fdf0881d37521f3d105"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a0e23c452353e7fdf0881d37521f3d105">underline</a> ()</td></tr>
|
|
<tr class="memdesc:a0e23c452353e7fdf0881d37521f3d105 inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Enables underlined text. <br/></td></tr>
|
|
<tr class="separator:a0e23c452353e7fdf0881d37521f3d105 inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8485c7073e94e77f9873b80e9cac3151 inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8485c7073e94e77f9873b80e9cac3151"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a8485c7073e94e77f9873b80e9cac3151">blink</a> ()</td></tr>
|
|
<tr class="memdesc:a8485c7073e94e77f9873b80e9cac3151 inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Enables blinking text. <br/></td></tr>
|
|
<tr class="separator:a8485c7073e94e77f9873b80e9cac3151 inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d770065054af95c2b8f98b561619ede inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4d770065054af95c2b8f98b561619ede"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a4d770065054af95c2b8f98b561619ede">reverse</a> ()</td></tr>
|
|
<tr class="memdesc:a4d770065054af95c2b8f98b561619ede inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Reverse the foreground and background colors for inverted text. <br/></td></tr>
|
|
<tr class="separator:a4d770065054af95c2b8f98b561619ede inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad1fc2be31d49124a1d32e8afddaa57b8 inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#ad1fc2be31d49124a1d32e8afddaa57b8">color</a> (<a class="el" href="classTerminal.html#a7a03a2e94316da7b2144dad5ba95ac20">Color</a> fg)</td></tr>
|
|
<tr class="memdesc:ad1fc2be31d49124a1d32e8afddaa57b8 inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Selects a text foreground color with the default background color. <a href="#ad1fc2be31d49124a1d32e8afddaa57b8">More...</a><br/></td></tr>
|
|
<tr class="separator:ad1fc2be31d49124a1d32e8afddaa57b8 inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae22436e478a854e8b559fe73182bc329 inherit pub_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#ae22436e478a854e8b559fe73182bc329">color</a> (<a class="el" href="classTerminal.html#a7a03a2e94316da7b2144dad5ba95ac20">Color</a> fg, <a class="el" href="classTerminal.html#a7a03a2e94316da7b2144dad5ba95ac20">Color</a> bg)</td></tr>
|
|
<tr class="memdesc:ae22436e478a854e8b559fe73182bc329 inherit pub_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Selects text foreground and background colors. <a href="#ae22436e478a854e8b559fe73182bc329">More...</a><br/></td></tr>
|
|
<tr class="separator:ae22436e478a854e8b559fe73182bc329 inherit pub_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a03dfba66a0125a8c02dd71b3f3b37870"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classShell.html#a03dfba66a0125a8c02dd71b3f3b37870">registerCommand</a> (ShellCommandRegister *cmd)</td></tr>
|
|
<tr class="memdesc:a03dfba66a0125a8c02dd71b3f3b37870"><td class="mdescLeft"> </td><td class="mdescRight">Registers a command with the shell. <a href="#a03dfba66a0125a8c02dd71b3f3b37870">More...</a><br/></td></tr>
|
|
<tr class="separator:a03dfba66a0125a8c02dd71b3f3b37870"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_static_methods_classTerminal"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classTerminal')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="classTerminal.html">Terminal</a></td></tr>
|
|
<tr class="memitem:a25fdddd02378250799016cbb714c8a6b inherit pub_static_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a25fdddd02378250799016cbb714c8a6b">isWideCharacter</a> (long code)</td></tr>
|
|
<tr class="memdesc:a25fdddd02378250799016cbb714c8a6b inherit pub_static_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Determine if a Unicode character is wide. <a href="#a25fdddd02378250799016cbb714c8a6b">More...</a><br/></td></tr>
|
|
<tr class="separator:a25fdddd02378250799016cbb714c8a6b inherit pub_static_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0ed780bd8568f752c5d3dfe68a111c52 inherit pub_static_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">static size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a0ed780bd8568f752c5d3dfe68a111c52">utf8Length</a> (long code)</td></tr>
|
|
<tr class="memdesc:a0ed780bd8568f752c5d3dfe68a111c52 inherit pub_static_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Determines the length of a Unicode code point in the UTF-8 encoding. <a href="#a0ed780bd8568f752c5d3dfe68a111c52">More...</a><br/></td></tr>
|
|
<tr class="separator:a0ed780bd8568f752c5d3dfe68a111c52 inherit pub_static_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae6478319776ecb726613b38429d7cdec inherit pub_static_methods_classTerminal"><td class="memItemLeft" align="right" valign="top">static size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#ae6478319776ecb726613b38429d7cdec">utf8Format</a> (uint8_t *buffer, long code)</td></tr>
|
|
<tr class="memdesc:ae6478319776ecb726613b38429d7cdec inherit pub_static_methods_classTerminal"><td class="mdescLeft"> </td><td class="mdescRight">Formats a Unicode code point in a buffer in the UTF-8 encoding. <a href="#ae6478319776ecb726613b38429d7cdec">More...</a><br/></td></tr>
|
|
<tr class="separator:ae6478319776ecb726613b38429d7cdec inherit pub_static_methods_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:a3ad32b7cd3b48c78953ab9f7384d5a58"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ad32b7cd3b48c78953ab9f7384d5a58"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classShell.html#a3ad32b7cd3b48c78953ab9f7384d5a58">beginSession</a> ()</td></tr>
|
|
<tr class="memdesc:a3ad32b7cd3b48c78953ab9f7384d5a58"><td class="mdescLeft"> </td><td class="mdescRight">Begins a login session. <br/></td></tr>
|
|
<tr class="separator:a3ad32b7cd3b48c78953ab9f7384d5a58"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a720144957bf6462659017cc25c429beb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a720144957bf6462659017cc25c429beb"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classShell.html#a720144957bf6462659017cc25c429beb">printPrompt</a> ()</td></tr>
|
|
<tr class="memdesc:a720144957bf6462659017cc25c429beb"><td class="mdescLeft"> </td><td class="mdescRight">Prints the current prompt string. <br/></td></tr>
|
|
<tr class="separator:a720144957bf6462659017cc25c429beb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab4a3f80dc5ff779ac99116a1f7e35cda"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4a3f80dc5ff779ac99116a1f7e35cda"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classShell.html#ab4a3f80dc5ff779ac99116a1f7e35cda">execute</a> ()</td></tr>
|
|
<tr class="memdesc:ab4a3f80dc5ff779ac99116a1f7e35cda"><td class="mdescLeft"> </td><td class="mdescRight">Executes the command in the buffer. <br/></td></tr>
|
|
<tr class="separator:ab4a3f80dc5ff779ac99116a1f7e35cda"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:a8c01f92a3930e107f45a0035c1adc290"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c01f92a3930e107f45a0035c1adc290"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>LoginShell</b></td></tr>
|
|
<tr class="separator:a8c01f92a3930e107f45a0035c1adc290"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="related"></a>
|
|
Related Functions</h2></td></tr>
|
|
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p>
|
|
</td></tr>
|
|
<tr class="memitem:ad5bac6a4033cd81e24c1345650bca744"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classShell.html#ad5bac6a4033cd81e24c1345650bca744">ShellCommandFunc</a></td></tr>
|
|
<tr class="memdesc:ad5bac6a4033cd81e24c1345650bca744"><td class="mdescLeft"> </td><td class="mdescRight">Type of functions that provide shell command handlers. <a href="#ad5bac6a4033cd81e24c1345650bca744">More...</a><br/></td></tr>
|
|
<tr class="separator:ad5bac6a4033cd81e24c1345650bca744"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a809d96cf913bf11d02f3c0d51a120740"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="classShell.html#a809d96cf913bf11d02f3c0d51a120740">ShellCommand</a>(name, <a class="el" href="classShell.html#a58b0e9104d1f6c7ec7d1663c69cd03dd">help</a>, function)</td></tr>
|
|
<tr class="memdesc:a809d96cf913bf11d02f3c0d51a120740"><td class="mdescLeft"> </td><td class="mdescRight">Registers a command with the shell. <a href="#a809d96cf913bf11d02f3c0d51a120740">More...</a><br/></td></tr>
|
|
<tr class="separator:a809d96cf913bf11d02f3c0d51a120740"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
|
|
Additional Inherited Members</h2></td></tr>
|
|
<tr class="inherit_header pub_types_classTerminal"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classTerminal')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classTerminal.html">Terminal</a></td></tr>
|
|
<tr class="memitem:a6fd7d021468962e9604bee0522b3a364 inherit pub_types_classTerminal"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364">Mode</a> { <a class="el" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364a7efe0e37dae166c00d913190cd8f55f6">Serial</a>,
|
|
<a class="el" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364a71eb4637496b7a884384c4250f3289a7">Telnet</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:a6fd7d021468962e9604bee0522b3a364"><td class="mdescLeft"> </td><td class="mdescRight">Mode to operate in, Serial or Telnet. <a href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364">More...</a><br/></td></tr>
|
|
<tr class="separator:a6fd7d021468962e9604bee0522b3a364 inherit pub_types_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7a03a2e94316da7b2144dad5ba95ac20 inherit pub_types_classTerminal"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classTerminal.html#a7a03a2e94316da7b2144dad5ba95ac20">Color</a> { <br/>
|
|
  <a class="el" href="classTerminal.html#a7a03a2e94316da7b2144dad5ba95ac20ae8891bcc826bd9843740727bd36481a4">Black</a> = 0x00,
|
|
<a class="el" href="classTerminal.html#a7a03a2e94316da7b2144dad5ba95ac20a7e02ffbae282462707f7fa9b521a5350">DarkRed</a> = 0x01,
|
|
<a class="el" href="classTerminal.html#a7a03a2e94316da7b2144dad5ba95ac20a3e3b823d801aa16880e837ee4b5a950a">DarkGreen</a> = 0x02,
|
|
<a class="el" href="classTerminal.html#a7a03a2e94316da7b2144dad5ba95ac20aa79363e8a838f09ac55b4be7ddabe625">DarkYellow</a> = 0x03,
|
|
<br/>
|
|
  <a class="el" href="classTerminal.html#a7a03a2e94316da7b2144dad5ba95ac20a857041b4a99e4a303f183a9881c32b8e">DarkBlue</a> = 0x04,
|
|
<a class="el" href="classTerminal.html#a7a03a2e94316da7b2144dad5ba95ac20a3c0cb0568e93ebf1ea54bea5991b40a9">DarkMagenta</a> = 0x05,
|
|
<a class="el" href="classTerminal.html#a7a03a2e94316da7b2144dad5ba95ac20a7770ad09b7bc5a420575bba06878efeb">DarkCyan</a> = 0x06,
|
|
<a class="el" href="classTerminal.html#a7a03a2e94316da7b2144dad5ba95ac20a3b4388fbed1f6c20cbe706d49b968683">LightGray</a> = 0x07,
|
|
<br/>
|
|
  <a class="el" href="classTerminal.html#a7a03a2e94316da7b2144dad5ba95ac20ab5595f67da54848741ee2b31a38bafec">DarkGray</a> = 0x08,
|
|
<a class="el" href="classTerminal.html#a7a03a2e94316da7b2144dad5ba95ac20af2687d41cae4cb8276778be71c1e1efb">Red</a> = 0x09,
|
|
<a class="el" href="classTerminal.html#a7a03a2e94316da7b2144dad5ba95ac20a884f0fec8e7a5adac3047b890fcbf491">Green</a> = 0x0A,
|
|
<a class="el" href="classTerminal.html#a7a03a2e94316da7b2144dad5ba95ac20a5f04853bd0cf9cea91dae31cc5294f22">Yellow</a> = 0x0B,
|
|
<br/>
|
|
  <a class="el" href="classTerminal.html#a7a03a2e94316da7b2144dad5ba95ac20a70f0c34fa3b8055231e826454b9cf8be">Blue</a> = 0x0C,
|
|
<a class="el" href="classTerminal.html#a7a03a2e94316da7b2144dad5ba95ac20a438c102a577219f2b654bebce4d53ea0">Magenta</a> = 0x0D,
|
|
<a class="el" href="classTerminal.html#a7a03a2e94316da7b2144dad5ba95ac20a12656e5c242667b489e639d399964077">Cyan</a> = 0x0E,
|
|
<a class="el" href="classTerminal.html#a7a03a2e94316da7b2144dad5ba95ac20ae8296a3587847d6e0dd41efcc65251e8">White</a> = 0x0F
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:a7a03a2e94316da7b2144dad5ba95ac20"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classTerminal.html" title="Extended stream interface for terminal operations. ">Terminal</a> foreground or background colors. <a href="classTerminal.html#a7a03a2e94316da7b2144dad5ba95ac20">More...</a><br/></td></tr>
|
|
<tr class="separator:a7a03a2e94316da7b2144dad5ba95ac20 inherit pub_types_classTerminal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Command-line shell access. </p>
|
|
<p>This class provides a command-line shell via serial ports, TCP connections, or any other type of Stream.</p>
|
|
<p>The following example is the minimal setup for a command-line shell on a serial port. The application calls <a class="el" href="classShell.html#ad9acba905b6e0b661cce19d57c067990" title="Begin shell handling on an underlying character stream. ">begin()</a> to set the underlying Stream, and periodically calls <a class="el" href="classShell.html#afc45cae4ccfc76321a254bb617dce08c" title="Performs regular activities on the shell. ">loop()</a> to manage shell-related events.</p>
|
|
<div class="fragment"><div class="line"><a class="code" href="classShell.html">Shell</a> shell;</div>
|
|
<div class="line"></div>
|
|
<div class="line"><span class="keywordtype">void</span> setup() {</div>
|
|
<div class="line"> <a class="code" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364a7efe0e37dae166c00d913190cd8f55f6">Serial</a>.begin(9600);</div>
|
|
<div class="line"> shell.<a class="code" href="classShell.html#a89d802eae5b716e80b2c4dfbce0a0a75">setPrompt</a>(<span class="stringliteral">"$ "</span>);</div>
|
|
<div class="line"> shell.<a class="code" href="classShell.html#ad9acba905b6e0b661cce19d57c067990">begin</a>(<a class="code" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364a7efe0e37dae166c00d913190cd8f55f6">Serial</a>);</div>
|
|
<div class="line">}</div>
|
|
<div class="line"></div>
|
|
<div class="line"><span class="keywordtype">void</span> <a class="code" href="classShell.html#afc45cae4ccfc76321a254bb617dce08c">loop</a>() {</div>
|
|
<div class="line"> shell.<a class="code" href="classShell.html#afc45cae4ccfc76321a254bb617dce08c">loop</a>();</div>
|
|
<div class="line">}</div>
|
|
</div><!-- fragment --><p>Commands can be registered with the shell by the application to be invoked when the user types in the corresponding command. Each command is associated with a handler function:</p>
|
|
<div class="fragment"><div class="line"><span class="keywordtype">void</span> cmdMotor(<a class="code" href="classShell.html">Shell</a> &shell, <span class="keywordtype">int</span> argc, <span class="keyword">const</span> <a class="code" href="classShellArguments.html">ShellArguments</a> &argv)</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> ...</div>
|
|
<div class="line">}</div>
|
|
<div class="line"></div>
|
|
<div class="line"><a class="code" href="classShell.html#a809d96cf913bf11d02f3c0d51a120740">ShellCommand</a>(motor, <span class="stringliteral">"Turn the motor on or off"</span>, cmdMotor);</div>
|
|
</div><!-- fragment --><p>There are two standard commands built into <a class="el" href="classShell.html" title="Command-line shell access. ">Shell</a>: "help" and "exit". The "help" command provides a list of all registered commands with the short help string from the <a class="el" href="classShell.html#a809d96cf913bf11d02f3c0d51a120740" title="Registers a command with the shell. ">ShellCommand()</a> registration. The "exit" command logs the user out and returns to the login prompt, or stops the underlying connection in the case of TCP streams.</p>
|
|
<p>The F1 key can be used as a synonym for "help" and CTRL-D can be used as a synonym for "exit".</p>
|
|
<p><a class="el" href="classShell.html" title="Command-line shell access. ">Shell</a> provides some limited history editing for scrolling back through previous commands. The size of the history stack is provided in the second argument to <a class="el" href="classShell.html#ad9acba905b6e0b661cce19d57c067990" title="Begin shell handling on an underlying character stream. ">begin()</a>:</p>
|
|
<div class="fragment"><div class="line">shell.<a class="code" href="classShell.html#ad9acba905b6e0b661cce19d57c067990">begin</a>(<a class="code" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364a7efe0e37dae166c00d913190cd8f55f6">Serial</a>, 5);</div>
|
|
</div><!-- fragment --><dl class="section see"><dt>See Also</dt><dd><a class="el" href="classLoginShell.html" title="Command-line shell access via a login shell. ">LoginShell</a>, <a class="el" href="classTerminal.html" title="Extended stream interface for terminal operations. ">Terminal</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="Shell_8h_source.html#l00062">62</a> of file <a class="el" href="Shell_8h_source.html">Shell.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="ad613444a902075e8fd26b1f51c4d3b63"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Shell::Shell </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructs a new <a class="el" href="classShell.html" title="Command-line shell access. ">Shell</a> instance. </p>
|
|
<p>This constructor must be followed by a call to <a class="el" href="classShell.html#ad9acba905b6e0b661cce19d57c067990" title="Begin shell handling on an underlying character stream. ">begin()</a> to specify the underlying I/O stream. </p>
|
|
|
|
<p>Definition at line <a class="el" href="Shell_8cpp_source.html#l00122">122</a> of file <a class="el" href="Shell_8cpp_source.html">Shell.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="ad9acba905b6e0b661cce19d57c067990"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Shell::begin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Stream & </td>
|
|
<td class="paramname"><em>stream</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>maxHistory</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364">Terminal::Mode</a> </td>
|
|
<td class="paramname"><em>mode</em> = <code><a class="el" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364a7efe0e37dae166c00d913190cd8f55f6">Serial</a></code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Begin shell handling on an underlying character stream. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">stream</td><td>The stream to apply the shell to. Usually this is a serial port or TCP network connection. </td></tr>
|
|
<tr><td class="paramname">maxHistory</td><td>The number of commands to allocate in the history stack for scrolling back through using Up/Down arrow keys. </td></tr>
|
|
<tr><td class="paramname">mode</td><td>The terminal mode to operate in, <a class="el" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364a7efe0e37dae166c00d913190cd8f55f6" title="Operates the terminal in serial mode. ">Terminal::Serial</a> or <a class="el" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364a71eb4637496b7a884384c4250f3289a7" title="Operates the terminal in telnet mode. ">Terminal::Telnet</a>. Default is <a class="el" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364a7efe0e37dae166c00d913190cd8f55f6" title="Operates the terminal in serial mode. ">Terminal::Serial</a>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns false if there is insufficient memory for the history stack. The session will continue but without command history.</dd></dl>
|
|
<p>This function will print the <a class="el" href="classShell.html#af4a335f97bc888a25f7e54f2a025c11c" title="Gets the prompt string to display in the shell. ">prompt()</a> in preparation for entry of the first command. The default prompt is "$ "; call <a class="el" href="classShell.html#a89d802eae5b716e80b2c4dfbce0a0a75" title="Sets the prompt string to display in the shell. ">setPrompt()</a> before <a class="el" href="classShell.html#ad9acba905b6e0b661cce19d57c067990" title="Begin shell handling on an underlying character stream. ">begin()</a> to change this:</p>
|
|
<div class="fragment"><div class="line"><a class="code" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364a7efe0e37dae166c00d913190cd8f55f6">Serial</a>.begin(9600);</div>
|
|
<div class="line">shell.<a class="code" href="classShell.html#a89d802eae5b716e80b2c4dfbce0a0a75">setPrompt</a>(<span class="stringliteral">"Command: "</span>);</div>
|
|
<div class="line">shell.<a class="code" href="classShell.html#ad9acba905b6e0b661cce19d57c067990">begin</a>(<a class="code" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364a7efe0e37dae166c00d913190cd8f55f6">Serial</a>);</div>
|
|
</div><!-- fragment --><p>The <em>maxHistory</em> parameter indicates the number of commands of maximum length that can be stored in the history. If the actual entered commands are shorter, then more commands can be stored in the history.</p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classShell.html#a8a654aadd0b6a379309bb1007749e41d" title="Ends shell processing on the underlying stream. ">end()</a>, <a class="el" href="classShell.html#a89d802eae5b716e80b2c4dfbce0a0a75" title="Sets the prompt string to display in the shell. ">setPrompt()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="Shell_8cpp_source.html#l00176">176</a> of file <a class="el" href="Shell_8cpp_source.html">Shell.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3ff0cc86725388d4fe92520e5a18ad92"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Shell::begin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Client & </td>
|
|
<td class="paramname"><em>client</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>maxHistory</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364">Terminal::Mode</a> </td>
|
|
<td class="paramname"><em>mode</em> = <code><a class="el" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364a71eb4637496b7a884384c4250f3289a7">Telnet</a></code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Begin shell handling on a connected TCP client. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">client</td><td>The client to apply the shell to. This must be a connected TCP client. </td></tr>
|
|
<tr><td class="paramname">maxHistory</td><td>The number of commands to allocate in the history stack for scrolling back through using Up/Down arrow keys. </td></tr>
|
|
<tr><td class="paramname">mode</td><td>The terminal mode to operate in, <a class="el" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364a7efe0e37dae166c00d913190cd8f55f6" title="Operates the terminal in serial mode. ">Terminal::Serial</a> or <a class="el" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364a71eb4637496b7a884384c4250f3289a7" title="Operates the terminal in telnet mode. ">Terminal::Telnet</a>. Default is <a class="el" href="classTerminal.html#a6fd7d021468962e9604bee0522b3a364a71eb4637496b7a884384c4250f3289a7" title="Operates the terminal in telnet mode. ">Terminal::Telnet</a>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns true if the shell was initialized, or false if there is insufficient memory for the history stack.</dd></dl>
|
|
<p>This override is provided as a convenience for starting a shell on a TCP connection. This function also modifies the behaviour of the builtin "exit" command to forcibly stop the TCP connection rather than returning to the login prompt.</p>
|
|
<p>The <em>maxHistory</em> parameter indicates the number of commands of maximum length that can be stored in the history. If the actual entered commands are shorter, then more commands can be stored in the history.</p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classShell.html#a8a654aadd0b6a379309bb1007749e41d" title="Ends shell processing on the underlying stream. ">end()</a>, <a class="el" href="classShell.html#a89d802eae5b716e80b2c4dfbce0a0a75" title="Sets the prompt string to display in the shell. ">setPrompt()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="Shell_8cpp_source.html#l00208">208</a> of file <a class="el" href="Shell_8cpp_source.html">Shell.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8a654aadd0b6a379309bb1007749e41d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Shell::end </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Ends shell processing on the underlying stream. </p>
|
|
<p>This function is intended to be called when a TCP network connection is closed to clean up the shell state that was in use by the connection.</p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classShell.html#ad9acba905b6e0b661cce19d57c067990" title="Begin shell handling on an underlying character stream. ">begin()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="Shell_8cpp_source.html#l00262">262</a> of file <a class="el" href="Shell_8cpp_source.html">Shell.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab9dab65bc0757ce3bb0ac926bbefcee3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Shell::exit </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Exit from the shell back to the login prompt. </p>
|
|
<p>If the underlying stream is a TCP client, then this function will stop the client, causing disconnection. </p>
|
|
|
|
<p>Definition at line <a class="el" href="Shell_8cpp_source.html#l00577">577</a> of file <a class="el" href="Shell_8cpp_source.html">Shell.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afc45cae4ccfc76321a254bb617dce08c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Shell::loop </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Performs regular activities on the shell. </p>
|
|
<p>This function must be called regularly from the application's main loop to process input for the shell. </p>
|
|
|
|
<p>Definition at line <a class="el" href="Shell_8cpp_source.html#l00294">294</a> of file <a class="el" href="Shell_8cpp_source.html">Shell.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af4a335f97bc888a25f7e54f2a025c11c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char * Shell::prompt </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the prompt string to display in the shell. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The current prompt. The default is "$ ".</dd></dl>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classShell.html#a89d802eae5b716e80b2c4dfbce0a0a75" title="Sets the prompt string to display in the shell. ">setPrompt()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="Shell_8h_source.html#l00076">76</a> of file <a class="el" href="Shell_8h_source.html">Shell.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a03dfba66a0125a8c02dd71b3f3b37870"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Shell::registerCommand </td>
|
|
<td>(</td>
|
|
<td class="paramtype">ShellCommandRegister * </td>
|
|
<td class="paramname"><em>cmd</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Registers a command with the shell. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This function is internal. The <a class="el" href="classShell.html#a809d96cf913bf11d02f3c0d51a120740" title="Registers a command with the shell. ">ShellCommand()</a> macro should be used instead. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="Shell_8cpp_source.html#l00472">472</a> of file <a class="el" href="Shell_8cpp_source.html">Shell.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a89d802eae5b716e80b2c4dfbce0a0a75"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Shell::setPrompt </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>prompt</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the prompt string to display in the shell. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">prompt</td><td>The new prompt string. The caller is responsible to ensure that the string persists after this call returns. The <a class="el" href="classShell.html" title="Command-line shell access. ">Shell</a> class does not make a copy of the string.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Calling this function will change the prompt for the next line of input.</p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classShell.html#af4a335f97bc888a25f7e54f2a025c11c" title="Gets the prompt string to display in the shell. ">prompt()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="Shell_8h_source.html#l00077">77</a> of file <a class="el" href="Shell_8h_source.html">Shell.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5db7316a4feb9829beea11dfe65462d2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Shell::setUserid </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>userid</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the user identifier for the currently logged in user. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">userid</td><td>The new user identifier to set, or -1 if there is no user logged in currently.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Normally the user identifier is set when <a class="el" href="classLoginShell.html" title="Command-line shell access via a login shell. ">LoginShell</a> detects a successful login. This function can be used to alter the access rights of the logged-in user after login.</p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classShell.html#a6ae6e1af0a7f6116e6a9a1e658fb9a84" title="Gets the user identifier for the currently logged in user, or -1 if there is no user logged in curren...">userid()</a>, <a class="el" href="classLoginShell.html#adad54b04ec54d3577df4cd11944fff1d" title="Password checking function for login shells. ">ShellPasswordCheckFunc</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="Shell_8h_source.html#l00080">80</a> of file <a class="el" href="Shell_8h_source.html">Shell.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6ae6e1af0a7f6116e6a9a1e658fb9a84"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int Shell::userid </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the user identifier for the currently logged in user, or -1 if there is no user logged in currently. </p>
|
|
<p>The user identifier can be used by applications to restrict the set of commands that are available to the user, or to restrict the behaviour of those commands when acting on critical resources.</p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classShell.html#a5db7316a4feb9829beea11dfe65462d2" title="Sets the user identifier for the currently logged in user. ">setUserid()</a>, <a class="el" href="classLoginShell.html#adad54b04ec54d3577df4cd11944fff1d" title="Password checking function for login shells. ">ShellPasswordCheckFunc</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="Shell_8h_source.html#l00079">79</a> of file <a class="el" href="Shell_8h_source.html">Shell.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Friends And Related Function Documentation</h2>
|
|
<a class="anchor" id="a809d96cf913bf11d02f3c0d51a120740"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define ShellCommand</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">name, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><a class="el" href="classShell.html#a58b0e9104d1f6c7ec7d1663c69cd03dd">help</a>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">function </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">related</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">static</span> <span class="keywordtype">char</span> <span class="keyword">const</span> shell_id_##name[] PROGMEM = #name; \</div>
|
|
<div class="line"> static <span class="keywordtype">char</span> <span class="keyword">const</span> shell_help_##name[] PROGMEM = <a class="code" href="classShell.html#a58b0e9104d1f6c7ec7d1663c69cd03dd">help</a>; \</div>
|
|
<div class="line"> static ShellCommandInfo <span class="keyword">const</span> shell_info_##name PROGMEM = { \</div>
|
|
<div class="line"> shell_id_##name, \</div>
|
|
<div class="line"> shell_help_##name, \</div>
|
|
<div class="line"> (<span class="keyword">function</span>) \</div>
|
|
<div class="line"> }; \</div>
|
|
<div class="line"> static ShellCommandRegister shell_cmd_##name(&shell_info_##name)</div>
|
|
</div><!-- fragment -->
|
|
<p>Registers a command with the shell. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>The name of the command. </td></tr>
|
|
<tr><td class="paramname">help</td><td>Help string to display that describes the command. </td></tr>
|
|
<tr><td class="paramname">function</td><td>The function to call to handle the command.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>The <em>name</em> and <em>help</em> parameters must be constant strings that can be placed into program memory.</p>
|
|
<div class="fragment"><div class="line"><span class="keywordtype">void</span> cmdMotor(<a class="code" href="classShell.html">Shell</a> &shell, <span class="keywordtype">int</span> argc, <span class="keyword">const</span> <a class="code" href="classShellArguments.html">ShellArguments</a> &argv)</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> ...</div>
|
|
<div class="line">}</div>
|
|
<div class="line"></div>
|
|
<div class="line"><a class="code" href="classShell.html#a809d96cf913bf11d02f3c0d51a120740">ShellCommand</a>(motor, <span class="stringliteral">"Turn the motor on or off"</span>, cmdMotor);</div>
|
|
</div><!-- fragment --><p>If there are multiple <a class="el" href="classShell.html" title="Command-line shell access. ">Shell</a> instances active in the system, then the command will be registered with all of them. </p>
|
|
|
|
<p>Definition at line <a class="el" href="Shell_8h_source.html#l00153">153</a> of file <a class="el" href="Shell_8h_source.html">Shell.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad5bac6a4033cd81e24c1345650bca744"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ShellCommandFunc</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">related</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Type of functions that provide shell command handlers. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">shell</td><td>Points to the shell instance that executed the command, which can be used to print command results or read more input. </td></tr>
|
|
<tr><td class="paramname">argc</td><td>Number of arguments to the command, including the command's name. </td></tr>
|
|
<tr><td class="paramname">argv</td><td>The arguments to the command.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classShell.html#a809d96cf913bf11d02f3c0d51a120740" title="Registers a command with the shell. ">ShellCommand()</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="Shell_8h_source.html">Shell.h</a></li>
|
|
<li><a class="el" href="Shell_8cpp_source.html">Shell.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Sat Mar 26 2016 19:04:41 for ArduinoLibs by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.6
|
|
</small></address>
|
|
</body>
|
|
</html>
|