ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
bme68x_bsec2.h
Go to the documentation of this file.
1#pragma once
2
6
7#ifdef USE_BSEC2
8
9#ifdef USE_SENSOR
11#endif
12
13#ifdef USE_TEXT_SENSOR
15#endif
16
17#include <cinttypes>
18#include <queue>
19
20#include <bsec2.h>
21
22namespace esphome::bme68x_bsec2 {
23
29
34
40
45
47 public:
48 void setup() override;
49 void dump_config() override;
50 void loop() override;
51
52 void set_algorithm_output(AlgorithmOutput algorithm_output) { this->algorithm_output_ = algorithm_output; }
53 void set_operating_age(OperatingAge operating_age) { this->operating_age_ = operating_age; }
54 void set_temperature_offset(float offset) { this->temperature_offset_ = offset; }
55 void set_voltage(Voltage voltage) { this->voltage_ = voltage; }
56
57 void set_sample_rate(SampleRate sample_rate) { this->sample_rate_ = sample_rate; }
58 void set_temperature_sample_rate(SampleRate sample_rate) { this->temperature_sample_rate_ = sample_rate; }
59 void set_pressure_sample_rate(SampleRate sample_rate) { this->pressure_sample_rate_ = sample_rate; }
60 void set_humidity_sample_rate(SampleRate sample_rate) { this->humidity_sample_rate_ = sample_rate; }
61
62 void set_bsec2_configuration(const uint8_t *data, const uint32_t len) {
63 this->bsec2_configuration_ = data;
65 }
66
67 void set_state_save_interval(uint32_t interval) { this->state_save_interval_ms_ = interval; }
68
69#ifdef USE_SENSOR
72 SUB_SENSOR(humidity)
73 SUB_SENSOR(gas_resistance)
74 SUB_SENSOR(iaq)
75 SUB_SENSOR(iaq_static)
76 SUB_SENSOR(iaq_accuracy)
77 SUB_SENSOR(co2_equivalent)
78 SUB_SENSOR(breath_voc_equivalent)
79#endif
80#ifdef USE_TEXT_SENSOR
81 SUB_TEXT_SENSOR(iaq_accuracy)
82#endif
83 virtual uint32_t get_hash() = 0;
84
85 protected:
86 void set_config_(const uint8_t *config, u_int32_t len);
87 float calc_sensor_sample_rate_(SampleRate sample_rate);
89
90 void run_();
91 void read_(int64_t trigger_time_ns);
92 void publish_(const bsec_output_t *outputs, uint8_t num_outputs);
93 int64_t get_time_ns_();
94 void check_status_();
95
96#ifdef USE_SENSOR
97 void publish_sensor_(sensor::Sensor *sensor, float value, bool change_only = false);
98#endif
99#ifdef USE_TEXT_SENSOR
100 void publish_sensor_(text_sensor::TextSensor *sensor, const char *value);
101#endif
102
103 void load_state_();
104 void save_state_(uint8_t accuracy);
105
106 void queue_push_(std::function<void()> &&f) { this->queue_.push(std::move(f)); }
107
108 struct bme68x_dev bme68x_;
109 bsec_bme_settings_t bsec_settings_;
110 bsec_version_t version_;
111 struct bme68x_heatr_conf bme68x_heatr_conf_;
112
113 std::queue<std::function<void()>> queue_;
115
116 uint8_t const *bsec2_configuration_{nullptr};
117
118 int64_t last_time_ms_{0};
119 int64_t trigger_time_ns_{0}; // Stored for set_timeout lambda to help avoid heap allocation on supported 32-bit
120 // toolchains with small std::function SBO
121
122 uint32_t state_save_interval_ms_{21600000}; // 6 hours - 4 times a day
126 bsec_library_return_t bsec_status_{BSEC_OK};
127
129
133 SampleRate sample_rate_{SAMPLE_RATE_LP}; // Core/gas sample rate
137
138 uint8_t bsec_instance_[BSEC_INSTANCE_SIZE];
139 uint8_t op_mode_; // operating mode of sensor
140 int8_t bme68x_status_{BME68X_OK};
142};
143
144} // namespace esphome::bme68x_bsec2
145#endif
void publish_(const bsec_output_t *outputs, uint8_t num_outputs)
void publish_sensor_(sensor::Sensor *sensor, float value, bool change_only=false)
void set_algorithm_output(AlgorithmOutput algorithm_output)
void set_bsec2_configuration(const uint8_t *data, const uint32_t len)
SUB_SENSOR(temperature) SUB_SENSOR(pressure) SUB_SENSOR(humidity) SUB_SENSOR(gas_resistance) SUB_SENSOR(iaq) SUB_SENSOR(iaq_static) SUB_SENSOR(iaq_accuracy) SUB_SENSOR(co2_equivalent) SUB_SENSOR(breath_voc_equivalent) SUB_TEXT_SENSOR(iaq_accuracy) virtual uint32_t get_hash()=0
struct bme68x_heatr_conf bme68x_heatr_conf_
void set_sample_rate(SampleRate sample_rate)
uint8_t bsec_instance_[BSEC_INSTANCE_SIZE]
void set_pressure_sample_rate(SampleRate sample_rate)
void set_config_(const uint8_t *config, u_int32_t len)
void set_state_save_interval(uint32_t interval)
void set_temperature_sample_rate(SampleRate sample_rate)
float calc_sensor_sample_rate_(SampleRate sample_rate)
void set_humidity_sample_rate(SampleRate sample_rate)
std::queue< std::function< void()> > queue_
void set_operating_age(OperatingAge operating_age)
void queue_push_(std::function< void()> &&f)
Base-class for all sensors.
Definition sensor.h:48
uint32_t value
Definition hal.cpp:41
const void size_t len
Definition hal.h:68
static void uint32_t
uint16_t temperature
Definition sun_gtil2.cpp:12
uint8_t pressure
Definition tt21100.cpp:7