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.
251 lines
14 KiB
HTML
251 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: mmwlan_scan_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__scan__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_scan_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 to hold scan arguments. </p>
|
|
<p >This structure should be initialized using <a class="el" href="group__MMWLAN__CTRL.html#ga185c90a221a8b25584fa41b8f33c2783">MMWLAN_SCAN_ARGS_INIT</a> for forward compatibility. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01184">1184</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:ae97bb04cac794a2be4dfa2c74dae1c6b"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmwlan__scan__args.html#ae97bb04cac794a2be4dfa2c74dae1c6b">dwell_time_ms</a></td></tr>
|
|
<tr class="memdesc:ae97bb04cac794a2be4dfa2c74dae1c6b"><td class="mdescLeft"> </td><td class="mdescRight">Minimum time to dwell on a channel waiting for probe responses/beacons. <a href="structmmwlan__scan__args.html#ae97bb04cac794a2be4dfa2c74dae1c6b">More...</a><br /></td></tr>
|
|
<tr class="separator:ae97bb04cac794a2be4dfa2c74dae1c6b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a404204866cd8ab0cac645b48ee53f36a"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmwlan__scan__args.html#a404204866cd8ab0cac645b48ee53f36a">extra_ies</a></td></tr>
|
|
<tr class="memdesc:a404204866cd8ab0cac645b48ee53f36a"><td class="mdescLeft"> </td><td class="mdescRight">Extra Information Elements to include in Probe Request frames. <a href="structmmwlan__scan__args.html#a404204866cd8ab0cac645b48ee53f36a">More...</a><br /></td></tr>
|
|
<tr class="separator:a404204866cd8ab0cac645b48ee53f36a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abb537560d46b1118f2ed43e43348adee"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmwlan__scan__args.html#abb537560d46b1118f2ed43e43348adee">extra_ies_len</a></td></tr>
|
|
<tr class="memdesc:abb537560d46b1118f2ed43e43348adee"><td class="mdescLeft"> </td><td class="mdescRight">Length of <code>extra_ies</code>. <a href="structmmwlan__scan__args.html#abb537560d46b1118f2ed43e43348adee">More...</a><br /></td></tr>
|
|
<tr class="separator:abb537560d46b1118f2ed43e43348adee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a62199cfc87f9a93a1e52d88d5a02d9eb"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmwlan__scan__args.html#a62199cfc87f9a93a1e52d88d5a02d9eb">ssid</a> [<a class="el" href="group__MMWLAN.html#gab3eb6b84d66a2bac936052645f431015">MMWLAN_SSID_MAXLEN</a>]</td></tr>
|
|
<tr class="memdesc:a62199cfc87f9a93a1e52d88d5a02d9eb"><td class="mdescLeft"> </td><td class="mdescRight">SSID used for scan. <a href="structmmwlan__scan__args.html#a62199cfc87f9a93a1e52d88d5a02d9eb">More...</a><br /></td></tr>
|
|
<tr class="separator:a62199cfc87f9a93a1e52d88d5a02d9eb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae90eb4d35c4fac1980702f678e8ef1ff"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmwlan__scan__args.html#ae90eb4d35c4fac1980702f678e8ef1ff">ssid_len</a></td></tr>
|
|
<tr class="memdesc:ae90eb4d35c4fac1980702f678e8ef1ff"><td class="mdescLeft"> </td><td class="mdescRight">Length of the SSID. <a href="structmmwlan__scan__args.html#ae90eb4d35c4fac1980702f678e8ef1ff">More...</a><br /></td></tr>
|
|
<tr class="separator:ae90eb4d35c4fac1980702f678e8ef1ff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab3d53a2735ea71f92a271b3416a9eda5"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmwlan__scan__args.html#ab3d53a2735ea71f92a271b3416a9eda5">dwell_on_home_ms</a></td></tr>
|
|
<tr class="memdesc:ab3d53a2735ea71f92a271b3416a9eda5"><td class="mdescLeft"> </td><td class="mdescRight">Time to dwell on home channel in between channels during a scan, to allow traffic to still pass. <a href="structmmwlan__scan__args.html#ab3d53a2735ea71f92a271b3416a9eda5">More...</a><br /></td></tr>
|
|
<tr class="separator:ab3d53a2735ea71f92a271b3416a9eda5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Field Documentation</h2>
|
|
<a id="ab3d53a2735ea71f92a271b3416a9eda5" name="ab3d53a2735ea71f92a271b3416a9eda5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab3d53a2735ea71f92a271b3416a9eda5">◆ </a></span>dwell_on_home_ms</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t mmwlan_scan_args::dwell_on_home_ms</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Time to dwell on home channel in between channels during a scan, to allow traffic to still pass. </p>
|
|
<p >This will only perform while connected to an AP and is ignored otherwise. If set to 0, the device will not return to the home channel during the scan. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01212">1212</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae97bb04cac794a2be4dfa2c74dae1c6b" name="ae97bb04cac794a2be4dfa2c74dae1c6b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae97bb04cac794a2be4dfa2c74dae1c6b">◆ </a></span>dwell_time_ms</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t mmwlan_scan_args::dwell_time_ms</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Minimum time to dwell on a channel waiting for probe responses/beacons. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>There is some additional delay applied on top of this to allow for tuning to each channel and sending a probe request. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01192">1192</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a404204866cd8ab0cac645b48ee53f36a" name="a404204866cd8ab0cac645b48ee53f36a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a404204866cd8ab0cac645b48ee53f36a">◆ </a></span>extra_ies</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t* mmwlan_scan_args::extra_ies</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Extra Information Elements to include in Probe Request frames. </p>
|
|
<p >May be <code>NULL</code> if <code>extra_ies_len</code> is zero. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01197">1197</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abb537560d46b1118f2ed43e43348adee" name="abb537560d46b1118f2ed43e43348adee"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abb537560d46b1118f2ed43e43348adee">◆ </a></span>extra_ies_len</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t mmwlan_scan_args::extra_ies_len</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Length of <code>extra_ies</code>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01199">1199</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a62199cfc87f9a93a1e52d88d5a02d9eb" name="a62199cfc87f9a93a1e52d88d5a02d9eb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a62199cfc87f9a93a1e52d88d5a02d9eb">◆ </a></span>ssid</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t mmwlan_scan_args::ssid[<a class="el" href="group__MMWLAN.html#gab3eb6b84d66a2bac936052645f431015">MMWLAN_SSID_MAXLEN</a>]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>SSID used for scan. </p>
|
|
<p >May be <code>NULL</code>, with <code>ssid_len</code> set to zero for an undirected scan. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmwlan_8h_source.html#l01204">1204</a> of file <a class="el" href="mmwlan_8h_source.html">mmwlan.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae90eb4d35c4fac1980702f678e8ef1ff" name="ae90eb4d35c4fac1980702f678e8ef1ff"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae90eb4d35c4fac1980702f678e8ef1ff">◆ </a></span>ssid_len</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t mmwlan_scan_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#l01206">1206</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__scan__args.html">mmwlan_scan_args</a></li>
|
|
<li class="footer">Copyright 2021 Morse Micro </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|