GitHub-Proxy/ESP3D
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/luc-github/ESP3D.git synced 2025-04-21 05:09:56 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
ESP3D/docs/html/gcode__host_8h.html
Luc 312f88e6e2 Test for dioxygen doc generation
2020-01-06 14:46:56 +01:00

371 lines
20 KiB
HTML
Raw Permalink Blame History

<!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/modules/gcode_host/gcode_host.h 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" />
</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('gcode__host_8h.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="#nested-classes">Classes</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">gcode_host.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;Arduino.h&gt;</code><br />
<code>#include &quot;<a class="el" href="authentication__service_8h_source.html">../authentication/authentication_service.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for gcode_host.h:</div>
<div class="dyncontent">
<div class="center"><img src="gcode__host_8h__incl.png" border="0" usemap="#esp3d_2src_2modules_2gcode__host_2gcode__host_8h" alt=""/></div>
<map name="esp3d_2src_2modules_2gcode__host_2gcode__host_8h" id="esp3d_2src_2modules_2gcode__host_2gcode__host_8h">
<area shape="rect" title=" " alt="" coords="97,5,268,47"/>
<area shape="rect" title=" " alt="" coords="5,348,83,375"/>
<area shape="rect" href="authentication__service_8h.html" title=" " alt="" coords="272,95,472,136"/>
<area shape="rect" href="esp3d__config_8h.html" title=" " alt="" coords="550,184,677,225"/>
<area shape="rect" href="defines_8h.html" title=" " alt="" coords="81,273,212,300"/>
<area shape="rect" href="pins_8h.html" title=" " alt="" coords="236,273,351,300"/>
<area shape="rect" href="configuration_8h.html" title=" " alt="" coords="375,273,505,300"/>
<area shape="rect" href="sanity__esp3d_8h.html" title=" " alt="" coords="530,273,697,300"/>
<area shape="rect" href="hal_8h.html" title=" " alt="" coords="721,273,812,300"/>
<area shape="rect" href="debug__esp3d_8h.html" title=" " alt="" coords="837,273,987,300"/>
<area shape="rect" href="version_8h.html" title=" " alt="" coords="1012,273,1143,300"/>
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="gcode__host_8h__dep__incl.png" border="0" usemap="#esp3d_2src_2modules_2gcode__host_2gcode__host_8hdep" alt=""/></div>
<map name="esp3d_2src_2modules_2gcode__host_2gcode__host_8hdep" id="esp3d_2src_2modules_2gcode__host_2gcode__host_8hdep">
<area shape="rect" title=" " alt="" coords="195,5,366,47"/>
<area shape="rect" href="esp3d_8cpp.html" title=" " alt="" coords="5,102,177,129"/>
<area shape="rect" href="_e_s_p700_8cpp.html" title=" " alt="" coords="201,95,360,136"/>
<area shape="rect" href="gcode__host_8cpp.html" title=" " alt="" coords="385,95,555,136"/>
</map>
</div>
</div>
<p><a href="gcode__host_8h_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 name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_gcode_host.html">GcodeHost</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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:ae3c7c46d5d9c8dca3f68e5a8e2b176cc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gcode__host_8h.html#ae3c7c46d5d9c8dca3f68e5a8e2b176cc">DEFAULT_TIMOUT</a>&#160;&#160;&#160;2000</td></tr>
<tr class="separator:ae3c7c46d5d9c8dca3f68e5a8e2b176cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa709086303f7b4f9c4e6b43225e3a167"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gcode__host_8h.html#aa709086303f7b4f9c4e6b43225e3a167">MAX_TRY_2_SEND</a>&#160;&#160;&#160;5</td></tr>
<tr class="separator:aa709086303f7b4f9c4e6b43225e3a167"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace434a3a200d2d2a53f3e0d438e6abd7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gcode__host_8h.html#ace434a3a200d2d2a53f3e0d438e6abd7">ERROR_NO_ERROR</a>&#160;&#160;&#160;0</td></tr>
<tr class="separator:ace434a3a200d2d2a53f3e0d438e6abd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d524649099a14b88d5b8d1b79ce1ea1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gcode__host_8h.html#a7d524649099a14b88d5b8d1b79ce1ea1">ERROR_TIME_OUT</a>&#160;&#160;&#160;1</td></tr>
<tr class="separator:a7d524649099a14b88d5b8d1b79ce1ea1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adcb34971c86c95daa9fc497344956a1b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gcode__host_8h.html#adcb34971c86c95daa9fc497344956a1b">ERROR_CANNOT_SEND_DATA</a>&#160;&#160;&#160;2</td></tr>
<tr class="separator:adcb34971c86c95daa9fc497344956a1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65c4cc9aa47ee11cb7175528c623a000"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gcode__host_8h.html#a65c4cc9aa47ee11cb7175528c623a000">ERROR_LINE_NUMBER</a>&#160;&#160;&#160;3</td></tr>
<tr class="separator:a65c4cc9aa47ee11cb7175528c623a000"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2bf7e6ce2f181454c69512ea079769c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gcode__host_8h.html#ad2bf7e6ce2f181454c69512ea079769c">ERROR_ACK_NUMBER</a>&#160;&#160;&#160;4</td></tr>
<tr class="separator:ad2bf7e6ce2f181454c69512ea079769c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae65ca500d49b185fb691d5c51543ca70"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gcode__host_8h.html#ae65ca500d49b185fb691d5c51543ca70">ERROR_MEMORY_PROBLEM</a>&#160;&#160;&#160;5</td></tr>
<tr class="separator:ae65ca500d49b185fb691d5c51543ca70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a456dcc3f8fae0377a8471fdafb1c056d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gcode__host_8h.html#a456dcc3f8fae0377a8471fdafb1c056d">ERROR_RESEND</a>&#160;&#160;&#160;6</td></tr>
<tr class="separator:a456dcc3f8fae0377a8471fdafb1c056d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5def3e63258f3ee80f7bfb95a417df2f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gcode__host_8h.html#a5def3e63258f3ee80f7bfb95a417df2f">ERROR_NUMBER_MISMATCH</a>&#160;&#160;&#160;7</td></tr>
<tr class="separator:a5def3e63258f3ee80f7bfb95a417df2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fc16c0111812c761ca9193aa2388876"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gcode__host_8h.html#a4fc16c0111812c761ca9193aa2388876">ERROR_LINE_IGNORED</a>&#160;&#160;&#160;8</td></tr>
<tr class="separator:a4fc16c0111812c761ca9193aa2388876"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:aee8daa3255a9e6ed0c9f461938e293ed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_gcode_host.html">GcodeHost</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gcode__host_8h.html#aee8daa3255a9e6ed0c9f461938e293ed">esp3d_gcode_host</a></td></tr>
<tr class="separator:aee8daa3255a9e6ed0c9f461938e293ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ae3c7c46d5d9c8dca3f68e5a8e2b176cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3c7c46d5d9c8dca3f68e5a8e2b176cc">&#9670;&nbsp;</a></span>DEFAULT_TIMOUT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DEFAULT_TIMOUT&#160;&#160;&#160;2000</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="gcode__host_8h_source.html#l00030">30</a> of file <a class="el" href="gcode__host_8h_source.html">gcode_host.h</a>.</p>
</div>
</div>
<a id="ad2bf7e6ce2f181454c69512ea079769c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2bf7e6ce2f181454c69512ea079769c">&#9670;&nbsp;</a></span>ERROR_ACK_NUMBER</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ERROR_ACK_NUMBER&#160;&#160;&#160;4</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="gcode__host_8h_source.html#l00036">36</a> of file <a class="el" href="gcode__host_8h_source.html">gcode_host.h</a>.</p>
</div>
</div>
<a id="adcb34971c86c95daa9fc497344956a1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adcb34971c86c95daa9fc497344956a1b">&#9670;&nbsp;</a></span>ERROR_CANNOT_SEND_DATA</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ERROR_CANNOT_SEND_DATA&#160;&#160;&#160;2</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="gcode__host_8h_source.html#l00034">34</a> of file <a class="el" href="gcode__host_8h_source.html">gcode_host.h</a>.</p>
</div>
</div>
<a id="a4fc16c0111812c761ca9193aa2388876"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4fc16c0111812c761ca9193aa2388876">&#9670;&nbsp;</a></span>ERROR_LINE_IGNORED</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ERROR_LINE_IGNORED&#160;&#160;&#160;8</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="gcode__host_8h_source.html#l00040">40</a> of file <a class="el" href="gcode__host_8h_source.html">gcode_host.h</a>.</p>
</div>
</div>
<a id="a65c4cc9aa47ee11cb7175528c623a000"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65c4cc9aa47ee11cb7175528c623a000">&#9670;&nbsp;</a></span>ERROR_LINE_NUMBER</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ERROR_LINE_NUMBER&#160;&#160;&#160;3</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="gcode__host_8h_source.html#l00035">35</a> of file <a class="el" href="gcode__host_8h_source.html">gcode_host.h</a>.</p>
</div>
</div>
<a id="ae65ca500d49b185fb691d5c51543ca70"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae65ca500d49b185fb691d5c51543ca70">&#9670;&nbsp;</a></span>ERROR_MEMORY_PROBLEM</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ERROR_MEMORY_PROBLEM&#160;&#160;&#160;5</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="gcode__host_8h_source.html#l00037">37</a> of file <a class="el" href="gcode__host_8h_source.html">gcode_host.h</a>.</p>
</div>
</div>
<a id="ace434a3a200d2d2a53f3e0d438e6abd7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace434a3a200d2d2a53f3e0d438e6abd7">&#9670;&nbsp;</a></span>ERROR_NO_ERROR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ERROR_NO_ERROR&#160;&#160;&#160;0</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="gcode__host_8h_source.html#l00032">32</a> of file <a class="el" href="gcode__host_8h_source.html">gcode_host.h</a>.</p>
</div>
</div>
<a id="a5def3e63258f3ee80f7bfb95a417df2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5def3e63258f3ee80f7bfb95a417df2f">&#9670;&nbsp;</a></span>ERROR_NUMBER_MISMATCH</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ERROR_NUMBER_MISMATCH&#160;&#160;&#160;7</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="gcode__host_8h_source.html#l00039">39</a> of file <a class="el" href="gcode__host_8h_source.html">gcode_host.h</a>.</p>
</div>
</div>
<a id="a456dcc3f8fae0377a8471fdafb1c056d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a456dcc3f8fae0377a8471fdafb1c056d">&#9670;&nbsp;</a></span>ERROR_RESEND</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ERROR_RESEND&#160;&#160;&#160;6</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="gcode__host_8h_source.html#l00038">38</a> of file <a class="el" href="gcode__host_8h_source.html">gcode_host.h</a>.</p>
</div>
</div>
<a id="a7d524649099a14b88d5b8d1b79ce1ea1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d524649099a14b88d5b8d1b79ce1ea1">&#9670;&nbsp;</a></span>ERROR_TIME_OUT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ERROR_TIME_OUT&#160;&#160;&#160;1</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="gcode__host_8h_source.html#l00033">33</a> of file <a class="el" href="gcode__host_8h_source.html">gcode_host.h</a>.</p>
</div>
</div>
<a id="aa709086303f7b4f9c4e6b43225e3a167"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa709086303f7b4f9c4e6b43225e3a167">&#9670;&nbsp;</a></span>MAX_TRY_2_SEND</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MAX_TRY_2_SEND&#160;&#160;&#160;5</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="gcode__host_8h_source.html#l00031">31</a> of file <a class="el" href="gcode__host_8h_source.html">gcode_host.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="aee8daa3255a9e6ed0c9f461938e293ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee8daa3255a9e6ed0c9f461938e293ed">&#9670;&nbsp;</a></span>esp3d_gcode_host</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_gcode_host.html">GcodeHost</a> esp3d_gcode_host</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="gcode__host_8cpp_source.html#l00030">30</a> of file <a class="el" href="gcode__host_8cpp_source.html">gcode_host.cpp</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- 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_2c1830491e0576ae3395f8c2f91c7d85.html">modules</a></li><li class="navelem"><a class="el" href="dir_8538a029712cab3b31105b68f2b48084.html">gcode_host</a></li><li class="navelem"><a class="el" href="gcode__host_8h.html">gcode_host.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>
Reference in New Issue View Git Blame Copy Permalink