510 lines
23 KiB
HTML
510 lines
23 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.10"/>
|
|
<title>ESP8266_RTOS_SDK: Upgrade APIs</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="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>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</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="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">ESP8266_RTOS_SDK
|
|
 <span id="projectnumber">v1.4.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.10 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<!-- 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="#nested-classes">Data Structures</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Upgrade APIs<div class="ingroups"><a class="el" href="group__System__APIs.html">System APIs</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Firmware upgrade (FOTA) APIs.
|
|
<a href="#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structupgrade__server__info.html">upgrade_server_info</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:ga518257817c69fec25290c1bebad544b0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Upgrade__APIs.html#ga518257817c69fec25290c1bebad544b0">SPI_FLASH_SEC_SIZE</a>   4096</td></tr>
|
|
<tr class="separator:ga518257817c69fec25290c1bebad544b0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga72e5aaa69793c72dc40998cb4b76168c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Upgrade__APIs.html#ga72e5aaa69793c72dc40998cb4b76168c">USER_BIN1</a>   0x00</td></tr>
|
|
<tr class="separator:ga72e5aaa69793c72dc40998cb4b76168c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7c4188e60c7cc5293d25dfb3b34dd224"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Upgrade__APIs.html#ga7c4188e60c7cc5293d25dfb3b34dd224">USER_BIN2</a>   0x01</td></tr>
|
|
<tr class="separator:ga7c4188e60c7cc5293d25dfb3b34dd224"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae9af3da1e7d88b1e0f353d45059f6f1b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Upgrade__APIs.html#gae9af3da1e7d88b1e0f353d45059f6f1b">UPGRADE_FLAG_IDLE</a>   0x00</td></tr>
|
|
<tr class="separator:gae9af3da1e7d88b1e0f353d45059f6f1b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa45c4c3f3b5ed0d3070af7cf0fe151a9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Upgrade__APIs.html#gaa45c4c3f3b5ed0d3070af7cf0fe151a9">UPGRADE_FLAG_START</a>   0x01</td></tr>
|
|
<tr class="separator:gaa45c4c3f3b5ed0d3070af7cf0fe151a9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga568d84b95c752e811a27a337830c3a54"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Upgrade__APIs.html#ga568d84b95c752e811a27a337830c3a54">UPGRADE_FLAG_FINISH</a>   0x02</td></tr>
|
|
<tr class="separator:ga568d84b95c752e811a27a337830c3a54"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3b1051980757f4b853a8e436397e0fa6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Upgrade__APIs.html#ga3b1051980757f4b853a8e436397e0fa6">UPGRADE_FW_BIN1</a>   0x00</td></tr>
|
|
<tr class="separator:ga3b1051980757f4b853a8e436397e0fa6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9c5730b00a161df609340303bd6b4647"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Upgrade__APIs.html#ga9c5730b00a161df609340303bd6b4647">UPGRADE_FW_BIN2</a>   0x01</td></tr>
|
|
<tr class="separator:ga9c5730b00a161df609340303bd6b4647"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:ga2897893fe6b22f7cd3159e57370dee7d"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Upgrade__APIs.html#ga2897893fe6b22f7cd3159e57370dee7d">upgrade_states_check_callback</a>) (void *arg)</td></tr>
|
|
<tr class="memdesc:ga2897893fe6b22f7cd3159e57370dee7d"><td class="mdescLeft"> </td><td class="mdescRight">Callback of upgrading firmware through WiFi. <a href="#ga2897893fe6b22f7cd3159e57370dee7d">More...</a><br /></td></tr>
|
|
<tr class="separator:ga2897893fe6b22f7cd3159e57370dee7d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:gad04181af74584d470c30d6c21dd2db85"><td class="memItemLeft" align="right" valign="top">uint8 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Upgrade__APIs.html#gad04181af74584d470c30d6c21dd2db85">system_upgrade_userbin_check</a> (void)</td></tr>
|
|
<tr class="memdesc:gad04181af74584d470c30d6c21dd2db85"><td class="mdescLeft"> </td><td class="mdescRight">Check the user bin. <a href="#gad04181af74584d470c30d6c21dd2db85">More...</a><br /></td></tr>
|
|
<tr class="separator:gad04181af74584d470c30d6c21dd2db85"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gafbc93a806155a9cf65d25119df0c6b1d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Upgrade__APIs.html#gafbc93a806155a9cf65d25119df0c6b1d">system_upgrade_reboot</a> (void)</td></tr>
|
|
<tr class="memdesc:gafbc93a806155a9cf65d25119df0c6b1d"><td class="mdescLeft"> </td><td class="mdescRight">Reboot system to use the new software. <a href="#gafbc93a806155a9cf65d25119df0c6b1d">More...</a><br /></td></tr>
|
|
<tr class="separator:gafbc93a806155a9cf65d25119df0c6b1d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga18b07d5b7a8b951a41da50506e03c837"><td class="memItemLeft" align="right" valign="top">uint8 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Upgrade__APIs.html#ga18b07d5b7a8b951a41da50506e03c837">system_upgrade_flag_check</a> ()</td></tr>
|
|
<tr class="memdesc:ga18b07d5b7a8b951a41da50506e03c837"><td class="mdescLeft"> </td><td class="mdescRight">Check the upgrade status flag. <a href="#ga18b07d5b7a8b951a41da50506e03c837">More...</a><br /></td></tr>
|
|
<tr class="separator:ga18b07d5b7a8b951a41da50506e03c837"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6760e9df629662611372bcdfca7a4f77"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Upgrade__APIs.html#ga6760e9df629662611372bcdfca7a4f77">system_upgrade_flag_set</a> (uint8 flag)</td></tr>
|
|
<tr class="memdesc:ga6760e9df629662611372bcdfca7a4f77"><td class="mdescLeft"> </td><td class="mdescRight">Set the upgrade status flag. <a href="#ga6760e9df629662611372bcdfca7a4f77">More...</a><br /></td></tr>
|
|
<tr class="separator:ga6760e9df629662611372bcdfca7a4f77"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9b7abd9fa4790f5807c20a24e5e9a51a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Upgrade__APIs.html#ga9b7abd9fa4790f5807c20a24e5e9a51a">system_upgrade_init</a> ()</td></tr>
|
|
<tr class="memdesc:ga9b7abd9fa4790f5807c20a24e5e9a51a"><td class="mdescLeft"> </td><td class="mdescRight">Upgrade function initialization. <a href="#ga9b7abd9fa4790f5807c20a24e5e9a51a">More...</a><br /></td></tr>
|
|
<tr class="separator:ga9b7abd9fa4790f5807c20a24e5e9a51a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga643d7df496074bba1c6d165a3b5c7296"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Upgrade__APIs.html#ga643d7df496074bba1c6d165a3b5c7296">system_upgrade_deinit</a> ()</td></tr>
|
|
<tr class="memdesc:ga643d7df496074bba1c6d165a3b5c7296"><td class="mdescLeft"> </td><td class="mdescRight">Upgrade function de-initialization. <a href="#ga643d7df496074bba1c6d165a3b5c7296">More...</a><br /></td></tr>
|
|
<tr class="separator:ga643d7df496074bba1c6d165a3b5c7296"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga738472f97b8dc72342cb3eb6b984d0bd"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Upgrade__APIs.html#ga738472f97b8dc72342cb3eb6b984d0bd">system_upgrade</a> (uint8 *data, uint32 len)</td></tr>
|
|
<tr class="memdesc:ga738472f97b8dc72342cb3eb6b984d0bd"><td class="mdescLeft"> </td><td class="mdescRight">Upgrade function de-initialization. <a href="#ga738472f97b8dc72342cb3eb6b984d0bd">More...</a><br /></td></tr>
|
|
<tr class="separator:ga738472f97b8dc72342cb3eb6b984d0bd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9575df7b73865f9a373637c1d7a3763f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Upgrade__APIs.html#ga9575df7b73865f9a373637c1d7a3763f">system_upgrade_start</a> (struct <a class="el" href="structupgrade__server__info.html">upgrade_server_info</a> *server)</td></tr>
|
|
<tr class="memdesc:ga9575df7b73865f9a373637c1d7a3763f"><td class="mdescLeft"> </td><td class="mdescRight">Start upgrade firmware through WiFi with normal connection. <a href="#ga9575df7b73865f9a373637c1d7a3763f">More...</a><br /></td></tr>
|
|
<tr class="separator:ga9575df7b73865f9a373637c1d7a3763f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>Firmware upgrade (FOTA) APIs. </p>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a class="anchor" id="ga518257817c69fec25290c1bebad544b0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SPI_FLASH_SEC_SIZE   4096</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>SPI Flash sector size </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga568d84b95c752e811a27a337830c3a54"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define UPGRADE_FLAG_FINISH   0x02</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>flag of upgrading firmware, finish upgrading </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gae9af3da1e7d88b1e0f353d45059f6f1b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define UPGRADE_FLAG_IDLE   0x00</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>flag of upgrading firmware, idle </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaa45c4c3f3b5ed0d3070af7cf0fe151a9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define UPGRADE_FLAG_START   0x01</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>flag of upgrading firmware, start upgrade </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga3b1051980757f4b853a8e436397e0fa6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define UPGRADE_FW_BIN1   0x00</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>firmware, user1.bin </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga9c5730b00a161df609340303bd6b4647"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define UPGRADE_FW_BIN2   0x01</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>firmware, user2.bin </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga72e5aaa69793c72dc40998cb4b76168c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define USER_BIN1   0x00</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>firmware, user1.bin </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga7c4188e60c7cc5293d25dfb3b34dd224"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define USER_BIN2   0x01</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>firmware, user2.bin </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a class="anchor" id="ga2897893fe6b22f7cd3159e57370dee7d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef void(* upgrade_states_check_callback) (void *arg)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Callback of upgrading firmware through WiFi. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">void</td><td>* arg : information about upgrading server</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>null </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga738472f97b8dc72342cb3eb6b984d0bd"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool system_upgrade </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8 * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32 </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Upgrade function de-initialization. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">uint8</td><td>*data : segment of the firmware bin data </td></tr>
|
|
<tr><td class="paramname">uint32</td><td>len : length of the segment bin data</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>null </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga643d7df496074bba1c6d165a3b5c7296"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void system_upgrade_deinit </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Upgrade function de-initialization. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">null</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>null </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga18b07d5b7a8b951a41da50506e03c837"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8 system_upgrade_flag_check </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check the upgrade status flag. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">null</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>#define UPGRADE_FLAG_IDLE 0x00 </dd>
|
|
<dd>
|
|
#define UPGRADE_FLAG_START 0x01 </dd>
|
|
<dd>
|
|
#define UPGRADE_FLAG_FINISH 0x02 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga6760e9df629662611372bcdfca7a4f77"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void system_upgrade_flag_set </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8 </td>
|
|
<td class="paramname"><em>flag</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the upgrade status flag. </p>
|
|
<dl class="section attention"><dt>Attention</dt><dd>After downloading new softwares, set the flag to UPGRADE_FLAG_FINISH and call system_upgrade_reboot to reboot the system in order to run the new software.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">uint8</td><td>flag:<ul>
|
|
<li>UPGRADE_FLAG_IDLE 0x00</li>
|
|
<li>UPGRADE_FLAG_START 0x01</li>
|
|
<li>UPGRADE_FLAG_FINISH 0x02</li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>null </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga9b7abd9fa4790f5807c20a24e5e9a51a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void system_upgrade_init </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Upgrade function initialization. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">null</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>null </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gafbc93a806155a9cf65d25119df0c6b1d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void system_upgrade_reboot </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reboot system to use the new software. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">null</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>null </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga9575df7b73865f9a373637c1d7a3763f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool system_upgrade_start </td>
|
|
<td>(</td>
|
|
<td class="paramtype">struct <a class="el" href="structupgrade__server__info.html">upgrade_server_info</a> * </td>
|
|
<td class="paramname"><em>server</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Start upgrade firmware through WiFi with normal connection. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">struct</td><td><a class="el" href="structupgrade__server__info.html">upgrade_server_info</a> *server : the firmware upgrade server info</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true : succeed </dd>
|
|
<dd>
|
|
false : fail </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gad04181af74584d470c30d6c21dd2db85"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8 system_upgrade_userbin_check </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check the user bin. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">null</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0x00 : UPGRADE_FW_BIN1, i.e. user1.bin </dd>
|
|
<dd>
|
|
0x01 : UPGRADE_FW_BIN2, i.e. user2.bin </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Tue Mar 1 2016 10:19:26 for ESP8266_RTOS_SDK by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.10
|
|
</small></address>
|
|
</body>
|
|
</html>
|