Tasmota/lib/Adafruit_BME680-1.0.5/docs/structbme680__dev.html

347 lines
16 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_dev Struct 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="#pub-attribs">Public Attributes</a> &#124;
<a href="structbme680__dev-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">bme680_dev Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>BME680 device structure.
<a href="structbme680__dev.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="bme680__defs_8h_source.html">bme680_defs.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a3698643172429ac7a5d9fd8d7a37c283"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbme680__dev.html#a3698643172429ac7a5d9fd8d7a37c283">chip_id</a></td></tr>
<tr class="separator:a3698643172429ac7a5d9fd8d7a37c283"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71b6ddedf9606872d64bc6239b8e5838"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbme680__dev.html#a71b6ddedf9606872d64bc6239b8e5838">dev_id</a></td></tr>
<tr class="separator:a71b6ddedf9606872d64bc6239b8e5838"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6000144e9ce5cca76d3945f61b1d4ac9"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="bme680__defs_8h.html#a2232c03d0c1282e976af41b39e1b87d6">bme680_intf</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbme680__dev.html#a6000144e9ce5cca76d3945f61b1d4ac9">intf</a></td></tr>
<tr class="separator:a6000144e9ce5cca76d3945f61b1d4ac9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a388e543d88b93a2a5c91e1f66ed0e998"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbme680__dev.html#a388e543d88b93a2a5c91e1f66ed0e998">mem_page</a></td></tr>
<tr class="separator:a388e543d88b93a2a5c91e1f66ed0e998"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9b2a0368dcafa1a6ea9e4e3ae84c77b"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbme680__dev.html#ae9b2a0368dcafa1a6ea9e4e3ae84c77b">amb_temp</a></td></tr>
<tr class="separator:ae9b2a0368dcafa1a6ea9e4e3ae84c77b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad73f25d84281fa4fbc15c1b40cfc0fb7"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structbme680__calib__data.html">bme680_calib_data</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbme680__dev.html#ad73f25d84281fa4fbc15c1b40cfc0fb7">calib</a></td></tr>
<tr class="separator:ad73f25d84281fa4fbc15c1b40cfc0fb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38a17360e0b57778b734393e80819294"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structbme680__tph__sett.html">bme680_tph_sett</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbme680__dev.html#a38a17360e0b57778b734393e80819294">tph_sett</a></td></tr>
<tr class="separator:a38a17360e0b57778b734393e80819294"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf0d4528b207d86b53e14a907bb3d7b8"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structbme680__gas__sett.html">bme680_gas_sett</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbme680__dev.html#aaf0d4528b207d86b53e14a907bb3d7b8">gas_sett</a></td></tr>
<tr class="separator:aaf0d4528b207d86b53e14a907bb3d7b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b2b2947aa6a6e336c90811373de1a6b"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbme680__dev.html#a7b2b2947aa6a6e336c90811373de1a6b">power_mode</a></td></tr>
<tr class="separator:a7b2b2947aa6a6e336c90811373de1a6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a488698f8c1c548bb19ac1f8ee67cbadd"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbme680__dev.html#a488698f8c1c548bb19ac1f8ee67cbadd">new_fields</a></td></tr>
<tr class="separator:a488698f8c1c548bb19ac1f8ee67cbadd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7bb14424d37da3c8fb0a527b7967a0d5"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbme680__dev.html#a7bb14424d37da3c8fb0a527b7967a0d5">info_msg</a></td></tr>
<tr class="separator:a7bb14424d37da3c8fb0a527b7967a0d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa36aaa5af7488e1a9dce5b8b834b1956"><td class="memItemLeft" align="right" valign="top"><a class="el" href="bme680__defs_8h.html#aa7d183195e66f1db50f64f3a3d4ede57">bme680_com_fptr_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbme680__dev.html#aa36aaa5af7488e1a9dce5b8b834b1956">read</a></td></tr>
<tr class="separator:aa36aaa5af7488e1a9dce5b8b834b1956"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e1e5dad78b9831125c240dde61b13a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="bme680__defs_8h.html#aa7d183195e66f1db50f64f3a3d4ede57">bme680_com_fptr_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbme680__dev.html#a5e1e5dad78b9831125c240dde61b13a2">write</a></td></tr>
<tr class="separator:a5e1e5dad78b9831125c240dde61b13a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac34a77bcf24d1f64fd53d3dcf23525a8"><td class="memItemLeft" align="right" valign="top">bme680_delay_fptr_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbme680__dev.html#ac34a77bcf24d1f64fd53d3dcf23525a8">delay_ms</a></td></tr>
<tr class="separator:ac34a77bcf24d1f64fd53d3dcf23525a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9baa012a046e51257ced31c2af0b01e5"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbme680__dev.html#a9baa012a046e51257ced31c2af0b01e5">com_rslt</a></td></tr>
<tr class="separator:a9baa012a046e51257ced31c2af0b01e5"><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>BME680 device structure. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="ae9b2a0368dcafa1a6ea9e4e3ae84c77b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9b2a0368dcafa1a6ea9e4e3ae84c77b">&#9670;&nbsp;</a></span>amb_temp</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int8_t bme680_dev::amb_temp</td>
</tr>
</table>
</div><div class="memdoc">
<p>Ambient temperature in Degree C </p>
</div>
</div>
<a id="ad73f25d84281fa4fbc15c1b40cfc0fb7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad73f25d84281fa4fbc15c1b40cfc0fb7">&#9670;&nbsp;</a></span>calib</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structbme680__calib__data.html">bme680_calib_data</a> bme680_dev::calib</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sensor calibration data </p>
</div>
</div>
<a id="a3698643172429ac7a5d9fd8d7a37c283"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3698643172429ac7a5d9fd8d7a37c283">&#9670;&nbsp;</a></span>chip_id</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t bme680_dev::chip_id</td>
</tr>
</table>
</div><div class="memdoc">
<p>Chip Id </p>
</div>
</div>
<a id="a9baa012a046e51257ced31c2af0b01e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9baa012a046e51257ced31c2af0b01e5">&#9670;&nbsp;</a></span>com_rslt</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int8_t bme680_dev::com_rslt</td>
</tr>
</table>
</div><div class="memdoc">
<p>Communication function result </p>
</div>
</div>
<a id="ac34a77bcf24d1f64fd53d3dcf23525a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac34a77bcf24d1f64fd53d3dcf23525a8">&#9670;&nbsp;</a></span>delay_ms</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bme680_delay_fptr_t bme680_dev::delay_ms</td>
</tr>
</table>
</div><div class="memdoc">
<p>Delay in ms </p>
</div>
</div>
<a id="a71b6ddedf9606872d64bc6239b8e5838"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71b6ddedf9606872d64bc6239b8e5838">&#9670;&nbsp;</a></span>dev_id</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t bme680_dev::dev_id</td>
</tr>
</table>
</div><div class="memdoc">
<p>Device Id </p>
</div>
</div>
<a id="aaf0d4528b207d86b53e14a907bb3d7b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf0d4528b207d86b53e14a907bb3d7b8">&#9670;&nbsp;</a></span>gas_sett</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structbme680__gas__sett.html">bme680_gas_sett</a> bme680_dev::gas_sett</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gas Sensor settings </p>
</div>
</div>
<a id="a7bb14424d37da3c8fb0a527b7967a0d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7bb14424d37da3c8fb0a527b7967a0d5">&#9670;&nbsp;</a></span>info_msg</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t bme680_dev::info_msg</td>
</tr>
</table>
</div><div class="memdoc">
<p>Store the info messages </p>
</div>
</div>
<a id="a6000144e9ce5cca76d3945f61b1d4ac9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6000144e9ce5cca76d3945f61b1d4ac9">&#9670;&nbsp;</a></span>intf</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="bme680__defs_8h.html#a2232c03d0c1282e976af41b39e1b87d6">bme680_intf</a> bme680_dev::intf</td>
</tr>
</table>
</div><div class="memdoc">
<p>SPI/I2C interface </p>
</div>
</div>
<a id="a388e543d88b93a2a5c91e1f66ed0e998"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a388e543d88b93a2a5c91e1f66ed0e998">&#9670;&nbsp;</a></span>mem_page</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t bme680_dev::mem_page</td>
</tr>
</table>
</div><div class="memdoc">
<p>Memory page used </p>
</div>
</div>
<a id="a488698f8c1c548bb19ac1f8ee67cbadd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a488698f8c1c548bb19ac1f8ee67cbadd">&#9670;&nbsp;</a></span>new_fields</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t bme680_dev::new_fields</td>
</tr>
</table>
</div><div class="memdoc">
<p>New sensor fields </p>
</div>
</div>
<a id="a7b2b2947aa6a6e336c90811373de1a6b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b2b2947aa6a6e336c90811373de1a6b">&#9670;&nbsp;</a></span>power_mode</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t bme680_dev::power_mode</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sensor power modes </p>
</div>
</div>
<a id="aa36aaa5af7488e1a9dce5b8b834b1956"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa36aaa5af7488e1a9dce5b8b834b1956">&#9670;&nbsp;</a></span>read</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="bme680__defs_8h.html#aa7d183195e66f1db50f64f3a3d4ede57">bme680_com_fptr_t</a> bme680_dev::read</td>
</tr>
</table>
</div><div class="memdoc">
<p>Burst read structure </p>
</div>
</div>
<a id="a38a17360e0b57778b734393e80819294"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38a17360e0b57778b734393e80819294">&#9670;&nbsp;</a></span>tph_sett</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structbme680__tph__sett.html">bme680_tph_sett</a> bme680_dev::tph_sett</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sensor settings </p>
</div>
</div>
<a id="a5e1e5dad78b9831125c240dde61b13a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e1e5dad78b9831125c240dde61b13a2">&#9670;&nbsp;</a></span>write</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="bme680__defs_8h.html#aa7d183195e66f1db50f64f3a3d4ede57">bme680_com_fptr_t</a> bme680_dev::write</td>
</tr>
</table>
</div><div class="memdoc">
<p>Burst write structure </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="bme680__defs_8h_source.html">bme680_defs.h</a></li>
</ul>
</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>