forked from adafruit/DHT-sensor-library
Deploy code docs to GitHub Pages Travis build:
Commit:
This commit is contained in:
Doxygen CI committed
1 parent
3c9c660461
commit
8398c9c3a4
6 files changed
+1
-30
No files matched your search
@@ -96,8 +96,6 @@ Macros</h2></td></tr>
|
||||
<tr class="separator:af718013a29c2115b00d7c77d2f28084b"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a3de32b1bf162072c5e2d695bea5bb296"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_d_h_t_8h.html#a3de32b1bf162072c5e2d695bea5bb296">AM2301</a>   21</td></tr>
|
||||
<tr class="separator:a3de32b1bf162072c5e2d695bea5bb296"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aa4a5bbc71d71ab25856c1366b6ca15bb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_d_h_t_8h.html#aa4a5bbc71d71ab25856c1366b6ca15bb">microsecondsToClockCycles</a>(a)   ((a) * (SystemCoreClock / 1000000L))</td></tr>
|
||||
<tr class="separator:aa4a5bbc71d71ab25856c1366b6ca15bb"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>This is a library for <a class="el" href="class_d_h_t.html" title="Class that stores state and functions for DHT. ">DHT</a> series of low cost temperature/humidity sensors.</p>
|
||||
@@ -232,25 +230,6 @@ Macros</h2></td></tr>
|
||||
</div><div class="memdoc">
|
||||
<p>AM2301 </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="aa4a5bbc71d71ab25856c1366b6ca15bb"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#aa4a5bbc71d71ab25856c1366b6ca15bb">◆ </a></span>microsecondsToClockCycles</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">#define microsecondsToClockCycles</td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"> </td>
|
||||
<td class="paramname">a</td><td>)</td>
|
||||
<td>   ((a) * (SystemCoreClock / 1000000L))</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>As of 7 Sep 2020 the Arduino Nano 33 BLE boards do not have microsecondsToClockCycles defined. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div><!-- contents -->
|
||||
|
||||
@@ -62,7 +62,7 @@ $(function() {
|
||||
<div class="title">DHT.h</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<a href="_d_h_t_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> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#ifndef DHT_H</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#define DHT_H</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">#include "Arduino.h"</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="comment">/* Uncomment to enable printing out nice debug messages. */</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">//#define DHT_DEBUG</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="_d_h_t_8h.html#afe84d42042833e4e334c977b93ff2407"> 26</a></span> <span class="preprocessor">#define DEBUG_PRINTER \</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor"> Serial </span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor"></span><span class="comment">/* Setup debug printing macros. */</span><span class="preprocessor"></span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#ifdef DHT_DEBUG</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#define DEBUG_PRINT(...) \</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"> { DEBUG_PRINTER.print(__VA_ARGS__); }</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#define DEBUG_PRINTLN(...) \</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor"> { DEBUG_PRINTER.println(__VA_ARGS__); }</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#define DEBUG_PRINT(...) \</span></div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="_d_h_t_8h.html#a88edd2aa4feabff4af21a997d5d8aa23"> 38</a></span> <span class="preprocessor"> {} </span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#define DEBUG_PRINTLN(...) \</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor"> {} </span></div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="_d_h_t_8h.html#ae414eccb9fbdc7c0cc6edfc588a3aa34"> 41</a></span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">/* Define types of sensors. */</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#define DHT11 11 </span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#define DHT12 12 </span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#define DHT22 22 </span></div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="_d_h_t_8h.html#ac7ca444ad6788a4e3686a83bc036efb6"> 47</a></span> <span class="preprocessor">#define DHT21 21 </span></div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="_d_h_t_8h.html#a1574ee8a0bebaff3165f634e2717d4e7"> 48</a></span> <span class="preprocessor">#define AM2301 21 </span></div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="_d_h_t_8h.html#af718013a29c2115b00d7c77d2f28084b"> 50</a></span> <span class="preprocessor">#if (TARGET_NAME == ARDUINO_NANO33BLE)</span></div><div class="line"><a name="l00051"></a><span class="lineno"><a clasLine truncated
|
||||
<a href="_d_h_t_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> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#ifndef DHT_H</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#define DHT_H</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">#include "Arduino.h"</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="comment">/* Uncomment to enable printing out nice debug messages. */</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">//#define DHT_DEBUG</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="_d_h_t_8h.html#afe84d42042833e4e334c977b93ff2407"> 26</a></span> <span class="preprocessor">#define DEBUG_PRINTER \</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor"> Serial </span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor"></span><span class="comment">/* Setup debug printing macros. */</span><span class="preprocessor"></span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#ifdef DHT_DEBUG</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#define DEBUG_PRINT(...) \</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"> { DEBUG_PRINTER.print(__VA_ARGS__); }</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#define DEBUG_PRINTLN(...) \</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor"> { DEBUG_PRINTER.println(__VA_ARGS__); }</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#define DEBUG_PRINT(...) \</span></div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="_d_h_t_8h.html#a88edd2aa4feabff4af21a997d5d8aa23"> 38</a></span> <span class="preprocessor"> {} </span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#define DEBUG_PRINTLN(...) \</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor"> {} </span></div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="_d_h_t_8h.html#ae414eccb9fbdc7c0cc6edfc588a3aa34"> 41</a></span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">/* Define types of sensors. */</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#define DHT11 11 </span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#define DHT12 12 </span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#define DHT22 22 </span></div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="_d_h_t_8h.html#ac7ca444ad6788a4e3686a83bc036efb6"> 47</a></span> <span class="preprocessor">#define DHT21 21 </span></div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="_d_h_t_8h.html#a1574ee8a0bebaff3165f634e2717d4e7"> 48</a></span> <span class="preprocessor">#define AM2301 21 </span></div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="_d_h_t_8h.html#af718013a29c2115b00d7c77d2f28084b"> 50</a></span> <span class="preprocessor">#if defined(TARGET_NAME) && (TARGET_NAME == ARDUINO_NANO33BLE)</span></div><div class="line"><a name="l00051">Line truncated
|
||||
<div class="ttc" id="class_d_h_t_html_afa429167bfeba848ab824fee0043f79d"><div class="ttname"><a href="class_d_h_t.html#afa429167bfeba848ab824fee0043f79d">DHT::DHT</a></div><div class="ttdeci">DHT(uint8_t pin, uint8_t type, uint8_t count=6)</div><div class="ttdoc">Instantiates a new DHT class. </div><div class="ttdef"><b>Definition:</b> DHT.cpp:43</div></div>
|
||||
<div class="ttc" id="class_d_h_t_html_a90530e38a2f47893e4767dda1d00d2a4"><div class="ttname"><a href="class_d_h_t.html#a90530e38a2f47893e4767dda1d00d2a4">DHT::convertFtoC</a></div><div class="ttdeci">float convertFtoC(float)</div><div class="ttdoc">Converts Fahrenheit to Celcius. </div><div class="ttdef"><b>Definition:</b> DHT.cpp:141</div></div>
|
||||
<div class="ttc" id="class_d_h_t_html_a4c1508f2997a5d03968b3afdeae70e03"><div class="ttname"><a href="class_d_h_t.html#a4c1508f2997a5d03968b3afdeae70e03">DHT::read</a></div><div class="ttdeci">bool read(bool force=false)</div><div class="ttdoc">Read value from sensor or return last one from less than two seconds. </div><div class="ttdef"><b>Definition:</b> DHT.cpp:232</div></div>
|
||||
|
||||
@@ -86,9 +86,6 @@ $(function() {
|
||||
<li>DHT_SENSOR_VERSION
|
||||
: <a class="el" href="_d_h_t___u_8h.html#a77b3acfd90db1775e9e644b87ab2a369">DHT_U.h</a>
|
||||
</li>
|
||||
<li>microsecondsToClockCycles
|
||||
: <a class="el" href="_d_h_t_8h.html#aa4a5bbc71d71ab25856c1366b6ca15bb">DHT.h</a>
|
||||
</li>
|
||||
<li>MIN_INTERVAL
|
||||
: <a class="el" href="_d_h_t_8cpp.html#ae5d44a5fa9fd9d113f6bff639f06ddd6">DHT.cpp</a>
|
||||
</li>
|
||||
|
||||
@@ -86,9 +86,6 @@ $(function() {
|
||||
<li>DHT_SENSOR_VERSION
|
||||
: <a class="el" href="_d_h_t___u_8h.html#a77b3acfd90db1775e9e644b87ab2a369">DHT_U.h</a>
|
||||
</li>
|
||||
<li>microsecondsToClockCycles
|
||||
: <a class="el" href="_d_h_t_8h.html#aa4a5bbc71d71ab25856c1366b6ca15bb">DHT.h</a>
|
||||
</li>
|
||||
<li>MIN_INTERVAL
|
||||
: <a class="el" href="_d_h_t_8cpp.html#ae5d44a5fa9fd9d113f6bff639f06ddd6">DHT.cpp</a>
|
||||
</li>
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
var searchData=
|
||||
[
|
||||
['microsecondstoclockcycles',['microsecondsToClockCycles',['../_d_h_t_8h.html#aa4a5bbc71d71ab25856c1366b6ca15bb',1,'DHT.h']]],
|
||||
['min_5finterval',['MIN_INTERVAL',['../_d_h_t_8cpp.html#ae5d44a5fa9fd9d113f6bff639f06ddd6',1,'DHT.cpp']]]
|
||||
];
|
||||
@@ -1,5 +1,4 @@
|
||||
var searchData=
|
||||
[
|
||||
['microsecondstoclockcycles',['microsecondsToClockCycles',['../_d_h_t_8h.html#aa4a5bbc71d71ab25856c1366b6ca15bb',1,'DHT.h']]],
|
||||
['min_5finterval',['MIN_INTERVAL',['../_d_h_t_8cpp.html#ae5d44a5fa9fd9d113f6bff639f06ddd6',1,'DHT.cpp']]]
|
||||
];
|
||||
Reference in new issue
Block a user