parallel-ref/mm-iot-sdk
1
0
Fork 0
mirror of https://github.com/buildwithparallel/mm-iot-sdk synced 2026-08-10 21:27:58 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
mm-iot-sdk/framework/doc/html/cli_8c.html
Morse Micro 4f4eb7fc7a Morse Micro MM-IoT-SDK release 2.9.7 
This commit introduces version 2.9.7 of the Morse Micro MM-IoT-SDK
for ARM microcontroller base platforms.
2025-10-04 02:04:28 +10:00

347 lines
17 KiB
HTML
Raw Permalink Blame History

<!-- HTML header for doxygen 1.8.17-->
<!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.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Morse Micro IoT SDK: cli.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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" />
<link href="style.css" rel="stylesheet" type="text/css"/>
<link rel="shortcut icon" href="favicon.svg" />
</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="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Morse Micro IoT SDK
&#160;<span id="projectnumber">2.9.7</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('cli_8c.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">cli.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Example command line interface (CLI) over UART. </p>
<dl class="section note"><dt>Note</dt><dd>It is assumed that you have followed the steps in the <a class="el" href="GETTING_STARTED.html">Getting Started</a> guide and are therefore familiar with how to build, flash, and monitor an application using the MM-IoT-SDK framework. </dd></dl>
<p class="definition">Definition in file <a class="el" href="cli_8c_source.html">cli.c</a>.</p>
</div><div class="textblock"><code>#include &quot;mmconfig.h&quot;</code><br />
<code>#include &quot;mmhal_uart.h&quot;</code><br />
<code>#include &quot;mmutils.h&quot;</code><br />
<code>#include &quot;mmagic.h&quot;</code><br />
<code>#include &quot;mm_app_regdb.h&quot;</code><br />
<code>#include &quot;mbedtls/mbedtls_config.h&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for cli.c:</div>
<div class="dyncontent">
<div class="center"><img src="cli_8c__incl.png" border="0" usemap="#acli_8c" alt=""/></div>
<map name="acli_8c" id="acli_8c">
<area shape="rect" title="Example command line interface (CLI) over UART." alt="" coords="1393,5,1441,32"/>
<area shape="rect" href="mmconfig_8h_source.html" title=" " alt="" coords="491,393,589,420"/>
<area shape="rect" href="mmhal__uart_8h_source.html" title=" " alt="" coords="498,80,611,107"/>
<area shape="rect" href="mmutils_8h_source.html" title=" " alt="" coords="1237,468,1325,495"/>
<area shape="rect" href="mmagic_8h_source.html" title=" " alt="" coords="1017,229,1103,256"/>
<area shape="rect" title=" " alt="" coords="1481,80,1615,107"/>
<area shape="rect" title=" " alt="" coords="1639,80,1830,107"/>
<area shape="rect" title=" " alt="" coords="365,468,440,495"/>
<area shape="rect" title=" " alt="" coords="560,543,643,569"/>
<area shape="rect" title=" " alt="" coords="865,543,935,569"/>
<area shape="rect" href="mmhal_8h_source.html" title=" " alt="" coords="381,155,461,181"/>
<area shape="rect" href="mmosal_8h_source.html" title=" " alt="" coords="1075,468,1162,495"/>
<area shape="rect" title=" " alt="" coords="389,311,453,338"/>
<area shape="rect" href="mmhal__flash_8h_source.html" title=" " alt="" coords="145,393,263,420"/>
<area shape="rect" href="mmhal__wlan_8h_source.html" title=" " alt="" coords="482,229,601,256"/>
<area shape="rect" href="mmpkt_8h_source.html" title=" " alt="" coords="715,393,797,420"/>
<area shape="rect" href="mmwlan_8h_source.html" title=" " alt="" coords="973,311,1064,338"/>
<area shape="rect" title=" " alt="" coords="1079,543,1145,569"/>
<area shape="rect" title=" " alt="" coords="1170,543,1241,569"/>
<area shape="rect" title=" " alt="" coords="1265,543,1335,569"/>
<area shape="rect" title=" " alt="" coords="967,543,1054,569"/>
<area shape="rect" title=" " alt="" coords="1371,543,1445,569"/>
<area shape="rect" title=" " alt="" coords="1139,304,1303,345"/>
</map>
</div>
</div>
<p><a href="cli_8c_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a2186a4f1575a4d496db9664449b457fd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cli_8c.html#a2186a4f1575a4d496db9664449b457fd">cli_uart_rx_handler</a> (const uint8_t *data, size_t length, void *arg)</td></tr>
<tr class="memdesc:a2186a4f1575a4d496db9664449b457fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler for the UART receive callback. <a href="cli_8c.html#a2186a4f1575a4d496db9664449b457fd">More...</a><br /></td></tr>
<tr class="separator:a2186a4f1575a4d496db9664449b457fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9be2be952913e9098eb6b7fddb4fa329"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cli_8c.html#a9be2be952913e9098eb6b7fddb4fa329">cli_tx_handler</a> (const char *data, size_t length, void *arg)</td></tr>
<tr class="memdesc:a9be2be952913e9098eb6b7fddb4fa329"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler for the CLI transmit callback. <a href="cli_8c.html#a9be2be952913e9098eb6b7fddb4fa329">More...</a><br /></td></tr>
<tr class="separator:a9be2be952913e9098eb6b7fddb4fa329"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34d8389c7f250ef638d620e68f69071a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cli_8c.html#a34d8389c7f250ef638d620e68f69071a">cli_set_deep_sleep_mode_handler</a> (enum <a class="el" href="group__MMAGIC__CONTROLLER__DATA__TYPES.html#ga6bff6987d5569c51bb6bb13b8fecb3eb">mmagic_deep_sleep_mode</a> mode, void *arg)</td></tr>
<tr class="memdesc:a34d8389c7f250ef638d620e68f69071a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler for the CLI set deep sleep mode callback. <a href="cli_8c.html#a34d8389c7f250ef638d620e68f69071a">More...</a><br /></td></tr>
<tr class="separator:a34d8389c7f250ef638d620e68f69071a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add3190cf715f513666f4be42874d91e2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cli_8c.html#add3190cf715f513666f4be42874d91e2">app_init</a> (void)</td></tr>
<tr class="memdesc:add3190cf715f513666f4be42874d91e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main entry point to the application. <a href="cli_8c.html#add3190cf715f513666f4be42874d91e2">More...</a><br /></td></tr>
<tr class="separator:add3190cf715f513666f4be42874d91e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a1d8093194bebe740746c8536684f99ff"><td class="memItemLeft" align="right" valign="top">struct mmagic_cli *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cli_8c.html#a1d8093194bebe740746c8536684f99ff">mmagic_cli_ctx</a></td></tr>
<tr class="memdesc:a1d8093194bebe740746c8536684f99ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to context for CLI receive callback. <a href="cli_8c.html#a1d8093194bebe740746c8536684f99ff">More...</a><br /></td></tr>
<tr class="separator:a1d8093194bebe740746c8536684f99ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="add3190cf715f513666f4be42874d91e2" name="add3190cf715f513666f4be42874d91e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add3190cf715f513666f4be42874d91e2">&#9670;&nbsp;</a></span>app_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void app_init </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Main entry point to the application. </p>
<p >This will be invoked in a thread once operating system and hardware initialization has completed. It may return, but it does not have to. </p>
<p class="definition">Definition at line <a class="el" href="cli_8c_source.html#l00107">107</a> of file <a class="el" href="cli_8c_source.html">cli.c</a>.</p>
</div>
</div>
<a id="a34d8389c7f250ef638d620e68f69071a" name="a34d8389c7f250ef638d620e68f69071a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34d8389c7f250ef638d620e68f69071a">&#9670;&nbsp;</a></span>cli_set_deep_sleep_mode_handler()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool cli_set_deep_sleep_mode_handler </td>
<td>(</td>
<td class="paramtype">enum <a class="el" href="group__MMAGIC__CONTROLLER__DATA__TYPES.html#ga6bff6987d5569c51bb6bb13b8fecb3eb">mmagic_deep_sleep_mode</a>&#160;</td>
<td class="paramname"><em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>arg</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Handler for the CLI set deep sleep mode callback. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mode</td><td>The deep sleep mode to set. </td></tr>
<tr><td class="paramname">arg</td><td>Opaque argument (unused).</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true on success, false on failure. </dd></dl>
<p class="definition">Definition at line <a class="el" href="cli_8c_source.html#l00078">78</a> of file <a class="el" href="cli_8c_source.html">cli.c</a>.</p>
</div>
</div>
<a id="a9be2be952913e9098eb6b7fddb4fa329" name="a9be2be952913e9098eb6b7fddb4fa329"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9be2be952913e9098eb6b7fddb4fa329">&#9670;&nbsp;</a></span>cli_tx_handler()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cli_tx_handler </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>arg</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Handler for the CLI transmit callback. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>Data to transmit. </td></tr>
<tr><td class="paramname">length</td><td>Length of data to transmit. </td></tr>
<tr><td class="paramname">arg</td><td>Opaque argument (unused). </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="cli_8c_source.html#l00064">64</a> of file <a class="el" href="cli_8c_source.html">cli.c</a>.</p>
</div>
</div>
<a id="a2186a4f1575a4d496db9664449b457fd" name="a2186a4f1575a4d496db9664449b457fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2186a4f1575a4d496db9664449b457fd">&#9670;&nbsp;</a></span>cli_uart_rx_handler()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cli_uart_rx_handler </td>
<td>(</td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>arg</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Handler for the UART receive callback. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>Received data. </td></tr>
<tr><td class="paramname">length</td><td>Length of received data. </td></tr>
<tr><td class="paramname">arg</td><td>Opaque argument (unused). </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="cli_8c_source.html#l00047">47</a> of file <a class="el" href="cli_8c_source.html">cli.c</a>.</p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a1d8093194bebe740746c8536684f99ff" name="a1d8093194bebe740746c8536684f99ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d8093194bebe740746c8536684f99ff">&#9670;&nbsp;</a></span>mmagic_cli_ctx</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct mmagic_cli* mmagic_cli_ctx</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to context for CLI receive callback. </p>
<p class="definition">Definition at line <a class="el" href="cli_8c_source.html#l00038">38</a> of file <a class="el" href="cli_8c_source.html">cli.c</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.17-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_91b8f418cff946e8d8b598a9068417a8.html">examples</a></li><li class="navelem"><a class="el" href="dir_4c635ab7076e85c8dad8905465af2e4c.html">cli</a></li><li class="navelem"><a class="el" href="dir_31f92f0a6b2ef38b165790b737081ce7.html">src</a></li><li class="navelem"><a class="el" href="cli_8c.html">cli.c</a></li>
<li class="footer">Copyright 2021 Morse Micro </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink