ESPHome  2024.2.1
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes
esphome::bme680_bsec::BME680BSECComponent Class Reference

#include <bme680_bsec.h>

Inheritance diagram for esphome::bme680_bsec::BME680BSECComponent:
esphome::Component esphome::i2c::I2CDevice

Public Member Functions

void set_device_id (const std::string &devid)
 
void set_temperature_offset (float offset)
 
void set_iaq_mode (IAQMode iaq_mode)
 
void set_state_save_interval (uint32_t interval)
 
void set_sample_rate (SampleRate sample_rate)
 
void set_temperature_sample_rate (SampleRate sample_rate)
 
void set_pressure_sample_rate (SampleRate sample_rate)
 
void set_humidity_sample_rate (SampleRate sample_rate)
 
void set_temperature_sensor (sensor::Sensor *sensor)
 
void set_pressure_sensor (sensor::Sensor *sensor)
 
void set_humidity_sensor (sensor::Sensor *sensor)
 
void set_gas_resistance_sensor (sensor::Sensor *sensor)
 
void set_iaq_sensor (sensor::Sensor *sensor)
 
void set_iaq_accuracy_text_sensor (text_sensor::TextSensor *sensor)
 
void set_iaq_accuracy_sensor (sensor::Sensor *sensor)
 
void set_co2_equivalent_sensor (sensor::Sensor *sensor)
 
void set_breath_voc_equivalent_sensor (sensor::Sensor *sensor)
 
void setup () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void loop () override
 
- Public Member Functions inherited from esphome::Component
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 ()
 
bool is_ready ()
 
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
 we use the C++ default constructor More...
 
void set_i2c_address (uint8_t address)
 We store the address of the device on the bus. More...
 
void set_i2c_bus (I2CBus *bus)
 we store the pointer to the I2CBus to use More...
 
I2CRegister reg (uint8_t a_register)
 calls the I2CRegister constructor More...
 
I2CRegister16 reg16 (uint16_t a_register)
 calls the I2CRegister16 constructor More...
 
ErrorCode read (uint8_t *data, size_t len)
 reads an array of bytes from the device using an I2CBus More...
 
ErrorCode read_register (uint8_t a_register, uint8_t *data, size_t len, bool stop=true)
 reads an array of bytes from a specific register in the I²C device More...
 
ErrorCode read_register16 (uint16_t a_register, uint8_t *data, size_t len, bool stop=true)
 reads an array of bytes from a specific register in the I²C device More...
 
ErrorCode write (const uint8_t *data, size_t len, bool stop=true)
 writes an array of bytes to a device using an I2CBus More...
 
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len, bool stop=true)
 writes an array of bytes to a specific register in the I²C device More...
 
ErrorCode write_register16 (uint16_t a_register, const uint8_t *data, size_t len, bool stop=true)
 write an array of bytes to a specific register in the I²C device More...
 
bool read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
 Compat APIs All methods below have been added for compatibility reasons. More...
 
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)
 

Static Public Member Functions

static int8_t read_bytes_wrapper (uint8_t devid, uint8_t a_register, uint8_t *data, uint16_t len)
 
static int8_t write_bytes_wrapper (uint8_t devid, uint8_t a_register, uint8_t *data, uint16_t len)
 
static void delay_ms (uint32_t period)
 

Static Public Attributes

static std::vector< BME680BSECComponent * > instances
 

Protected Member Functions

void set_config_ ()
 
float calc_sensor_sample_rate_ (SampleRate sample_rate)
 
void update_subscription_ ()
 
void run_ ()
 
void read_ ()
 
void publish_ (const bsec_output_t *outputs, uint8_t num_outputs)
 
int64_t get_time_ns_ ()
 
void publish_sensor_ (sensor::Sensor *sensor, float value, bool change_only=false)
 
void publish_sensor_ (text_sensor::TextSensor *sensor, const std::string &value)
 
void snapshot_state_ ()
 
void restore_state_ ()
 
int reinit_bsec_lib_ ()
 
void load_state_ ()
 
void save_state_ (uint8_t accuracy)
 
void queue_push_ (std::function< void()> &&f)
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
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(uint8_t)> &&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(uint8_t)> &&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

