ESP3D/docs/html/_e_s_p106_8cpp_source.html
2020-01-06 14:46:56 +01:00

170 lines
18 KiB
HTML

<!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.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ESP3D: esp3d/src/core/espcmd/ESP106.cpp Source File</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" />
</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="ESP3D_social_mini.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ESP3D
&#160;<span id="projectnumber">3.0</span>
</div>
<div id="projectbrief">Firmware for ESP boards connected to 3D Printer</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_e_s_p106_8cpp_source.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="headertitle">
<div class="title">ESP106.cpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="_e_s_p106_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> ESP106.cpp - ESP3D command class</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> Copyright (c) 2014 Luc Lebosse. All rights reserved.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> This library is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> modify it under the terms of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> License as published by the Free Software Foundation; either</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> version 2.1 of the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> This library is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> Lesser General Public License for more details.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> License along with this library; if not, write to the Free Software</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;../../include/esp3d_config.h&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#if defined (WIFI_FEATURE)</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &quot;../commands.h&quot;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;../esp3doutput.h&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;../settings_esp3d.h&quot;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &quot;../../modules/wifi/wificonfig.h&quot;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &quot;../../modules/authentication/authentication_service.h&quot;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment">//AP Password</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment">//[ESP106]&lt;Password&gt;[pwd=&lt;admin password&gt;]</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="class_commands.html#a23d25924b2fdb347a0209dd313c39c47"> 29</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="class_commands.html#a23d25924b2fdb347a0209dd313c39c47">Commands::ESP106</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* cmd_params, <a class="code" href="authentication__service_8h.html#a3095411b68dbc51b5b535151b5bf0ae6">level_authenticate_type</a> auth_type, <a class="code" href="class_e_s_p3_d_output.html">ESP3DOutput</a> * output)</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;{</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordtype">bool</span> response = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; String parameter;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#ifdef AUTHENTICATION_FEATURE</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordflow">if</span> (auth_type != <a class="code" href="authentication__service_8h.html#a3095411b68dbc51b5b535151b5bf0ae6a4ddf9e0f200403030b62492db571d9bb">LEVEL_ADMIN</a>) {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; output-&gt;<a class="code" href="class_e_s_p3_d_output.html#afab9c235fa943a24967f1170c10b445c">printERROR</a>(<span class="stringliteral">&quot;Wrong authentication!&quot;</span>, 401);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; }</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; (void)auth_type;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor">#endif //AUTHENTICATION_FEATURE</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; parameter = <a class="code" href="class_commands.html#a6b98161a39a7b612d4e8d3c0a848708b">get_param</a> (cmd_params, <span class="stringliteral">&quot;&quot;</span>);</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordflow">if</span> (!<a class="code" href="class_wi_fi_config.html#a7f07849a19bf536563efe45503bfa9ce">WiFiConfig::isPasswordValid</a> (parameter.c_str() ) ) {</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; output-&gt;<a class="code" href="class_e_s_p3_d_output.html#afab9c235fa943a24967f1170c10b445c">printERROR</a> (<span class="stringliteral">&quot;Incorrect password!&quot;</span>);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; response = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordflow">if</span>(!<a class="code" href="class_settings___e_s_p3_d.html#af9f796eac6d76d18a67f4b77b78837ea">Settings_ESP3D::write_string</a>(<a class="code" href="settings__esp3d_8h.html#aa08f1bd2e2d588bedecb1273b1e628df">ESP_AP_PASSWORD</a>, parameter.c_str())) {</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; output-&gt;<a class="code" href="class_e_s_p3_d_output.html#afab9c235fa943a24967f1170c10b445c">printERROR</a> (<span class="stringliteral">&quot;Set failed!&quot;</span>);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; response = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; output-&gt;<a class="code" href="class_e_s_p3_d_output.html#a6073308dcb9808e45d903446747711ca">printMSG</a> (<span class="stringliteral">&quot;ok&quot;</span>);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; }</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; }</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keywordflow">return</span> response;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;}</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="preprocessor">#endif //WIFI_FEATURE</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclass_commands_html_a6b98161a39a7b612d4e8d3c0a848708b"><div class="ttname"><a href="class_commands.html#a6b98161a39a7b612d4e8d3c0a848708b">Commands::get_param</a></div><div class="ttdeci">const char * get_param(const char *cmd_params, const char *label)</div><div class="ttdef"><b>Definition:</b> <a href="commands_8cpp_source.html#l00162">commands.cpp:162</a></div></div>
<div class="ttc" id="aclass_wi_fi_config_html_a7f07849a19bf536563efe45503bfa9ce"><div class="ttname"><a href="class_wi_fi_config.html#a7f07849a19bf536563efe45503bfa9ce">WiFiConfig::isPasswordValid</a></div><div class="ttdeci">static bool isPasswordValid(const char *password)</div><div class="ttdef"><b>Definition:</b> <a href="wificonfig_8cpp_source.html#l00091">wificonfig.cpp:91</a></div></div>
<div class="ttc" id="asettings__esp3d_8h_html_aa08f1bd2e2d588bedecb1273b1e628df"><div class="ttname"><a href="settings__esp3d_8h.html#aa08f1bd2e2d588bedecb1273b1e628df">ESP_AP_PASSWORD</a></div><div class="ttdeci">#define ESP_AP_PASSWORD</div><div class="ttdef"><b>Definition:</b> <a href="settings__esp3d_8h_source.html#l00061">settings_esp3d.h:61</a></div></div>
<div class="ttc" id="aauthentication__service_8h_html_a3095411b68dbc51b5b535151b5bf0ae6"><div class="ttname"><a href="authentication__service_8h.html#a3095411b68dbc51b5b535151b5bf0ae6">level_authenticate_type</a></div><div class="ttdeci">level_authenticate_type</div><div class="ttdef"><b>Definition:</b> <a href="authentication__service_8h_source.html#l00025">authentication_service.h:25</a></div></div>
<div class="ttc" id="aclass_e_s_p3_d_output_html_a6073308dcb9808e45d903446747711ca"><div class="ttname"><a href="class_e_s_p3_d_output.html#a6073308dcb9808e45d903446747711ca">ESP3DOutput::printMSG</a></div><div class="ttdeci">size_t printMSG(const char *s, bool withNL=true)</div><div class="ttdef"><b>Definition:</b> <a href="esp3doutput_8cpp_source.html#l00190">esp3doutput.cpp:190</a></div></div>
<div class="ttc" id="aclass_commands_html_a23d25924b2fdb347a0209dd313c39c47"><div class="ttname"><a href="class_commands.html#a23d25924b2fdb347a0209dd313c39c47">Commands::ESP106</a></div><div class="ttdeci">bool ESP106(const char *cmd_params, level_authenticate_type auth_level, ESP3DOutput *output)</div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p106_8cpp_source.html#l00029">ESP106.cpp:29</a></div></div>
<div class="ttc" id="aclass_e_s_p3_d_output_html_afab9c235fa943a24967f1170c10b445c"><div class="ttname"><a href="class_e_s_p3_d_output.html#afab9c235fa943a24967f1170c10b445c">ESP3DOutput::printERROR</a></div><div class="ttdeci">size_t printERROR(const char *s, int code_error=200)</div><div class="ttdef"><b>Definition:</b> <a href="esp3doutput_8cpp_source.html#l00247">esp3doutput.cpp:247</a></div></div>
<div class="ttc" id="aclass_settings___e_s_p3_d_html_af9f796eac6d76d18a67f4b77b78837ea"><div class="ttname"><a href="class_settings___e_s_p3_d.html#af9f796eac6d76d18a67f4b77b78837ea">Settings_ESP3D::write_string</a></div><div class="ttdeci">static bool write_string(int pos, const char *byte_buffer)</div><div class="ttdef"><b>Definition:</b> <a href="settings__esp3d_8cpp_source.html#l00870">settings_esp3d.cpp:870</a></div></div>
<div class="ttc" id="aauthentication__service_8h_html_a3095411b68dbc51b5b535151b5bf0ae6a4ddf9e0f200403030b62492db571d9bb"><div class="ttname"><a href="authentication__service_8h.html#a3095411b68dbc51b5b535151b5bf0ae6a4ddf9e0f200403030b62492db571d9bb">LEVEL_ADMIN</a></div><div class="ttdeci">@ LEVEL_ADMIN</div><div class="ttdef"><b>Definition:</b> <a href="authentication__service_8h_source.html#l00028">authentication_service.h:28</a></div></div>
<div class="ttc" id="aclass_e_s_p3_d_output_html"><div class="ttname"><a href="class_e_s_p3_d_output.html">ESP3DOutput</a></div><div class="ttdef"><b>Definition:</b> <a href="esp3doutput_8h_source.html#l00048">esp3doutput.h:48</a></div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_26e324fd2d3b807b96644664d24a0768.html">esp3d</a></li><li class="navelem"><a class="el" href="dir_8d0579f238dc492a9f9393e76adf8153.html">src</a></li><li class="navelem"><a class="el" href="dir_a3ba38e9455c6fb83275f9d5bbe99bd2.html">core</a></li><li class="navelem"><a class="el" href="dir_1b7c67e984daa0210ea52a415021dc16.html">espcmd</a></li><li class="navelem"><a class="el" href="_e_s_p106_8cpp.html">ESP106.cpp</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>