ESPHome  2022.11.3
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::bme680::BME680Component Class Reference

#include <bme680.h>

Inheritance diagram for esphome::bme680::BME680Component:
esphome::PollingComponent esphome::i2c::I2CDevice esphome::Component

Public Member Functions

void set_temperature_oversampling (BME680Oversampling temperature_oversampling)
 Set the temperature oversampling value. Defaults to 16X. More...
 
void set_pressure_oversampling (BME680Oversampling pressure_oversampling)
 Set the pressure oversampling value. Defaults to 16X. More...
 
void set_humidity_oversampling (BME680Oversampling humidity_oversampling)
 Set the humidity oversampling value. Defaults to 16X. More...
 
void set_iir_filter (BME680IIRFilter iir_filter)
 Set the IIR Filter value. Defaults to no IIR Filter. More...
 
void set_temperature_sensor (sensor::Sensor *temperature_sensor)
 
void set_pressure_sensor (sensor::Sensor *pressure_sensor)
 
void set_humidity_sensor (sensor::Sensor *humidity_sensor)
 
void set_gas_resistance_sensor (sensor::Sensor *gas_resistance_sensor)
 
void set_heater (uint16_t heater_temperature, uint16_t heater_duration)
 Set how the internal heater should operate. More...
 
void setup () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void update () override
 
- Public Member Functions inherited from esphome::PollingComponent
 PollingComponent ()
 
 PollingComponent (uint32_t update_interval)
 Initialize this polling component with the given update interval in ms. More...
 
virtual void set_update_interval (uint32_t update_interval)
 Manually set the update interval in ms for this polling object. More...
 
void call_setup () override
 
virtual uint32_t get_update_interval () const
 Get the update interval in ms of this sensor. More...
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly. More...
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop(). More...
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
bool is_failed ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const std::string &name, uint32_t length=5000)
 
void status_momentary_error (const std::string &name, uint32_t length=5000)
 
bool has_overridden_loop () const
 
void set_component_source (const char *source)
 Set where this component was loaded from for some debug messages. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 
- Public Member Functions inherited from esphome::i2c::I2CDevice
 I2CDevice ()=default
 
void set_i2c_address (uint8_t address)
 
void set_i2c_bus (I2CBus *bus)
 
I2CRegister reg (uint8_t a_register)
 
ErrorCode read (uint8_t *data, size_t len)
 
ErrorCode read_register (uint8_t a_register, uint8_t *data, size_t len, bool stop=true)
 
ErrorCode write (const uint8_t *data, uint8_t len, bool stop=true)
 
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len, bool stop=true)
 
bool read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
 
bool read_bytes_raw (uint8_t *data, uint8_t len)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes (uint8_t a_register)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes_raw ()
 
bool read_bytes_16 (uint8_t a_register, uint16_t *data, uint8_t len)
 
bool read_byte (uint8_t a_register, uint8_t *data, bool stop=true)
 
optional< uint8_t > read_byte (uint8_t a_register)
 
bool read_byte_16 (uint8_t a_register, uint16_t *data)
 
bool write_bytes (uint8_t a_register, const uint8_t *data, uint8_t len, bool stop=true)
 
bool write_bytes (uint8_t a_register, const std::vector< uint8_t > &data)
 
template<size_t N>
bool write_bytes (uint8_t a_register, const std::array< uint8_t, N > &data)
 
bool write_bytes_16 (uint8_t a_register, const uint16_t *data, uint8_t len)
 
bool write_byte (uint8_t a_register, uint8_t data, bool stop=true)
 
bool write_byte_16 (uint8_t a_register, uint16_t data)
 

Protected Member Functions

uint8_t calc_heater_resistance_ (uint16_t temperature)
 Calculate the heater resistance value to send to the BME680 register. More...
 
uint8_t calc_heater_duration_ (uint16_t duration)
 Calculate the heater duration value to send to the BME680 register. More...
 
void read_data_ ()
 Read data from the BME680 and publish results. More...
 
float calc_temperature_ (uint32_t raw_temperature)
 Calculate the temperature in °C using the provided raw ADC value. More...
 
float calc_pressure_ (uint32_t raw_pressure)
 Calculate the pressure in hPa using the provided raw ADC value. More...
 
