mirror of https://github.com/arendst/Tasmota.git
88 lines
15 KiB
HTML
88 lines
15 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"/>
|
|
<meta name="generator" content="Doxygen 1.8.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Adafruit BME680 Library: bme680.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="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="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Adafruit BME680 Library
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<!-- 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">bme680.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="bme680_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="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#ifndef BME680_H_</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#define BME680_H_</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span></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="preprocessor">#endif</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">/* Header includes */</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor">#include "<a class="code" href="bme680__defs_8h.html">bme680_defs.h</a>"</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment">/* function prototype declarations */</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> int8_t <a class="code" href="group___b_m_e680.html#gaee75ae524b7ca8f4a9b6dbb7f640c2e4">bme680_init</a>(<span class="keyword">struct</span> <a class="code" href="structbme680__dev.html">bme680_dev</a> *dev);</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> int8_t <a class="code" href="group___b_m_e680.html#ga5d1bad74f7ac28e75aca9d7de66fd2b4">bme680_set_regs</a>(<span class="keyword">const</span> uint8_t *reg_addr, <span class="keyword">const</span> uint8_t *reg_data, uint8_t len, <span class="keyword">struct</span> <a class="code" href="structbme680__dev.html">bme680_dev</a> *dev);</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> int8_t <a class="code" href="group___b_m_e680.html#gaf5548cbdbf327e2c77bdb0afb1dde9e4">bme680_get_regs</a>(uint8_t reg_addr, uint8_t *reg_data, uint16_t len, <span class="keyword">struct</span> <a class="code" href="structbme680__dev.html">bme680_dev</a> *dev);</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> int8_t <a class="code" href="group___b_m_e680.html#ga7f0f1a4378bc6cd0a34acf62509cdec7">bme680_soft_reset</a>(<span class="keyword">struct</span> <a class="code" href="structbme680__dev.html">bme680_dev</a> *dev);</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> int8_t <a class="code" href="group___b_m_e680.html#ga5ca765226e758e71c862553c7cc0b371">bme680_set_sensor_mode</a>(<span class="keyword">struct</span> <a class="code" href="structbme680__dev.html">bme680_dev</a> *dev);</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> int8_t <a class="code" href="group___b_m_e680.html#ga4e50492a1f4747868f7e9a826492f1e7">bme680_get_sensor_mode</a>(<span class="keyword">struct</span> <a class="code" href="structbme680__dev.html">bme680_dev</a> *dev);</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="keywordtype">void</span> <a class="code" href="group___b_m_e680.html#ga192f772bc9cb619e5855e93d6ebd6128">bme680_set_profile_dur</a>(uint16_t duration, <span class="keyword">struct</span> <a class="code" href="structbme680__dev.html">bme680_dev</a> *dev);</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> </div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="keywordtype">void</span> <a class="code" href="group___b_m_e680.html#ga191c03ab8aa1f4bc440953fd2f6317c2">bme680_get_profile_dur</a>(uint16_t *duration, <span class="keyword">struct</span> <a class="code" href="structbme680__dev.html">bme680_dev</a> *dev);</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> </div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> int8_t <a class="code" href="group___b_m_e680.html#ga1025301e420e1e21911044bebb62f940">bme680_get_sensor_data</a>(<span class="keyword">struct</span> <a class="code" href="structbme680__field__data.html">bme680_field_data</a> *data, <span class="keyword">struct</span> <a class="code" href="structbme680__dev.html">bme680_dev</a> *dev);</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> </div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> int8_t <a class="code" href="group___b_m_e680.html#ga2fea1365b4fa1d33eef434769b16e811">bme680_set_sensor_settings</a>(uint16_t desired_settings, <span class="keyword">struct</span> <a class="code" href="structbme680__dev.html">bme680_dev</a> *dev);</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> </div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span> int8_t <a class="code" href="group___b_m_e680.html#ga7826b058b8eddcf05ccbb117fd9d41b7">bme680_get_sensor_settings</a>(uint16_t desired_settings, <span class="keyword">struct</span> <a class="code" href="structbme680__dev.html">bme680_dev</a> *dev);</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> }</div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="preprocessor">#endif </span><span class="comment">/* End of CPP guard */</span><span class="preprocessor"></span></div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="preprocessor">#endif </span><span class="comment">/* BME680_H_ */</span><span class="preprocessor"></span></div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> </div><div class="ttc" id="group___b_m_e680_html_gaee75ae524b7ca8f4a9b6dbb7f640c2e4"><div class="ttname"><a href="group___b_m_e680.html#gaee75ae524b7ca8f4a9b6dbb7f640c2e4">bme680_init</a></div><div class="ttdeci">int8_t bme680_init(struct bme680_dev *dev)</div><div class="ttdoc">This API is the entry point. It reads the chip-id and calibration data from the sensor. </div><div class="ttdef"><b>Definition:</b> bme680.c:237</div></div>
|
|
<div class="ttc" id="group___b_m_e680_html_ga4e50492a1f4747868f7e9a826492f1e7"><div class="ttname"><a href="group___b_m_e680.html#ga4e50492a1f4747868f7e9a826492f1e7">bme680_get_sensor_mode</a></div><div class="ttdeci">int8_t bme680_get_sensor_mode(struct bme680_dev *dev)</div><div class="ttdoc">This API is used to get the power mode of the sensor. </div><div class="ttdef"><b>Definition:</b> bme680.c:568</div></div>
|
|
<div class="ttc" id="group___b_m_e680_html_ga2fea1365b4fa1d33eef434769b16e811"><div class="ttname"><a href="group___b_m_e680.html#ga2fea1365b4fa1d33eef434769b16e811">bme680_set_sensor_settings</a></div><div class="ttdeci">int8_t bme680_set_sensor_settings(uint16_t desired_settings, struct bme680_dev *dev)</div><div class="ttdoc">This API is used to set the oversampling, filter and T,P,H, gas selection settings in the sensor...</div><div class="ttdef"><b>Definition:</b> bme680.c:364</div></div>
|
|
<div class="ttc" id="group___b_m_e680_html_ga7826b058b8eddcf05ccbb117fd9d41b7"><div class="ttname"><a href="group___b_m_e680.html#ga7826b058b8eddcf05ccbb117fd9d41b7">bme680_get_sensor_settings</a></div><div class="ttdeci">int8_t bme680_get_sensor_settings(uint16_t desired_settings, struct bme680_dev *dev)</div><div class="ttdoc">This API is used to get the oversampling, filter and T,P,H, gas selection settings in the sensor...</div><div class="ttdef"><b>Definition:</b> bme680.c:482</div></div>
|
|
<div class="ttc" id="group___b_m_e680_html_gaf5548cbdbf327e2c77bdb0afb1dde9e4"><div class="ttname"><a href="group___b_m_e680.html#gaf5548cbdbf327e2c77bdb0afb1dde9e4">bme680_get_regs</a></div><div class="ttdeci">int8_t bme680_get_regs(uint8_t reg_addr, uint8_t *reg_data, uint16_t len, struct bme680_dev *dev)</div><div class="ttdoc">This API reads the data from the given register address of the sensor. </div><div class="ttdef"><b>Definition:</b> bme680.c:266</div></div>
|
|
<div class="ttc" id="group___b_m_e680_html_ga191c03ab8aa1f4bc440953fd2f6317c2"><div class="ttname"><a href="group___b_m_e680.html#ga191c03ab8aa1f4bc440953fd2f6317c2">bme680_get_profile_dur</a></div><div class="ttdeci">void bme680_get_profile_dur(uint16_t *duration, struct bme680_dev *dev)</div><div class="ttdoc">This API is used to get the profile duration of the sensor. </div><div class="ttdef"><b>Definition:</b> bme680.c:606</div></div>
|
|
<div class="ttc" id="bme680__defs_8h_html"><div class="ttname"><a href="bme680__defs_8h.html">bme680_defs.h</a></div><div class="ttdoc">Sensor driver for BME680 sensor. </div></div>
|
|
<div class="ttc" id="group___b_m_e680_html_ga5d1bad74f7ac28e75aca9d7de66fd2b4"><div class="ttname"><a href="group___b_m_e680.html#ga5d1bad74f7ac28e75aca9d7de66fd2b4">bme680_set_regs</a></div><div class="ttdeci">int8_t bme680_set_regs(const uint8_t *reg_addr, const uint8_t *reg_data, uint8_t len, struct bme680_dev *dev)</div><div class="ttdoc">This API writes the given data to the register address of the sensor. </div><div class="ttdef"><b>Definition:</b> bme680.c:291</div></div>
|
|
<div class="ttc" id="group___b_m_e680_html_ga5ca765226e758e71c862553c7cc0b371"><div class="ttname"><a href="group___b_m_e680.html#ga5ca765226e758e71c862553c7cc0b371">bme680_set_sensor_mode</a></div><div class="ttdeci">int8_t bme680_set_sensor_mode(struct bme680_dev *dev)</div><div class="ttdoc">This API is used to set the power mode of the sensor. </div><div class="ttdef"><b>Definition:</b> bme680.c:529</div></div>
|
|
<div class="ttc" id="group___b_m_e680_html_ga192f772bc9cb619e5855e93d6ebd6128"><div class="ttname"><a href="group___b_m_e680.html#ga192f772bc9cb619e5855e93d6ebd6128">bme680_set_profile_dur</a></div><div class="ttdeci">void bme680_set_profile_dur(uint16_t duration, struct bme680_dev *dev)</div><div class="ttdoc">This API is used to set the profile duration of the sensor. </div><div class="ttdef"><b>Definition:</b> bme680.c:587</div></div>
|
|
<div class="ttc" id="group___b_m_e680_html_ga1025301e420e1e21911044bebb62f940"><div class="ttname"><a href="group___b_m_e680.html#ga1025301e420e1e21911044bebb62f940">bme680_get_sensor_data</a></div><div class="ttdeci">int8_t bme680_get_sensor_data(struct bme680_field_data *data, struct bme680_dev *dev)</div><div class="ttdoc">This API reads the pressure, temperature and humidity and gas data from the sensor, compensates the data and store it in the bme680_data structure instance passed by the user. </div><div class="ttdef"><b>Definition:</b> bme680.c:627</div></div>
|
|
<div class="ttc" id="structbme680__field__data_html"><div class="ttname"><a href="structbme680__field__data.html">bme680_field_data</a></div><div class="ttdoc">Sensor field data structure. </div><div class="ttdef"><b>Definition:</b> bme680_defs.h:382</div></div>
|
|
<div class="ttc" id="group___b_m_e680_html_ga7f0f1a4378bc6cd0a34acf62509cdec7"><div class="ttname"><a href="group___b_m_e680.html#ga7f0f1a4378bc6cd0a34acf62509cdec7">bme680_soft_reset</a></div><div class="ttdeci">int8_t bme680_soft_reset(struct bme680_dev *dev)</div><div class="ttdoc">This API performs the soft reset of the sensor. </div><div class="ttdef"><b>Definition:</b> bme680.c:330</div></div>
|
|
<div class="ttc" id="structbme680__dev_html"><div class="ttname"><a href="structbme680__dev.html">bme680_dev</a></div><div class="ttdoc">BME680 device structure. </div><div class="ttdef"><b>Definition:</b> bme680_defs.h:494</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|