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_source.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

234 lines
32 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 Source File</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_source.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="headertitle"><div class="title">cli.c</div></div>
</div><!--header-->
<div class="contents">
<a href="cli_8c.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Copyright 2023 Morse Micro</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * SPDX-License-Identifier: Apache-2.0</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> */</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#include &quot;mmconfig.h&quot;</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include &quot;mmhal_uart.h&quot;</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#include &quot;mmutils.h&quot;</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#include &quot;mmagic.h&quot;</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include &quot;mm_app_regdb.h&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#if !defined(MBEDTLS_CONFIG_FILE)</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include &quot;mbedtls/mbedtls_config.h&quot;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include MBEDTLS_CONFIG_FILE</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#ifdef MBEDTLS_THREADING_ALT</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include &quot;threading_alt.h&quot;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#ifndef APPLICATION_VERSION</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="preprocessor">#error Please define APPLICATION_VERSION to an appropriate value.</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="cli_8c.html#a1d8093194bebe740746c8536684f99ff"> 38</a></span><span class="keyword">struct </span>mmagic_cli *<a class="code hl_variable" href="cli_8c.html#a1d8093194bebe740746c8536684f99ff">mmagic_cli_ctx</a>;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="cli_8c.html#a2186a4f1575a4d496db9664449b457fd"> 47</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="cli_8c.html#a2186a4f1575a4d496db9664449b457fd">cli_uart_rx_handler</a>(<span class="keyword">const</span> uint8_t *data, <span class="keywordtype">size_t</span> length, <span class="keywordtype">void</span> *arg)</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span>{</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <a class="code hl_define" href="group__MMUTILS.html#ga0157597bdd038d83fbb0f2f488e6e4ee">MM_UNUSED</a>(arg);</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keywordflow">if</span> (<a class="code hl_variable" href="cli_8c.html#a1d8093194bebe740746c8536684f99ff">mmagic_cli_ctx</a> != NULL)</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> {</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <a class="code hl_function" href="group__MMAGIC__CLI.html#gab3d5e5b9c0cc38beee36f1531cc55fd7">mmagic_cli_rx</a>(<a class="code hl_variable" href="cli_8c.html#a1d8093194bebe740746c8536684f99ff">mmagic_cli_ctx</a>, (<span class="keyword">const</span> <span class="keywordtype">char</span> *)data, length);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> }</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span>}</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="cli_8c.html#a9be2be952913e9098eb6b7fddb4fa329"> 64</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="cli_8c.html#a9be2be952913e9098eb6b7fddb4fa329">cli_tx_handler</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">size_t</span> length, <span class="keywordtype">void</span> *arg)</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span>{</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <a class="code hl_define" href="group__MMUTILS.html#ga0157597bdd038d83fbb0f2f488e6e4ee">MM_UNUSED</a>(arg);</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <a class="code hl_function" href="group__MMHAL__UART.html#ga22114935cff34ea4bdf3d714acdda560">mmhal_uart_tx</a>((<span class="keyword">const</span> uint8_t *)data, length);</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span>}</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="cli_8c.html#a34d8389c7f250ef638d620e68f69071a"> 78</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="cli_8c.html#a34d8389c7f250ef638d620e68f69071a">cli_set_deep_sleep_mode_handler</a>(<span class="keyword">enum</span> <a class="code hl_enumeration" href="group__MMAGIC__CONTROLLER__DATA__TYPES.html#ga6bff6987d5569c51bb6bb13b8fecb3eb">mmagic_deep_sleep_mode</a> mode, <span class="keywordtype">void</span> *arg)</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span>{</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="group__MMHAL__UART.html#ga88024c213665f84c6273777704117b8c">mmhal_uart_deep_sleep_mode</a> mode_uart;</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <a class="code hl_define" href="group__MMUTILS.html#ga0157597bdd038d83fbb0f2f488e6e4ee">MM_UNUSED</a>(arg);</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keywordflow">switch</span> (mode)</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> {</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="group__MMAGIC__CONTROLLER__DATA__TYPES.html#gga6bff6987d5569c51bb6bb13b8fecb3eba4ac15813152be41be5e8a1bf42f5eea4">MMAGIC_DEEP_SLEEP_MODE_DISABLED</a>:</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> mode_uart = <a class="code hl_enumvalue" href="group__MMHAL__UART.html#gga88024c213665f84c6273777704117b8ca5cdc4ec8e6be8869746c7e39725b1134">MMHAL_UART_DEEP_SLEEP_DISABLED</a>;</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keywordflow">break</span>;</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="group__MMAGIC__CONTROLLER__DATA__TYPES.html#gga6bff6987d5569c51bb6bb13b8fecb3eba26dd8e91f6c92d184d1410c1b54ae763">MMAGIC_DEEP_SLEEP_MODE_ONE_SHOT</a>:</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> mode_uart = <a class="code hl_enumvalue" href="group__MMHAL__UART.html#gga88024c213665f84c6273777704117b8ca0eb6679f719abcc8c7aed5a74f405d73">MMHAL_UART_DEEP_SLEEP_ONE_SHOT</a>;</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="comment">/* 1ms delay to flush out the LF that follows a CR - or else this will wake us up */</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <a class="code hl_function" href="group__MMOSAL__TASKS.html#ga62710c8923b3dbfc3de33e11ffd49bd4">mmosal_task_sleep</a>(1);</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <span class="keywordflow">break</span>;</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> </div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <span class="keywordflow">default</span>:</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> }</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> </div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <span class="keywordflow">return</span> <a class="code hl_function" href="group__MMHAL__UART.html#gaf31cd17018e1bd3a8387de5a038fd06c">mmhal_uart_set_deep_sleep_mode</a>(mode_uart);</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span>}</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"><a class="line" href="cli_8c.html#add3190cf715f513666f4be42874d91e2"> 107</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="cli_8c.html#add3190cf715f513666f4be42874d91e2">app_init</a>(<span class="keywordtype">void</span>)</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span>{</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> <span class="keywordtype">char</span> cli_mode[4] = <span class="stringliteral">&quot;cli&quot;</span>;</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> (void)<a class="code hl_function" href="group__MMCONFIG__API.html#ga49a03e759500ae9d9395a22d3846c11e">mmconfig_read_string</a>(<span class="stringliteral">&quot;cli.mode&quot;</span>, cli_mode, <span class="keyword">sizeof</span>(cli_mode));</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> </div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> <a class="code hl_function" href="group__MMHAL__UART.html#gad368f1afcc9094ac2ff4c85a1be3c4c0">mmhal_uart_init</a>(<a class="code hl_function" href="cli_8c.html#a2186a4f1575a4d496db9664449b457fd">cli_uart_rx_handler</a>, NULL);</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> </div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> <span class="comment">/* Initialize mbedTLS threading (required if MBEDTLS_THREADING_ALT is defined) */</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span><span class="preprocessor">#ifdef MBEDTLS_THREADING_ALT</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> mbedtls_platform_threading_init();</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> <span class="comment">/* If the cli.mode config variable is set to m2m then use MMAGIC in binary machine-to-machine</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span><span class="comment"> * mode, otherwise use it in interactive CLI mode. */</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> <span class="keywordflow">if</span> (strcasecmp(cli_mode, <span class="stringliteral">&quot;m2m&quot;</span>))</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> {</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> <span class="keyword">const</span> <span class="keyword">struct </span><a class="code hl_struct" href="structmmagic__cli__init__args.html">mmagic_cli_init_args</a> init_args = {</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> .<a class="code hl_variable" href="structmmagic__cli__init__args.html#a1bb65a2fbd8ab2521bfba887fd55c314">app_version</a> = APPLICATION_VERSION,</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> .tx_cb = <a class="code hl_function" href="cli_8c.html#a9be2be952913e9098eb6b7fddb4fa329">cli_tx_handler</a>,</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> .set_deep_sleep_mode_cb = <a class="code hl_function" href="cli_8c.html#a34d8389c7f250ef638d620e68f69071a">cli_set_deep_sleep_mode_handler</a>,</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> .reg_db = get_regulatory_db(),</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> };</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> <a class="code hl_variable" href="cli_8c.html#a1d8093194bebe740746c8536684f99ff">mmagic_cli_ctx</a> = <a class="code hl_function" href="group__MMAGIC__CLI.html#ga3a2cf9304b5229e57401a69f8476ab2a">mmagic_cli_init</a>(&amp;init_args);</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> printf(<span class="stringliteral">&quot;CLI interface enabled\n&quot;</span>);</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> }</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> <span class="keywordflow">else</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> {</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> <span class="keyword">const</span> <span class="keyword">struct </span><a class="code hl_struct" href="structmmagic__m2m__agent__init__args.html">mmagic_m2m_agent_init_args</a> init_args = {</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> .<a class="code hl_variable" href="structmmagic__m2m__agent__init__args.html#ad4731621e21f22b29c7cb8bf54e55ab9">app_version</a> = APPLICATION_VERSION,</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> .reg_db = get_regulatory_db(),</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> };</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> <span class="keyword">struct </span>mmagic_m2m_agent *mmagic_m2m_agent = <a class="code hl_function" href="group__MMAGIC__AGENT.html#ga0c7e0c69e10d9b0046cf7a8733a88cc8">mmagic_m2m_agent_init</a>(&amp;init_args);</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> <a class="code hl_define" href="group__MMUTILS.html#ga0157597bdd038d83fbb0f2f488e6e4ee">MM_UNUSED</a>(mmagic_m2m_agent);</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> printf(<span class="stringliteral">&quot;M2M interface enabled\n&quot;</span>);</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> }</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span>}</div>
<div class="ttc" id="acli_8c_html_a1d8093194bebe740746c8536684f99ff"><div class="ttname"><a href="cli_8c.html#a1d8093194bebe740746c8536684f99ff">mmagic_cli_ctx</a></div><div class="ttdeci">struct mmagic_cli * mmagic_cli_ctx</div><div class="ttdoc">Pointer to context for CLI receive callback.</div><div class="ttdef"><b>Definition:</b> <a href="cli_8c_source.html#l00038">cli.c:38</a></div></div>
<div class="ttc" id="acli_8c_html_a2186a4f1575a4d496db9664449b457fd"><div class="ttname"><a href="cli_8c.html#a2186a4f1575a4d496db9664449b457fd">cli_uart_rx_handler</a></div><div class="ttdeci">void cli_uart_rx_handler(const uint8_t *data, size_t length, void *arg)</div><div class="ttdoc">Handler for the UART receive callback.</div><div class="ttdef"><b>Definition:</b> <a href="cli_8c_source.html#l00047">cli.c:47</a></div></div>
<div class="ttc" id="acli_8c_html_a34d8389c7f250ef638d620e68f69071a"><div class="ttname"><a href="cli_8c.html#a34d8389c7f250ef638d620e68f69071a">cli_set_deep_sleep_mode_handler</a></div><div class="ttdeci">bool cli_set_deep_sleep_mode_handler(enum mmagic_deep_sleep_mode mode, void *arg)</div><div class="ttdoc">Handler for the CLI set deep sleep mode callback.</div><div class="ttdef"><b>Definition:</b> <a href="cli_8c_source.html#l00078">cli.c:78</a></div></div>
<div class="ttc" id="acli_8c_html_a9be2be952913e9098eb6b7fddb4fa329"><div class="ttname"><a href="cli_8c.html#a9be2be952913e9098eb6b7fddb4fa329">cli_tx_handler</a></div><div class="ttdeci">void cli_tx_handler(const char *data, size_t length, void *arg)</div><div class="ttdoc">Handler for the CLI transmit callback.</div><div class="ttdef"><b>Definition:</b> <a href="cli_8c_source.html#l00064">cli.c:64</a></div></div>
<div class="ttc" id="acli_8c_html_add3190cf715f513666f4be42874d91e2"><div class="ttname"><a href="cli_8c.html#add3190cf715f513666f4be42874d91e2">app_init</a></div><div class="ttdeci">void app_init(void)</div><div class="ttdoc">Main entry point to the application.</div><div class="ttdef"><b>Definition:</b> <a href="cli_8c_source.html#l00107">cli.c:107</a></div></div>
<div class="ttc" id="agroup__MMAGIC__AGENT_html_ga0c7e0c69e10d9b0046cf7a8733a88cc8"><div class="ttname"><a href="group__MMAGIC__AGENT.html#ga0c7e0c69e10d9b0046cf7a8733a88cc8">mmagic_m2m_agent_init</a></div><div class="ttdeci">struct mmagic_m2m_agent * mmagic_m2m_agent_init(const struct mmagic_m2m_agent_init_args *args)</div><div class="ttdoc">Initialize the M2M agent.</div></div>
<div class="ttc" id="agroup__MMAGIC__CLI_html_ga3a2cf9304b5229e57401a69f8476ab2a"><div class="ttname"><a href="group__MMAGIC__CLI.html#ga3a2cf9304b5229e57401a69f8476ab2a">mmagic_cli_init</a></div><div class="ttdeci">struct mmagic_cli * mmagic_cli_init(const struct mmagic_cli_init_args *args)</div><div class="ttdoc">Initialize and enable the CLI.</div></div>
<div class="ttc" id="agroup__MMAGIC__CLI_html_gab3d5e5b9c0cc38beee36f1531cc55fd7"><div class="ttname"><a href="group__MMAGIC__CLI.html#gab3d5e5b9c0cc38beee36f1531cc55fd7">mmagic_cli_rx</a></div><div class="ttdeci">void mmagic_cli_rx(struct mmagic_cli *ctx, const char *buf, size_t len)</div><div class="ttdoc">This function is used to pass received characters to the MMAGIC CLI.</div></div>
<div class="ttc" id="agroup__MMAGIC__CONTROLLER__DATA__TYPES_html_ga6bff6987d5569c51bb6bb13b8fecb3eb"><div class="ttname"><a href="group__MMAGIC__CONTROLLER__DATA__TYPES.html#ga6bff6987d5569c51bb6bb13b8fecb3eb">mmagic_deep_sleep_mode</a></div><div class="ttdeci">mmagic_deep_sleep_mode</div><div class="ttdoc">Deep sleep modes for the agent MCU.</div><div class="ttdef"><b>Definition:</b> <a href="mmagic__controller_8h_source.html#l00213">mmagic_controller.h:214</a></div></div>
<div class="ttc" id="agroup__MMAGIC__CONTROLLER__DATA__TYPES_html_gga6bff6987d5569c51bb6bb13b8fecb3eba26dd8e91f6c92d184d1410c1b54ae763"><div class="ttname"><a href="group__MMAGIC__CONTROLLER__DATA__TYPES.html#gga6bff6987d5569c51bb6bb13b8fecb3eba26dd8e91f6c92d184d1410c1b54ae763">MMAGIC_DEEP_SLEEP_MODE_ONE_SHOT</a></div><div class="ttdeci">@ MMAGIC_DEEP_SLEEP_MODE_ONE_SHOT</div><div class="ttdoc">Deep sleep is enabled until activity occurs on the datalink.</div><div class="ttdef"><b>Definition:</b> <a href="mmagic__controller_8h_source.html#l00218">mmagic_controller.h:218</a></div></div>
<div class="ttc" id="agroup__MMAGIC__CONTROLLER__DATA__TYPES_html_gga6bff6987d5569c51bb6bb13b8fecb3eba4ac15813152be41be5e8a1bf42f5eea4"><div class="ttname"><a href="group__MMAGIC__CONTROLLER__DATA__TYPES.html#gga6bff6987d5569c51bb6bb13b8fecb3eba4ac15813152be41be5e8a1bf42f5eea4">MMAGIC_DEEP_SLEEP_MODE_DISABLED</a></div><div class="ttdeci">@ MMAGIC_DEEP_SLEEP_MODE_DISABLED</div><div class="ttdoc">Deep sleep is disabled.</div><div class="ttdef"><b>Definition:</b> <a href="mmagic__controller_8h_source.html#l00216">mmagic_controller.h:216</a></div></div>
<div class="ttc" id="agroup__MMCONFIG__API_html_ga49a03e759500ae9d9395a22d3846c11e"><div class="ttname"><a href="group__MMCONFIG__API.html#ga49a03e759500ae9d9395a22d3846c11e">mmconfig_read_string</a></div><div class="ttdeci">int mmconfig_read_string(const char *key, char *buffer, int bufsize)</div><div class="ttdoc">Returns the persistent store string value identified by the key.</div></div>
<div class="ttc" id="agroup__MMHAL__UART_html_ga22114935cff34ea4bdf3d714acdda560"><div class="ttname"><a href="group__MMHAL__UART.html#ga22114935cff34ea4bdf3d714acdda560">mmhal_uart_tx</a></div><div class="ttdeci">void mmhal_uart_tx(const uint8_t *data, size_t length)</div><div class="ttdoc">Transmit data on the UART.</div></div>
<div class="ttc" id="agroup__MMHAL__UART_html_ga88024c213665f84c6273777704117b8c"><div class="ttname"><a href="group__MMHAL__UART.html#ga88024c213665f84c6273777704117b8c">mmhal_uart_deep_sleep_mode</a></div><div class="ttdeci">mmhal_uart_deep_sleep_mode</div><div class="ttdoc">Enumeration of deep sleep modes for the UART HAL.</div><div class="ttdef"><b>Definition:</b> <a href="mmhal__uart_8h_source.html#l00071">mmhal_uart.h:72</a></div></div>
<div class="ttc" id="agroup__MMHAL__UART_html_gad368f1afcc9094ac2ff4c85a1be3c4c0"><div class="ttname"><a href="group__MMHAL__UART.html#gad368f1afcc9094ac2ff4c85a1be3c4c0">mmhal_uart_init</a></div><div class="ttdeci">void mmhal_uart_init(mmhal_uart_rx_cb_t rx_cb, void *rx_cb_arg)</div><div class="ttdoc">Initialize the UART HAL and perform any setup necessary.</div></div>
<div class="ttc" id="agroup__MMHAL__UART_html_gaf31cd17018e1bd3a8387de5a038fd06c"><div class="ttname"><a href="group__MMHAL__UART.html#gaf31cd17018e1bd3a8387de5a038fd06c">mmhal_uart_set_deep_sleep_mode</a></div><div class="ttdeci">bool mmhal_uart_set_deep_sleep_mode(enum mmhal_uart_deep_sleep_mode mode)</div><div class="ttdoc">Set the deep sleep mode for the UART.</div></div>
<div class="ttc" id="agroup__MMHAL__UART_html_gga88024c213665f84c6273777704117b8ca0eb6679f719abcc8c7aed5a74f405d73"><div class="ttname"><a href="group__MMHAL__UART.html#gga88024c213665f84c6273777704117b8ca0eb6679f719abcc8c7aed5a74f405d73">MMHAL_UART_DEEP_SLEEP_ONE_SHOT</a></div><div class="ttdeci">@ MMHAL_UART_DEEP_SLEEP_ONE_SHOT</div><div class="ttdoc">Enable deep sleep until activity occurs on data-link transport.</div><div class="ttdef"><b>Definition:</b> <a href="mmhal__uart_8h_source.html#l00076">mmhal_uart.h:76</a></div></div>
<div class="ttc" id="agroup__MMHAL__UART_html_gga88024c213665f84c6273777704117b8ca5cdc4ec8e6be8869746c7e39725b1134"><div class="ttname"><a href="group__MMHAL__UART.html#gga88024c213665f84c6273777704117b8ca5cdc4ec8e6be8869746c7e39725b1134">MMHAL_UART_DEEP_SLEEP_DISABLED</a></div><div class="ttdeci">@ MMHAL_UART_DEEP_SLEEP_DISABLED</div><div class="ttdoc">Deep sleep mode is disabled.</div><div class="ttdef"><b>Definition:</b> <a href="mmhal__uart_8h_source.html#l00074">mmhal_uart.h:74</a></div></div>
<div class="ttc" id="agroup__MMOSAL__TASKS_html_ga62710c8923b3dbfc3de33e11ffd49bd4"><div class="ttname"><a href="group__MMOSAL__TASKS.html#ga62710c8923b3dbfc3de33e11ffd49bd4">mmosal_task_sleep</a></div><div class="ttdeci">void mmosal_task_sleep(uint32_t duration_ms)</div><div class="ttdoc">Sleep for a period of time, yielding during that time.</div></div>
<div class="ttc" id="agroup__MMUTILS_html_ga0157597bdd038d83fbb0f2f488e6e4ee"><div class="ttname"><a href="group__MMUTILS.html#ga0157597bdd038d83fbb0f2f488e6e4ee">MM_UNUSED</a></div><div class="ttdeci">#define MM_UNUSED(_x)</div><div class="ttdoc">Casts the given expression to void to avoid &quot;unused&quot; warnings from the compiler.</div><div class="ttdef"><b>Definition:</b> <a href="mmutils_8h_source.html#l00069">mmutils.h:69</a></div></div>
<div class="ttc" id="astructmmagic__cli__init__args_html"><div class="ttname"><a href="structmmagic__cli__init__args.html">mmagic_cli_init_args</a></div><div class="ttdoc">CLI initialization arguments structure.</div><div class="ttdef"><b>Definition:</b> <a href="mmagic_8h_source.html#l00249">mmagic.h:250</a></div></div>
<div class="ttc" id="astructmmagic__cli__init__args_html_a1bb65a2fbd8ab2521bfba887fd55c314"><div class="ttname"><a href="structmmagic__cli__init__args.html#a1bb65a2fbd8ab2521bfba887fd55c314">mmagic_cli_init_args::app_version</a></div><div class="ttdeci">char app_version[MMAGIC_SYS_MAX_APP_VERSION_LENGTH+1]</div><div class="ttdoc">Application version string.</div><div class="ttdef"><b>Definition:</b> <a href="mmagic_8h_source.html#l00252">mmagic.h:252</a></div></div>
<div class="ttc" id="astructmmagic__m2m__agent__init__args_html"><div class="ttname"><a href="structmmagic__m2m__agent__init__args.html">mmagic_m2m_agent_init_args</a></div><div class="ttdoc">M2M initialization args.</div><div class="ttdef"><b>Definition:</b> <a href="mmagic_8h_source.html#l00292">mmagic.h:293</a></div></div>
<div class="ttc" id="astructmmagic__m2m__agent__init__args_html_ad4731621e21f22b29c7cb8bf54e55ab9"><div class="ttname"><a href="structmmagic__m2m__agent__init__args.html#ad4731621e21f22b29c7cb8bf54e55ab9">mmagic_m2m_agent_init_args::app_version</a></div><div class="ttdeci">char app_version[MMAGIC_SYS_MAX_APP_VERSION_LENGTH+1]</div><div class="ttdoc">Application version string.</div><div class="ttdef"><b>Definition:</b> <a href="mmagic_8h_source.html#l00295">mmagic.h:295</a></div></div>
</div><!-- fragment --></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