mirror of
https://git.mirrors.martin98.com/https://github.com/luc-github/ESP3D.git
synced 2025-04-22 13:50:01 +08:00
175 lines
16 KiB
HTML
175 lines
16 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/modules/dht/dht.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('dht_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">dht.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="dht_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"> dht.h - dht functions 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>  </div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifndef _DHT_H</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#define _DHT_H</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="class_d_h_t.html"> 26</a></span> <span class="keyword">class </span><a class="code" href="class_d_h_t.html">DHT</a></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> {</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <a class="code" href="class_d_h_t.html#addc81efbe31ac923b054636f675a2d8b">DHT</a>();</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <a class="code" href="class_d_h_t.html#aa3034e0207490f85b581a7700547d225">~DHT</a>();</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordtype">bool</span> <a class="code" href="class_d_h_t.html#affeec3f3752eeac17c684c781d9a962c">begin</a>();</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordtype">void</span> <a class="code" href="class_d_h_t.html#a39d833ae18a85d54f42ea71510e36a85">end</a>();</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordtype">void</span> <a class="code" href="class_d_h_t.html#abd5c9d81622db606c48fc0fd59d0c36a">handle</a>();</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordtype">bool</span> <a class="code" href="class_d_h_t.html#ac1d1de00a426e99563d1b31c2c27b43d">setInterval</a>(uint <a class="code" href="class_d_h_t.html#aaf0ba32ce2f73ce6234aa5e52560588b">interval</a>);</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  uint <a class="code" href="class_d_h_t.html#aaf0ba32ce2f73ce6234aa5e52560588b">interval</a>();</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  uint8_t <a class="code" href="class_d_h_t.html#ad9482ea9db355745c289120299c0c0e8">GetModel</a>();</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="class_d_h_t.html#a4b7002244953847605abc08db2981e0d">GetModelString</a>();</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">float</span> <a class="code" href="class_d_h_t.html#ae2a3991e1153bf6acdc827a306cc4aa2">getHumidity</a>();</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">float</span> <a class="code" href="class_d_h_t.html#af404e4b14a31928fed9aa5268b4c2b99">getTemperature</a>();</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">bool</span> <a class="code" href="class_d_h_t.html#abccbc1d739863770ebe65a7d9cfea70f">started</a>();</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordtype">bool</span> <a class="code" href="class_d_h_t.html#a4cd4e070920943a1c457209e44f9e327">isCelsiusUnit</a>();</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">void</span> <a class="code" href="class_d_h_t.html#a4a0cada75d18735b20fe9db31aa1dae7">setCelsiusUnit</a>(<span class="keywordtype">bool</span> set);</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordtype">bool</span> _started;</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordtype">bool</span> _usecelsius;</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  uint32_t _interval;</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  uint32_t _lastReadTime;</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">float</span> _temperature;</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">float</span> _humidity;</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> };</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">extern</span> <a class="code" href="class_d_h_t.html">DHT</a> <a class="code" href="dht_8h.html#a65942a2b41cf2a08699e185fac352515">esp3d_DHT</a>;</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#endif //_DHT_H</span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div class="ttc" id="aclass_d_h_t_html_ac1d1de00a426e99563d1b31c2c27b43d"><div class="ttname"><a href="class_d_h_t.html#ac1d1de00a426e99563d1b31c2c27b43d">DHT::setInterval</a></div><div class="ttdeci">bool setInterval(uint interval)</div></div>
|
|
<div class="ttc" id="aclass_d_h_t_html_abd5c9d81622db606c48fc0fd59d0c36a"><div class="ttname"><a href="class_d_h_t.html#abd5c9d81622db606c48fc0fd59d0c36a">DHT::handle</a></div><div class="ttdeci">void handle()</div></div>
|
|
<div class="ttc" id="aclass_d_h_t_html_aaf0ba32ce2f73ce6234aa5e52560588b"><div class="ttname"><a href="class_d_h_t.html#aaf0ba32ce2f73ce6234aa5e52560588b">DHT::interval</a></div><div class="ttdeci">uint interval()</div></div>
|
|
<div class="ttc" id="aclass_d_h_t_html_abccbc1d739863770ebe65a7d9cfea70f"><div class="ttname"><a href="class_d_h_t.html#abccbc1d739863770ebe65a7d9cfea70f">DHT::started</a></div><div class="ttdeci">bool started()</div></div>
|
|
<div class="ttc" id="aclass_d_h_t_html_a39d833ae18a85d54f42ea71510e36a85"><div class="ttname"><a href="class_d_h_t.html#a39d833ae18a85d54f42ea71510e36a85">DHT::end</a></div><div class="ttdeci">void end()</div></div>
|
|
<div class="ttc" id="adht_8h_html_a65942a2b41cf2a08699e185fac352515"><div class="ttname"><a href="dht_8h.html#a65942a2b41cf2a08699e185fac352515">esp3d_DHT</a></div><div class="ttdeci">DHT esp3d_DHT</div></div>
|
|
<div class="ttc" id="aclass_d_h_t_html_a4b7002244953847605abc08db2981e0d"><div class="ttname"><a href="class_d_h_t.html#a4b7002244953847605abc08db2981e0d">DHT::GetModelString</a></div><div class="ttdeci">const char * GetModelString()</div></div>
|
|
<div class="ttc" id="aclass_d_h_t_html_affeec3f3752eeac17c684c781d9a962c"><div class="ttname"><a href="class_d_h_t.html#affeec3f3752eeac17c684c781d9a962c">DHT::begin</a></div><div class="ttdeci">bool begin()</div></div>
|
|
<div class="ttc" id="aclass_d_h_t_html_ae2a3991e1153bf6acdc827a306cc4aa2"><div class="ttname"><a href="class_d_h_t.html#ae2a3991e1153bf6acdc827a306cc4aa2">DHT::getHumidity</a></div><div class="ttdeci">float getHumidity()</div></div>
|
|
<div class="ttc" id="aclass_d_h_t_html_addc81efbe31ac923b054636f675a2d8b"><div class="ttname"><a href="class_d_h_t.html#addc81efbe31ac923b054636f675a2d8b">DHT::DHT</a></div><div class="ttdeci">DHT()</div></div>
|
|
<div class="ttc" id="aclass_d_h_t_html_af404e4b14a31928fed9aa5268b4c2b99"><div class="ttname"><a href="class_d_h_t.html#af404e4b14a31928fed9aa5268b4c2b99">DHT::getTemperature</a></div><div class="ttdeci">float getTemperature()</div></div>
|
|
<div class="ttc" id="aclass_d_h_t_html_a4a0cada75d18735b20fe9db31aa1dae7"><div class="ttname"><a href="class_d_h_t.html#a4a0cada75d18735b20fe9db31aa1dae7">DHT::setCelsiusUnit</a></div><div class="ttdeci">void setCelsiusUnit(bool set)</div></div>
|
|
<div class="ttc" id="aclass_d_h_t_html"><div class="ttname"><a href="class_d_h_t.html">DHT</a></div><div class="ttdef"><b>Definition:</b> <a href="dht_8h_source.html#l00026">dht.h:26</a></div></div>
|
|
<div class="ttc" id="aclass_d_h_t_html_aa3034e0207490f85b581a7700547d225"><div class="ttname"><a href="class_d_h_t.html#aa3034e0207490f85b581a7700547d225">DHT::~DHT</a></div><div class="ttdeci">~DHT()</div></div>
|
|
<div class="ttc" id="aclass_d_h_t_html_ad9482ea9db355745c289120299c0c0e8"><div class="ttname"><a href="class_d_h_t.html#ad9482ea9db355745c289120299c0c0e8">DHT::GetModel</a></div><div class="ttdeci">uint8_t GetModel()</div></div>
|
|
<div class="ttc" id="aclass_d_h_t_html_a4cd4e070920943a1c457209e44f9e327"><div class="ttname"><a href="class_d_h_t.html#a4cd4e070920943a1c457209e44f9e327">DHT::isCelsiusUnit</a></div><div class="ttdeci">bool isCelsiusUnit()</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_2c1830491e0576ae3395f8c2f91c7d85.html">modules</a></li><li class="navelem"><a class="el" href="dir_2a628a8d4e7b600ab68c11249cd0e388.html">dht</a></li><li class="navelem"><a class="el" href="dht_8h.html">dht.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>
|