ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
sen6x.h
Go to the documentation of this file.
1#pragma once
2
7#ifdef SEN6X_STATUS_SENSOR_COUNT
10#endif
11
12namespace esphome::sen6x {
13
14#ifdef SEN6X_STATUS_SENSOR_COUNT
15// Bits of the device status register (datasheet section 4.3) a binary sensor can watch
25
29 uint8_t bit; // of the status register, set at setup once the variant is known
30};
31#endif
32
33// The NOx algorithm requires std_initial to stay at 50 (Sensirion datasheet)
34static constexpr uint16_t NOX_STD_INITIAL = 50;
35
36// Raw parameter block for the VOC/NOx algorithm tuning commands
45
46// Raw values in the device's fixed-point encoding (offset x200, slope x10000)
52
53// Raw values in the device's fixed-point encoding (all x10)
55 uint16_t k;
56 uint16_t p;
57 uint16_t t1;
58 uint16_t t2;
59};
60
61// The CO2 settings a config may leave out: altitude is 0 to 3000 m, pressure 700 to 1200 hPa
62inline constexpr uint16_t ALTITUDE_UNSET = 0xFFFF;
63inline constexpr uint16_t PRESSURE_UNSET = 0;
64
66 SUB_SENSOR(pm_1_0)
67 SUB_SENSOR(pm_2_5)
68 SUB_SENSOR(pm_4_0)
69 SUB_SENSOR(pm_10_0)
70#ifdef USE_SEN6X_NUMBER_CONCENTRATION
71 SUB_SENSOR(pmc_0_5)
72 SUB_SENSOR(pmc_1_0)
73 SUB_SENSOR(pmc_2_5)
74 SUB_SENSOR(pmc_4_0)
75 SUB_SENSOR(pmc_10_0)
76#endif
77 SUB_SENSOR(temperature)
78 SUB_SENSOR(humidity)
79 SUB_SENSOR(voc)
80 SUB_SENSOR(nox)
81 SUB_SENSOR(co2)
82 SUB_SENSOR(hcho)
83 // Input sensors for compensation
84 SUB_SENSOR(ambient_pressure_source)
85
86 public:
87 void setup() override;
88 void dump_config() override;
89 void update() override;
90
91 enum Sen6xType : uint8_t { SEN62, SEN63C, SEN65, SEN66, SEN68, SEN69C, UNKNOWN };
92
93 void set_type(Sen6xType type) { this->sen6x_type_ = type; }
94 void set_voc_algorithm_tuning(uint16_t index_offset, uint16_t learning_time_offset_hours,
95 uint16_t learning_time_gain_hours, uint16_t gating_max_duration_minutes,
96 uint16_t std_initial, uint16_t gain_factor) {
98 index_offset, learning_time_offset_hours, learning_time_gain_hours, gating_max_duration_minutes, std_initial,
99 gain_factor};
100 }
101 void set_nox_algorithm_tuning(uint16_t index_offset, uint16_t learning_time_offset_hours,
102 uint16_t learning_time_gain_hours, uint16_t gating_max_duration_minutes,
103 uint16_t gain_factor) {
104 this->nox_tuning_params_ = GasTuning{index_offset,
105 learning_time_offset_hours,
106 learning_time_gain_hours,
107 gating_max_duration_minutes,
108 NOX_STD_INITIAL,
109 gain_factor};
110 }
111 void set_startup_delay(uint32_t delay_ms) { this->startup_delay_ms_ = delay_ms; }
112 void set_temperature_compensation(int16_t offset, int16_t normalized_offset_slope, uint16_t time_constant) {
113 this->temperature_compensation_ = TemperatureCompensation{offset, normalized_offset_slope, time_constant};
114 }
115 void set_temperature_acceleration(uint16_t k, uint16_t p, uint16_t t1, uint16_t t2) {
117 }
118#ifdef SEN6X_STATUS_SENSOR_COUNT
119 void add_status_binary_sensor(binary_sensor::BinarySensor *sensor, Sen6xStatus status) {
120 this->status_sensors_.push_back({sensor, status, 0});
121 }
122#endif
123 void set_automatic_self_calibration(bool enabled) { this->co2_asc_ = enabled; }
124 void set_altitude_compensation(uint16_t altitude) { this->altitude_compensation_ = altitude; }
125 void set_ambient_pressure_compensation(uint16_t pressure_hpa) { this->ambient_pressure_ = pressure_hpa; }
126 void start_measurement();
127 void stop_measurement();
128 void start_fan_cleaning();
129 void activate_sht_heater();
130
131 protected:
142
144 bool write_setup_step_(SetupStep step);
145 void finish_setup_();
146 bool write_config_words_(uint16_t i2c_command, const uint16_t *data, uint8_t len);
147 bool write_tuning_parameters_(uint16_t i2c_command, const GasTuning &tuning);
148 bool write_setup_register_(uint16_t i2c_command, uint16_t value);
151 void write_ambient_pressure_(uint16_t pressure_hpa);
152 void update_ambient_pressure_compensation_(float pressure_hpa);
154 bool command_blocked_() const;
155 void set_command_wait_(uint32_t wait_ms);
157 void poll_data_ready_();
158 void read_measurements_();
160 void read_device_status_();
161#ifdef SEN6X_STATUS_SENSOR_COUNT
163#endif
164#ifdef USE_SEN6X_NUMBER_CONCENTRATION
168#endif
169
170 char serial_number_[33]{};
171#ifdef SEN6X_STATUS_SENSOR_COUNT
173#endif
174 optional<GasTuning> voc_tuning_params_;
175 optional<GasTuning> nox_tuning_params_;
176 optional<TemperatureAcceleration> temperature_acceleration_;
177 optional<TemperatureCompensation> temperature_compensation_;
178 uint16_t read_cmd_{0};
180 Sen6xType sen6x_type_{UNKNOWN};
181 // Post-command wait windows, stored as start time plus duration so elapsed-time checks survive millis() wrap
188 // Last pressure written to the device, used to skip redundant writes
190 optional<bool> co2_asc_;
195 uint8_t read_words_{0};
196 bool initialized_{false};
198 bool measuring_{false};
199 bool startup_complete_{false};
200};
201
202} // namespace esphome::sen6x
uint8_t status
Definition bl0942.h:8
virtual void setup()
Where the component's initialization should happen.
Definition component.cpp:84
This class simplifies creating components that periodically check a state.
Definition component.h:532
Minimal static vector - saves memory by avoiding std::vector overhead.
Definition helpers.h:304
Base class for all binary_sensor-type classes.
void parse_and_publish_number_concentration_()
Definition sen6x.cpp:678
bool write_temperature_compensation_(const TemperatureCompensation &compensation)
Definition sen6x.cpp:291
optional< GasTuning > voc_tuning_params_
Definition sen6x.h:174
bool has_number_concentration_sensor_() const
Definition sen6x.cpp:663
StaticVector< StatusSensor, SEN6X_STATUS_SENSOR_COUNT > status_sensors_
Definition sen6x.h:172
optional< TemperatureAcceleration > temperature_acceleration_
Definition sen6x.h:176
void set_command_wait_(uint32_t wait_ms)
Definition sen6x.cpp:724
uint32_t command_wait_remaining_() const
Definition sen6x.cpp:717
bool write_setup_register_(uint16_t i2c_command, uint16_t value)
Definition sen6x.cpp:303
bool write_temperature_acceleration_(const TemperatureAcceleration &acceleration)
Definition sen6x.cpp:298
bool write_config_words_(uint16_t i2c_command, const uint16_t *data, uint8_t len)
Definition sen6x.cpp:321
bool write_setup_step_(SetupStep step)
Definition sen6x.cpp:249
optional< TemperatureCompensation > temperature_compensation_
Definition sen6x.h:177
optional< GasTuning > nox_tuning_params_
Definition sen6x.h:175
optional< bool > co2_asc_
Definition sen6x.h:190
bool write_tuning_parameters_(uint16_t i2c_command, const GasTuning &tuning)
Definition sen6x.cpp:331
void write_ambient_pressure_(uint16_t pressure_hpa)
Definition sen6x.cpp:694
void update_ambient_pressure_compensation_(float pressure_hpa)
Definition sen6x.cpp:699
uint8_t type
constexpr uint16_t ALTITUDE_UNSET
Definition sen6x.h:62
constexpr uint16_t PRESSURE_UNSET
Definition sen6x.h:63
uint32_t value
Definition hal.cpp:41
const void size_t len
Definition hal.h:68
static void uint32_t
uint16_t learning_time_gain_hours
Definition sen6x.h:40
uint16_t learning_time_offset_hours
Definition sen6x.h:39
uint16_t gating_max_duration_minutes
Definition sen6x.h:41
binary_sensor::BinarySensor * sensor
Definition sen6x.h:27
uint16_t temperature
Definition sun_gtil2.cpp:12