ESPHome 2025.5.0
Loading...
Searching...
No Matches
sgp30.cpp
Go to the documentation of this file.
1#include "sgp30.h"
2#include <cinttypes>
4#include "esphome/core/hal.h"
5#include "esphome/core/log.h"
6
7namespace esphome {
8namespace sgp30 {
9
10static const char *const TAG = "sgp30";
11
12static const uint16_t SGP30_CMD_GET_SERIAL_ID = 0x3682;
13static const uint16_t SGP30_CMD_GET_FEATURESET = 0x202f;
14static const uint16_t SGP30_CMD_IAQ_INIT = 0x2003;
15static const uint16_t SGP30_CMD_MEASURE_IAQ = 0x2008;
16static const uint16_t SGP30_CMD_SET_ABSOLUTE_HUMIDITY = 0x2061;
17static const uint16_t SGP30_CMD_GET_IAQ_BASELINE = 0x2015;
18static const uint16_t SGP30_CMD_SET_IAQ_BASELINE = 0x201E;
19
20// Sensor baseline should first be relied on after 1H of operation,
21// if the sensor starts with a baseline value provided
23
24// Sensor baseline could first be relied on after 12H of operation,
25// if the sensor starts without any prior baseline value provided
27
28// Shortest time interval of 1H for storing baseline values.
29// Prevents wear of the flash because of too many write operations
31
32// Store anyway if the baseline difference exceeds the max storage diff value
33const uint32_t MAXIMUM_STORAGE_DIFF = 50;
34
36 ESP_LOGCONFIG(TAG, "Setting up SGP30...");
37
38 // Serial Number identification
39 uint16_t raw_serial_number[3];
40 if (!this->get_register(SGP30_CMD_GET_SERIAL_ID, raw_serial_number, 3)) {
41 this->mark_failed();
42 return;
43 }
44 this->serial_number_ = (uint64_t(raw_serial_number[0]) << 24) | (uint64_t(raw_serial_number[1]) << 16) |
45 (uint64_t(raw_serial_number[2]));
46 ESP_LOGD(TAG, "Serial Number: %" PRIu64, this->serial_number_);
47
48 // Featureset identification for future use
49 uint16_t raw_featureset;
50 if (!this->get_register(SGP30_CMD_GET_FEATURESET, raw_featureset)) {
51 this->mark_failed();
52 return;
53 }
54 this->featureset_ = raw_featureset;
55 if (uint16_t(this->featureset_ >> 12) != 0x0) {
56 if (uint16_t(this->featureset_ >> 12) == 0x1) {
57 // ID matching a different sensor: SGPC3
58 this->error_code_ = UNSUPPORTED_ID;
59 } else {
60 // Unknown ID
61 this->error_code_ = INVALID_ID;
62 }
63 this->mark_failed();
64 return;
65 }
66 ESP_LOGD(TAG, "Product version: 0x%0X", uint16_t(this->featureset_ & 0x1FF));
67
68 // Sensor initialization
69 if (!this->write_command(SGP30_CMD_IAQ_INIT)) {
70 ESP_LOGE(TAG, "Sensor sgp30_iaq_init failed.");
71 this->error_code_ = MEASUREMENT_INIT_FAILED;
72 this->mark_failed();
73 return;
74 }
75
76 // Hash with compilation time and serial number
77 // This ensures the baseline storage is cleared after OTA
78 // Serial numbers are unique to each sensor, so mulitple sensors can be used without conflict
79 uint32_t hash = fnv1_hash(App.get_compilation_time() + std::to_string(this->serial_number_));
81
82 if (this->pref_.load(&this->baselines_storage_)) {
83 ESP_LOGI(TAG, "Loaded eCO2 baseline: 0x%04X, TVOC baseline: 0x%04X", this->baselines_storage_.eco2,
87 }
88
89 // Initialize storage timestamp
91
92 // Sensor baseline reliability timer
93 if (this->eco2_baseline_ > 0 && this->tvoc_baseline_ > 0) {
96 } else {
98 }
99}
100
102 if ((this->required_warm_up_time_ == 0) || (std::floor(millis() / 1000) >= this->required_warm_up_time_)) {
103 // requirement for warm up is removed once the millis uptime surpasses the required warm_up_time
104 // this avoids the repetitive warm up when the millis uptime is rolled over every ~40 days
105 this->required_warm_up_time_ = 0;
106 return true;
107 }
108 return false;
109}
110
112 if (this->is_sensor_baseline_reliable_()) {
113 if (!this->write_command(SGP30_CMD_GET_IAQ_BASELINE)) {
114 ESP_LOGD(TAG, "Error getting baseline");
115 this->status_set_warning();
116 return;
117 }
118 this->set_timeout(50, [this]() {
119 uint16_t raw_data[2];
120 if (!this->read_data(raw_data, 2)) {
121 this->status_set_warning();
122 return;
123 }
124
125 uint16_t eco2baseline = (raw_data[0]);
126 uint16_t tvocbaseline = (raw_data[1]);
127
128 ESP_LOGI(TAG, "Current eCO2 baseline: 0x%04X, TVOC baseline: 0x%04X", eco2baseline, tvocbaseline);
129 if (eco2baseline != this->eco2_baseline_ || tvocbaseline != this->tvoc_baseline_) {
130 this->eco2_baseline_ = eco2baseline;
131 this->tvoc_baseline_ = tvocbaseline;
132 if (this->eco2_sensor_baseline_ != nullptr)
134 if (this->tvoc_sensor_baseline_ != nullptr)
136
137 // Store baselines after defined interval or if the difference between current and stored baseline becomes too
138 // much
139 if (this->store_baseline_ &&
140 (this->seconds_since_last_store_ > SHORTEST_BASELINE_STORE_INTERVAL ||
141 (uint32_t) abs(this->baselines_storage_.eco2 - this->eco2_baseline_) > MAXIMUM_STORAGE_DIFF ||
142 (uint32_t) abs(this->baselines_storage_.tvoc - this->tvoc_baseline_) > MAXIMUM_STORAGE_DIFF)) {
146 if (this->pref_.save(&this->baselines_storage_)) {
147 ESP_LOGI(TAG, "Store eCO2 baseline: 0x%04X, TVOC baseline: 0x%04X", this->baselines_storage_.eco2,
148 this->baselines_storage_.tvoc);
149 } else {
150 ESP_LOGW(TAG, "Could not store eCO2 and TVOC baselines");
151 }
152 }
153 }
154 this->status_clear_warning();
155 });
156 } else {
157 ESP_LOGD(TAG, "Baseline reading not available for: %.0fs",
158 (this->required_warm_up_time_ - std::floor(millis() / 1000)));
159 }
160}
161
163 if (this->humidity_sensor_ == nullptr && this->temperature_sensor_ == nullptr)
164 return;
165 float humidity = NAN;
166 if (this->humidity_sensor_ != nullptr)
167 humidity = this->humidity_sensor_->state;
168 if (std::isnan(humidity) || humidity < 0.0f || humidity > 100.0f) {
169 ESP_LOGW(TAG, "Compensation not possible yet: bad humidity data.");
170 return;
171 } else {
172 ESP_LOGD(TAG, "External compensation data received: Humidity %0.2f%%", humidity);
173 }
174 float temperature = NAN;
175 if (this->temperature_sensor_ != nullptr) {
176 temperature = float(this->temperature_sensor_->state);
177 }
178 if (std::isnan(temperature) || temperature < -40.0f || temperature > 85.0f) {
179 ESP_LOGW(TAG, "Compensation not possible yet: bad temperature value data.");
180 return;
181 } else {
182 ESP_LOGD(TAG, "External compensation data received: Temperature %0.2f°C", temperature);
183 }
184
185 float absolute_humidity;
186 if (temperature < 0) {
187 absolute_humidity =
188 216.67f *
189 ((humidity * 0.061121f * std::exp((23.036f - temperature / 333.7f) * (temperature / (279.82f + temperature)))) /
190 (273.15f + temperature));
191 } else {
192 absolute_humidity =
193 216.67f *
194 ((humidity * 0.061121f * std::exp((18.678f - temperature / 234.5f) * (temperature / (257.14f + temperature)))) /
195 (273.15f + temperature));
196 }
197 uint8_t humidity_full = uint8_t(std::floor(absolute_humidity));
198 uint8_t humidity_dec = uint8_t(std::floor((absolute_humidity - std::floor(absolute_humidity)) * 256));
199 ESP_LOGD(TAG, "Calculated Absolute humidity: %0.3f g/m³ (0x%04X)", absolute_humidity,
200 uint16_t(uint16_t(humidity_full) << 8 | uint16_t(humidity_dec)));
201 uint8_t crc = sht_crc_(humidity_full, humidity_dec);
202 uint8_t data[4];
203 data[0] = SGP30_CMD_SET_ABSOLUTE_HUMIDITY & 0xFF;
204 data[1] = humidity_full;
205 data[2] = humidity_dec;
206 data[3] = crc;
207 if (!this->write_bytes(SGP30_CMD_SET_ABSOLUTE_HUMIDITY >> 8, data, 4)) {
208 ESP_LOGE(TAG, "Error sending compensation data.");
209 }
210}
211
212void SGP30Component::write_iaq_baseline_(uint16_t eco2_baseline, uint16_t tvoc_baseline) {
213 uint8_t data[7];
214 data[0] = SGP30_CMD_SET_IAQ_BASELINE & 0xFF;
215 data[1] = tvoc_baseline >> 8;
216 data[2] = tvoc_baseline & 0xFF;
217 data[3] = sht_crc_(data[1], data[2]);
218 data[4] = eco2_baseline >> 8;
219 data[5] = eco2_baseline & 0xFF;
220 data[6] = sht_crc_(data[4], data[5]);
221 if (!this->write_bytes(SGP30_CMD_SET_IAQ_BASELINE >> 8, data, 7)) {
222 ESP_LOGE(TAG, "Error applying eCO2 baseline: 0x%04X, TVOC baseline: 0x%04X", eco2_baseline, tvoc_baseline);
223 } else {
224 ESP_LOGI(TAG, "Initial baselines applied successfully! eCO2 baseline: 0x%04X, TVOC baseline: 0x%04X", eco2_baseline,
225 tvoc_baseline);
226 }
227}
228
230 ESP_LOGCONFIG(TAG, "SGP30:");
231 LOG_I2C_DEVICE(this);
232 if (this->is_failed()) {
233 switch (this->error_code_) {
235 ESP_LOGW(TAG, "Communication failed! Is the sensor connected?");
236 break;
238 ESP_LOGW(TAG, "Measurement Initialization failed!");
239 break;
240 case INVALID_ID:
241 ESP_LOGW(TAG, "Sensor reported an invalid ID. Is this an SGP30?");
242 break;
243 case UNSUPPORTED_ID:
244 ESP_LOGW(TAG, "Sensor reported an unsupported ID (SGPC3).");
245 break;
246 default:
247 ESP_LOGW(TAG, "Unknown setup error!");
248 break;
249 }
250 } else {
251 ESP_LOGCONFIG(TAG, " Serial number: %" PRIu64, this->serial_number_);
252 if (this->eco2_baseline_ != 0x0000 && this->tvoc_baseline_ != 0x0000) {
253 ESP_LOGCONFIG(TAG, " Baseline:");
254 ESP_LOGCONFIG(TAG, " eCO2 Baseline: 0x%04X", this->eco2_baseline_);
255 ESP_LOGCONFIG(TAG, " TVOC Baseline: 0x%04X", this->tvoc_baseline_);
256 } else {
257 ESP_LOGCONFIG(TAG, " Baseline: No baseline configured");
258 }
259 ESP_LOGCONFIG(TAG, " Warm up time: %" PRIu32 "s", this->required_warm_up_time_);
260 }
261 LOG_UPDATE_INTERVAL(this);
262 LOG_SENSOR(" ", "eCO2 sensor", this->eco2_sensor_);
263 LOG_SENSOR(" ", "TVOC sensor", this->tvoc_sensor_);
264 LOG_SENSOR(" ", "eCO2 baseline sensor", this->eco2_sensor_baseline_);
265 LOG_SENSOR(" ", "TVOC baseline sensor", this->tvoc_sensor_baseline_);
266 ESP_LOGCONFIG(TAG, "Store baseline: %s", YESNO(this->store_baseline_));
267 if (this->humidity_sensor_ != nullptr && this->temperature_sensor_ != nullptr) {
268 ESP_LOGCONFIG(TAG, " Compensation:");
269 LOG_SENSOR(" ", "Temperature Source:", this->temperature_sensor_);
270 LOG_SENSOR(" ", "Humidity Source:", this->humidity_sensor_);
271 } else {
272 ESP_LOGCONFIG(TAG, " Compensation: No source configured");
273 }
274}
275
277 if (!this->write_command(SGP30_CMD_MEASURE_IAQ)) {
278 this->status_set_warning();
279 return;
280 }
281 this->seconds_since_last_store_ += this->update_interval_ / 1000;
282 this->set_timeout(50, [this]() {
283 uint16_t raw_data[2];
284 if (!this->read_data(raw_data, 2)) {
285 this->status_set_warning();
286 return;
287 }
288
289 float eco2 = (raw_data[0]);
290 float tvoc = (raw_data[1]);
291
292 ESP_LOGD(TAG, "Got eCO2=%.1fppm TVOC=%.1fppb", eco2, tvoc);
293 if (this->eco2_sensor_ != nullptr)
294 this->eco2_sensor_->publish_state(eco2);
295 if (this->tvoc_sensor_ != nullptr)
296 this->tvoc_sensor_->publish_state(tvoc);
297
298 this->status_clear_warning();
299 this->send_env_data_();
300 this->read_iaq_baseline_();
301 });
302}
303
304} // namespace sgp30
305} // namespace esphome
std::string get_compilation_time() const
virtual void mark_failed()
Mark this component as failed.
bool is_failed() const
void status_set_warning(const char *message="unspecified")
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.
Definition component.cpp:72
bool save(const T *src)
Definition preferences.h:21
virtual ESPPreferenceObject make_preference(size_t length, uint32_t type, bool in_flash)=0
bool write_bytes(uint8_t a_register, const uint8_t *data, uint8_t len, bool stop=true)
Definition i2c.h:252
bool get_register(uint16_t command, uint16_t *data, uint8_t len, uint8_t delay=0)
get data words from i2c register.
uint8_t sht_crc_(uint16_t data)
8-bit CRC checksum that is transmitted after each data word for read and write operation
bool write_command(T i2c_register)
Write a command to the i2c device.
bool read_data(uint16_t *data, uint8_t len)
Read data words from i2c device.
void publish_state(float state)
Publish a new state to the front-end.
Definition sensor.cpp:39
float state
This member variable stores the last state that has passed through all filters.
Definition sensor.h:131
sensor::Sensor * eco2_sensor_baseline_
Definition sgp30.h:59
sensor::Sensor * temperature_sensor_
Definition sgp30.h:67
SGP30Baselines baselines_storage_
Definition sgp30.h:46
sensor::Sensor * tvoc_sensor_
Definition sgp30.h:58
sensor::Sensor * tvoc_sensor_baseline_
Definition sgp30.h:60
sensor::Sensor * humidity_sensor_
Input sensor for humidity and temperature compensation.
Definition sgp30.h:66
uint32_t seconds_since_last_store_
Definition sgp30.h:45
ESPPreferenceObject pref_
Definition sgp30.h:47
void write_iaq_baseline_(uint16_t eco2_baseline, uint16_t tvoc_baseline)
Definition sgp30.cpp:212
void dump_config() override
Definition sgp30.cpp:229
sensor::Sensor * eco2_sensor_
Definition sgp30.h:57
const uint32_t IAQ_BASELINE_WARM_UP_SECONDS_WITHOUT_BASELINE
Definition sgp30.cpp:26
const uint32_t SHORTEST_BASELINE_STORE_INTERVAL
Definition sgp30.cpp:30
const uint32_t MAXIMUM_STORAGE_DIFF
Definition sgp30.cpp:33
const uint32_t IAQ_BASELINE_WARM_UP_SECONDS_WITH_BASELINE_PROVIDED
Definition sgp30.cpp:22
Providing packet encoding functions for exchanging data with a remote host.
Definition a01nyub.cpp:7
uint32_t fnv1_hash(const std::string &str)
Calculate a FNV-1 hash of str.
Definition helpers.cpp:186
ESPPreferences * global_preferences
uint32_t IRAM_ATTR HOT millis()
Definition core.cpp:27
Application App
Global storage of Application pointer - only one Application can exist.
uint16_t temperature
Definition sun_gtil2.cpp:12