struct bme680_dev bme680_
 
bsec_library_return_t bsec_status_ {BSEC_OK}
 
int8_t bme680_status_ {BME680_OK}
 
int64_t last_time_ms_ {0}
 
uint32_t millis_overflow_counter_ {0}
 
int64_t next_call_ns_ {0}
 
std::queue< std::function< void()> > queue_
 
bool bsec_state_data_valid_
 
uint8_t bsec_state_data_ [BSEC_MAX_STATE_BLOB_SIZE]
 
ESPPreferenceObject bsec_state_
 
uint32_t state_save_interval_ms_ {21600000}
 
uint32_t last_state_save_ms_ = 0
 
bsec_bme_settings_t bme680_settings_
 
std::string device_id_
 
float temperature_offset_ {0}
 
IAQMode iaq_mode_ {IAQ_MODE_STATIC}
 
SampleRate sample_rate_ {SAMPLE_RATE_LP}
 
SampleRate temperature_sample_rate_ {SAMPLE_RATE_DEFAULT}
 
SampleRate pressure_sample_rate_ {SAMPLE_RATE_DEFAULT}
 
SampleRate humidity_sample_rate_ {SAMPLE_RATE_DEFAULT}
 
sensor::Sensortemperature_sensor_ {nullptr}
 
sensor::Sensorpressure_sensor_ {nullptr}
 
sensor::Sensorhumidity_sensor_ {nullptr}
 
sensor::Sensorgas_resistance_sensor_ {nullptr}
 
sensor::Sensoriaq_sensor_ {nullptr}
 
text_sensor::TextSensoriaq_accuracy_text_sensor_ {nullptr}
 
sensor::Sensoriaq_accuracy_sensor_ {nullptr}
 
sensor::Sensorco2_equivalent_sensor_ {nullptr}
 
sensor::Sensorbreath_voc_equivalent_sensor_ {nullptr}
 
- 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}
 store the address of the device on the bus More...
 
I2CBusbus_ {nullptr}
 pointer to I2CBus instance More...
 

Static Protected Attributes

static uint8_t work_buffer_ [BSEC_MAX_WORKBUFFER_SIZE] = {0}
 

Detailed Description

Definition at line 32 of file bme680_bsec.h.

Member Function Documentation

◆ calc_sensor_sample_rate_()

float esphome::bme680_bsec::BME680BSECComponent::calc_sensor_sample_rate_ ( SampleRate  sample_rate)
protected

Definition at line 69 of file bme680_bsec.cpp.

◆ delay_ms()

void esphome::bme680_bsec::BME680BSECComponent::delay_ms ( uint32_t  period)
static

Definition at line 441 of file bme680_bsec.cpp.

◆ dump_config()

void esphome::bme680_bsec::BME680BSECComponent::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 131 of file bme680_bsec.cpp.

◆ get_setup_priority()

float esphome::bme680_bsec::BME680BSECComponent::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 165 of file bme680_bsec.cpp.

◆ get_time_ns_()

int64_t esphome::bme680_bsec::BME680BSECComponent::get_time_ns_ ( )
protected

Definition at line 401 of file bme680_bsec.cpp.

◆ load_state_()

void esphome::bme680_bsec::BME680BSECComponent::load_state_ ( )
protected

Definition at line 500 of file bme680_bsec.cpp.

◆ loop()

void esphome::bme680_bsec::BME680BSECComponent::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 167 of file bme680_bsec.cpp.

◆ publish_()

void esphome::bme680_bsec::BME680BSECComponent::publish_ ( const bsec_output_t *  outputs,
uint8_t  num_outputs 
)
protected

Definition at line 362 of file bme680_bsec.cpp.

◆ publish_sensor_() [1/2]

void esphome::bme680_bsec::BME680BSECComponent::publish_sensor_ ( sensor::Sensor sensor,
float  value,
bool  change_only = false 
)
protected

Definition at line 411 of file bme680_bsec.cpp.

◆ publish_sensor_() [2/2]

void esphome::bme680_bsec::BME680BSECComponent::publish_sensor_ ( text_sensor::TextSensor sensor,
const std::string &  value 
)
protected

Definition at line 418 of file bme680_bsec.cpp.

