mirror of
https://git.mirrors.martin98.com/https://github.com/luc-github/ESP3D.git
synced 2025-04-21 21:30:05 +08:00
154 lines
14 KiB
HTML
154 lines
14 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/esp3d.h 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
|
|
 <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&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&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&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('esp3d_8h_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">esp3d.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="esp3d_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> esp3d.h - esp3d class</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <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> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <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> <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> <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> <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> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <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> <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> <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> <span class="comment"> Lesser General Public License for more details.</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <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> <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> <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> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#ifndef _ESP3D_H</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define _ESP3D_H</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">//be sure correct IDE and settings are used for ESP8266 or ESP32</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#if !(defined( ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32))</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#error Oops! Make sure you have 'ESP8266 or ESP32' compatible board selected from the 'Tools -> Boards' menu.</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#endif // ARDUINO_ARCH_ESP8266 + ARDUINO_ARCH_ESP32</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <Arduino.h></span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="class_esp3_d.html"> 28</a></span> <span class="keyword">class </span><a class="code" href="class_esp3_d.html">Esp3D</a></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> {</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="class_esp3_d.html#ab6c0fec3c193b6319eb8aaead4fe7ba8">Esp3D</a>();</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <a class="code" href="class_esp3_d.html#adcbd5b2595b86d684adde0d623928e7c">~Esp3D</a>();</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordtype">bool</span> <a class="code" href="class_esp3_d.html#afb33f64a43ad00448d494e66e970339a">begin</a>();</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordtype">void</span> <a class="code" href="class_esp3_d.html#acfb8aca15f861a61952b484f807cc9af">handle</a>();</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordtype">bool</span> <a class="code" href="class_esp3_d.html#a11a24bdbaa419ec6ce635124a66cc584">end</a>();</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_esp3_d.html#a032444e5d5abb4ef85252c302e7c42a5">reset</a>();</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_esp3_d.html#a3da44c399bbd0bf82c1f45a33e62d375">restart_esp</a>(<span class="keywordtype">bool</span> need_restart = <span class="keyword">true</span>);</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> restart;</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">void</span> restart_now();</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> };</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#endif //_ESP3D_H</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div class="ttc" id="aclass_esp3_d_html_adcbd5b2595b86d684adde0d623928e7c"><div class="ttname"><a href="class_esp3_d.html#adcbd5b2595b86d684adde0d623928e7c">Esp3D::~Esp3D</a></div><div class="ttdeci">~Esp3D()</div><div class="ttdef"><b>Definition:</b> <a href="esp3d_8cpp_source.html#l00062">esp3d.cpp:62</a></div></div>
|
|
<div class="ttc" id="aclass_esp3_d_html_afb33f64a43ad00448d494e66e970339a"><div class="ttname"><a href="class_esp3_d.html#afb33f64a43ad00448d494e66e970339a">Esp3D::begin</a></div><div class="ttdeci">bool begin()</div><div class="ttdef"><b>Definition:</b> <a href="esp3d_8cpp_source.html#l00068">esp3d.cpp:68</a></div></div>
|
|
<div class="ttc" id="aclass_esp3_d_html_acfb8aca15f861a61952b484f807cc9af"><div class="ttname"><a href="class_esp3_d.html#acfb8aca15f861a61952b484f807cc9af">Esp3D::handle</a></div><div class="ttdeci">void handle()</div><div class="ttdef"><b>Definition:</b> <a href="esp3d_8cpp_source.html#l00122">esp3d.cpp:122</a></div></div>
|
|
<div class="ttc" id="aclass_esp3_d_html_a032444e5d5abb4ef85252c302e7c42a5"><div class="ttname"><a href="class_esp3_d.html#a032444e5d5abb4ef85252c302e7c42a5">Esp3D::reset</a></div><div class="ttdeci">static bool reset()</div><div class="ttdef"><b>Definition:</b> <a href="esp3d_8cpp_source.html#l00154">esp3d.cpp:154</a></div></div>
|
|
<div class="ttc" id="aclass_esp3_d_html_a11a24bdbaa419ec6ce635124a66cc584"><div class="ttname"><a href="class_esp3_d.html#a11a24bdbaa419ec6ce635124a66cc584">Esp3D::end</a></div><div class="ttdeci">bool end()</div><div class="ttdef"><b>Definition:</b> <a href="esp3d_8cpp_source.html#l00138">esp3d.cpp:138</a></div></div>
|
|
<div class="ttc" id="aclass_esp3_d_html_a3da44c399bbd0bf82c1f45a33e62d375"><div class="ttname"><a href="class_esp3_d.html#a3da44c399bbd0bf82c1f45a33e62d375">Esp3D::restart_esp</a></div><div class="ttdeci">static void restart_esp(bool need_restart=true)</div><div class="ttdef"><b>Definition:</b> <a href="esp3d_8cpp_source.html#l00169">esp3d.cpp:169</a></div></div>
|
|
<div class="ttc" id="aclass_esp3_d_html"><div class="ttname"><a href="class_esp3_d.html">Esp3D</a></div><div class="ttdef"><b>Definition:</b> <a href="esp3d_8h_source.html#l00028">esp3d.h:28</a></div></div>
|
|
<div class="ttc" id="aclass_esp3_d_html_ab6c0fec3c193b6319eb8aaead4fe7ba8"><div class="ttname"><a href="class_esp3_d.html#ab6c0fec3c193b6319eb8aaead4fe7ba8">Esp3D::Esp3D</a></div><div class="ttdeci">Esp3D()</div><div class="ttdef"><b>Definition:</b> <a href="esp3d_8cpp_source.html#l00056">esp3d.cpp:56</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="esp3d_8h.html">esp3d.h</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>
|