ESPHome 2025.8.0b2
|
#include <bme680_bsec.h>
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_supply_voltage (SupplyVoltage supply_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_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 |
![]() | |
float | get_actual_setup_priority () const |
void | set_setup_priority (float priority) |
virtual float | get_loop_priority () const |
priority of loop(). | |
void | call () |
virtual void | on_shutdown () |
virtual void | on_safe_shutdown () |
virtual bool | teardown () |
Called during teardown to allow component to gracefully finish operations. | |
virtual void | on_powerdown () |
Called after teardown is complete to power down hardware. | |
uint8_t | get_component_state () const |
void | reset_to_construction_state () |
Reset this component back to the construction state to allow setup to run again. | |
bool | is_in_loop_state () const |
Check if this component has completed setup and is in the loop state. | |
virtual void | mark_failed () |
Mark this component as failed. | |
void | mark_failed (const char *message) |
void | disable_loop () |
Disable this component's loop. | |
void | enable_loop () |
Enable this component's loop. | |
void | enable_loop_soon_any_context () |
Thread and ISR-safe version of enable_loop() that can be called from any context. | |
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=nullptr) |
void | status_set_error (const char *message=nullptr) |
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. | |
const char * | get_component_source () const |
Get the integration where this component was declared as a string. | |
bool | should_warn_of_blocking (uint32_t blocking_time) |
![]() | |
I2CDevice ()=default | |
we use the C++ default constructor | |
void | set_i2c_address (uint8_t address) |
We store the address of the device on the bus. | |
uint8_t | get_i2c_address () const |
Returns the I2C address of the object. | |
void | set_i2c_bus (I2CBus *bus) |
we store the pointer to the I2CBus to use | |
I2CRegister | reg (uint8_t a_register) |
calls the I2CRegister constructor | |
I2CRegister16 | reg16 (uint16_t a_register) |
calls the I2CRegister16 constructor | |
ErrorCode | read (uint8_t *data, size_t len) |
reads an array of bytes from the device using an I2CBus | |
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 | |
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 | |
ErrorCode | write (const uint8_t *data, size_t len, bool stop=true) |
writes an array of bytes to a device using an I2CBus | |
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 | |
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 | |
bool | read_bytes (uint8_t a_register, uint8_t *data, uint8_t len) |
Compat APIs All methods below have been added for compatibility reasons. | |
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) |
![]() | |
virtual void | call_loop () |
virtual void | call_setup () |
virtual void | call_dump_config () |
void | set_component_state_ (uint8_t state) |
Helper to set component state (clears state bits and sets new state) | |
void | set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f) |
Set an interval function with a unique name. | |
void | set_interval (const char *name, uint32_t interval, std::function< void()> &&f) |
Set an interval function with a const char* name. | |
void | set_interval (uint32_t interval, std::function< void()> &&f) |
bool | cancel_interval (const std::string &name) |
Cancel an interval function. | |
bool | cancel_interval (const char *name) |
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. | |
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. | |
void | set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f) |
Set a timeout function with a unique name. | |
void | set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f) |
Set a timeout function with a const char* name. | |
void | set_timeout (uint32_t timeout, std::function< void()> &&f) |
bool | cancel_timeout (const std::string &name) |
Cancel a timeout function. | |
bool | cancel_timeout (const char *name) |
void | defer (const std::string &name, std::function< void()> &&f) |
Defer a callback to the next loop() call. | |
void | defer (const char *name, std::function< void()> &&f) |
Defer a callback to the next loop() call with a const char* name. | |
void | defer (std::function< void()> &&f) |
Defer a callback to the next loop() call. | |
bool | cancel_defer (const std::string &name) |
Cancel a defer callback using the specified name, name must not be empty. | |
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} |
SupplyVoltage | supply_voltage_ |
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} |
text_sensor::TextSensor * | iaq_accuracy_text_sensor_ {nullptr} |
sensor::Sensor * | iaq_accuracy_sensor_ {nullptr} |
sensor::Sensor * | co2_equivalent_sensor_ {nullptr} |
sensor::Sensor * | breath_voc_equivalent_sensor_ {nullptr} |
![]() | |
const char * | component_source_ {nullptr} |
uint16_t | warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS} |
Warn if blocked for this many ms (max 65.5s) | |
uint8_t | component_state_ {0x00} |
State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bits 5-7: Unused - reserved for future expansion. | |
volatile bool | pending_enable_loop_ {false} |
ISR-safe flag for enable_loop_soon_any_context. | |
![]() | |
uint8_t | address_ {0x00} |
store the address of the device on the bus | |
I2CBus * | bus_ {nullptr} |
pointer to I2CBus instance | |
Static Protected Attributes | |
static uint8_t | work_buffer_ [BSEC_MAX_WORKBUFFER_SIZE] = {0} |
Definition at line 37 of file bme680_bsec.h.
|
protected |
Definition at line 83 of file bme680_bsec.cpp.
|
static |
Definition at line 460 of file bme680_bsec.cpp.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 145 of file bme680_bsec.cpp.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 184 of file bme680_bsec.cpp.
|
protected |
Definition at line 420 of file bme680_bsec.cpp.
|
protected |
Definition at line 519 of file bme680_bsec.cpp.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 186 of file bme680_bsec.cpp.
|
protected |
Definition at line 381 of file bme680_bsec.cpp.
|
protected |
Definition at line 430 of file bme680_bsec.cpp.
|
protected |
Definition at line 437 of file bme680_bsec.cpp.
|
inlineprotected |
Definition at line 95 of file bme680_bsec.h.
|
protected |
Definition at line 271 of file bme680_bsec.cpp.
|
static |
Definition at line 446 of file bme680_bsec.cpp.
|
protected |
Definition at line 495 of file bme680_bsec.cpp.
|
protected |
Definition at line 481 of file bme680_bsec.cpp.
|
protected |
Definition at line 209 of file bme680_bsec.cpp.
|
protected |
Definition at line 541 of file bme680_bsec.cpp.
|
inline |
Definition at line 58 of file bme680_bsec.h.
|
inline |
Definition at line 57 of file bme680_bsec.h.
|
protected |
Definition at line 51 of file bme680_bsec.cpp.
|
inline |
Definition at line 39 of file bme680_bsec.h.
|
inline |
Definition at line 53 of file bme680_bsec.h.
|
inline |
Definition at line 48 of file bme680_bsec.h.
|
inline |
Definition at line 52 of file bme680_bsec.h.
|
inline |
Definition at line 56 of file bme680_bsec.h.
|
inline |
Definition at line 55 of file bme680_bsec.h.
|
inline |
Definition at line 41 of file bme680_bsec.h.
|
inline |
Definition at line 54 of file bme680_bsec.h.
|
inline |
Definition at line 47 of file bme680_bsec.h.
|
inline |
Definition at line 51 of file bme680_bsec.h.
|
inline |
Definition at line 45 of file bme680_bsec.h.
|
inline |
Definition at line 42 of file bme680_bsec.h.
|
inline |
Definition at line 43 of file bme680_bsec.h.
|
inline |
Definition at line 40 of file bme680_bsec.h.
|
inline |
Definition at line 46 of file bme680_bsec.h.
|
inline |
Definition at line 50 of file bme680_bsec.h.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 17 of file bme680_bsec.cpp.
|
protected |
Definition at line 467 of file bme680_bsec.cpp.
|
protected |
Definition at line 90 of file bme680_bsec.cpp.
|
static |
Definition at line 454 of file bme680_bsec.cpp.
|
protected |
Definition at line 98 of file bme680_bsec.h.
|
protected |
Definition at line 113 of file bme680_bsec.h.
|
protected |
Definition at line 100 of file bme680_bsec.h.
|
protected |
Definition at line 133 of file bme680_bsec.h.
|
protected |
Definition at line 110 of file bme680_bsec.h.
|
protected |
Definition at line 109 of file bme680_bsec.h.
|
protected |
Definition at line 108 of file bme680_bsec.h.
|
protected |
Definition at line 99 of file bme680_bsec.h.
|
protected |
Definition at line 132 of file bme680_bsec.h.
|
protected |
Definition at line 115 of file bme680_bsec.h.
|
protected |
Definition at line 128 of file bme680_bsec.h.
|
protected |
Definition at line 123 of file bme680_bsec.h.
|
protected |
Definition at line 127 of file bme680_bsec.h.
|
protected |
Definition at line 131 of file bme680_bsec.h.
|
protected |
Definition at line 130 of file bme680_bsec.h.
|
protected |
Definition at line 117 of file bme680_bsec.h.
|
protected |
Definition at line 129 of file bme680_bsec.h.
|
static |
Definition at line 60 of file bme680_bsec.h.
|
protected |
Definition at line 112 of file bme680_bsec.h.
|
protected |
Definition at line 102 of file bme680_bsec.h.
|
protected |
Definition at line 103 of file bme680_bsec.h.
|
protected |
Definition at line 104 of file bme680_bsec.h.
|
protected |
Definition at line 122 of file bme680_bsec.h.
|
protected |
Definition at line 126 of file bme680_bsec.h.
|
protected |
Definition at line 106 of file bme680_bsec.h.
|
protected |
Definition at line 120 of file bme680_bsec.h.
|
protected |
Definition at line 111 of file bme680_bsec.h.
|
protected |
Definition at line 118 of file bme680_bsec.h.
|
protected |
Definition at line 116 of file bme680_bsec.h.
|
protected |
Definition at line 121 of file bme680_bsec.h.
|
protected |
Definition at line 125 of file bme680_bsec.h.
|
staticprotected |
Definition at line 97 of file bme680_bsec.h.