forked from adafruit/Adafruit_Sensor
Deploy docs to GitHub Pages from commit 137b67db45
Commit: 137b67db45
GitHub Actions run: 2770727278
This commit is contained in:
Doxygen CI committed
1 parent
638d45a15a
commit
0c52ad48c8
7 files changed
+35
-9
No files matched your search
@@ -62,15 +62,15 @@ $(function() {
|
||||
<div class="title">Adafruit_Sensor.h</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<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"> * Copyright (C) 2008 The Android Open Source Project</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"> * Licensed under the Apache License, Version 2.0 (the "License");</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * You may obtain a copy of the License at</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software< /span></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * limitations under the License.</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> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">/* Update by K. Townsend (Adafruit Industries) for lighter typedefs, and</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * extended sensor support to include color, voltage and current */</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">#ifndef _ADAFRUIT_SENSOR_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define _ADAFRUIT_SENSOR_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="preprocessor">#ifndef ARDUINO</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <stdint.h></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#elif ARDUINO >= 100</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "Arduino.h"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "Print.h"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "WProgram.h"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">/* Constants */</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#define SENSORS_GRAVITY_EARTH (9.80665F) </span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#define SENSORS_GRAVITY_MOON (1.6F) </span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#Line truncated
|
||||
<div class="ttc" id="class_adafruit___sensor_html"><div class="ttname"><a href="class_adafruit___sensor.html">Adafruit_Sensor</a></div><div class="ttdoc">Common sensor interface to unify various sensors. Intentionally modeled after sensors.h in the Android API: https://github.com/android/platform_hardware_libhardware/blob/master/include/hardware/sensors.h. </div><div class="ttdef"><b>Definition:</b> Adafruit_Sensor.h:162</div></div>
|
||||
<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"> * Copyright (C) 2008 The Android Open Source Project</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"> * Licensed under the Apache License, Version 2.0 (the "License");</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * You may obtain a copy of the License at</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software< /span></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * limitations under the License.</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> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">/* Update by K. Townsend (Adafruit Industries) for lighter typedefs, and</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * extended sensor support to include color, voltage and current */</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">#ifndef _ADAFRUIT_SENSOR_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define _ADAFRUIT_SENSOR_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="preprocessor">#ifndef ARDUINO</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <stdint.h></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#elif ARDUINO >= 100</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "Arduino.h"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "Print.h"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "WProgram.h"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">/* Constants */</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#define SENSORS_GRAVITY_EARTH (9.80665F) </span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#define SENSORS_GRAVITY_MOON (1.6F) </span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#Line truncated
|
||||
<div class="ttc" id="class_adafruit___sensor_html"><div class="ttname"><a href="class_adafruit___sensor.html">Adafruit_Sensor</a></div><div class="ttdoc">Common sensor interface to unify various sensors. Intentionally modeled after sensors.h in the Android API: https://github.com/android/platform_hardware_libhardware/blob/master/include/hardware/sensors.h. </div><div class="ttdef"><b>Definition:</b> Adafruit_Sensor.h:164</div></div>
|
||||
<div class="ttc" id="class_adafruit___sensor_html_a0636562b9bc853b796ecc87b5d4b1bec"><div class="ttname"><a href="class_adafruit___sensor.html#a0636562b9bc853b796ecc87b5d4b1bec">Adafruit_Sensor::getEvent</a></div><div class="ttdeci">virtual bool getEvent(sensors_event_t *)=0</div><div class="ttdoc">Get the latest sensor event. </div></div>
|
||||
<div class="ttc" id="class_adafruit___sensor_html_af994cc1147831134ad7bf7b2c99d7478"><div class="ttname"><a href="class_adafruit___sensor.html#af994cc1147831134ad7bf7b2c99d7478">Adafruit_Sensor::printSensorDetails</a></div><div class="ttdeci">void printSensorDetails(void)</div><div class="ttdoc">Prints sensor information to serial console. </div><div class="ttdef"><b>Definition:</b> Adafruit_Sensor.cpp:8</div></div>
|
||||
<div class="ttc" id="structsensor__t_html"><div class="ttname"><a href="structsensor__t.html">sensor_t</a></div><div class="ttdef"><b>Definition:</b> Adafruit_Sensor.h:145</div></div>
|
||||
<div class="ttc" id="structsensors__event__t_html"><div class="ttname"><a href="structsensors__event__t.html">sensors_event_t</a></div><div class="ttdef"><b>Definition:</b> Adafruit_Sensor.h:117</div></div>
|
||||
<div class="ttc" id="structsensor__t_html"><div class="ttname"><a href="structsensor__t.html">sensor_t</a></div><div class="ttdef"><b>Definition:</b> Adafruit_Sensor.h:147</div></div>
|
||||
<div class="ttc" id="structsensors__event__t_html"><div class="ttname"><a href="structsensors__event__t.html">sensors_event_t</a></div><div class="ttdef"><b>Definition:</b> Adafruit_Sensor.h:118</div></div>
|
||||
<div class="ttc" id="class_adafruit___sensor_html_a19e844c1eb2dc37cb72705d5572c4676"><div class="ttname"><a href="class_adafruit___sensor.html#a19e844c1eb2dc37cb72705d5572c4676">Adafruit_Sensor::getSensor</a></div><div class="ttdeci">virtual void getSensor(sensor_t *)=0</div><div class="ttdoc">Get info about the sensor itself. </div></div>
|
||||
<div class="ttc" id="structsensors__color__t_html"><div class="ttname"><a href="structsensors__color__t.html">sensors_color_t</a></div><div class="ttdef"><b>Definition:</b> Adafruit_Sensor.h:101</div></div>
|
||||
<div class="ttc" id="class_adafruit___sensor_html_ace6c1f26eeb956f95801b9fc1841f3a0"><div class="ttname"><a href="class_adafruit___sensor.html#ace6c1f26eeb956f95801b9fc1841f3a0">Adafruit_Sensor::enableAutoRange</a></div><div class="ttdeci">virtual void enableAutoRange(bool enabled)</div><div class="ttdoc">Whether we should automatically change the range (if possible) for higher precision. </div><div class="ttdef"><b>Definition:</b> Adafruit_Sensor.h:173</div></div>
|
||||
<div class="ttc" id="structsensors__color__t_html"><div class="ttname"><a href="structsensors__color__t.html">sensors_color_t</a></div><div class="ttdef"><b>Definition:</b> Adafruit_Sensor.h:102</div></div>
|
||||
<div class="ttc" id="class_adafruit___sensor_html_ace6c1f26eeb956f95801b9fc1841f3a0"><div class="ttname"><a href="class_adafruit___sensor.html#ace6c1f26eeb956f95801b9fc1841f3a0">Adafruit_Sensor::enableAutoRange</a></div><div class="ttdeci">virtual void enableAutoRange(bool enabled)</div><div class="ttdoc">Whether we should automatically change the range (if possible) for higher precision. </div><div class="ttdef"><b>Definition:</b> Adafruit_Sensor.h:175</div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
|
||||
@@ -220,6 +220,9 @@ $(function() {
|
||||
<li>timestamp
|
||||
: <a class="el" href="structsensors__event__t.html#acd3be1560458b3e3bf52f93f744e8238">sensors_event_t</a>
|
||||
</li>
|
||||
<li>tvoc
|
||||
: <a class="el" href="structsensors__event__t.html#a6ce5ca5bb4ab3f8a6861fc965a154599">sensors_event_t</a>
|
||||
</li>
|
||||
<li>type
|
||||
: <a class="el" href="structsensor__t.html#ae1d59df64438923d3bd95f2416c32203">sensor_t</a>
|
||||
, <a class="el" href="structsensors__event__t.html#a58401dd7f3400d9eb96c71b8fba9f8e8">sensors_event_t</a>
|
||||
|
||||
@@ -204,6 +204,9 @@ $(function() {
|
||||
<li>timestamp
|
||||
: <a class="el" href="structsensors__event__t.html#acd3be1560458b3e3bf52f93f744e8238">sensors_event_t</a>
|
||||
</li>
|
||||
<li>tvoc
|
||||
: <a class="el" href="structsensors__event__t.html#a6ce5ca5bb4ab3f8a6861fc965a154599">sensors_event_t</a>
|
||||
</li>
|
||||
<li>type
|
||||
: <a class="el" href="structsensor__t.html#ae1d59df64438923d3bd95f2416c32203">sensor_t</a>
|
||||
, <a class="el" href="structsensors__event__t.html#a58401dd7f3400d9eb96c71b8fba9f8e8">sensors_event_t</a>
|
||||
|
||||
@@ -2,5 +2,6 @@ var searchData=
|
||||
[
|
||||
['temperature',['temperature',['../structsensors__event__t.html#a914f76beb75bd99aa3c13d3a8e56e21c',1,'sensors_event_t']]],
|
||||
['timestamp',['timestamp',['../structsensors__event__t.html#acd3be1560458b3e3bf52f93f744e8238',1,'sensors_event_t']]],
|
||||
['tvoc',['tvoc',['../structsensors__event__t.html#a6ce5ca5bb4ab3f8a6861fc965a154599',1,'sensors_event_t']]],
|
||||
['type',['type',['../structsensors__event__t.html#a58401dd7f3400d9eb96c71b8fba9f8e8',1,'sensors_event_t::type()'],['../structsensor__t.html#ae1d59df64438923d3bd95f2416c32203',1,'sensor_t::type()']]]
|
||||
];
|
||||
@@ -2,5 +2,6 @@ var searchData=
|
||||
[
|
||||
['temperature',['temperature',['../structsensors__event__t.html#a914f76beb75bd99aa3c13d3a8e56e21c',1,'sensors_event_t']]],
|
||||
['timestamp',['timestamp',['../structsensors__event__t.html#acd3be1560458b3e3bf52f93f744e8238',1,'sensors_event_t']]],
|
||||
['tvoc',['tvoc',['../structsensors__event__t.html#a6ce5ca5bb4ab3f8a6861fc965a154599',1,'sensors_event_t']]],
|
||||
['type',['type',['../structsensors__event__t.html#a58401dd7f3400d9eb96c71b8fba9f8e8',1,'sensors_event_t::type()'],['../structsensor__t.html#ae1d59df64438923d3bd95f2416c32203',1,'sensor_t::type()']]]
|
||||
];
|
||||
@@ -80,9 +80,10 @@ $(function() {
|
||||
<tr class="even"><td class="entry"><a class="el" href="structsensors__event__t.html#a6b06d35b17afbee79de7f45d9d71ed0b">sensor_id</a></td><td class="entry"><a class="el" href="structsensors__event__t.html">sensors_event_t</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="structsensors__event__t.html#a914f76beb75bd99aa3c13d3a8e56e21c">temperature</a></td><td class="entry"><a class="el" href="structsensors__event__t.html">sensors_event_t</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="structsensors__event__t.html#acd3be1560458b3e3bf52f93f744e8238">timestamp</a></td><td class="entry"><a class="el" href="structsensors__event__t.html">sensors_event_t</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="structsensors__event__t.html#a58401dd7f3400d9eb96c71b8fba9f8e8">type</a></td><td class="entry"><a class="el" href="structsensors__event__t.html">sensors_event_t</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="structsensors__event__t.html#a2134d60fdb21e3495c595a2df2f5cece">version</a></td><td class="entry"><a class="el" href="structsensors__event__t.html">sensors_event_t</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="structsensors__event__t.html#ab01b52f6b83f390a6370d319ded97b28">voltage</a></td><td class="entry"><a class="el" href="structsensors__event__t.html">sensors_event_t</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="structsensors__event__t.html#a6ce5ca5bb4ab3f8a6861fc965a154599">tvoc</a></td><td class="entry"><a class="el" href="structsensors__event__t.html">sensors_event_t</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="structsensors__event__t.html#a58401dd7f3400d9eb96c71b8fba9f8e8">type</a></td><td class="entry"><a class="el" href="structsensors__event__t.html">sensors_event_t</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="structsensors__event__t.html#a2134d60fdb21e3495c595a2df2f5cece">version</a></td><td class="entry"><a class="el" href="structsensors__event__t.html">sensors_event_t</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="structsensors__event__t.html#ab01b52f6b83f390a6370d319ded97b28">voltage</a></td><td class="entry"><a class="el" href="structsensors__event__t.html">sensors_event_t</a></td><td class="entry"></td></tr>
|
||||
</table></div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
|
||||
@@ -108,6 +108,8 @@ union {</td></tr>
|
||||
<tr class="separator:a59fb7860f17278a53f2bbe5885e732e0"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a25730de40ee25582b84abc87c633e954"><td class="memItemLeft" >   float   <a class="el" href="structsensors__event__t.html#ab01b52f6b83f390a6370d319ded97b28">voltage</a></td></tr>
|
||||
<tr class="separator:a25730de40ee25582b84abc87c633e954"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a3ee9abcdb09c97ca64cd06248a395c20"><td class="memItemLeft" >   float   <a class="el" href="structsensors__event__t.html#a6ce5ca5bb4ab3f8a6861fc965a154599">tvoc</a></td></tr>
|
||||
<tr class="separator:a3ee9abcdb09c97ca64cd06248a395c20"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:afe61b10a98efe7be5163598a5a68058e"><td class="memItemLeft" >   <a class="el" href="structsensors__color__t.html">sensors_color_t</a>   <a class="el" href="structsensors__event__t.html#a56b4d05fbf47013727ec1a0a94db91e6">color</a></td></tr>
|
||||
<tr class="separator:afe61b10a98efe7be5163598a5a68058e"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a65765f2fda6943ab0fa6ef1d4b9d7d35"><td class="memItemLeft" valign="top">}; </td><td class="memItemRight" valign="bottom"></td></tr>
|
||||
@@ -355,6 +357,21 @@ union {</td></tr>
|
||||
</div><div class="memdoc">
|
||||
<p>voltage in volts (V) </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a6ce5ca5bb4ab3f8a6861fc965a154599"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a6ce5ca5bb4ab3f8a6861fc965a154599">◆ </a></span>tvoc</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">float sensors_event_t::tvoc</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Total Volatile Organic Compounds, in ppb </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a56b4d05fbf47013727ec1a0a94db91e6"></a>
|
||||
|
||||
Reference in new issue
Block a user