mirror of https://github.com/arendst/Tasmota.git
130 lines
14 KiB
HTML
130 lines
14 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 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> </div>
|
|
<div class="headertitle">
|
|
<div class="title">bme680.h 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 "<a class="el" href="bme680__defs_8h_source.html">bme680_defs.h</a>"</code><br />
|
|
</div>
|
|
<p><a href="bme680_8h_source.html">Go to the source code of this file.</a></p>
|
|
<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 </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"> </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"> </td></tr>
|
|
<tr class="memitem:ga5d1bad74f7ac28e75aca9d7de66fd2b4"><td class="memItemLeft" align="right" valign="top">int8_t </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"> </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"> </td></tr>
|
|
<tr class="memitem:gaf5548cbdbf327e2c77bdb0afb1dde9e4"><td class="memItemLeft" align="right" valign="top">int8_t </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"> </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"> </td></tr>
|
|
<tr class="memitem:ga7f0f1a4378bc6cd0a34acf62509cdec7"><td class="memItemLeft" align="right" valign="top">int8_t </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"> </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"> </td></tr>
|
|
<tr class="memitem:ga5ca765226e758e71c862553c7cc0b371"><td class="memItemLeft" align="right" valign="top">int8_t </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"> </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"> </td></tr>
|
|
<tr class="memitem:ga4e50492a1f4747868f7e9a826492f1e7"><td class="memItemLeft" align="right" valign="top">int8_t </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"> </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"> </td></tr>
|
|
<tr class="memitem:ga192f772bc9cb619e5855e93d6ebd6128"><td class="memItemLeft" align="right" valign="top">void </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"> </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"> </td></tr>
|
|
<tr class="memitem:ga191c03ab8aa1f4bc440953fd2f6317c2"><td class="memItemLeft" align="right" valign="top">void </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"> </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"> </td></tr>
|
|
<tr class="memitem:ga1025301e420e1e21911044bebb62f940"><td class="memItemLeft" align="right" valign="top">int8_t </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"> </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"> </td></tr>
|
|
<tr class="memitem:ga2fea1365b4fa1d33eef434769b16e811"><td class="memItemLeft" align="right" valign="top">int8_t </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"> </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"> </td></tr>
|
|
<tr class="memitem:ga7826b058b8eddcf05ccbb117fd9d41b7"><td class="memItemLeft" align="right" valign="top">int8_t </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"> </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"> </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>
|
|
<p>Copyright (C) 2017 - 2018 Bosch Sensortec GmbH</p>
|
|
<p>Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:</p>
|
|
<p>Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.</p>
|
|
<p>Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.</p>
|
|
<p>Neither the name of the copyright holder nor the names of the contributors may be used to endorse or promote products derived from this software without specific prior written permission.</p>
|
|
<p>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE</p>
|
|
<p>The information provided is believed to be accurate and reliable. The copyright holder assumes no responsibility for the consequences of use of such information nor for any infringement of patents or other rights of third parties which may result from its use. No license is granted by implication or otherwise under any patent or patent rights of the copyright holder.</p>
|
|
<dl class="section date"><dt>Date</dt><dd>5 Jul 2017 </dd></dl>
|
|
<dl class="section version"><dt>Version</dt><dd>3.5.1</dd></dl>
|
|
</div></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>
|