◆ queue_push_()

void esphome::bme680_bsec::BME680BSECComponent::queue_push_ ( std::function< void()> &&  f)
inlineprotected

Definition at line 89 of file bme680_bsec.h.

◆ read_()

void esphome::bme680_bsec::BME680BSECComponent::read_ ( )
protected

Definition at line 252 of file bme680_bsec.cpp.

◆ read_bytes_wrapper()

int8_t esphome::bme680_bsec::BME680BSECComponent::read_bytes_wrapper ( uint8_t  devid,
uint8_t  a_register,
uint8_t *  data,
uint16_t  len 
)
static

Definition at line 427 of file bme680_bsec.cpp.

◆ reinit_bsec_lib_()

int esphome::bme680_bsec::BME680BSECComponent::reinit_bsec_lib_ ( )
protected

Definition at line 476 of file bme680_bsec.cpp.

◆ restore_state_()

void esphome::bme680_bsec::BME680BSECComponent::restore_state_ ( )
protected

Definition at line 462 of file bme680_bsec.cpp.

◆ run_()

void esphome::bme680_bsec::BME680BSECComponent::run_ ( )
protected

Definition at line 190 of file bme680_bsec.cpp.

◆ save_state_()

void esphome::bme680_bsec::BME680BSECComponent::save_state_ ( uint8_t  accuracy)
protected

Definition at line 522 of file bme680_bsec.cpp.

◆ set_breath_voc_equivalent_sensor()

void esphome::bme680_bsec::BME680BSECComponent::set_breath_voc_equivalent_sensor ( sensor::Sensor sensor)
inline

Definition at line 52 of file bme680_bsec.h.

◆ set_co2_equivalent_sensor()

void esphome::bme680_bsec::BME680BSECComponent::set_co2_equivalent_sensor ( sensor::Sensor sensor)
inline

Definition at line 51 of file bme680_bsec.h.

◆ set_config_()

void esphome::bme680_bsec::BME680BSECComponent::set_config_ ( )
protected

Definition at line 53 of file bme680_bsec.cpp.

◆ set_device_id()

void esphome::bme680_bsec::BME680BSECComponent::set_device_id ( const std::string &  devid)
inline

Definition at line 34 of file bme680_bsec.h.

◆ set_gas_resistance_sensor()

void esphome::bme680_bsec::BME680BSECComponent::set_gas_resistance_sensor ( sensor::Sensor sensor)
inline

Definition at line 47 of file bme680_bsec.h.

◆ set_humidity_sample_rate()

void esphome::bme680_bsec::BME680BSECComponent::set_humidity_sample_rate ( SampleRate  sample_rate)
inline

Definition at line 42 of file bme680_bsec.h.

◆ set_humidity_sensor()

void esphome::bme680_bsec::BME680BSECComponent::set_humidity_sensor ( sensor::Sensor sensor)
inline

Definition at line 46 of file bme680_bsec.h.

◆ set_iaq_accuracy_sensor()

void esphome::bme680_bsec::BME680BSECComponent::set_iaq_accuracy_sensor ( sensor::Sensor sensor)
inline

Definition at line 50 of file bme680_bsec.h.

◆ set_iaq_accuracy_text_sensor()

void esphome::bme680_bsec::BME680BSECComponent::set_iaq_accuracy_text_sensor ( text_sensor::TextSensor sensor)
inline

Definition at line 49 of file bme680_bsec.h.

◆ set_iaq_mode()

void esphome::bme680_bsec::BME680BSECComponent::set_iaq_mode ( IAQMode  iaq_mode)
inline

Definition at line 36 of file bme680_bsec.h.

◆ set_iaq_sensor()

void esphome::bme680_bsec::BME680BSECComponent::set_iaq_sensor ( sensor::Sensor sensor)
inline

Definition at line 48 of file bme680_bsec.h.

◆ set_pressure_sample_rate()

void esphome::bme680_bsec::BME680BSECComponent::set_pressure_sample_rate ( SampleRate  sample_rate)
inline

Definition at line 41 of file bme680_bsec.h.

◆ set_pressure_sensor()

void esphome::bme680_bsec::BME680BSECComponent::set_pressure_sensor ( sensor::Sensor sensor)
inline

