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

408 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: TemperatureController 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_temperature_controller.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">TemperatureController Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="TemperatureController" -->
<p><code>#include &lt;<a class="el" href="_extruder_8h_source.html">Extruder.h</a>&gt;</code></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_temperature_controller.html#a3e33e9cfc1e3cb7d918aeee45df9f169">setTargetTemperature</a> (float target)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_temperature_controller.html#acb70906f42292a995009918b00f32ce1">updateCurrentTemperature</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_temperature_controller.html#a424b8e012f4c53e5370042d7d046be3a">updateTempControlVars</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_temperature_controller.html#a68d2c172f1dcac955c4aa3fdd9d8672e">isAlarm</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_temperature_controller.html#a4bb054bc8d3fb4e93b96256eefad0d8f">setAlarm</a> (bool on)</td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_temperature_controller.html#a8700a88a5e4fff1fa5fd4ddaf093de58">pwmIndex</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">pwm index for output control. 0-2 = <a class="el" href="class_extruder.html" title="Data to drive one extruder.">Extruder</a>, 3 = Fan, 4 = Heated Bed <a href="#a8700a88a5e4fff1fa5fd4ddaf093de58"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_temperature_controller.html#a1dde056b62710e02166dedd907f90cd4">sensorType</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of temperature sensor. <a href="#a1dde056b62710e02166dedd907f90cd4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_temperature_controller.html#aca51ed4c72193b3dfba35c28d5ff7eec">sensorPin</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Pin to read extruder temperature. <a href="#aca51ed4c72193b3dfba35c28d5ff7eec"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_temperature_controller.html#ab04920387c302ba239d9b59bdbaed381">currentTemperature</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Currenttemperature value read from sensor. <a href="#ab04920387c302ba239d9b59bdbaed381"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_temperature_controller.html#a79605ab0ded13d1f3b98779ae41921f5">targetTemperature</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Target temperature value in units of sensor. <a href="#a79605ab0ded13d1f3b98779ae41921f5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_temperature_controller.html#aaef2b12184c93d3d1e810e16b0622d70">currentTemperatureC</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Current temperature in degC. <a href="#aaef2b12184c93d3d1e810e16b0622d70"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_temperature_controller.html#aa74b6e6ce4377461c89007835536d846">targetTemperatureC</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Target temperature in degC. <a href="#aa74b6e6ce4377461c89007835536d846"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_temperature_controller.html#a0e3b91c39a85d7abe4bba766714dcf0a">lastTemperatureUpdate</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Time in millis of the last temperature update. <a href="#a0e3b91c39a85d7abe4bba766714dcf0a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_temperature_controller.html#aad69ed92f2a3f42e8056d9364bdecb7e">heatManager</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">How is temperature controled. 0 = on/off, 1 = PID-Control, 3 = deat time control. <a href="#aad69ed92f2a3f42e8056d9364bdecb7e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_temperature_controller.html#aa2585d779da0ab21273a8d92de9a0ebe">flags</a></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="class_temperature_controller.html">TemperatureController</a> manages one heater-temperature sensore loop. You can have up to 4 loops allowing pid/bang bang for up to 3 extruder and the heated bed. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a68d2c172f1dcac955c4aa3fdd9d8672e"></a><!-- doxytag: member="TemperatureController::isAlarm" ref="a68d2c172f1dcac955c4aa3fdd9d8672e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="class_temperature_controller.html#a68d2c172f1dcac955c4aa3fdd9d8672e">isAlarm</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a4bb054bc8d3fb4e93b96256eefad0d8f"></a><!-- doxytag: member="TemperatureController::setAlarm" ref="a4bb054bc8d3fb4e93b96256eefad0d8f" args="(bool on)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_temperature_controller.html#a4bb054bc8d3fb4e93b96256eefad0d8f">setAlarm</a> </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>on</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a3e33e9cfc1e3cb7d918aeee45df9f169"></a><!-- doxytag: member="TemperatureController::setTargetTemperature" ref="a3e33e9cfc1e3cb7d918aeee45df9f169" args="(float target)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_temperature_controller.html#a3e33e9cfc1e3cb7d918aeee45df9f169">setTargetTemperature</a> </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>target</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="acb70906f42292a995009918b00f32ce1"></a><!-- doxytag: member="TemperatureController::updateCurrentTemperature" ref="acb70906f42292a995009918b00f32ce1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_temperature_controller.html#acb70906f42292a995009918b00f32ce1">updateCurrentTemperature</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a424b8e012f4c53e5370042d7d046be3a"></a><!-- doxytag: member="TemperatureController::updateTempControlVars" ref="a424b8e012f4c53e5370042d7d046be3a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_temperature_controller.html#a424b8e012f4c53e5370042d7d046be3a">updateTempControlVars</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="ab04920387c302ba239d9b59bdbaed381"></a><!-- doxytag: member="TemperatureController::currentTemperature" ref="ab04920387c302ba239d9b59bdbaed381" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int16_t <a class="el" href="class_temperature_controller.html#ab04920387c302ba239d9b59bdbaed381">currentTemperature</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Currenttemperature value read from sensor. </p>
</div>
</div>
<a class="anchor" id="aaef2b12184c93d3d1e810e16b0622d70"></a><!-- doxytag: member="TemperatureController::currentTemperatureC" ref="aaef2b12184c93d3d1e810e16b0622d70" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="class_temperature_controller.html#aaef2b12184c93d3d1e810e16b0622d70">currentTemperatureC</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Current temperature in degC. </p>
</div>
</div>
<a class="anchor" id="aa2585d779da0ab21273a8d92de9a0ebe"></a><!-- doxytag: member="TemperatureController::flags" ref="aa2585d779da0ab21273a8d92de9a0ebe" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t <a class="el" href="class_temperature_controller.html#aa2585d779da0ab21273a8d92de9a0ebe">flags</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aad69ed92f2a3f42e8056d9364bdecb7e"></a><!-- doxytag: member="TemperatureController::heatManager" ref="aad69ed92f2a3f42e8056d9364bdecb7e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int8_t <a class="el" href="class_temperature_controller.html#aad69ed92f2a3f42e8056d9364bdecb7e">heatManager</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>How is temperature controled. 0 = on/off, 1 = PID-Control, 3 = deat time control. </p>
</div>
</div>
<a class="anchor" id="a0e3b91c39a85d7abe4bba766714dcf0a"></a><!-- doxytag: member="TemperatureController::lastTemperatureUpdate" ref="a0e3b91c39a85d7abe4bba766714dcf0a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="class_temperature_controller.html#a0e3b91c39a85d7abe4bba766714dcf0a">lastTemperatureUpdate</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Time in millis of the last temperature update. </p>
</div>
</div>
<a class="anchor" id="a8700a88a5e4fff1fa5fd4ddaf093de58"></a><!-- doxytag: member="TemperatureController::pwmIndex" ref="a8700a88a5e4fff1fa5fd4ddaf093de58" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t <a class="el" href="class_temperature_controller.html#a8700a88a5e4fff1fa5fd4ddaf093de58">pwmIndex</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>pwm index for output control. 0-2 = <a class="el" href="class_extruder.html" title="Data to drive one extruder.">Extruder</a>, 3 = Fan, 4 = Heated Bed </p>
</div>
</div>
<a class="anchor" id="aca51ed4c72193b3dfba35c28d5ff7eec"></a><!-- doxytag: member="TemperatureController::sensorPin" ref="aca51ed4c72193b3dfba35c28d5ff7eec" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t <a class="el" href="class_temperature_controller.html#aca51ed4c72193b3dfba35c28d5ff7eec">sensorPin</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Pin to read extruder temperature. </p>
</div>
</div>
<a class="anchor" id="a1dde056b62710e02166dedd907f90cd4"></a><!-- doxytag: member="TemperatureController::sensorType" ref="a1dde056b62710e02166dedd907f90cd4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t <a class="el" href="class_temperature_controller.html#a1dde056b62710e02166dedd907f90cd4">sensorType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Type of temperature sensor. </p>
</div>
</div>
<a class="anchor" id="a79605ab0ded13d1f3b98779ae41921f5"></a><!-- doxytag: member="TemperatureController::targetTemperature" ref="a79605ab0ded13d1f3b98779ae41921f5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int16_t <a class="el" href="class_temperature_controller.html#a79605ab0ded13d1f3b98779ae41921f5">targetTemperature</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Target temperature value in units of sensor. </p>
</div>
</div>
<a class="anchor" id="aa74b6e6ce4377461c89007835536d846"></a><!-- doxytag: member="TemperatureController::targetTemperatureC" ref="aa74b6e6ce4377461c89007835536d846" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="class_temperature_controller.html#aa74b6e6ce4377461c89007835536d846">targetTemperatureC</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Target temperature in degC. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/ArduinoAVR/Repetier/<a class="el" href="_extruder_8h_source.html">Extruder.h</a></li>
<li>src/ArduinoAVR/Repetier/<a class="el" href="_extruder_8cpp.html">Extruder.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_temperature_controller.html">TemperatureController</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>