dfrobot_sen0465_base.h

Go to the documentation of this file.

#pragma once
 
#include "esphome/components/sensor/sensor.h"
#include "esphome/core/component.h"
#include "esphome/core/defines.h"
#include "esphome/core/helpers.h"
 
namespace esphome::dfrobot_sen0465_base {
 
static constexpr uint8_t FRAME_SIZE = 9;
static constexpr uint8_t FRAME_HEAD = 0xFF;
 
// Scheduler ids, shared with the bus variants
static constexpr uint32_t STEP_TIMEOUT_ID = 0;
static constexpr uint32_t RESPONSE_TIMEOUT_ID = 1;
 
enum class AlarmType : uint8_t {
  ALARM_TYPE_OFF,
  ALARM_TYPE_LOW,
  ALARM_TYPE_HIGH,
};
 
enum class SetupStep : uint8_t {
  SETUP_STEP_ACQUIRE_MODE,
  SETUP_STEP_ALARM,
  SETUP_STEP_DONE,
};
 
class DFRobotSEN0465Component : public PollingComponent {
  SUB_SENSOR(concentration)
  SUB_SENSOR(temperature)
 
 public:
  DFRobotSEN0465Component(uint8_t gas_type, const char *gas_name) : gas_name_(gas_name), gas_type_(gas_type) {}
 
  void setup() override;
  void update() override;
  void dump_config() override;
 
  void set_alarm(AlarmType type, uint16_t threshold, uint8_t decimals) {
    this->alarm_type_ = type;
    this->alarm_threshold_ = threshold;
    this->alarm_decimals_ = decimals;
  }
 
#ifdef USE_DFROBOT_SEN0465_TEMPERATURE_COMPENSATION
  void add_compensation_range(int8_t low, int8_t high, float a, float b, float c, float d) {
    this->compensation_.push_back({low, high, a, b, c, d});
  }
#endif
 
 protected:
  virtual bool write_frame(const uint8_t *frame) = 0;
  virtual void read_response() = 0;
 
  void handle_response_(const uint8_t *frame);
  void handle_no_response_();
  void fail_reading_();
 
  bool send_step_request_();
  void retry_step_request_();
  void step_failed_(const LogString *reason);
  void next_step_();
  void handle_data_(const uint8_t *frame);
  bool send_command_(uint8_t command, uint8_t arg0 = 0, uint8_t arg1 = 0, uint8_t arg2 = 0, uint8_t arg3 = 0);
 
  const char *gas_name_;
  uint16_t alarm_threshold_{0};
  uint8_t gas_type_;
  AlarmType alarm_type_{AlarmType::ALARM_TYPE_OFF};
  uint8_t alarm_decimals_{0};
  SetupStep step_{SetupStep::SETUP_STEP_ACQUIRE_MODE};
  uint8_t attempts_{0};
  uint8_t pending_command_{0};
  bool setup_incomplete_{false};
 
#ifdef USE_DFROBOT_SEN0465_TEMPERATURE_COMPENSATION
  struct CompensationRange {
    int8_t low;
    int8_t high;
    float a;
    float b;
    float c;
    float d;
  };
 
  float compensate_(float concentration, float temperature) const;
 
  StaticVector<CompensationRange, DFROBOT_SEN0465_COMPENSATION_RANGES> compensation_;
#endif
};
 
}  // namespace esphome::dfrobot_sen0465_base