Definition at line 45 of file bme680_bsec.h.

◆ set_sample_rate()

void esphome::bme680_bsec::BME680BSECComponent::set_sample_rate ( SampleRate  sample_rate)
inline

Definition at line 39 of file bme680_bsec.h.

◆ set_state_save_interval()

void esphome::bme680_bsec::BME680BSECComponent::set_state_save_interval ( uint32_t  interval)
inline

Definition at line 37 of file bme680_bsec.h.

◆ set_temperature_offset()

void esphome::bme680_bsec::BME680BSECComponent::set_temperature_offset ( float  offset)
inline

Definition at line 35 of file bme680_bsec.h.

◆ set_temperature_sample_rate()

void esphome::bme680_bsec::BME680BSECComponent::set_temperature_sample_rate ( SampleRate  sample_rate)
inline

Definition at line 40 of file bme680_bsec.h.

◆ set_temperature_sensor()

void esphome::bme680_bsec::BME680BSECComponent::set_temperature_sensor ( sensor::Sensor sensor)
inline

Definition at line 44 of file bme680_bsec.h.

◆ setup()

void esphome::bme680_bsec::BME680BSECComponent::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 17 of file bme680_bsec.cpp.

◆ snapshot_state_()

void esphome::bme680_bsec::BME680BSECComponent::snapshot_state_ ( )
protected

Definition at line 448 of file bme680_bsec.cpp.

◆ update_subscription_()

void esphome::bme680_bsec::BME680BSECComponent::update_subscription_ ( )
protected

Definition at line 76 of file bme680_bsec.cpp.

◆ write_bytes_wrapper()

int8_t esphome::bme680_bsec::BME680BSECComponent::write_bytes_wrapper ( uint8_t  devid,
uint8_t  a_register,
uint8_t *  data,
uint16_t  len 
)
static

Definition at line 435 of file bme680_bsec.cpp.

Field Documentation

◆ bme680_

struct bme680_dev esphome::bme680_bsec::BME680BSECComponent::bme680_
protected

Definition at line 92 of file bme680_bsec.h.

◆ bme680_settings_

bsec_bme_settings_t esphome::bme680_bsec::BME680BSECComponent::bme680_settings_
protected

Definition at line 107 of file bme680_bsec.h.

◆ bme680_status_

int8_t esphome::bme680_bsec::BME680BSECComponent::bme680_status_ {BME680_OK}
protected

Definition at line 94 of file bme680_bsec.h.

◆ breath_voc_equivalent_sensor_

sensor::Sensor* esphome::bme680_bsec::BME680BSECComponent::breath_voc_equivalent_sensor_ {nullptr}
protected

Definition at line 126 of file bme680_bsec.h.

◆ bsec_state_

ESPPreferenceObject esphome::bme680_bsec::BME680BSECComponent::bsec_state_
protected

Definition at line 104 of file bme680_bsec.h.

◆ bsec_state_data_

uint8_t esphome::bme680_bsec::BME680BSECComponent::bsec_state_data_[BSEC_MAX_STATE_BLOB_SIZE]
protected

Definition at line 103 of file bme680_bsec.h.

◆ bsec_state_data_valid_

bool esphome::bme680_bsec::BME680BSECComponent::bsec_state_data_valid_
protected

Definition at line 102 of file bme680_bsec.h.

◆ bsec_status_

bsec_library_return_t esphome::bme680_bsec::BME680BSECComponent::bsec_status_ {BSEC_OK}
protected

Definition at line 93 of file bme680_bsec.h.

◆ co2_equivalent_sensor_

sensor::Sensor* esphome::bme680_bsec::BME680BSECComponent::co2_equivalent_sensor_ {nullptr}
protected

Definition at line 125 of file bme680_bsec.h.

◆ device_id_

std::string esphome::bme680_bsec::BME680BSECComponent::device_id_
protected

Definition at line 109 of file bme680_bsec.h.

◆ gas_resistance_sensor_

sensor::Sensor* esphome::bme680_bsec::BME680BSECComponent::gas_resistance_sensor_ {nullptr}
protected

Definition at line 121 of file bme680_bsec.h.

