mirrors
/
Tasmota
mirror of https://github.com/arendst/Tasmota.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Tasmota/lib/Adafruit_BME680-1.0.5/docs/bme680_8c.html

158 lines
14 KiB
HTML
Raw Normal View History

Add support for BME680 5.10.0a * Add (experimental) support for sensor SHT3x * Add support for sensor MH-Z19(B) using serial interface to be enabled with define USE_MHZ19 in user_config.h (#561, #1248) * Add (experimental) support for sensor MH-Z19(B) using SoftwareSerial to be enabled with define USE_MHZ19 in user_config.h (#561, #1248) * Add support for iTead SI7021 temperature and humidity sensor by consolidating DHT22 into AM2301 and using former DHT22 as SI7021 (#735) * Fix BME280 calculation (#1051) * Add support for BME680 using adafruit libraries (#1212) * Change ADS1115 default voltage range from +/-2V to +/-6V (#1289) * Add multipress support and more user configurable options to Sonoff Dual R2 (#1291) * Fix Sonoff Bridge missed learned key if learned data contains 0x55 (End of Transmission) flag (#1095, #1294) * Add support for TSL2561 using adafruit library (#661, #1311) * Add alternative support for SHT3x (#1314)
2017-12-06 16:14:41 +00:00
<!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.c File Reference</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>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">bme680.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Sensor driver for BME680 sensor.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="bme680_8h_source.html">bme680.h</a>&quot;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaee75ae524b7ca8f4a9b6dbb7f640c2e4"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_m_e680.html#gaee75ae524b7ca8f4a9b6dbb7f640c2e4">bme680_init</a> (struct <a class="el" href="structbme680__dev.html">bme680_dev</a> *dev)</td></tr>
<tr class="memdesc:gaee75ae524b7ca8f4a9b6dbb7f640c2e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">This API is the entry point. It reads the chip-id and calibration data from the sensor. <a href="group___b_m_e680.html#gaee75ae524b7ca8f4a9b6dbb7f640c2e4">More...</a><br /></td></tr>
<tr class="separator:gaee75ae524b7ca8f4a9b6dbb7f640c2e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf5548cbdbf327e2c77bdb0afb1dde9e4"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_m_e680.html#gaf5548cbdbf327e2c77bdb0afb1dde9e4">bme680_get_regs</a> (uint8_t reg_addr, uint8_t *reg_data, uint16_t len, struct <a class="el" href="structbme680__dev.html">bme680_dev</a> *dev)</td></tr>
<tr class="memdesc:gaf5548cbdbf327e2c77bdb0afb1dde9e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">This API reads the data from the given register address of the sensor. <a href="group___b_m_e680.html#gaf5548cbdbf327e2c77bdb0afb1dde9e4">More...</a><br /></td></tr>
<tr class="separator:gaf5548cbdbf327e2c77bdb0afb1dde9e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5d1bad74f7ac28e75aca9d7de66fd2b4"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_m_e680.html#ga5d1bad74f7ac28e75aca9d7de66fd2b4">bme680_set_regs</a> (const uint8_t *reg_addr, const uint8_t *reg_data, uint8_t len, struct <a class="el" href="structbme680__dev.html">bme680_dev</a> *dev)</td></tr>
<tr class="memdesc:ga5d1bad74f7ac28e75aca9d7de66fd2b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">This API writes the given data to the register address of the sensor. <a href="group___b_m_e680.html#ga5d1bad74f7ac28e75aca9d7de66fd2b4">More...</a><br /></td></tr>
<tr class="separator:ga5d1bad74f7ac28e75aca9d7de66fd2b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7f0f1a4378bc6cd0a34acf62509cdec7"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_m_e680.html#ga7f0f1a4378bc6cd0a34acf62509cdec7">bme680_soft_reset</a> (struct <a class="el" href="structbme680__dev.html">bme680_dev</a> *dev)</td></tr>
<tr class="memdesc:ga7f0f1a4378bc6cd0a34acf62509cdec7"><td class="mdescLeft">&#160;</td><td class="mdescRight">This API performs the soft reset of the sensor. <a href="group___b_m_e680.html#ga7f0f1a4378bc6cd0a34acf62509cdec7">More...</a><br /></td></tr>
<tr class="separator:ga7f0f1a4378bc6cd0a34acf62509cdec7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2fea1365b4fa1d33eef434769b16e811"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_m_e680.html#ga2fea1365b4fa1d33eef434769b16e811">bme680_set_sensor_settings</a> (uint16_t desired_settings, struct <a class="el" href="structbme680__dev.html">bme680_dev</a> *dev)</td></tr>
<tr class="memdesc:ga2fea1365b4fa1d33eef434769b16e811"><td class="mdescLeft">&#160;</td><td class="mdescRight">This API is used to set the oversampling, filter and T,P,H, gas selection settings in the sensor. <a href="group___b_m_e680.html#ga2fea1365b4fa1d33eef434769b16e811">More...</a><br /></td></tr>
<tr class="separator:ga2fea1365b4fa1d33eef434769b16e811"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7826b058b8eddcf05ccbb117fd9d41b7"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_m_e680.html#ga7826b058b8eddcf05ccbb117fd9d41b7">bme680_get_sensor_settings</a> (uint16_t desired_settings, struct <a class="el" href="structbme680__dev.html">bme680_dev</a> *dev)</td></tr>
<tr class="memdesc:ga7826b058b8eddcf05ccbb117fd9d41b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">This API is used to get the oversampling, filter and T,P,H, gas selection settings in the sensor. <a href="group___b_m_e680.html#ga7826b058b8eddcf05ccbb117fd9d41b7">More...</a><br /></td></tr>
<tr class="separator:ga7826b058b8eddcf05ccbb117fd9d41b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5ca765226e758e71c862553c7cc0b371"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_m_e680.html#ga5ca765226e758e71c862553c7cc0b371">bme680_set_sensor_mode</a> (struct <a class="el" href="structbme680__dev.html">bme680_dev</a> *dev)</td></tr>
<tr class="memdesc:ga5ca765226e758e71c862553c7cc0b371"><td class="mdescLeft">&#160;</td><td class="mdescRight">This API is used to set the power mode of the sensor. <a href="group___b_m_e680.html#ga5ca765226e758e71c862553c7cc0b371">More...</a><br /></td></tr>
<tr class="separator:ga5ca765226e758e71c862553c7cc0b371"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4e50492a1f4747868f7e9a826492f1e7"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_m_e680.html#ga4e50492a1f4747868f7e9a826492f1e7">bme680_get_sensor_mode</a> (struct <a class="el" href="structbme680__dev.html">bme680_dev</a> *dev)</td></tr>
<tr class="memdesc:ga4e50492a1f4747868f7e9a826492f1e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">This API is used to get the power mode of the sensor. <a href="group___b_m_e680.html#ga4e50492a1f4747868f7e9a826492f1e7">More...</a><br /></td></tr>
<tr class="separator:ga4e50492a1f4747868f7e9a826492f1e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga192f772bc9cb619e5855e93d6ebd6128"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_m_e680.html#ga192f772bc9cb619e5855e93d6ebd6128">bme680_set_profile_dur</a> (uint16_t duration, struct <a class="el" href="structbme680__dev.html">bme680_dev</a> *dev)</td></tr>
<tr class="memdesc:ga192f772bc9cb619e5855e93d6ebd6128"><td class="mdescLeft">&#160;</td><td class="mdescRight">This API is used to set the profile duration of the sensor. <a href="group___b_m_e680.html#ga192f772bc9cb619e5855e93d6ebd6128">More...</a><br /></td></tr>
<tr class="separator:ga192f772bc9cb619e5855e93d6ebd6128"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga191c03ab8aa1f4bc440953fd2f6317c2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_m_e680.html#ga191c03ab8aa1f4bc440953fd2f6317c2">bme680_get_profile_dur</a> (uint16_t *duration, struct <a class="el" href="structbme680__dev.html">bme680_dev</a> *dev)</td></tr>
<tr class="memdesc:ga191c03ab8aa1f4bc440953fd2f6317c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">This API is used to get the profile duration of the sensor. <a href="group___b_m_e680.html#ga191c03ab8aa1f4bc440953fd2f6317c2">More...</a><br /></td></tr>
<tr class="separator:ga191c03ab8aa1f4bc440953fd2f6317c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1025301e420e1e21911044bebb62f940"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_m_e680.html#ga1025301e420e1e21911044bebb62f940">bme680_get_sensor_data</a> (struct <a class="el" href="structbme680__field__data.html">bme680_field_data</a> *data, struct <a class="el" href="structbme680__dev.html">bme680_dev</a> *dev)</td></tr>
<tr class="memdesc:ga1025301e420e1e21911044bebb62f940"><td class="mdescLeft">&#160;</td><td class="mdescRight">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. <a href="group___b_m_e680.html#ga1025301e420e1e21911044bebb62f940">More...</a><br /></td></tr>
<tr class="separator:ga1025301e420e1e21911044bebb62f940"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:adededc333f13a6bae1487b7cadee4a5f"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bme680_8c.html#adededc333f13a6bae1487b7cadee4a5f">lookupTable1</a> [16]</td></tr>
<tr class="separator:adededc333f13a6bae1487b7cadee4a5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf3a4ba4968870a9fb857fe7f47f9461"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bme680_8c.html#aaf3a4ba4968870a9fb857fe7f47f9461">lookupTable2</a> [16]</td></tr>
<tr class="separator:aaf3a4ba4968870a9fb857fe7f47f9461"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Sensor driver for BME680 sensor. </p>
</div><h2 class="groupheader">Variable Documentation</h2>
<a id="adededc333f13a6bae1487b7cadee4a5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adededc333f13a6bae1487b7cadee4a5f">&#9670;&nbsp;</a></span>lookupTable1</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t lookupTable1[16]</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= { UINT32_C(2147483647), UINT32_C(2147483647), UINT32_C(2147483647), UINT32_C(2147483647),</div><div class="line"> UINT32_C(2147483647), UINT32_C(2126008810), UINT32_C(2147483647), UINT32_C(2130303777), UINT32_C(2147483647),</div><div class="line"> UINT32_C(2147483647), UINT32_C(2143188679), UINT32_C(2136746228), UINT32_C(2147483647), UINT32_C(2126008810),</div><div class="line"> UINT32_C(2147483647), UINT32_C(2147483647) }</div></div><!-- fragment --><p>static variables Look up table for the possible gas range values </p>
</div>
</div>
<a id="aaf3a4ba4968870a9fb857fe7f47f9461"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf3a4ba4968870a9fb857fe7f47f9461">&#9670;&nbsp;</a></span>lookupTable2</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t lookupTable2[16]</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= { UINT32_C(4096000000), UINT32_C(2048000000), UINT32_C(1024000000), UINT32_C(512000000),</div><div class="line"> UINT32_C(255744255), UINT32_C(127110228), UINT32_C(64000000), UINT32_C(32258064), UINT32_C(16016016), UINT32_C(</div><div class="line"> 8000000), UINT32_C(4000000), UINT32_C(2000000), UINT32_C(1000000), UINT32_C(500000), UINT32_C(250000),</div><div class="line"> UINT32_C(125000) }</div></div><!-- fragment --><p>Look up table for the possible gas range values </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>