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
d83378b1f1
commit
b8c0076e1d
3 files changed
+4
-4
No files matched your search
+1
-1
@@ -115,7 +115,7 @@ Macros</h2></td></tr>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Define where debug output will be printed. </p>
|
||||
<p>Define where debug output will be printed. \ </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -62,8 +62,8 @@ $(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="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef DHT_H</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define DHT_H</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "Arduino.h"</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> <span class="comment">/* Uncomment to enable printing out nice debug messages. */</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">//#define DHT_DEBUG</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</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 Serial </span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor"></span><span class="comment">/* Setup debug printing macros. */</span><span class="preprocessor"></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#ifdef DHT_DEBUG</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor"> #define DEBUG_PRINT(...) { DEBUG_PRINTER.print(__VA_ARGS__); }</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor"> #define DEBUG_PRINTLN(...) { DEBUG_PRINTER.println(__VA_ARGS__); }</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="_d_h_t_8h.html#a88edd2aa4feabff4af21a997d5d8aa23"> 33</a></span> <span class="preprocessor"> #define DEBUG_PRINT(...) {} </span></div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="_d_h_t_8h.html#ae414eccb9fbdc7c0cc6edfc588a3aa34"> 34</a></span> <span class="preprocessor"> #define DEBUG_PRINTLN(...) {} </span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">/* Define types of sensors. */</span></div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="_d_h_t_8h.html#ac7ca444ad6788a4e3686a83bc036efb6"> 38</a></span> <span class="preprocessor">#define DHT11 11 </span></div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="_d_h_t_8h.html#a1574ee8a0bebaff3165f634e2717d4e7"> 39</a></span> <span class="preprocessor">#define DHT12 12 </span></div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="_d_h_t_8h.html#a1d34ec65a101891e5800d6e6a69fe528"> 40</a></span> <span class="preprocessor">#define DHT22 22 </span></div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="_d_h_t_8h.html#af718013a29c2115b00d7c77d2f28084b"> 41</a></span> <span class="preprocessor">#define DHT21 21 </span></div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="_d_h_t_8h.html#a3de32b1bf162072c5e2d695bea5bb296"> 42</a></span> <span class="preprocessor">#define AM2301 21 </span></div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="class_d_h_t.html"> 47</a></span> <span class="preprocessor">class DHT {</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="class_d_h_t.html">DHT</a>(uint8_t pin, uint8_t type, uint8_t count=6);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">void</span> begin(uint8_t usec=55);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordtype">float</span> readTemperature(<span class="keywordtype">bool</span> S=<span class="keyword">false</span>, <span class="keywordtypLine truncated
|
||||
<div class="ttc" id="class_interrupt_lock_html"><div class="ttname"><a href="class_interrupt_lock.html">InterruptLock</a></div><div class="ttdoc">Class that defines Interrupt Lock Avaiability. </div><div class="ttdef"><b>Definition:</b> DHT.h:78</div></div>
|
||||
<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="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">class DHT {</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00055"></a><span classLine truncated
|
||||
<div class="ttc" id="class_interrupt_lock_html"><div class="ttname"><a href="class_interrupt_lock.html">InterruptLock</a></div><div class="ttdoc">Class that defines Interrupt Lock Avaiability. </div><div class="ttdef"><b>Definition:</b> DHT.h:88</div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
|
||||
@@ -63,7 +63,7 @@ $(function() {
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<a href="_d_h_t___u_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="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#ifndef DHT_U_H</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#define DHT_U_H</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include <Adafruit_Sensor.h></span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#include <<a class="code" href="_d_h_t_8h.html">DHT.h</a>></span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="_d_h_t___u_8h.html#a77b3acfd90db1775e9e644b87ab2a369"> 39</a></span> <span class="preprocessor">#define DHT_SENSOR_VERSION 1 </span></div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="class_d_h_t___unified.html"> 45</a></span> <span class="preprocessor">class DHT_Unified {</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="class_d_h_t___unified.html">DHT_Unified</a>(uint8_t pin, uint8_t type, uint8_t count = 6,</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  int32_t tempSensorId = -1, int32_t humiditySensorId = -1);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">void</span> begin();</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="class_d_h_t___unified_1_1_temperature.html"> 54</a></span>  <span class="keyword">class </span><a class="code" href="class_d_h_t___unified_1_1_temperature.html">Temperature</a> : <span class="keyword">public</span> Adafruit_Sensor {</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="class_d_h_t___unified_1_1_temperature.html">Temperature</a>(<a class="code" href="class_d_h_t___unified.html">DHT_Unified</a> *parent, int32_t <span class="keywordtype">id</span>);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">bool</span> getEvent(sensors_event_t *event);</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">void</span> getSensor(sensor_t *sensor);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="class_d_h_t___unified.html">DHT_Unified</a> *_parent;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  int32_t _id;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  };</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="class_d_h_t___unified_1_1_humidity.html"> 68</a></span>  <span class="keyword">class </span><a class="code" href="class_d_h_t___unified_1_1_humidity.html">Humidity</a> : <span class="keyword">public</span> Adafruit_Sensor {</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <a class="code" href="class_d_h_t___unified_1_1_humidity.html">Humidity</a>(<a class="code" href="class_d_h_t___unified.html">DHT_Unified</a> *parent, int32_t <span class="keywordtype">id</span>);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">bool</span> getEvent(sensors_event_t *event);</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">void</span> getSensor(sensor_t *sensor);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">private</span>:</div><div claLine truncated
|
||||
<div class="ttc" id="class_d_h_t_html"><div class="ttname"><a href="class_d_h_t.html">DHT</a></div><div class="ttdoc">Class that stores state and functions for DHT. </div><div class="ttdef"><b>Definition:</b> DHT.h:47</div></div>
|
||||
<div class="ttc" id="class_d_h_t_html"><div class="ttname"><a href="class_d_h_t.html">DHT</a></div><div class="ttdoc">Class that stores state and functions for DHT. </div><div class="ttdef"><b>Definition:</b> DHT.h:56</div></div>
|
||||
<div class="ttc" id="class_d_h_t___unified_1_1_temperature_html"><div class="ttname"><a href="class_d_h_t___unified_1_1_temperature.html">DHT_Unified::Temperature</a></div><div class="ttdoc">Class that stores state and functions about Temperature. </div><div class="ttdef"><b>Definition:</b> DHT_U.h:54</div></div>
|
||||
<div class="ttc" id="class_d_h_t___unified_html"><div class="ttname"><a href="class_d_h_t___unified.html">DHT_Unified</a></div><div class="ttdoc">Class that stores state and functions for interacting with DHT_Unified. </div><div class="ttdef"><b>Definition:</b> DHT_U.h:45</div></div>
|
||||
<div class="ttc" id="_d_h_t_8h_html"><div class="ttname"><a href="_d_h_t_8h.html">DHT.h</a></div></div>
|
||||
|
||||
Reference in new issue
Block a user