◆ humidity_sample_rate_

SampleRate esphome::bme680_bsec::BME680BSECComponent::humidity_sample_rate_ {SAMPLE_RATE_DEFAULT}
protected

Definition at line 116 of file bme680_bsec.h.

◆ humidity_sensor_

sensor::Sensor* esphome::bme680_bsec::BME680BSECComponent::humidity_sensor_ {nullptr}
protected

Definition at line 120 of file bme680_bsec.h.

◆ iaq_accuracy_sensor_

sensor::Sensor* esphome::bme680_bsec::BME680BSECComponent::iaq_accuracy_sensor_ {nullptr}
protected

Definition at line 124 of file bme680_bsec.h.

◆ iaq_accuracy_text_sensor_

text_sensor::TextSensor* esphome::bme680_bsec::BME680BSECComponent::iaq_accuracy_text_sensor_ {nullptr}
protected

Definition at line 123 of file bme680_bsec.h.

◆ iaq_mode_

IAQMode esphome::bme680_bsec::BME680BSECComponent::iaq_mode_ {IAQ_MODE_STATIC}
protected

Definition at line 111 of file bme680_bsec.h.

◆ iaq_sensor_

sensor::Sensor* esphome::bme680_bsec::BME680BSECComponent::iaq_sensor_ {nullptr}
protected

Definition at line 122 of file bme680_bsec.h.

◆ instances

std::vector< BME680BSECComponent * > esphome::bme680_bsec::BME680BSECComponent::instances
static

Definition at line 54 of file bme680_bsec.h.

◆ last_state_save_ms_

uint32_t esphome::bme680_bsec::BME680BSECComponent::last_state_save_ms_ = 0
protected

Definition at line 106 of file bme680_bsec.h.

◆ last_time_ms_

int64_t esphome::bme680_bsec::BME680BSECComponent::last_time_ms_ {0}
protected

Definition at line 96 of file bme680_bsec.h.

◆ millis_overflow_counter_

uint32_t esphome::bme680_bsec::BME680BSECComponent::millis_overflow_counter_ {0}
protected

Definition at line 97 of file bme680_bsec.h.

◆ next_call_ns_

int64_t esphome::bme680_bsec::BME680BSECComponent::next_call_ns_ {0}
protected

Definition at line 98 of file bme680_bsec.h.

◆ pressure_sample_rate_

SampleRate esphome::bme680_bsec::BME680BSECComponent::pressure_sample_rate_ {SAMPLE_RATE_DEFAULT}
protected

Definition at line 115 of file bme680_bsec.h.

◆ pressure_sensor_

sensor::Sensor* esphome::bme680_bsec::BME680BSECComponent::pressure_sensor_ {nullptr}
protected

Definition at line 119 of file bme680_bsec.h.

◆ queue_

std::queue<std::function<void()> > esphome::bme680_bsec::BME680BSECComponent::queue_
protected

Definition at line 100 of file bme680_bsec.h.

◆ sample_rate_

SampleRate esphome::bme680_bsec::BME680BSECComponent::sample_rate_ {SAMPLE_RATE_LP}
protected

Definition at line 113 of file bme680_bsec.h.

◆ state_save_interval_ms_

uint32_t esphome::bme680_bsec::BME680BSECComponent::state_save_interval_ms_ {21600000}
protected

Definition at line 105 of file bme680_bsec.h.

◆ temperature_offset_

float esphome::bme680_bsec::BME680BSECComponent::temperature_offset_ {0}
protected

Definition at line 110 of file bme680_bsec.h.

◆ temperature_sample_rate_

SampleRate esphome::bme680_bsec::BME680BSECComponent::temperature_sample_rate_ {SAMPLE_RATE_DEFAULT}
protected

Definition at line 114 of file bme680_bsec.h.

◆ temperature_sensor_

sensor::Sensor* esphome::bme680_bsec::BME680BSECComponent::temperature_sensor_ {nullptr}
protected

Definition at line 118 of file bme680_bsec.h.

◆ work_buffer_

uint8_t esphome::bme680_bsec::BME680BSECComponent::work_buffer_ = {0}
staticprotected

Definition at line 91 of file bme680_bsec.h.


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