mics_5524.h

Go to the documentation of this file.

#pragma once
 
#include <cmath>
#include <cstdint>
 
#include "esphome/components/sensor/sensor.h"
#include "esphome/components/voltage_sampler/voltage_sampler.h"
#include "esphome/core/component.h"
#include "esphome/core/helpers.h"
 
#include "mics_math.h"
 
namespace esphome::mics_5524 {
 
class MiCS5524GasSensor : public sensor::Sensor {
 public:
  MiCS5524GasSensor(float threshold, float gain, float min_ppm, float max_ppm)
      : curve_{threshold, gain, min_ppm, max_ppm} {}
 
  void publish_ratio(float ratio);
 
  float get_min_ppm() const { return this->curve_.min_ppm; }
  float get_max_ppm() const { return this->curve_.max_ppm; }
 
 protected:
  micsmath::VendorCurve curve_;
};
 
class MiCS5524Component : public PollingComponent {
 public:
  explicit MiCS5524Component(voltage_sampler::VoltageSampler *source) : source_(source) {}
 
  void setup() override;
  void loop() override;
  void update() override;
  void dump_config() override;
 
#ifdef MICS_5524_GAS_COUNT
  void register_gas_sensor(MiCS5524GasSensor *gas) { this->gases_.push_back(gas); }
#endif
 
  void set_vcc(float vcc) { this->vcc_ = vcc; }
  void set_voltage_multiplier(float multiplier) { this->voltage_multiplier_ = multiplier; }
  void set_samples(uint8_t samples) { this->samples_ = samples; }
  void set_warmup_time(uint32_t warmup) { this->warmup_time_ = warmup; }
  void set_calibration(uint32_t delay, uint32_t samples, uint32_t sample_interval);
  void set_air_reference(float air_reference) { this->reference_ = air_reference; }
 
 protected:
  float sample_voltage_();
  float read_air_value_();
  void publish_ratio_(float ratio);
 
  void begin_calibration_();
  void process_calibration_();
  void finish_calibration_();
  void schedule_calibration_retry_();
  bool has_reference_() const { return this->reference_ > 0.0f; }
 
  voltage_sampler::VoltageSampler *source_{nullptr};
  float vcc_{5.0f};
  float voltage_multiplier_{1.0f};
  uint32_t warmup_time_{0};
 
  uint32_t calibration_delay_{0};
  uint32_t calibration_samples_{0};
  uint32_t sample_interval_{20};
 
  static constexpr uint32_t CALIBRATION_START_ID = 0;
  static constexpr uint32_t CALIBRATION_RETRY_MIN_MS = 10000;
 
  uint32_t calibration_last_sample_{0};
  uint32_t calibration_count_{0};
  uint32_t calibration_attempts_{0};
  float calibration_sum_{0.0f};
  float calibration_min_{0.0f};
  float calibration_max_{0.0f};
 
  float reference_{0.0f};
 
  // Sized by code generation; the host unit tests run none, so the list compiles out there.
#ifdef MICS_5524_GAS_COUNT
  StaticVector<MiCS5524GasSensor *, MICS_5524_GAS_COUNT> gases_;
#endif
 
  uint8_t samples_{4};
  bool calibrating_{false};
};
 
}  // namespace esphome::mics_5524