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.
238 lines
13 KiB
HTML
238 lines
13 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: mmwlan_dpp_cb_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('structmmwlan__dpp__cb__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">mmwlan_dpp_cb_args Struct Reference<div class="ingroups"><a class="el" href="group__MMWLAN.html">Morse Micro Wireless LAN (mmwlan) API</a> » <a class="el" href="group__MMWLAN__CTRL.html">WLAN Control API</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 >Structure passed back when a DPP event occurs. </p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>BETA NOTICE: This is beta API that is under development; breaking changes may be introduced in future releases. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01085">1085</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
</div>
|
|
<p><code>#include <<a class="el" href="mmwlan_8h_source.html">mmwlan.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:aefb678469add397dcbf227856c039eb7"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__MMWLAN__CTRL.html#gaff0a5b52c6328bf4d24644c68b723ed3">mmwlan_dpp_event</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmwlan__dpp__cb__args.html#aefb678469add397dcbf227856c039eb7">event</a></td></tr>
|
|
<tr class="memdesc:aefb678469add397dcbf227856c039eb7"><td class="mdescLeft"> </td><td class="mdescRight">The DPP event that has occurred. <a href="structmmwlan__dpp__cb__args.html#aefb678469add397dcbf227856c039eb7">More...</a><br /></td></tr>
|
|
<tr class="separator:aefb678469add397dcbf227856c039eb7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a02f8dc30ca3410a73f8ab26e190a28be"><td class="memItemLeft" ><a id="a02f8dc30ca3410a73f8ab26e190a28be" name="a02f8dc30ca3410a73f8ab26e190a28be"></a>
|
|
union {</td></tr>
|
|
<tr class="memitem:a4f225f0759624ab9968a9f58dd0ee7a3"><td class="memItemLeft" >
|
|
   struct {</td></tr>
|
|
<tr class="memitem:ad5293e4a97a0fd3b03d5fc819ba38334"><td class="memItemLeft" >      enum <a class="el" href="group__MMWLAN__CTRL.html#gade954a79247b07a1737c72f34e2697ea">mmwlan_dpp_pb_result</a>   <a class="el" href="structmmwlan__dpp__cb__args.html#abf4a9352e8bd4b846461ae113e9b2921">result</a></td></tr>
|
|
<tr class="memdesc:ad5293e4a97a0fd3b03d5fc819ba38334"><td class="mdescLeft"> </td><td class="mdescRight">Result of DPP push button. <a href="structmmwlan__dpp__cb__args.html#abf4a9352e8bd4b846461ae113e9b2921">More...</a><br /></td></tr>
|
|
<tr class="separator:ad5293e4a97a0fd3b03d5fc819ba38334"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3e72717962c60b81fb66b84449854dfb"><td class="memItemLeft" >      const uint8_t *   <a class="el" href="structmmwlan__dpp__cb__args.html#a098b37c9cbab1fc893f960103174b84e">ssid</a></td></tr>
|
|
<tr class="memdesc:a3e72717962c60b81fb66b84449854dfb"><td class="mdescLeft"> </td><td class="mdescRight">SSID of the AP to connect to. <a href="structmmwlan__dpp__cb__args.html#a098b37c9cbab1fc893f960103174b84e">More...</a><br /></td></tr>
|
|
<tr class="separator:a3e72717962c60b81fb66b84449854dfb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a06327f0cb1756b6a547d40bb3afe1220"><td class="memItemLeft" >      uint16_t   <a class="el" href="structmmwlan__dpp__cb__args.html#a8f7bdd888e29a6bb5c8be2cc26a82f6f">ssid_len</a></td></tr>
|
|
<tr class="memdesc:a06327f0cb1756b6a547d40bb3afe1220"><td class="mdescLeft"> </td><td class="mdescRight">Length of the SSID. <a href="structmmwlan__dpp__cb__args.html#a8f7bdd888e29a6bb5c8be2cc26a82f6f">More...</a><br /></td></tr>
|
|
<tr class="separator:a06327f0cb1756b6a547d40bb3afe1220"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0a626bf0d1cb48fae4b84847f0e44586"><td class="memItemLeft" >      const char *   <a class="el" href="structmmwlan__dpp__cb__args.html#a9f7384bfd6b53adddb5f8c97eece24d2">passphrase</a></td></tr>
|
|
<tr class="memdesc:a0a626bf0d1cb48fae4b84847f0e44586"><td class="mdescLeft"> </td><td class="mdescRight">Passphrase, NULL terminated. <a href="structmmwlan__dpp__cb__args.html#a9f7384bfd6b53adddb5f8c97eece24d2">More...</a><br /></td></tr>
|
|
<tr class="separator:a0a626bf0d1cb48fae4b84847f0e44586"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4f225f0759624ab9968a9f58dd0ee7a3"><td class="memItemLeft" valign="top">   }   <b>pb_result</b></td></tr>
|
|
<tr class="memdesc:a4f225f0759624ab9968a9f58dd0ee7a3"><td class="mdescLeft"> </td><td class="mdescRight">Argument for <code>MMWLAN_DPP_EVT_PB_RESULT</code> event. <br /></td></tr>
|
|
<tr class="separator:a4f225f0759624ab9968a9f58dd0ee7a3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a02f8dc30ca3410a73f8ab26e190a28be"><td class="memItemLeft" valign="top">} </td><td class="memItemRight" valign="bottom"><b>args</b></td></tr>
|
|
<tr class="memdesc:a02f8dc30ca3410a73f8ab26e190a28be"><td class="mdescLeft"> </td><td class="mdescRight">Union of arguments for DPP events. <br /></td></tr>
|
|
<tr class="separator:a02f8dc30ca3410a73f8ab26e190a28be"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Field Documentation</h2>
|
|
<a id="aefb678469add397dcbf227856c039eb7" name="aefb678469add397dcbf227856c039eb7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aefb678469add397dcbf227856c039eb7">◆ </a></span>event</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__MMWLAN__CTRL.html#gaff0a5b52c6328bf4d24644c68b723ed3">mmwlan_dpp_event</a> mmwlan_dpp_cb_args::event</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The DPP event that has occurred. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01088">1088</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9f7384bfd6b53adddb5f8c97eece24d2" name="a9f7384bfd6b53adddb5f8c97eece24d2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9f7384bfd6b53adddb5f8c97eece24d2">◆ </a></span>passphrase</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char* mmwlan_dpp_cb_args::passphrase</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Passphrase, NULL terminated. </p>
|
|
<p >May be <code>NULL</code>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01102">1102</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abf4a9352e8bd4b846461ae113e9b2921" name="abf4a9352e8bd4b846461ae113e9b2921"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abf4a9352e8bd4b846461ae113e9b2921">◆ </a></span>result</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__MMWLAN__CTRL.html#gade954a79247b07a1737c72f34e2697ea">mmwlan_dpp_pb_result</a> mmwlan_dpp_cb_args::result</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Result of DPP push button. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01096">1096</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a098b37c9cbab1fc893f960103174b84e" name="a098b37c9cbab1fc893f960103174b84e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a098b37c9cbab1fc893f960103174b84e">◆ </a></span>ssid</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const uint8_t* mmwlan_dpp_cb_args::ssid</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>SSID of the AP to connect to. </p>
|
|
<p >May be <code>NUlL</code>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01098">1098</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8f7bdd888e29a6bb5c8be2cc26a82f6f" name="a8f7bdd888e29a6bb5c8be2cc26a82f6f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8f7bdd888e29a6bb5c8be2cc26a82f6f">◆ </a></span>ssid_len</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t mmwlan_dpp_cb_args::ssid_len</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Length of the SSID. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01100">1100</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li><a class="el" href="mmwlan_8h_source.html">mmwlan.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="structmmwlan__dpp__cb__args.html">mmwlan_dpp_cb_args</a></li>
|
|
<li class="footer">Copyright 2021 Morse Micro </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|