Repetier-Firmware-4-Davinci/api-doc/html/class_commands.html

426 wiersze
20 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"/>
<title>Repetier-Firmware: Commands Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="repetier-logo-trans128.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Repetier-Firmware
&#160;<span id="projectnumber">0.91</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<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&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data&#160;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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('class_commands.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pri-static-attribs">Static Private Attributes</a> </div>
<div class="headertitle">
<div class="title">Commands Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="Commands" -->
<p><code>#include &lt;<a class="el" href="_commands_8h_source.html">Commands.h</a>&gt;</code></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_commands.html#a73ac5b354668597a85019c55022f717c">commandLoop</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_commands.html#a1e640fd00eec5b91b08cc5a93caf85ec">checkForPeriodicalActions</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_commands.html#a92f3e9b9ebb7dd9f191b6ec62cd31bf9">executeGCode</a> (<a class="el" href="class_g_code.html">GCode</a> *com)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the command stored in com. <a href="#a92f3e9b9ebb7dd9f191b6ec62cd31bf9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_commands.html#a7ed7af043e451e359849d16f80cd0c63">waitUntilEndOfAllMoves</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Waits until movement cache is empty. <a href="#a7ed7af043e451e359849d16f80cd0c63"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_commands.html#a1854598ada31069e5673da5d2d203ca9">printCurrentPosition</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_commands.html#af3c379ee75226ab047f3a1ae53610eab">printTemperatures</a> (bool showRaw=false)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_commands.html#adaced362a3446a68730398472683dd6d">setFanSpeed</a> (int speed, bool wait)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_commands.html#a50cab022c00987b7babbf457611226ce">changeFeedrateMultiply</a> (int factorInPercent)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set fan speed 0..255. <a href="#a50cab022c00987b7babbf457611226ce"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_commands.html#af5a8c4524691d4a5df4a0a062a49bc5f">changeFlowateMultiply</a> (int factorInPercent)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_commands.html#a452710a8ed1e61316d1d7651d514ce0f">reportPrinterUsage</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_commands.html#aef68e49eb90ce86fe498ffc757de5141">emergencyStop</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_commands.html#a4a2c1078dd11650ccd3b5b7c7ef8835b">checkFreeMemory</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_commands.html#a53d8779e780c8c329209bd53065d51a8">writeLowestFreeRAM</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pri-static-attribs"></a>
Static Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_commands.html#a81b1581664cc2fa8fcbe2c68e1092c01">lowestRAMValue</a> = <a class="el" href="_h_a_l_8h.html#a44caf16d49cdf922186674a1421b558d">MAX_RAM</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_commands.html#acbdf5644eb1440331dac1788d7cb823e">lowestRAMValueSend</a> = <a class="el" href="_h_a_l_8h.html#a44caf16d49cdf922186674a1421b558d">MAX_RAM</a></td></tr>
</table>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a50cab022c00987b7babbf457611226ce"></a><!-- doxytag: member="Commands::changeFeedrateMultiply" ref="a50cab022c00987b7babbf457611226ce" args="(int factorInPercent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_commands.html#a50cab022c00987b7babbf457611226ce">changeFeedrateMultiply</a> </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>factorInPercent</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set fan speed 0..255. </p>
</div>
</div>
<a class="anchor" id="af5a8c4524691d4a5df4a0a062a49bc5f"></a><!-- doxytag: member="Commands::changeFlowateMultiply" ref="af5a8c4524691d4a5df4a0a062a49bc5f" args="(int factorInPercent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_commands.html#af5a8c4524691d4a5df4a0a062a49bc5f">changeFlowateMultiply</a> </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>factorInPercent</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a1e640fd00eec5b91b08cc5a93caf85ec"></a><!-- doxytag: member="Commands::checkForPeriodicalActions" ref="a1e640fd00eec5b91b08cc5a93caf85ec" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_commands.html#a1e640fd00eec5b91b08cc5a93caf85ec">checkForPeriodicalActions</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a4a2c1078dd11650ccd3b5b7c7ef8835b"></a><!-- doxytag: member="Commands::checkFreeMemory" ref="a4a2c1078dd11650ccd3b5b7c7ef8835b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_commands.html#a4a2c1078dd11650ccd3b5b7c7ef8835b">checkFreeMemory</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a73ac5b354668597a85019c55022f717c"></a><!-- doxytag: member="Commands::commandLoop" ref="a73ac5b354668597a85019c55022f717c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_commands.html#a73ac5b354668597a85019c55022f717c">commandLoop</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aef68e49eb90ce86fe498ffc757de5141"></a><!-- doxytag: member="Commands::emergencyStop" ref="aef68e49eb90ce86fe498ffc757de5141" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_commands.html#aef68e49eb90ce86fe498ffc757de5141">emergencyStop</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a92f3e9b9ebb7dd9f191b6ec62cd31bf9"></a><!-- doxytag: member="Commands::executeGCode" ref="a92f3e9b9ebb7dd9f191b6ec62cd31bf9" args="(GCode *com)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_commands.html#a92f3e9b9ebb7dd9f191b6ec62cd31bf9">executeGCode</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_g_code.html">GCode</a> *&#160;</td>
<td class="paramname"><em>com</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute the command stored in com. </p>
</div>
</div>
<a class="anchor" id="a1854598ada31069e5673da5d2d203ca9"></a><!-- doxytag: member="Commands::printCurrentPosition" ref="a1854598ada31069e5673da5d2d203ca9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_commands.html#a1854598ada31069e5673da5d2d203ca9">printCurrentPosition</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="af3c379ee75226ab047f3a1ae53610eab"></a><!-- doxytag: member="Commands::printTemperatures" ref="af3c379ee75226ab047f3a1ae53610eab" args="(bool showRaw=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_commands.html#af3c379ee75226ab047f3a1ae53610eab">printTemperatures</a> </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>showRaw</em> = <code>false</code></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a452710a8ed1e61316d1d7651d514ce0f"></a><!-- doxytag: member="Commands::reportPrinterUsage" ref="a452710a8ed1e61316d1d7651d514ce0f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_commands.html#a452710a8ed1e61316d1d7651d514ce0f">reportPrinterUsage</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="adaced362a3446a68730398472683dd6d"></a><!-- doxytag: member="Commands::setFanSpeed" ref="adaced362a3446a68730398472683dd6d" args="(int speed, bool wait)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_commands.html#adaced362a3446a68730398472683dd6d">setFanSpeed</a> </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>speed</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>wait</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a7ed7af043e451e359849d16f80cd0c63"></a><!-- doxytag: member="Commands::waitUntilEndOfAllMoves" ref="a7ed7af043e451e359849d16f80cd0c63" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_commands.html#a7ed7af043e451e359849d16f80cd0c63">waitUntilEndOfAllMoves</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Waits until movement cache is empty. </p>
<p>Some commands expect no movement, before they can execute. This function waits, until the steppers are stopped. In the meanwhile it buffers incoming commands and manages temperatures. </p>
</div>
</div>
<a class="anchor" id="a53d8779e780c8c329209bd53065d51a8"></a><!-- doxytag: member="Commands::writeLowestFreeRAM" ref="a53d8779e780c8c329209bd53065d51a8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_commands.html#a53d8779e780c8c329209bd53065d51a8">writeLowestFreeRAM</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a81b1581664cc2fa8fcbe2c68e1092c01"></a><!-- doxytag: member="Commands::lowestRAMValue" ref="a81b1581664cc2fa8fcbe2c68e1092c01" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="class_commands.html#a81b1581664cc2fa8fcbe2c68e1092c01">lowestRAMValue</a> = <a class="el" href="_h_a_l_8h.html#a44caf16d49cdf922186674a1421b558d">MAX_RAM</a><code> [static, private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="acbdf5644eb1440331dac1788d7cb823e"></a><!-- doxytag: member="Commands::lowestRAMValueSend" ref="acbdf5644eb1440331dac1788d7cb823e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="class_commands.html#acbdf5644eb1440331dac1788d7cb823e">lowestRAMValueSend</a> = <a class="el" href="_h_a_l_8h.html#a44caf16d49cdf922186674a1421b558d">MAX_RAM</a><code> [static, private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/ArduinoAVR/Repetier/<a class="el" href="_commands_8h_source.html">Commands.h</a></li>
<li>src/ArduinoAVR/Repetier/<a class="el" href="_commands_8cpp.html">Commands.cpp</a></li>
</ul>
</div><!-- contents -->
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Defines</a></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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="class_commands.html">Commands</a> </li>
<li class="footer">Generated on Mon Dec 30 2013 18:53:03 for Repetier-Firmware by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li>
</ul>
</div>
</body>
</html>