float calc_humidity_ (uint16_t raw_humidity)
 Calculate the relative humidity in % using the provided raw ADC value. More...
 
uint32_t calc_gas_resistance_ (uint16_t raw_gas, uint8_t range)
 Calculate the gas resistance in Ω using the provided raw ADC value. More...
 
uint32_t calc_meas_duration_ ()
 Calculate how long the sensor will take until we can retrieve data. More...
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_dump_config ()
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
void set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult()> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name. More...
 
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult()> &&f, float backoff_increase_factor=1.0f)
 
bool cancel_retry (const std::string &name)
 Cancel a retry function. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 

Protected Attributes

BME680CalibrationData calibration_
 
BME680Oversampling temperature_oversampling_ {BME680_OVERSAMPLING_16X}
 
BME680Oversampling pressure_oversampling_ {BME680_OVERSAMPLING_16X}
 
BME680Oversampling humidity_oversampling_ {BME680_OVERSAMPLING_16X}
 
BME680IIRFilter iir_filter_ {BME680_IIR_FILTER_OFF}
 
uint16_t heater_temperature_ {320}
 
uint16_t heater_duration_ {150}
 
sensor::Sensortemperature_sensor_ {nullptr}
 
sensor::Sensorpressure_sensor_ {nullptr}
 
sensor::Sensorhumidity_sensor_ {nullptr}
 
sensor::Sensorgas_resistance_sensor_ {nullptr}
 
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ {nullptr}
 
- Protected Attributes inherited from esphome::i2c::I2CDevice
uint8_t address_ {0x00}
 
I2CBusbus_ {nullptr}
 

Detailed Description

Definition at line 69 of file bme680.h.

Member Function Documentation

◆ calc_gas_resistance_()

uint32_t esphome::bme680::BME680Component::calc_gas_resistance_ ( uint16_t  raw_gas,
uint8_t  range 
)
protected

Calculate the gas resistance in Ω using the provided raw ADC value.

Definition at line 431 of file bme680.cpp.

◆ calc_heater_duration_()

uint8_t esphome::bme680::BME680Component::calc_heater_duration_ ( uint16_t  duration)
protected

Calculate the heater duration value to send to the BME680 register.

Definition at line 277 of file bme680.cpp.

◆ calc_heater_resistance_()

uint8_t esphome::bme680::BME680Component::calc_heater_resistance_ ( uint16_t  temperature)
protected

Calculate the heater resistance value to send to the BME680 register.

Definition at line 246 of file bme680.cpp.

◆ calc_humidity_()

float esphome::bme680::BME680Component::calc_humidity_ ( uint16_t  raw_humidity)
protected

Calculate the relative humidity in % using the provided raw ADC value.

Definition at line 395 of file bme680.cpp.

◆ calc_meas_duration_()

uint32_t esphome::bme680::BME680Component::calc_meas_duration_ ( )
protected

Calculate how long the sensor will take until we can retrieve data.

Definition at line 446 of file bme680.cpp.

◆ calc_pressure_()

float esphome::bme680::BME680Component::calc_pressure_ ( uint32_t  raw_pressure)
protected

Calculate the pressure in hPa using the provided raw ADC value.

Definition at line 353 of file bme680.cpp.

◆ calc_temperature_()

float esphome::bme680::BME680Component::calc_temperature_ ( uint32_t  raw_temperature)
protected

Calculate the temperature in °C using the provided raw ADC value.

Definition at line 327 of file bme680.cpp.

◆ dump_config()

void esphome::bme680::BME680Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 208 of file bme680.cpp.

◆ get_setup_priority()

float esphome::bme680::BME680Component::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 231 of file bme680.cpp.

◆ read_data_()

void esphome::bme680::BME680Component::read_data_ ( )
protected

Read data from the BME680 and publish results.

Definition at line 293 of file bme680.cpp.

◆ set_gas_resistance_sensor()

void esphome::bme680::BME680Component::set_gas_resistance_sensor ( sensor::Sensor gas_resistance_sensor)
inline

Definition at line 83 of file bme680.h.

◆ set_heater()

void esphome::bme680::BME680Component::set_heater ( uint16_t  heater_temperature,
uint16_t  heater_duration 
)

