ESPHome  2024.9.0
esphome::bme68x_bsec2_i2c::BME68xBSEC2I2CComponent Class Reference

#include <bme68x_bsec2_i2c.h>

Inheritance diagram for esphome::bme68x_bsec2_i2c::BME68xBSEC2I2CComponent:
esphome::bme68x_bsec2::BME68xBSEC2Component esphome::i2c::I2CDevice esphome::Component

Additional Inherited Members

- Public Member Functions inherited from esphome::bme68x_bsec2::BME68xBSEC2Component
float get_setup_priority () const override
 
void loop () override
 
void set_algorithm_output (AlgorithmOutput algorithm_output)
 
void set_operating_age (OperatingAge operating_age)
 
void set_temperature_offset (float offset)
 
void set_voltage (Voltage voltage)
 
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_bsec2_configuration (const uint8_t *data, const uint32_t len)
 
void set_state_save_interval (uint32_t interval)
 
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_static_sensor (sensor::Sensor *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 set_iaq_accuracy_text_sensor (text_sensor::TextSensor *sensor)
 
- 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 () const
 
bool is_ready () const
 
virtual bool can_proceed ()
 
bool status_has_warning () const
 
bool status_has_error () const
 
void status_set_warning (const char *message="unspecified")
 
void status_set_error (const char *message="unspecified")
 
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)
 
- Protected Member Functions inherited from esphome::bme68x_bsec2::BME68xBSEC2Component
void set_config_ (const uint8_t *config, u_int32_t len)
 
float calc_sensor_sample_rate_ (SampleRate sample_rate)
 
void update_subscription_ ()
 
void run_ ()
 
void read_ (int64_t trigger_time_ns)
 
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 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 inherited from esphome::bme68x_bsec2::BME68xBSEC2Component
struct bme68x_dev bme68x_
 
bsec_bme_settings_t bsec_settings_
 
bsec_version_t version_
 
uint8_t bsec_instance_ [BSEC_INSTANCE_SIZE]
 
struct bme68x_heatr_conf bme68x_heatr_conf_
 
uint8_t op_mode_
 
bool sleep_mode_
 
bsec_library_return_t bsec_status_ {BSEC_OK}
 
int8_t bme68x_status_ {BME68X_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_
 
uint8_t const * bsec2_configuration_ {nullptr}
 
uint32_t bsec2_configuration_length_ {0}
 
bool bsec2_blob_configured_ {false}
 
ESPPreferenceObject bsec_state_
 
uint32_t state_save_interval_ms_ {21600000}
 
uint32_t last_state_save_ms_ = 0
 
float temperature_offset_ {0}
 
AlgorithmOutput algorithm_output_ {ALGORITHM_OUTPUT_IAQ}
 
OperatingAge operating_age_ {OPERATING_AGE_28D}
 
Voltage voltage_ {VOLTAGE_3_3V}
 
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::Sensor * temperature_sensor_ {nullptr}
 
sensor::Sensor * pressure_sensor_ {nullptr}
 
sensor::Sensor * humidity_sensor_ {nullptr}
 
sensor::Sensor * gas_resistance_sensor_ {nullptr}
 
sensor::Sensor * iaq_sensor_ {nullptr}
 
sensor::Sensor * iaq_static_sensor_ {nullptr}
 
sensor::Sensor * iaq_accuracy_sensor_ {nullptr}
 
sensor::Sensor * co2_equivalent_sensor_ {nullptr}
 
sensor::Sensor * breath_voc_equivalent_sensor_ {nullptr}
 
text_sensor::TextSensor * iaq_accuracy_text_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...
 
I2CBus * bus_ {nullptr}
 pointer to I2CBus instance More...
 

Detailed Description

Definition at line 15 of file bme68x_bsec2_i2c.h.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.13