mirror of
https://github.com/buildwithparallel/mm-iot-sdk
synced 2026-08-10 21:27:58 -04:00
4f4eb7fc7a
This commit introduces version 2.9.7 of the Morse Micro MM-IoT-SDK for ARM microcontroller base platforms.
247 lines
14 KiB
HTML
247 lines
14 KiB
HTML
<!-- 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: mmagic_cli_init_args Struct 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
|
|
 <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&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&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&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('structmmagic__cli__init__args.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="#pub-attribs">Data Fields</a> </div>
|
|
<div class="headertitle"><div class="title">mmagic_cli_init_args Struct Reference<div class="ingroups"><a class="el" href="group__MMAGIC.html">MMAGIC: CLI and Machine-to-Machine interface infrastructure</a> » <a class="el" href="group__MMAGIC__CLI.html">Morse Command Line Interface (CLI)</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p >CLI initialization arguments structure. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmagic_8h_source.html#l00249">249</a> of file <a class="el" href="mmagic_8h_source.html">mmagic.h</a>.</p>
|
|
</div>
|
|
<p><code>#include <<a class="el" href="mmagic_8h_source.html">mmagic.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
|
|
Data Fields</h2></td></tr>
|
|
<tr class="memitem:a1bb65a2fbd8ab2521bfba887fd55c314"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmagic__cli__init__args.html#a1bb65a2fbd8ab2521bfba887fd55c314">app_version</a> [<a class="el" href="group__MMAGIC__AGENT__COMMON.html#gaf1afc9d481c358028520f708301f96a0">MMAGIC_SYS_MAX_APP_VERSION_LENGTH</a>+1]</td></tr>
|
|
<tr class="memdesc:a1bb65a2fbd8ab2521bfba887fd55c314"><td class="mdescLeft"> </td><td class="mdescRight">Application version string. <a href="structmmagic__cli__init__args.html#a1bb65a2fbd8ab2521bfba887fd55c314">More...</a><br /></td></tr>
|
|
<tr class="separator:a1bb65a2fbd8ab2521bfba887fd55c314"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a03775cd69e4bffee5c7b80b56d9b308a"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmagic__cli__init__args.html#a03775cd69e4bffee5c7b80b56d9b308a">tx_cb_arg</a></td></tr>
|
|
<tr class="memdesc:a03775cd69e4bffee5c7b80b56d9b308a"><td class="mdescLeft"> </td><td class="mdescRight">Opaque arg to pass to <code>tx_cb</code>. <a href="structmmagic__cli__init__args.html#a03775cd69e4bffee5c7b80b56d9b308a">More...</a><br /></td></tr>
|
|
<tr class="separator:a03775cd69e4bffee5c7b80b56d9b308a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a425bf23a006687459901bf9c9d827781"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmagic__cli__init__args.html#a425bf23a006687459901bf9c9d827781">tx_cb</a> )(const char *<a class="el" href="sslclient_8c.html#abdc8ea8147d82c962a7d88863ee32ee0">buf</a>, size_t len, void *cb_arg)</td></tr>
|
|
<tr class="memdesc:a425bf23a006687459901bf9c9d827781"><td class="mdescLeft"> </td><td class="mdescRight">Transmit callback. <a href="structmmagic__cli__init__args.html#a425bf23a006687459901bf9c9d827781">More...</a><br /></td></tr>
|
|
<tr class="separator:a425bf23a006687459901bf9c9d827781"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a291ac15a9e2834d1256f3f5f316bbc5c"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmagic__cli__init__args.html#a291ac15a9e2834d1256f3f5f316bbc5c">set_deep_sleep_mode_cb_arg</a></td></tr>
|
|
<tr class="memdesc:a291ac15a9e2834d1256f3f5f316bbc5c"><td class="mdescLeft"> </td><td class="mdescRight">Opaque arg to pass to <code>set_deep_sleep_mode_cb</code>. <a href="structmmagic__cli__init__args.html#a291ac15a9e2834d1256f3f5f316bbc5c">More...</a><br /></td></tr>
|
|
<tr class="separator:a291ac15a9e2834d1256f3f5f316bbc5c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a70aa8bfd2b5f537d22e09d441cda4b5e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MMAGIC__AGENT__COMMON.html#gabc07fe9b2d5f96145d897b2229b74fcd">mmagic_set_deep_sleep_mode_cb_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmagic__cli__init__args.html#a70aa8bfd2b5f537d22e09d441cda4b5e">set_deep_sleep_mode_cb</a></td></tr>
|
|
<tr class="memdesc:a70aa8bfd2b5f537d22e09d441cda4b5e"><td class="mdescLeft"> </td><td class="mdescRight">Set deep sleep mode callback. <a href="structmmagic__cli__init__args.html#a70aa8bfd2b5f537d22e09d441cda4b5e">More...</a><br /></td></tr>
|
|
<tr class="separator:a70aa8bfd2b5f537d22e09d441cda4b5e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1317fcbac5cde8f608a8719a9f00f39e"><td class="memItemLeft" align="right" valign="top">const struct <a class="el" href="structmmwlan__regulatory__db.html">mmwlan_regulatory_db</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmagic__cli__init__args.html#a1317fcbac5cde8f608a8719a9f00f39e">reg_db</a></td></tr>
|
|
<tr class="memdesc:a1317fcbac5cde8f608a8719a9f00f39e"><td class="mdescLeft"> </td><td class="mdescRight">Reference to the regulatory database, used to initialize wlan. <a href="structmmagic__cli__init__args.html#a1317fcbac5cde8f608a8719a9f00f39e">More...</a><br /></td></tr>
|
|
<tr class="separator:a1317fcbac5cde8f608a8719a9f00f39e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Field Documentation</h2>
|
|
<a id="a1bb65a2fbd8ab2521bfba887fd55c314" name="a1bb65a2fbd8ab2521bfba887fd55c314"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1bb65a2fbd8ab2521bfba887fd55c314">◆ </a></span>app_version</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char mmagic_cli_init_args::app_version[<a class="el" href="group__MMAGIC__AGENT__COMMON.html#gaf1afc9d481c358028520f708301f96a0">MMAGIC_SYS_MAX_APP_VERSION_LENGTH</a>+1]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Application version string. </p>
|
|
<p >This is a null terminated string. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmagic_8h_source.html#l00252">252</a> of file <a class="el" href="mmagic_8h_source.html">mmagic.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1317fcbac5cde8f608a8719a9f00f39e" name="a1317fcbac5cde8f608a8719a9f00f39e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1317fcbac5cde8f608a8719a9f00f39e">◆ </a></span>reg_db</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const struct <a class="el" href="structmmwlan__regulatory__db.html">mmwlan_regulatory_db</a>* mmagic_cli_init_args::reg_db</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reference to the regulatory database, used to initialize wlan. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmagic_8h_source.html#l00262">262</a> of file <a class="el" href="mmagic_8h_source.html">mmagic.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a70aa8bfd2b5f537d22e09d441cda4b5e" name="a70aa8bfd2b5f537d22e09d441cda4b5e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a70aa8bfd2b5f537d22e09d441cda4b5e">◆ </a></span>set_deep_sleep_mode_cb</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__MMAGIC__AGENT__COMMON.html#gabc07fe9b2d5f96145d897b2229b74fcd">mmagic_set_deep_sleep_mode_cb_t</a> mmagic_cli_init_args::set_deep_sleep_mode_cb</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set deep sleep mode callback. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmagic_8h_source.html#l00260">260</a> of file <a class="el" href="mmagic_8h_source.html">mmagic.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a291ac15a9e2834d1256f3f5f316bbc5c" name="a291ac15a9e2834d1256f3f5f316bbc5c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a291ac15a9e2834d1256f3f5f316bbc5c">◆ </a></span>set_deep_sleep_mode_cb_arg</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* mmagic_cli_init_args::set_deep_sleep_mode_cb_arg</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Opaque arg to pass to <code>set_deep_sleep_mode_cb</code>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmagic_8h_source.html#l00258">258</a> of file <a class="el" href="mmagic_8h_source.html">mmagic.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a425bf23a006687459901bf9c9d827781" name="a425bf23a006687459901bf9c9d827781"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a425bf23a006687459901bf9c9d827781">◆ </a></span>tx_cb</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void(* mmagic_cli_init_args::tx_cb) (const char *<a class="el" href="sslclient_8c.html#abdc8ea8147d82c962a7d88863ee32ee0">buf</a>, size_t len, void *cb_arg)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Transmit callback. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmagic_8h_source.html#l00256">256</a> of file <a class="el" href="mmagic_8h_source.html">mmagic.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a03775cd69e4bffee5c7b80b56d9b308a" name="a03775cd69e4bffee5c7b80b56d9b308a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a03775cd69e4bffee5c7b80b56d9b308a">◆ </a></span>tx_cb_arg</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* mmagic_cli_init_args::tx_cb_arg</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Opaque arg to pass to <code>tx_cb</code>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmagic_8h_source.html#l00254">254</a> of file <a class="el" href="mmagic_8h_source.html">mmagic.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li><a class="el" href="mmagic_8h_source.html">mmagic.h</a></li>
|
|
</ul>
|
|
</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="structmmagic__cli__init__args.html">mmagic_cli_init_args</a></li>
|
|
<li class="footer">Copyright 2021 Morse Micro </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|