Set how the internal heater should operate.

By default, the heater is off. If you want to to have more reliable humidity and Gas Resistance values, you can however setup the heater with this method.

Parameters
heater_temperatureThe temperature of the heater in °C.
heater_durationThe duration in ms that the heater should turn on for when measuring.

Definition at line 479 of file bme680.cpp.

◆ set_humidity_oversampling()

void esphome::bme680::BME680Component::set_humidity_oversampling ( BME680Oversampling  humidity_oversampling)

Set the humidity oversampling value. Defaults to 16X.

Definition at line 475 of file bme680.cpp.

◆ set_humidity_sensor()

void esphome::bme680::BME680Component::set_humidity_sensor ( sensor::Sensor humidity_sensor)
inline

Definition at line 82 of file bme680.h.

◆ set_iir_filter()

void esphome::bme680::BME680Component::set_iir_filter ( BME680IIRFilter  iir_filter)

Set the IIR Filter value. Defaults to no IIR Filter.

Definition at line 478 of file bme680.cpp.

◆ set_pressure_oversampling()

void esphome::bme680::BME680Component::set_pressure_oversampling ( BME680Oversampling  pressure_oversampling)

Set the pressure oversampling value. Defaults to 16X.

Definition at line 472 of file bme680.cpp.

◆ set_pressure_sensor()

void esphome::bme680::BME680Component::set_pressure_sensor ( sensor::Sensor pressure_sensor)
inline

Definition at line 81 of file bme680.h.

◆ set_temperature_oversampling()

void esphome::bme680::BME680Component::set_temperature_oversampling ( BME680Oversampling  temperature_oversampling)

Set the temperature oversampling value. Defaults to 16X.

Definition at line 469 of file bme680.cpp.

◆ set_temperature_sensor()

void esphome::bme680::BME680Component::set_temperature_sensor ( sensor::Sensor temperature_sensor)
inline

Definition at line 80 of file bme680.h.

◆ setup()

void esphome::bme680::BME680Component::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 73 of file bme680.cpp.

◆ update()

void esphome::bme680::BME680Component::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 233 of file bme680.cpp.

Field Documentation

◆ calibration_

BME680CalibrationData esphome::bme680::BME680Component::calibration_
protected

Definition at line 124 of file bme680.h.

◆ gas_resistance_sensor_

sensor::Sensor* esphome::bme680::BME680Component::gas_resistance_sensor_ {nullptr}
protected

Definition at line 135 of file bme680.h.

◆ heater_duration_

uint16_t esphome::bme680::BME680Component::heater_duration_ {150}
protected

Definition at line 130 of file bme680.h.

◆ heater_temperature_

uint16_t esphome::bme680::BME680Component::heater_temperature_ {320}
protected

Definition at line 129 of file bme680.h.

◆ humidity_oversampling_

BME680Oversampling esphome::bme680::BME680Component::humidity_oversampling_ {BME680_OVERSAMPLING_16X}
protected

Definition at line 127 of file bme680.h.

◆ humidity_sensor_

sensor::Sensor* esphome::bme680::BME680Component::humidity_sensor_ {nullptr}
protected

Definition at line 134 of file bme680.h.

◆ iir_filter_

BME680IIRFilter esphome::bme680::BME680Component::iir_filter_ {BME680_IIR_FILTER_OFF}
protected

Definition at line 128 of file bme680.h.

◆ pressure_oversampling_

BME680Oversampling esphome::bme680::BME680Component::pressure_oversampling_ {BME680_OVERSAMPLING_16X}
protected

Definition at line 126 of file bme680.h.

◆ pressure_sensor_

sensor::Sensor* esphome::bme680::BME680Component::pressure_sensor_ {nullptr}
protected

Definition at line 133 of file bme680.h.

◆ temperature_oversampling_

BME680Oversampling esphome::bme680::BME680Component::temperature_oversampling_ {BME680_OVERSAMPLING_16X}
protected

Definition at line 125 of file bme680.h.

◆ temperature_sensor_

sensor::Sensor* esphome::bme680::BME680Component::temperature_sensor_ {nullptr}
protected

Definition at line 132 of file bme680.h.


The documentation for this class was generated from the following files: