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.
255 lines
13 KiB
HTML
255 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: dpp.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
|
|
 <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('dpp_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> </div>
|
|
<div class="headertitle"><div class="title">dpp.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 >DPP example application. </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="dpp_8c_source.html">dpp.c</a>.</p>
|
|
</div><div class="textblock"><code>#include <stdio.h></code><br />
|
|
<code>#include <string.h></code><br />
|
|
<code>#include "mmutils.h"</code><br />
|
|
<code>#include "mmosal.h"</code><br />
|
|
<code>#include "mmwlan.h"</code><br />
|
|
<code>#include "mmconfig.h"</code><br />
|
|
<code>#include "mm_app_common.h"</code><br />
|
|
</div><div class="textblock"><div class="dynheader">
|
|
Include dependency graph for dpp.c:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="dpp_8c__incl.png" border="0" usemap="#adpp_8c" alt=""/></div>
|
|
<map name="adpp_8c" id="adpp_8c">
|
|
<area shape="rect" title="DPP example application." alt="" coords="165,5,222,32"/>
|
|
<area shape="rect" title=" " alt="" coords="5,304,72,331"/>
|
|
<area shape="rect" title=" " alt="" coords="98,304,169,331"/>
|
|
<area shape="rect" href="mmutils_8h_source.html" title=" " alt="" coords="337,229,425,256"/>
|
|
<area shape="rect" href="mmosal_8h_source.html" title=" " alt="" coords="175,229,262,256"/>
|
|
<area shape="rect" href="mmwlan_8h_source.html" title=" " alt="" coords="336,80,427,107"/>
|
|
<area shape="rect" href="mmconfig_8h_source.html" title=" " alt="" coords="636,155,735,181"/>
|
|
<area shape="rect" title=" " alt="" coords="501,80,656,107"/>
|
|
<area shape="rect" title=" " alt="" coords="728,304,803,331"/>
|
|
<area shape="rect" title=" " alt="" coords="427,304,498,331"/>
|
|
<area shape="rect" title=" " alt="" coords="303,304,374,331"/>
|
|
<area shape="rect" title=" " alt="" coords="523,304,605,331"/>
|
|
<area shape="rect" title=" " alt="" coords="193,304,279,331"/>
|
|
<area shape="rect" href="mmpkt_8h_source.html" title=" " alt="" coords="501,155,582,181"/>
|
|
<area shape="rect" title=" " alt="" coords="601,229,676,256"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
<p><a href="dpp_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:a3298592967f7111b34fbb7ac4e8e400a"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="dpp_8c.html#a3298592967f7111b34fbb7ac4e8e400a">mmwlan_dpp_pb_result_to_string</a> (enum <a class="el" href="group__MMWLAN__CTRL.html#gade954a79247b07a1737c72f34e2697ea">mmwlan_dpp_pb_result</a> result)</td></tr>
|
|
<tr class="memdesc:a3298592967f7111b34fbb7ac4e8e400a"><td class="mdescLeft"> </td><td class="mdescRight">Convert a DPP push button result code to its string representation. <a href="dpp_8c.html#a3298592967f7111b34fbb7ac4e8e400a">More...</a><br /></td></tr>
|
|
<tr class="separator:a3298592967f7111b34fbb7ac4e8e400a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab775d0ad229c3382e824051e190f09b6"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="dpp_8c.html#ab775d0ad229c3382e824051e190f09b6">dpp_event_handler</a> (const struct <a class="el" href="structmmwlan__dpp__cb__args.html">mmwlan_dpp_cb_args</a> *dpp_event, void *arg)</td></tr>
|
|
<tr class="memdesc:ab775d0ad229c3382e824051e190f09b6"><td class="mdescLeft"> </td><td class="mdescRight">Function to handle dpp events. <a href="dpp_8c.html#ab775d0ad229c3382e824051e190f09b6">More...</a><br /></td></tr>
|
|
<tr class="separator:ab775d0ad229c3382e824051e190f09b6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:add3190cf715f513666f4be42874d91e2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="dpp_8c.html#add3190cf715f513666f4be42874d91e2">app_init</a> (void)</td></tr>
|
|
<tr class="memdesc:add3190cf715f513666f4be42874d91e2"><td class="mdescLeft"> </td><td class="mdescRight">Main entry point to the application. <a href="dpp_8c.html#add3190cf715f513666f4be42874d91e2">More...</a><br /></td></tr>
|
|
<tr class="separator:add3190cf715f513666f4be42874d91e2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="add3190cf715f513666f4be42874d91e2" name="add3190cf715f513666f4be42874d91e2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#add3190cf715f513666f4be42874d91e2">◆ </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 </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="dpp_8c_source.html#l00099">99</a> of file <a class="el" href="dpp_8c_source.html">dpp.c</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab775d0ad229c3382e824051e190f09b6" name="ab775d0ad229c3382e824051e190f09b6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab775d0ad229c3382e824051e190f09b6">◆ </a></span>dpp_event_handler()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void dpp_event_handler </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const struct <a class="el" href="structmmwlan__dpp__cb__args.html">mmwlan_dpp_cb_args</a> * </td>
|
|
<td class="paramname"><em>dpp_event</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>arg</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Function to handle dpp events. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dpp_event</td><td>Reference to dpp event argument structure </td></tr>
|
|
<tr><td class="paramname">arg</td><td>User argument that was registered when <code><a class="el" href="group__MMWLAN__CTRL.html#gaf2278ba50e3bcbd6fa96408ec3c634c3" title="Function to start the Device Provisioning Protocol (DPP) process.">mmwlan_dpp_start()</a></code> was called. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dpp_8c_source.html#l00054">54</a> of file <a class="el" href="dpp_8c_source.html">dpp.c</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3298592967f7111b34fbb7ac4e8e400a" name="a3298592967f7111b34fbb7ac4e8e400a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3298592967f7111b34fbb7ac4e8e400a">◆ </a></span>mmwlan_dpp_pb_result_to_string()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char * mmwlan_dpp_pb_result_to_string </td>
|
|
<td>(</td>
|
|
<td class="paramtype">enum <a class="el" href="group__MMWLAN__CTRL.html#gade954a79247b07a1737c72f34e2697ea">mmwlan_dpp_pb_result</a> </td>
|
|
<td class="paramname"><em>result</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Convert a DPP push button result code to its string representation. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">result</td><td>The enumeration value of type <code>enum</code> mmwlan_dpp_pb_result to be converted.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A constant string describing the result. If the input is not a recognized enumeration value, the string "Unknown Result" is returned. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dpp_8c_source.html#l00033">33</a> of file <a class="el" href="dpp_8c_source.html">dpp.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_48749c2862d5a440a5c1ecfea3f0aa62.html">dpp</a></li><li class="navelem"><a class="el" href="dir_de65f5c5630985912bc1f6fae1a91ea7.html">src</a></li><li class="navelem"><a class="el" href="dpp_8c.html">dpp.c</a></li>
|
|
<li class="footer">Copyright 2021 Morse Micro </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|