Skip to content

Commit

Permalink
Deploy updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
web-flow committed Feb 12, 2024
1 parent 9224a41 commit e26f53a
Show file tree
Hide file tree
Showing 202 changed files with 9,814 additions and 682 deletions.
162 changes: 162 additions & 0 deletions CLI_8cpp.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
<!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">
<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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OOKwiz: /home/runner/work/OOKwiz/OOKwiz/main/src/CLI.cpp 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>
<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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OOKwiz
</div>
<div id="projectbrief">on/off-keying for ESP32 and a variety of supported radio modules</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">CLI.cpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="CLI_8h_source.html">CLI.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="config_8h_source.html">config.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="serial__output_8h_source.html">serial_output.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="tools_8h_source.html">tools.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="Settings_8h_source.html">Settings.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="Radio_8h_source.html">Radio.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="OOKwiz_8h_source.html">OOKwiz.h</a>&quot;</code><br />
</div>
<p><a href="CLI_8cpp_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 name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceCLI"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceCLI.html">CLI</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ae524697576f78a9707a790011fe750f1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="CLI_8cpp.html#ae524697576f78a9707a790011fe750f1">COMMAND</a>(c)</td></tr>
<tr class="separator:ae524697576f78a9707a790011fe750f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a534859233b15fe77e8f1ff06151cd163"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="CLI_8cpp.html#a534859233b15fe77e8f1ff06151cd163">END_CMD</a>&#160;&#160;&#160;return; }</td></tr>
<tr class="separator:a534859233b15fe77e8f1ff06151cd163"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a8757901cd08f4f81efb19b3b226f28b2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceCLI.html#a8757901cd08f4f81efb19b3b226f28b2">CLI::parse</a> (String cmd)</td></tr>
<tr class="separator:a8757901cd08f4f81efb19b3b226f28b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9af91bae9053f9d192801dc2b147d62b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceCLI.html#a9af91bae9053f9d192801dc2b147d62b">CLI::loop</a> ()</td></tr>
<tr class="separator:a9af91bae9053f9d192801dc2b147d62b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:ac1a0c60454bd3a361cb4fc3ec4d64693"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceCLI.html#ac1a0c60454bd3a361cb4fc3ec4d64693">CLI::cli_start_msg_printed</a> = false</td></tr>
<tr class="separator:ac1a0c60454bd3a361cb4fc3ec4d64693"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a268599b898b8618cbb0996922a5358d6"><td class="memItemLeft" align="right" valign="top">String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceCLI.html#a268599b898b8618cbb0996922a5358d6">CLI::serial_buffer</a></td></tr>
<tr class="separator:a268599b898b8618cbb0996922a5358d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ae524697576f78a9707a790011fe750f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae524697576f78a9707a790011fe750f1">&#9670;&nbsp;</a></span>COMMAND</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COMMAND</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">c</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> tmp = c;\</div>
<div class="line"> if (cmd.startsWith(tmp)) {\</div>
<div class="line"> args = cmd.substring(tmp.length() + 1);<a class="code" href="namespacetools.html#af65c903a50ffc843b950355af6bd05f4">\</a></div>
<div class="line"><a class="code" href="namespacetools.html#af65c903a50ffc843b950355af6bd05f4"> tools::trim</a>(args);</div>
<div class="ttc" id="anamespacetools_html_af65c903a50ffc843b950355af6bd05f4"><div class="ttname"><a href="namespacetools.html#af65c903a50ffc843b950355af6bd05f4">tools::trim</a></div><div class="ttdeci">void trim(String &amp;in)</div><div class="ttdoc">Takes spaces off start and end of supplied string, operates in place on String passed in.</div><div class="ttdef"><b>Definition:</b> <a href="tools_8cpp_source.html#l00012">tools.cpp:12</a></div></div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="CLI_8cpp_source.html#l00009">9</a> of file <a class="el" href="CLI_8cpp_source.html">CLI.cpp</a>.</p>

</div>
</div>
<a id="a534859233b15fe77e8f1ff06151cd163"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a534859233b15fe77e8f1ff06151cd163">&#9670;&nbsp;</a></span>END_CMD</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define END_CMD&#160;&#160;&#160;return; }</td>
</tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="CLI_8cpp_source.html#l00015">15</a> of file <a class="el" href="CLI_8cpp_source.html">CLI.cpp</a>.</p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
22 changes: 11 additions & 11 deletions CLI_8cpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -70,33 +70,33 @@
<div class="title">CLI.cpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#</span><span class="preprocessor">include</span> <a class="code" href="CLI_8h.html">&quot;CLI.h&quot;</a></div>
<a href="CLI_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#</span><span class="preprocessor">include</span> <a class="code" href="CLI_8h.html">&quot;CLI.h&quot;</a></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#</span><span class="preprocessor">include</span> <a class="code" href="config_8h.html">&quot;config.h&quot;</a></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#</span><span class="preprocessor">include</span> <a class="code" href="serial__output_8h.html">&quot;serial_output.h&quot;</a></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#</span><span class="preprocessor">include</span> <a class="code" href="tools_8h.html">&quot;tools.h&quot;</a></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#</span><span class="preprocessor">include</span> <a class="code" href="Settings_8h.html">&quot;Settings.h&quot;</a></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#</span><span class="preprocessor">include</span> <a class="code" href="Radio_8h.html">&quot;Radio.h&quot;</a></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#</span><span class="preprocessor">include</span> <a class="code" href="OOKwiz_8h.html">&quot;OOKwiz.h&quot;</a></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">COMMAND</span><span class="preprocessor">(</span><span class="preprocessor">c</span><span class="preprocessor">)</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"><a class="line" href="CLI_8cpp.html#ae524697576f78a9707a790011fe750f1"> 9</a></span>&#160;<span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">COMMAND</span><span class="preprocessor">(</span><span class="preprocessor">c</span><span class="preprocessor">)</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; <span class="preprocessor">tmp</span> <span class="preprocessor">=</span> <span class="preprocessor">c</span><span class="preprocessor">;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; <span class="keywordflow">if</span> <span class="preprocessor">(</span><span class="preprocessor">cmd</span><span class="preprocessor">.</span><span class="preprocessor">startsWith</span><span class="preprocessor">(</span><span class="preprocessor">tmp</span><span class="preprocessor">)</span><span class="preprocessor">)</span> <span class="preprocessor">{</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; <span class="preprocessor">args</span> <span class="preprocessor">=</span> <span class="preprocessor">cmd</span><span class="preprocessor">.</span><span class="preprocessor">substring</span><span class="preprocessor">(</span><span class="preprocessor">tmp</span><span class="preprocessor">.</span><span class="preprocessor">length</span><span class="preprocessor">(</span><span class="preprocessor">)</span> <span class="preprocessor">+</span> 1<span class="preprocessor">)</span><span class="preprocessor">;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; <span class="preprocessor">tools</span><span class="preprocessor">::</span><span class="preprocessor">trim</span><span class="preprocessor">(</span><span class="preprocessor">args</span><span class="preprocessor">)</span><span class="preprocessor">;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">END_CMD</span> <span class="keywordflow">return</span><span class="preprocessor">;</span> <span class="preprocessor">}</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="CLI_8cpp.html#a534859233b15fe77e8f1ff06151cd163"> 15</a></span>&#160;<span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">END_CMD</span> <span class="keywordflow">return</span><span class="preprocessor">;</span> <span class="preprocessor">}</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="keyword">namespace</span> CLI {</div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="namespaceCLI.html"> 18</a></span>&#160;<span class="keyword">namespace</span> <a class="code" href="namespaceCLI.html">CLI</a> {</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keywordtype">bool</span> cli_start_msg_printed = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; String serial_buffer;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keywordtype">void</span> parse(String cmd);</div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="namespaceCLI.html#ac1a0c60454bd3a361cb4fc3ec4d64693"> 20</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="namespaceCLI.html#ac1a0c60454bd3a361cb4fc3ec4d64693">cli_start_msg_printed</a> = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="namespaceCLI.html#a268599b898b8618cbb0996922a5358d6"> 21</a></span>&#160; <a class="code" href="namespaceCLI.html#a268599b898b8618cbb0996922a5358d6">String</a> <a class="code" href="namespaceCLI.html#a268599b898b8618cbb0996922a5358d6">serial_buffer</a>;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keywordtype">void</span> <a class="code" href="namespaceCLI.html#a8757901cd08f4f81efb19b3b226f28b2">parse</a>(String cmd);</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keywordtype">void</span> loop() {</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keywordflow">if</span> (!cli_start_msg_printed) {</div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="namespaceCLI.html#a9af91bae9053f9d192801dc2b147d62b"> 24</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="namespaceCLI.html#a9af91bae9053f9d192801dc2b147d62b">loop</a>() {</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keywordflow">if</span> (!<a class="code" href="namespaceCLI.html#ac1a0c60454bd3a361cb4fc3ec4d64693">cli_start_msg_printed</a>) {</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <a class="code" href="serial__output_8h.html#aedf01192151e10a6620567952711ff69">INFO</a>(<span class="stringliteral">&quot;CLI started on Serial. Type &#39;help&#39; for list of commands.\n&quot;</span>);</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; cli_start_msg_printed = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <a class="code" href="namespaceCLI.html#ac1a0c60454bd3a361cb4fc3ec4d64693">cli_start_msg_printed</a> = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; }</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordflow">while</span> (Serial.available()) {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keywordtype">char</span> inp = Serial.read();</div>
Expand All @@ -112,7 +112,7 @@
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; }</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; }</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordtype">void</span> parse(String cmd) {</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="namespaceCLI.html#a8757901cd08f4f81efb19b3b226f28b2"> 43</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="namespaceCLI.html#a8757901cd08f4f81efb19b3b226f28b2">parse</a>(String cmd) {</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; String args;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; String tmp;</div>
Expand Down
Loading

0 comments on commit e26f53a

Please sign in to comment.