mgeppert/Tasmota
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity
7ad979163f
Tasmota/lib/Adafruit_BME680-1.0.5/docs/class_adafruit___b_m_e680.html
arendst 9c9a80f7b6 v5.11.0 
5.11.0 20180107
 * Minor webpage HTML optimizations (#1358)
 * Updated
German translation (#1438)
 * Change Sonoff Pow Energy MQTT data message
and consolidate Status 8 into Status 10
 * Change ADS1115 default
voltage range from +/-2V to +/-6V (#1289)
 * Change text to Active for 3
minutes (#1364)
 * Change Wemo SetBinaryState to distinguish from
GetBinaryState (#1357)
 * Change output of HTTP command to valid JSON
and Array only (#1363)
 * Removed all MQTT, JSON and Command language
defines from locale files and set fixed to English (#1473)
 * Renamed
commands Color2,3,4 to Color3,4,5
 * Fix BME280 calculation (#1051)
 *
Fix Sonoff Bridge missed learned key if learned data contains 0x55 (End
of Transmission) flag (#1095, #1294)
 * Fix PWM initialization in
Dimmer/Color mode (#1321)
 * Fix Wemo Emulation (#1357)
 * Fix display
of build date and time in non-english locale (#1465)
 * Fix Wemo and Hue
emulation by adding M-Search response delay (#1486)
 * Add libraries
Adafruit_BME680-1.0.5, Adafruit_Sensor-1.0.2.02, TasmotaSerial-1.0.0 and
TSL2561-Arduino-Library
 * Add command Color2 to set color while keeping
same dimmer value
 * Add device function pointers
 * Add support for
SenseAir S8 CO2 sensor
 * Add color led signal to Carbon Dioxide (CO2)
sensors using defines CO2_LOW and CO2_HIGH in user_config.h
 * Add
support for Domoticz Air Quality sensor to be used by MH-Z19(B) and
SenseAir sensors
 * Add support for PZEM004T energy sensor
 * Add
support for iTead SI7021 temperature and humidity sensor by
consolidating DHT22 into AM2301 and using former DHT22 as SI7021 (#735)

* Add support for BME680 using adafruit libraries (#1212)
 * Add support
for MH-Z19(B) CO2 sensor (#561, #1248)
 * Add multipress support and
more user configurable GPIO to Sonoff Dual R2 (#1291)
 * Add support for
TSL2561 using adafruit library (#661, #1311)
 * Add support for SHT3x
(#1314)
 * Add support for Arilux LC06 (#1414)
 * Add Italian language
file (#1449)
 * Add 2nd Gen Alexa support to Wemo emulation discovery
(#1357, #1450)
 * Add define for additional number of WS2812 schemes
(#1463)
2018-01-07 14:40:37 +01:00

538 lines
30 KiB
HTML
Raw Blame History

<!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: Adafruit_BME680 Class 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-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="class_adafruit___b_m_e680-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Adafruit_BME680 Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="_adafruit___b_m_e680_8h_source.html">Adafruit_BME680.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af147d564868b9eac61a2c7fcd8f614cd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___b_m_e680.html#af147d564868b9eac61a2c7fcd8f614cd">Adafruit_BME680</a> (int8_t cspin=-1)</td></tr>
<tr class="memdesc:af147d564868b9eac61a2c7fcd8f614cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Instantiates sensor with Hardware SPI or I2C. <a href="#af147d564868b9eac61a2c7fcd8f614cd">More...</a><br /></td></tr>
<tr class="separator:af147d564868b9eac61a2c7fcd8f614cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e89aaed66497bb2dde7ab678aa81173"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___b_m_e680.html#a8e89aaed66497bb2dde7ab678aa81173">Adafruit_BME680</a> (int8_t cspin, int8_t mosipin, int8_t misopin, int8_t sckpin)</td></tr>
<tr class="memdesc:a8e89aaed66497bb2dde7ab678aa81173"><td class="mdescLeft">&#160;</td><td class="mdescRight">Instantiates sensor with Software (bit-bang) SPI. <a href="#a8e89aaed66497bb2dde7ab678aa81173">More...</a><br /></td></tr>
<tr class="separator:a8e89aaed66497bb2dde7ab678aa81173"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6d9d5dc90424c2c3c3a3b311c1141dc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___b_m_e680.html#ac6d9d5dc90424c2c3c3a3b311c1141dc">begin</a> (uint8_t addr=BME680_DEFAULT_ADDRESS)</td></tr>
<tr class="memdesc:ac6d9d5dc90424c2c3c3a3b311c1141dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the sensor. <a href="#ac6d9d5dc90424c2c3c3a3b311c1141dc">More...</a><br /></td></tr>
<tr class="separator:ac6d9d5dc90424c2c3c3a3b311c1141dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b554e6edf5cea06cf480e53bcb65aec"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___b_m_e680.html#a7b554e6edf5cea06cf480e53bcb65aec">readTemperature</a> (void)</td></tr>
<tr class="memdesc:a7b554e6edf5cea06cf480e53bcb65aec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs a reading and returns the ambient temperature. <a href="#a7b554e6edf5cea06cf480e53bcb65aec">More...</a><br /></td></tr>
<tr class="separator:a7b554e6edf5cea06cf480e53bcb65aec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd081183a7845fee1d1c080cce20495e"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___b_m_e680.html#afd081183a7845fee1d1c080cce20495e">readPressure</a> (void)</td></tr>
<tr class="memdesc:afd081183a7845fee1d1c080cce20495e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs a reading and returns the barometric pressure. <a href="#afd081183a7845fee1d1c080cce20495e">More...</a><br /></td></tr>
<tr class="separator:afd081183a7845fee1d1c080cce20495e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1402c97860f9c61bf133be7e7056658b"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___b_m_e680.html#a1402c97860f9c61bf133be7e7056658b">readHumidity</a> (void)</td></tr>
<tr class="memdesc:a1402c97860f9c61bf133be7e7056658b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs a reading and returns the relative humidity. <a href="#a1402c97860f9c61bf133be7e7056658b">More...</a><br /></td></tr>
<tr class="separator:a1402c97860f9c61bf133be7e7056658b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0b55eb1049c5949ff186de86aaafb55"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___b_m_e680.html#ae0b55eb1049c5949ff186de86aaafb55">readGas</a> (void)</td></tr>
<tr class="memdesc:ae0b55eb1049c5949ff186de86aaafb55"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculates the resistance of the MOX gas sensor. <a href="#ae0b55eb1049c5949ff186de86aaafb55">More...</a><br /></td></tr>
<tr class="separator:ae0b55eb1049c5949ff186de86aaafb55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3caae92aa981508f0084b11b1fed4883"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___b_m_e680.html#a3caae92aa981508f0084b11b1fed4883">readAltitude</a> (float seaLevel)</td></tr>
<tr class="memdesc:a3caae92aa981508f0084b11b1fed4883"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculates the altitude (in meters). <a href="#a3caae92aa981508f0084b11b1fed4883">More...</a><br /></td></tr>
<tr class="separator:a3caae92aa981508f0084b11b1fed4883"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a640ee0a0cb7ca57af30e8408260cc6e6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___b_m_e680.html#a640ee0a0cb7ca57af30e8408260cc6e6">setTemperatureOversampling</a> (uint8_t os)</td></tr>
<tr class="memdesc:a640ee0a0cb7ca57af30e8408260cc6e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setter for Temperature oversampling. <a href="#a640ee0a0cb7ca57af30e8408260cc6e6">More...</a><br /></td></tr>
<tr class="separator:a640ee0a0cb7ca57af30e8408260cc6e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73a9467c838951a187a268172a2b5d8c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___b_m_e680.html#a73a9467c838951a187a268172a2b5d8c">setPressureOversampling</a> (uint8_t os)</td></tr>
<tr class="memdesc:a73a9467c838951a187a268172a2b5d8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setter for Pressure oversampling. <a href="#a73a9467c838951a187a268172a2b5d8c">More...</a><br /></td></tr>
<tr class="separator:a73a9467c838951a187a268172a2b5d8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1f05d2f024e946c1d7cbe3fb90b0859"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___b_m_e680.html#af1f05d2f024e946c1d7cbe3fb90b0859">setHumidityOversampling</a> (uint8_t os)</td></tr>
<tr class="memdesc:af1f05d2f024e946c1d7cbe3fb90b0859"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setter for Humidity oversampling. <a href="#af1f05d2f024e946c1d7cbe3fb90b0859">More...</a><br /></td></tr>
<tr class="separator:af1f05d2f024e946c1d7cbe3fb90b0859"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42f25a4f258aad9abad4abb6bd95ec77"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___b_m_e680.html#a42f25a4f258aad9abad4abb6bd95ec77">setIIRFilterSize</a> (uint8_t fs)</td></tr>
<tr class="memdesc:a42f25a4f258aad9abad4abb6bd95ec77"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setter for IIR filter. <a href="#a42f25a4f258aad9abad4abb6bd95ec77">More...</a><br /></td></tr>
<tr class="separator:a42f25a4f258aad9abad4abb6bd95ec77"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e6a61b5441c51bf5e44c3af3ee3fec8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___b_m_e680.html#a2e6a61b5441c51bf5e44c3af3ee3fec8">setGasHeater</a> (uint16_t heaterTemp, uint16_t heaterTime)</td></tr>
<tr class="memdesc:a2e6a61b5441c51bf5e44c3af3ee3fec8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable and configure gas reading + heater. <a href="#a2e6a61b5441c51bf5e44c3af3ee3fec8">More...</a><br /></td></tr>
<tr class="separator:a2e6a61b5441c51bf5e44c3af3ee3fec8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa58210864cad77b272669eb86f1d2a88"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___b_m_e680.html#aa58210864cad77b272669eb86f1d2a88">performReading</a> (void)</td></tr>
<tr class="memdesc:aa58210864cad77b272669eb86f1d2a88"><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs a full reading of all 4 sensors in the BME680. <a href="#aa58210864cad77b272669eb86f1d2a88">More...</a><br /></td></tr>
<tr class="separator:aa58210864cad77b272669eb86f1d2a88"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a074501406d2bf249551e3e489cb9316e"><td class="memItemLeft" align="right" valign="top"><a id="a074501406d2bf249551e3e489cb9316e"></a>
float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___b_m_e680.html#a074501406d2bf249551e3e489cb9316e">temperature</a></td></tr>
<tr class="memdesc:a074501406d2bf249551e3e489cb9316e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Temperature (Celsius) assigned after calling <a class="el" href="class_adafruit___b_m_e680.html#aa58210864cad77b272669eb86f1d2a88" title="Performs a full reading of all 4 sensors in the BME680. ">performReading()</a> <br /></td></tr>
<tr class="separator:a074501406d2bf249551e3e489cb9316e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a956b36e719ef0b37e59e6c3ecb8c5583"><td class="memItemLeft" align="right" valign="top"><a id="a956b36e719ef0b37e59e6c3ecb8c5583"></a>
float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___b_m_e680.html#a956b36e719ef0b37e59e6c3ecb8c5583">pressure</a></td></tr>
<tr class="memdesc:a956b36e719ef0b37e59e6c3ecb8c5583"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pressure (Pascals) assigned after calling <a class="el" href="class_adafruit___b_m_e680.html#aa58210864cad77b272669eb86f1d2a88" title="Performs a full reading of all 4 sensors in the BME680. ">performReading()</a> <br /></td></tr>
<tr class="separator:a956b36e719ef0b37e59e6c3ecb8c5583"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a442787f3ad0f2ab9087535ba9c22102b"><td class="memItemLeft" align="right" valign="top"><a id="a442787f3ad0f2ab9087535ba9c22102b"></a>
float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___b_m_e680.html#a442787f3ad0f2ab9087535ba9c22102b">humidity</a></td></tr>
<tr class="memdesc:a442787f3ad0f2ab9087535ba9c22102b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Humidity (RH %) assigned after calling <a class="el" href="class_adafruit___b_m_e680.html#aa58210864cad77b272669eb86f1d2a88" title="Performs a full reading of all 4 sensors in the BME680. ">performReading()</a> <br /></td></tr>
<tr class="separator:a442787f3ad0f2ab9087535ba9c22102b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef05921539684ec297168bdd0cee7c7c"><td class="memItemLeft" align="right" valign="top"><a id="aef05921539684ec297168bdd0cee7c7c"></a>
float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___b_m_e680.html#aef05921539684ec297168bdd0cee7c7c">gas_resistance</a></td></tr>
<tr class="memdesc:aef05921539684ec297168bdd0cee7c7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gas resistor (ohms) assigned after calling <a class="el" href="class_adafruit___b_m_e680.html#aa58210864cad77b272669eb86f1d2a88" title="Performs a full reading of all 4 sensors in the BME680. ">performReading()</a> <br /></td></tr>
<tr class="separator:aef05921539684ec297168bdd0cee7c7c"><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><a class="el" href="class_adafruit___b_m_e680.html">Adafruit_BME680</a> Class for both I2C and SPI usage. Wraps the Bosch library for Arduino usage </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af147d564868b9eac61a2c7fcd8f614cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af147d564868b9eac61a2c7fcd8f614cd">&#9670;&nbsp;</a></span>Adafruit_BME680() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Adafruit_BME680::Adafruit_BME680 </td>
<td>(</td>
<td class="paramtype">int8_t&#160;</td>
<td class="paramname"><em>cspin</em> = <code>-1</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Instantiates sensor with Hardware SPI or I2C. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cspin</td><td>SPI chip select. If not passed in, I2C will be used </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8e89aaed66497bb2dde7ab678aa81173"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e89aaed66497bb2dde7ab678aa81173">&#9670;&nbsp;</a></span>Adafruit_BME680() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Adafruit_BME680::Adafruit_BME680 </td>
<td>(</td>
<td class="paramtype">int8_t&#160;</td>
<td class="paramname"><em>cspin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int8_t&#160;</td>
<td class="paramname"><em>mosipin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int8_t&#160;</td>
<td class="paramname"><em>misopin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int8_t&#160;</td>
<td class="paramname"><em>sckpin</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Instantiates sensor with Software (bit-bang) SPI. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cspin</td><td>SPI chip select </td></tr>
<tr><td class="paramname">mosipin</td><td>SPI MOSI (Data from microcontroller to sensor) </td></tr>
<tr><td class="paramname">misopin</td><td>SPI MISO (Data to microcontroller from sensor) </td></tr>
<tr><td class="paramname">sckpin</td><td>SPI Clock </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac6d9d5dc90424c2c3c3a3b311c1141dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac6d9d5dc90424c2c3c3a3b311c1141dc">&#9670;&nbsp;</a></span>begin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Adafruit_BME680::begin </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>addr</em> = <code>BME680_DEFAULT_ADDRESS</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes the sensor. </p>
<p>Hardware ss initialized, verifies it is in the I2C or SPI bus, then reads calibration data in preparation for sensor reads.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">addr</td><td>Optional parameter for the I2C address of BME680. Default is 0x77 </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on sensor initialization success. False on failure. </dd></dl>
</div>
</div>
<a id="aa58210864cad77b272669eb86f1d2a88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa58210864cad77b272669eb86f1d2a88">&#9670;&nbsp;</a></span>performReading()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Adafruit_BME680::performReading </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs a full reading of all 4 sensors in the BME680. </p>
<p>Assigns the internal <a class="el" href="class_adafruit___b_m_e680.html#a074501406d2bf249551e3e489cb9316e" title="Temperature (Celsius) assigned after calling performReading() ">Adafruit_BME680::temperature</a>, <a class="el" href="class_adafruit___b_m_e680.html#a956b36e719ef0b37e59e6c3ecb8c5583" title="Pressure (Pascals) assigned after calling performReading() ">Adafruit_BME680::pressure</a>, <a class="el" href="class_adafruit___b_m_e680.html#a442787f3ad0f2ab9087535ba9c22102b" title="Humidity (RH %) assigned after calling performReading() ">Adafruit_BME680::humidity</a> and <a class="el" href="class_adafruit___b_m_e680.html#aef05921539684ec297168bdd0cee7c7c" title="Gas resistor (ohms) assigned after calling performReading() ">Adafruit_BME680::gas_resistance</a> member variables</p>
<dl class="section return"><dt>Returns</dt><dd>True on success, False on failure </dd></dl>
</div>
</div>
<a id="a3caae92aa981508f0084b11b1fed4883"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3caae92aa981508f0084b11b1fed4883">&#9670;&nbsp;</a></span>readAltitude()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float Adafruit_BME680::readAltitude </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>seaLevel</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculates the altitude (in meters). </p>
<p>Reads the current atmostpheric pressure (in hPa) from the sensor and calculates via the provided sea-level pressure (in hPa).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">seaLevel</td><td>Sea-level pressure in hPa </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Altitude in meters </dd></dl>
</div>
</div>
<a id="ae0b55eb1049c5949ff186de86aaafb55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0b55eb1049c5949ff186de86aaafb55">&#9670;&nbsp;</a></span>readGas()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t Adafruit_BME680::readGas </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculates the resistance of the MOX gas sensor. </p>
<dl class="section return"><dt>Returns</dt><dd>Resistance in Ohms </dd></dl>
</div>
</div>
<a id="a1402c97860f9c61bf133be7e7056658b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1402c97860f9c61bf133be7e7056658b">&#9670;&nbsp;</a></span>readHumidity()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float Adafruit_BME680::readHumidity </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs a reading and returns the relative humidity. </p>
<dl class="section return"><dt>Returns</dt><dd>Relative humidity as floating point </dd></dl>
</div>
</div>
<a id="afd081183a7845fee1d1c080cce20495e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd081183a7845fee1d1c080cce20495e">&#9670;&nbsp;</a></span>readPressure()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float Adafruit_BME680::readPressure </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs a reading and returns the barometric pressure. </p>
<dl class="section return"><dt>Returns</dt><dd>Barometic pressure in Pascals </dd></dl>
</div>
</div>
<a id="a7b554e6edf5cea06cf480e53bcb65aec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b554e6edf5cea06cf480e53bcb65aec">&#9670;&nbsp;</a></span>readTemperature()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float Adafruit_BME680::readTemperature </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs a reading and returns the ambient temperature. </p>
<dl class="section return"><dt>Returns</dt><dd>Temperature in degrees Centigrade </dd></dl>
</div>
</div>
<a id="a2e6a61b5441c51bf5e44c3af3ee3fec8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e6a61b5441c51bf5e44c3af3ee3fec8">&#9670;&nbsp;</a></span>setGasHeater()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Adafruit_BME680::setGasHeater </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>heaterTemp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>heaterTime</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable and configure gas reading + heater. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">heaterTemp</td><td>Desired temperature in degrees Centigrade </td></tr>
<tr><td class="paramname">heaterTime</td><td>Time to keep heater on in milliseconds </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on success, False on failure </dd></dl>
</div>
</div>
<a id="af1f05d2f024e946c1d7cbe3fb90b0859"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1f05d2f024e946c1d7cbe3fb90b0859">&#9670;&nbsp;</a></span>setHumidityOversampling()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Adafruit_BME680::setHumidityOversampling </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>oversample</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Setter for Humidity oversampling. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">oversample</td><td>Oversampling setting, can be BME680_OS_NONE (turn off Humidity reading), BME680_OS_1X, BME680_OS_2X, BME680_OS_4X, BME680_OS_8X or BME680_OS_16X </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on success, False on failure </dd></dl>
</div>
</div>
<a id="a42f25a4f258aad9abad4abb6bd95ec77"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42f25a4f258aad9abad4abb6bd95ec77">&#9670;&nbsp;</a></span>setIIRFilterSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Adafruit_BME680::setIIRFilterSize </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>filtersize</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Setter for IIR filter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filtersize</td><td>Size of the filter (in samples). Can be BME680_FILTER_SIZE_0 (no filtering), BME680_FILTER_SIZE_1, BME680_FILTER_SIZE_3, BME680_FILTER_SIZE_7, BME680_FILTER_SIZE_15, BME680_FILTER_SIZE_31, BME680_FILTER_SIZE_63, BME680_FILTER_SIZE_127 </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on success, False on failure </dd></dl>
</div>
</div>
<a id="a73a9467c838951a187a268172a2b5d8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73a9467c838951a187a268172a2b5d8c">&#9670;&nbsp;</a></span>setPressureOversampling()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Adafruit_BME680::setPressureOversampling </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>os</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Setter for Pressure oversampling. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">oversample</td><td>Oversampling setting, can be BME680_OS_NONE (turn off Pressure reading), BME680_OS_1X, BME680_OS_2X, BME680_OS_4X, BME680_OS_8X or BME680_OS_16X </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on success, False on failure </dd></dl>
</div>
</div>
<a id="a640ee0a0cb7ca57af30e8408260cc6e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a640ee0a0cb7ca57af30e8408260cc6e6">&#9670;&nbsp;</a></span>setTemperatureOversampling()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Adafruit_BME680::setTemperatureOversampling </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>oversample</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Setter for Temperature oversampling. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">oversample</td><td>Oversampling setting, can be BME680_OS_NONE (turn off Temperature reading), BME680_OS_1X, BME680_OS_2X, BME680_OS_4X, BME680_OS_8X or BME680_OS_16X </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on success, False on failure </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_adafruit___b_m_e680_8h_source.html">Adafruit_BME680.h</a></li>
<li>Adafruit_BME680.cpp</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>
Reference in New Issue View Git Blame Copy Permalink