ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
sen5x.h
Go to the documentation of this file.
1#pragma once
2
8
9namespace esphome::sen5x {
10
16
17enum class Sen5xType : uint8_t { SEN50, SEN54, SEN55, UNKNOWN };
18
27
33
34// Shortest time interval of 2H (in milliseconds) for storing baseline values.
35// Prevents wear of the flash because of too many write operations
36static const uint32_t SHORTEST_BASELINE_STORE_INTERVAL = 2 * 60 * 60 * 1000;
37
39 public:
40 void setup() override;
41 void dump_config() override;
42 void update() override;
43
44 void set_store_baseline(bool store_baseline) { this->store_baseline_ = store_baseline; }
45 void set_acceleration_mode(RhtAccelerationMode mode) { this->acceleration_mode_ = mode; }
46 void set_auto_cleaning_interval(uint32_t auto_cleaning_interval) {
47 this->auto_cleaning_interval_ = auto_cleaning_interval;
48 }
49 void set_voc_algorithm_tuning(uint16_t index_offset, uint16_t learning_time_offset_hours,
50 uint16_t learning_time_gain_hours, uint16_t gating_max_duration_minutes,
51 uint16_t std_initial, uint16_t gain_factor) {
52 GasTuning tuning_params;
53 tuning_params.index_offset = index_offset;
54 tuning_params.learning_time_offset_hours = learning_time_offset_hours;
55 tuning_params.learning_time_gain_hours = learning_time_gain_hours;
56 tuning_params.gating_max_duration_minutes = gating_max_duration_minutes;
57 tuning_params.std_initial = std_initial;
58 tuning_params.gain_factor = gain_factor;
59 this->voc_tuning_params_ = tuning_params;
60 }
61 void set_nox_algorithm_tuning(uint16_t index_offset, uint16_t learning_time_offset_hours,
62 uint16_t learning_time_gain_hours, uint16_t gating_max_duration_minutes,
63 uint16_t gain_factor) {
64 GasTuning tuning_params;
65 tuning_params.index_offset = index_offset;
66 tuning_params.learning_time_offset_hours = learning_time_offset_hours;
67 tuning_params.learning_time_gain_hours = learning_time_gain_hours;
68 tuning_params.gating_max_duration_minutes = gating_max_duration_minutes;
69 tuning_params.std_initial = 50;
70 tuning_params.gain_factor = gain_factor;
71 this->nox_tuning_params_ = tuning_params;
72 }
73 void set_temperature_compensation(float offset, float normalized_offset_slope, uint16_t time_constant) {
75 temp_comp.offset = offset * 200;
76 temp_comp.normalized_offset_slope = normalized_offset_slope * 10000;
77 temp_comp.time_constant = time_constant;
78 this->temperature_compensation_ = temp_comp;
79 }
80 void set_model(Sen5xType model) { this->model_override_ = model; }
81 bool start_fan_cleaning();
82
83 protected:
84 bool write_tuning_parameters_(uint16_t i2c_command, const GasTuning &tuning);
86
87 char serial_number_[17] = "UNKNOWN";
88 uint16_t voc_baseline_state_[4]{0};
90 uint16_t firmware_version_{0};
92 bool initialized_{false};
93 bool store_baseline_{false};
94
95 SUB_SENSOR(pm_1_0)
96 SUB_SENSOR(pm_2_5)
97 SUB_SENSOR(pm_4_0)
98 SUB_SENSOR(pm_10_0)
99 // SEN54 and SEN55 only
100 SUB_SENSOR(temperature)
101 SUB_SENSOR(humidity)
102 SUB_SENSOR(voc)
103 // SEN55 only
104 SUB_SENSOR(nox)
105
106 protected:
107 optional<RhtAccelerationMode> acceleration_mode_;
108 optional<uint32_t> auto_cleaning_interval_;
109 optional<GasTuning> voc_tuning_params_;
110 optional<GasTuning> nox_tuning_params_;
111 optional<TemperatureCompensation> temperature_compensation_;
112 optional<Sen5xType> model_override_;
114};
115
116} // namespace esphome::sen5x
BedjetMode mode
BedJet operating mode.
This class simplifies creating components that periodically check a state.
Definition component.h:532
void set_temperature_compensation(float offset, float normalized_offset_slope, uint16_t time_constant)
Definition sen5x.h:73
void set_model(Sen5xType model)
Definition sen5x.h:80
SUB_SENSOR(pm_1_0) SUB_SENSOR(pm_2_5) SUB_SENSOR(pm_4_0) SUB_SENSOR(pm_10_0) SUB_SENSOR(temperature) SUB_SENSOR(humidity) SUB_SENSOR(voc) SUB_SENSOR(nox) protected optional< uint32_t > auto_cleaning_interval_
Definition sen5x.h:95
void dump_config() override
Definition sen5x.cpp:226
void set_acceleration_mode(RhtAccelerationMode mode)
Definition sen5x.h:45
void set_auto_cleaning_interval(uint32_t auto_cleaning_interval)
Definition sen5x.h:46
ESPPreferenceObject pref_
Definition sen5x.h:113
bool write_tuning_parameters_(uint16_t i2c_command, const GasTuning &tuning)
Definition sen5x.cpp:345
optional< Sen5xType > model_override_
Definition sen5x.h:112
void set_store_baseline(bool store_baseline)
Definition sen5x.h:44
optional< TemperatureCompensation > temperature_compensation_
Definition sen5x.h:111
optional< GasTuning > voc_tuning_params_
Definition sen5x.h:109
void set_voc_algorithm_tuning(uint16_t index_offset, uint16_t learning_time_offset_hours, uint16_t learning_time_gain_hours, uint16_t gating_max_duration_minutes, uint16_t std_initial, uint16_t gain_factor)
Definition sen5x.h:49
bool write_temperature_compensation_(const TemperatureCompensation &compensation)
Definition sen5x.cpp:360
optional< GasTuning > nox_tuning_params_
Definition sen5x.h:110
void set_nox_algorithm_tuning(uint16_t index_offset, uint16_t learning_time_offset_hours, uint16_t learning_time_gain_hours, uint16_t gating_max_duration_minutes, uint16_t gain_factor)
Definition sen5x.h:61
uint16_t voc_baseline_state_[4]
Definition sen5x.h:88
RhtAccelerationMode
Definition sen5x.h:11
@ LOW_ACCELERATION
Definition sen5x.h:12
@ HIGH_ACCELERATION
Definition sen5x.h:14
@ MEDIUM_ACCELERATION
Definition sen5x.h:13
static void uint32_t
uint16_t learning_time_gain_hours
Definition sen5x.h:22
uint16_t gating_max_duration_minutes
Definition sen5x.h:23
uint16_t learning_time_offset_hours
Definition sen5x.h:21
uint16_t temperature
Definition sun_gtil2.cpp:12