12namespace bme68x_bsec2 {
14#define BME68X_BSEC2_ALGORITHM_OUTPUT_LOG(a) (a == ALGORITHM_OUTPUT_CLASSIFICATION ? "Classification" : "Regression")
15#define BME68X_BSEC2_OPERATING_AGE_LOG(o) (o == OPERATING_AGE_4D ? "4 days" : "28 days")
16#define BME68X_BSEC2_SAMPLE_RATE_LOG(r) (r == SAMPLE_RATE_DEFAULT ? "Default" : (r == SAMPLE_RATE_ULP ? "ULP" : "LP"))
17#define BME68X_BSEC2_VOLTAGE_LOG(v) (v == VOLTAGE_3_3V ? "3.3V" : "1.8V")
19static const char *
const TAG =
"bme68x_bsec2.sensor";
21static const std::string IAQ_ACCURACY_STATES[4] = {
"Stabilizing",
"Uncertain",
"Calibrating",
"Calibrated"};
27 ESP_LOGE(TAG,
"bsec_init_m failed: status %d", this->
bsec_status_);
36 ESP_LOGE(TAG,
"bme68x_init failed: status %d", this->
bme68x_status_);
43 ESP_LOGE(TAG,
"bsec_set_configuration_m failed: status %d", this->
bsec_status_);
51 ESP_LOGE(TAG,
"bsec_update_subscription_m failed: status %d", this->
bsec_status_);
61 " BSEC2 version: %d.%d.%d.%d\n"
62 " BSEC2 configuration blob:\n"
64 this->
version_.major, this->version_.minor, this->version_.major_bugfix, this->version_.minor_bugfix,
71 ESP_LOGE(TAG,
"Communication failed (BSEC2 status: %d, BME68X status: %d)", this->
bsec_status_,
76 ESP_LOGCONFIG(TAG,
" Algorithm output: %s", BME68X_BSEC2_ALGORITHM_OUTPUT_LOG(this->
algorithm_output_));
79 " Operating age: %s\n"
82 " State save interval: %ims\n"
83 " Temperature offset: %.2f",
101#ifdef USE_TEXT_SENSOR
123 if (this->
queue_.size()) {
124 auto action = std::move(this->
queue_.front());
131 if (
len > BSEC_MAX_PROPERTY_BLOB_SIZE) {
132 ESP_LOGE(TAG,
"Configuration is larger than BSEC_MAX_PROPERTY_BLOB_SIZE");
136 uint8_t work_buffer[BSEC_MAX_PROPERTY_BLOB_SIZE];
147 return sample_rate ==
SAMPLE_RATE_ULP ? BSEC_SAMPLE_RATE_ULP : BSEC_SAMPLE_RATE_LP;
151 bsec_sensor_configuration_t virtual_sensors[BSEC_NUMBER_OUTPUTS];
152 uint8_t num_virtual_sensors = 0;
155 virtual_sensors[num_virtual_sensors].sensor_id = BSEC_OUTPUT_IAQ;
157 num_virtual_sensors++;
161 virtual_sensors[num_virtual_sensors].sensor_id = BSEC_OUTPUT_STATIC_IAQ;
163 num_virtual_sensors++;
167 virtual_sensors[num_virtual_sensors].sensor_id = BSEC_OUTPUT_CO2_EQUIVALENT;
169 num_virtual_sensors++;
173 virtual_sensors[num_virtual_sensors].sensor_id = BSEC_OUTPUT_BREATH_VOC_EQUIVALENT;
175 num_virtual_sensors++;
179 virtual_sensors[num_virtual_sensors].sensor_id = BSEC_OUTPUT_RAW_PRESSURE;
181 num_virtual_sensors++;
185 virtual_sensors[num_virtual_sensors].sensor_id = BSEC_OUTPUT_RAW_GAS;
187 num_virtual_sensors++;
191 virtual_sensors[num_virtual_sensors].sensor_id = BSEC_OUTPUT_SENSOR_HEAT_COMPENSATED_TEMPERATURE;
193 num_virtual_sensors++;
197 virtual_sensors[num_virtual_sensors].sensor_id = BSEC_OUTPUT_SENSOR_HEAT_COMPENSATED_HUMIDITY;
199 num_virtual_sensors++;
202 bsec_sensor_configuration_t sensor_settings[BSEC_MAX_PHYSICAL_SENSOR];
203 uint8_t num_sensor_settings = BSEC_MAX_PHYSICAL_SENSOR;
205 sensor_settings, &num_sensor_settings);
216 ESP_LOGV(TAG,
"Performing sensor run");
218 struct bme68x_conf bme68x_conf;
220 if (this->bsec_status_ < BSEC_OK) {
221 ESP_LOGW(TAG,
"Failed to fetch sensor control settings (BSEC2 error code %d)", this->bsec_status_);
226 case BME68X_FORCED_MODE:
227 bme68x_get_conf(&bme68x_conf, &this->
bme68x_);
230 bme68x_conf.os_temp = this->
bsec_settings_.temperature_oversampling;
232 bme68x_set_conf(&bme68x_conf, &this->
bme68x_);
239 status = bme68x_set_op_mode(BME68X_FORCED_MODE, &this->
bme68x_);
240 this->
op_mode_ = BME68X_FORCED_MODE;
241 ESP_LOGV(TAG,
"Using forced mode");
244 case BME68X_PARALLEL_MODE:
246 bme68x_get_conf(&bme68x_conf, &this->
bme68x_);
249 bme68x_conf.os_temp = this->
bsec_settings_.temperature_oversampling;
251 bme68x_set_conf(&bme68x_conf, &this->
bme68x_);
258 BSEC_TOTAL_HEAT_DUR -
259 (bme68x_get_meas_dur(BME68X_PARALLEL_MODE, &bme68x_conf, &this->
bme68x_) / INT64_C(1000));
263 status = bme68x_set_op_mode(BME68X_PARALLEL_MODE, &this->
bme68x_);
264 this->
op_mode_ = BME68X_PARALLEL_MODE;
265 ESP_LOGV(TAG,
"Using parallel mode");
268 case BME68X_SLEEP_MODE:
270 bme68x_set_op_mode(BME68X_SLEEP_MODE, &this->
bme68x_);
272 ESP_LOGV(TAG,
"Using sleep mode");
277 if (this->
bsec_settings_.trigger_measurement && this->bsec_settings_.op_mode != BME68X_SLEEP_MODE) {
278 uint32_t meas_dur = 0;
279 meas_dur = bme68x_get_meas_dur(this->
op_mode_, &bme68x_conf, &this->
bme68x_);
280 ESP_LOGV(TAG,
"Queueing read in %uus", meas_dur);
281 this->
set_timeout(
"read", meas_dur / 1000, [
this, curr_time_ns]() { this->
read_(curr_time_ns); });
283 ESP_LOGV(TAG,
"Measurement not required");
284 this->
read_(curr_time_ns);
289 ESP_LOGV(TAG,
"Reading data");
292 uint8_t current_op_mode;
295 if (current_op_mode == BME68X_SLEEP_MODE) {
296 ESP_LOGV(TAG,
"Still in sleep mode, doing nothing");
302 ESP_LOGV(TAG,
"Data processing not required");
306 struct bme68x_data data[3];
311 ESP_LOGW(TAG,
"Failed to get sensor data (BME68X error code %d)", this->
bme68x_status_);
315 ESP_LOGD(TAG,
"BME68X did not provide new data");
319 for (uint8_t i = 0; i < nFields; i++) {
320 bsec_input_t inputs[BSEC_MAX_PHYSICAL_SENSOR];
321 uint8_t num_inputs = 0;
323 if (BSEC_CHECK_INPUT(this->
bsec_settings_.process_data, BSEC_INPUT_TEMPERATURE)) {
324 inputs[num_inputs].sensor_id = BSEC_INPUT_TEMPERATURE;
325 inputs[num_inputs].signal = data[i].temperature;
326 inputs[num_inputs].time_stamp = trigger_time_ns;
329 if (BSEC_CHECK_INPUT(this->
bsec_settings_.process_data, BSEC_INPUT_HEATSOURCE)) {
330 inputs[num_inputs].sensor_id = BSEC_INPUT_HEATSOURCE;
332 inputs[num_inputs].time_stamp = trigger_time_ns;
335 if (BSEC_CHECK_INPUT(this->
bsec_settings_.process_data, BSEC_INPUT_HUMIDITY)) {
336 inputs[num_inputs].sensor_id = BSEC_INPUT_HUMIDITY;
337 inputs[num_inputs].signal = data[i].humidity;
338 inputs[num_inputs].time_stamp = trigger_time_ns;
341 if (BSEC_CHECK_INPUT(this->
bsec_settings_.process_data, BSEC_INPUT_PRESSURE)) {
342 inputs[num_inputs].sensor_id = BSEC_INPUT_PRESSURE;
343 inputs[num_inputs].signal = data[i].pressure;
344 inputs[num_inputs].time_stamp = trigger_time_ns;
347 if (BSEC_CHECK_INPUT(this->
bsec_settings_.process_data, BSEC_INPUT_GASRESISTOR)) {
348 if (data[i].
status & BME68X_GASM_VALID_MSK) {
349 inputs[num_inputs].sensor_id = BSEC_INPUT_GASRESISTOR;
350 inputs[num_inputs].signal = data[i].gas_resistance;
351 inputs[num_inputs].time_stamp = trigger_time_ns;
354 ESP_LOGD(TAG,
"BME68X did not report gas data");
357 if (BSEC_CHECK_INPUT(this->
bsec_settings_.process_data, BSEC_INPUT_PROFILE_PART) &&
358 (data[i].status & BME68X_GASM_VALID_MSK)) {
359 inputs[num_inputs].sensor_id = BSEC_INPUT_PROFILE_PART;
360 inputs[num_inputs].signal = (this->
op_mode_ == BME68X_FORCED_MODE) ? 0 : data[i].gas_index;
361 inputs[num_inputs].time_stamp = trigger_time_ns;
365 if (num_inputs < 1) {
366 ESP_LOGD(TAG,
"No signal inputs available for BSEC2");
370 bsec_output_t outputs[BSEC_NUMBER_OUTPUTS];
371 uint8_t num_outputs = BSEC_NUMBER_OUTPUTS;
374 ESP_LOGW(TAG,
"BSEC2 failed to process signals (BSEC2 error code %d)", this->
bsec_status_);
377 if (num_outputs < 1) {
378 ESP_LOGD(TAG,
"No signal outputs provided by BSEC2");
382 this->
publish_(outputs, num_outputs);
387 ESP_LOGV(TAG,
"Publishing sensor states");
388 bool update_accuracy =
false;
389 uint8_t max_accuracy = 0;
390 for (uint8_t i = 0; i < num_outputs; i++) {
391 float signal = outputs[i].signal;
392 switch (outputs[i].sensor_id) {
393 case BSEC_OUTPUT_IAQ:
394 max_accuracy = std::max(outputs[i].accuracy, max_accuracy);
395 update_accuracy =
true;
400 case BSEC_OUTPUT_STATIC_IAQ:
401 max_accuracy = std::max(outputs[i].accuracy, max_accuracy);
402 update_accuracy =
true;
407 case BSEC_OUTPUT_CO2_EQUIVALENT:
412 case BSEC_OUTPUT_BREATH_VOC_EQUIVALENT:
417 case BSEC_OUTPUT_RAW_PRESSURE:
422 case BSEC_OUTPUT_RAW_GAS:
427 case BSEC_OUTPUT_SENSOR_HEAT_COMPENSATED_TEMPERATURE:
432 case BSEC_OUTPUT_SENSOR_HEAT_COMPENSATED_HUMIDITY:
439 if (update_accuracy) {
444#ifdef USE_TEXT_SENSOR
455 int64_t time_ms =
millis();
466 if (!sensor || (change_only && sensor->
has_state() && sensor->
state == value)) {
473#ifdef USE_TEXT_SENSOR
486 uint8_t
state[BSEC_MAX_STATE_BLOB_SIZE];
488 ESP_LOGV(TAG,
"Loading state");
489 uint8_t work_buffer[BSEC_MAX_WORKBUFFER_SIZE];
491 bsec_set_state_m(&this->
bsec_instance_, state, BSEC_MAX_STATE_BLOB_SIZE, work_buffer,
sizeof(work_buffer));
493 ESP_LOGW(TAG,
"Failed to load state (BSEC2 error code %d)", this->
bsec_status_);
495 ESP_LOGI(TAG,
"Loaded state");
504 ESP_LOGV(TAG,
"Saving state");
506 uint8_t
state[BSEC_MAX_STATE_BLOB_SIZE];
507 uint8_t work_buffer[BSEC_MAX_STATE_BLOB_SIZE];
508 uint32_t num_serialized_state = BSEC_MAX_STATE_BLOB_SIZE;
511 BSEC_MAX_STATE_BLOB_SIZE, &num_serialized_state);
513 ESP_LOGW(TAG,
"Failed fetch state for save (BSEC2 error code %d)", this->
bsec_status_);
518 ESP_LOGW(TAG,
"Failed to save state");
523 ESP_LOGI(TAG,
"Saved state");
virtual void mark_failed()
Mark this component as failed.
void status_set_warning(const char *message=nullptr)
void status_clear_error()
void status_clear_warning()
void set_timeout(const std::string &name, uint32_t timeout, std::function< void()> &&f)
Set a timeout function with a unique name.
void status_set_error(const char *message=nullptr)
virtual ESPPreferenceObject make_preference(size_t length, uint32_t type, bool in_flash)=0
void publish_(const bsec_output_t *outputs, uint8_t num_outputs)
uint32_t state_save_interval_ms_
void update_subscription_()
OperatingAge operating_age_
void publish_sensor_(sensor::Sensor *sensor, float value, bool change_only=false)
sensor::Sensor * pressure_sensor_
sensor::Sensor * temperature_sensor_
uint32_t last_state_save_ms_
uint32_t bsec2_configuration_length_
void read_(int64_t trigger_time_ns)
text_sensor::TextSensor * iaq_accuracy_text_sensor_
sensor::Sensor * gas_resistance_sensor_
uint32_t millis_overflow_counter_
sensor::Sensor * humidity_sensor_
SampleRate temperature_sample_rate_
struct bme68x_dev bme68x_
bsec_library_return_t bsec_status_
struct bme68x_heatr_conf bme68x_heatr_conf_
float get_setup_priority() const override
bsec_bme_settings_t bsec_settings_
uint8_t const * bsec2_configuration_
sensor::Sensor * breath_voc_equivalent_sensor_
uint8_t bsec_instance_[BSEC_INSTANCE_SIZE]
AlgorithmOutput algorithm_output_
sensor::Sensor * iaq_sensor_
void set_config_(const uint8_t *config, u_int32_t len)
sensor::Sensor * iaq_static_sensor_
SampleRate pressure_sample_rate_
virtual uint32_t get_hash()=0
bool bsec2_blob_configured_
sensor::Sensor * iaq_accuracy_sensor_
float calc_sensor_sample_rate_(SampleRate sample_rate)
SampleRate humidity_sample_rate_
void save_state_(uint8_t accuracy)
std::queue< std::function< void()> > queue_
void queue_push_(std::function< void()> &&f)
void dump_config() override
sensor::Sensor * co2_equivalent_sensor_
float temperature_offset_
ESPPreferenceObject bsec_state_
Base-class for all sensors.
void publish_state(float state)
Publish a new state to the front-end.
float state
This member variable stores the last state that has passed through all filters.
void publish_state(const std::string &state)
const float DATA
For components that import data from directly connected sensors like DHT.
Providing packet encoding functions for exchanging data with a remote host.
ESPPreferences * global_preferences
uint32_t IRAM_ATTR HOT millis()