sascha/esphome
1
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2025-09-18 11:12:20 +01:00
Code Issues Releases Wiki Activity

[sps30] Tidy up, optimize (#10606)

Browse Source
This commit is contained in:
Keith Burzinski
2025-09-05 14:11:14 -05:00
committed by GitHub
parent 86c2af4882
commit 0069163d31
2 changed files with 21 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
esphome/components/sps30/sps30.cpp
View File

@@ -43,20 +43,20 @@ void SPS30Component::setup() {
this->serial_number_[i * 2] = static_cast<char>(raw_serial_number[i] >> 8); this->serial_number_[i * 2] = static_cast<char>(raw_serial_number[i] >> 8);
this->serial_number_[i * 2 + 1] = uint16_t(uint16_t(raw_serial_number[i] & 0xFF)); this->serial_number_[i * 2 + 1] = uint16_t(uint16_t(raw_serial_number[i] & 0xFF));
} }
ESP_LOGD(TAG, " Serial Number: '%s'", this->serial_number_); ESP_LOGV(TAG, " Serial number: %s", this->serial_number_);
bool result; bool result;
if (this->fan_interval_.has_value()) { if (this->fan_interval_.has_value()) {
// override default value // override default value
result = write_command(SPS30_CMD_SET_AUTOMATIC_CLEANING_INTERVAL_SECONDS, this->fan_interval_.value()); result = this->write_command(SPS30_CMD_SET_AUTOMATIC_CLEANING_INTERVAL_SECONDS, this->fan_interval_.value());
} else { } else {
result = write_command(SPS30_CMD_SET_AUTOMATIC_CLEANING_INTERVAL_SECONDS); result = this->write_command(SPS30_CMD_SET_AUTOMATIC_CLEANING_INTERVAL_SECONDS);
} }
if (result) { if (result) {
delay(20); delay(20);
uint16_t secs[2]; uint16_t secs[2];
if (this->read_data(secs, 2)) { if (this->read_data(secs, 2)) {
fan_interval_ = secs[0] << 16 | secs[1]; this->fan_interval_ = secs[0] << 16 | secs[1];
} }
} }
@@ -67,7 +67,7 @@ void SPS30Component::setup() {
} }
void SPS30Component::dump_config() { void SPS30Component::dump_config() {
ESP_LOGCONFIG(TAG, "sps30:"); ESP_LOGCONFIG(TAG, "SPS30:");
LOG_I2C_DEVICE(this); LOG_I2C_DEVICE(this);
if (this->is_failed()) { if (this->is_failed()) {
switch (this->error_code_) { switch (this->error_code_) {
@@ -78,16 +78,16 @@ void SPS30Component::dump_config() {
ESP_LOGW(TAG, "Measurement Initialization failed"); ESP_LOGW(TAG, "Measurement Initialization failed");
break; break;
case SERIAL_NUMBER_REQUEST_FAILED: case SERIAL_NUMBER_REQUEST_FAILED:
ESP_LOGW(TAG, "Unable to request sensor serial number"); ESP_LOGW(TAG, "Unable to request serial number");
break; break;
case SERIAL_NUMBER_READ_FAILED: case SERIAL_NUMBER_READ_FAILED:
ESP_LOGW(TAG, "Unable to read sensor serial number"); ESP_LOGW(TAG, "Unable to read serial number");
break; break;
case FIRMWARE_VERSION_REQUEST_FAILED: case FIRMWARE_VERSION_REQUEST_FAILED:
ESP_LOGW(TAG, "Unable to request sensor firmware version"); ESP_LOGW(TAG, "Unable to request firmware version");
break; break;
case FIRMWARE_VERSION_READ_FAILED: case FIRMWARE_VERSION_READ_FAILED:
ESP_LOGW(TAG, "Unable to read sensor firmware version"); ESP_LOGW(TAG, "Unable to read firmware version");
break; break;
default: default:
ESP_LOGW(TAG, "Unknown setup error"); ESP_LOGW(TAG, "Unknown setup error");
@@ -96,9 +96,9 @@ void SPS30Component::dump_config() {
} }
LOG_UPDATE_INTERVAL(this); LOG_UPDATE_INTERVAL(this);
ESP_LOGCONFIG(TAG, ESP_LOGCONFIG(TAG,
" Serial Number: '%s'\n" " Serial number: %s\n"
" Firmware version v%0d.%0d", " Firmware version v%0d.%0d",
this->serial_number_, (raw_firmware_version_ >> 8), uint16_t(raw_firmware_version_ & 0xFF)); this->serial_number_, this->raw_firmware_version_ >> 8, this->raw_firmware_version_ & 0xFF);
LOG_SENSOR(" ", "PM1.0 Weight Concentration", this->pm_1_0_sensor_); LOG_SENSOR(" ", "PM1.0 Weight Concentration", this->pm_1_0_sensor_);
LOG_SENSOR(" ", "PM2.5 Weight Concentration", this->pm_2_5_sensor_); LOG_SENSOR(" ", "PM2.5 Weight Concentration", this->pm_2_5_sensor_);
LOG_SENSOR(" ", "PM4 Weight Concentration", this->pm_4_0_sensor_); LOG_SENSOR(" ", "PM4 Weight Concentration", this->pm_4_0_sensor_);
@@ -113,15 +113,15 @@ void SPS30Component::dump_config() {
void SPS30Component::update() { void SPS30Component::update() {
/// Check if warning flag active (sensor reconnected?) /// Check if warning flag active (sensor reconnected?)
if (this->status_has_warning()) { if (this->status_has_warning()) {
ESP_LOGD(TAG, "Trying to reconnect"); ESP_LOGD(TAG, "Reconnecting");
if (this->write_command(SPS30_CMD_SOFT_RESET)) { if (this->write_command(SPS30_CMD_SOFT_RESET)) {
ESP_LOGD(TAG, "Soft-reset successful. Waiting for reconnection in 500 ms"); ESP_LOGD(TAG, "Soft-reset successful; waiting 500 ms");
this->set_timeout(500, [this]() { this->set_timeout(500, [this]() {
this->start_continuous_measurement_(); this->start_continuous_measurement_();
/// Sensor restarted and reading attempt made next cycle /// Sensor restarted and reading attempt made next cycle
this->status_clear_warning(); this->status_clear_warning();
this->skipped_data_read_cycles_ = 0; this->skipped_data_read_cycles_ = 0;
ESP_LOGD(TAG, "Reconnect successful. Resuming continuous measurement"); ESP_LOGD(TAG, "Reconnected; resuming continuous measurement");
}); });
} else { } else {
ESP_LOGD(TAG, "Soft-reset failed"); ESP_LOGD(TAG, "Soft-reset failed");
@@ -136,12 +136,12 @@ void SPS30Component::update() {
uint16_t raw_read_status; uint16_t raw_read_status;
if (!this->read_data(&raw_read_status, 1) || raw_read_status == 0x00) { if (!this->read_data(&raw_read_status, 1) || raw_read_status == 0x00) {
ESP_LOGD(TAG, "Not ready yet"); ESP_LOGD(TAG, "Not ready");
this->skipped_data_read_cycles_++; this->skipped_data_read_cycles_++;
/// The following logic is required to address the cases when a sensor is quickly replaced before it's marked /// The following logic is required to address the cases when a sensor is quickly replaced before it's marked
/// as failed so that new sensor is eventually forced to be reinitialized for continuous measurement. /// as failed so that new sensor is eventually forced to be reinitialized for continuous measurement.
if (this->skipped_data_read_cycles_ > MAX_SKIPPED_DATA_CYCLES_BEFORE_ERROR) { if (this->skipped_data_read_cycles_ > MAX_SKIPPED_DATA_CYCLES_BEFORE_ERROR) {
ESP_LOGD(TAG, "Exceeded max allowed attempts; communication will be reinitialized"); ESP_LOGD(TAG, "Exceeded max attempts; will reinitialize");
this->status_set_warning(); this->status_set_warning();
} }
return; return;
@@ -211,11 +211,6 @@ void SPS30Component::update() {
} }
bool SPS30Component::start_continuous_measurement_() { bool SPS30Component::start_continuous_measurement_() {
uint8_t data[4];
data[0] = SPS30_CMD_START_CONTINUOUS_MEASUREMENTS & 0xFF;
data[1] = 0x03;
data[2] = 0x00;
data[3] = sht_crc_(0x03, 0x00);
if (!this->write_command(SPS30_CMD_START_CONTINUOUS_MEASUREMENTS, SPS30_CMD_START_CONTINUOUS_MEASUREMENTS_ARG)) { if (!this->write_command(SPS30_CMD_START_CONTINUOUS_MEASUREMENTS, SPS30_CMD_START_CONTINUOUS_MEASUREMENTS_ARG)) {
ESP_LOGE(TAG, "Error initiating measurements"); ESP_LOGE(TAG, "Error initiating measurements");
return false; return false;
@@ -224,9 +219,9 @@ bool SPS30Component::start_continuous_measurement_() {
} }
bool SPS30Component::start_fan_cleaning() { bool SPS30Component::start_fan_cleaning() {
if (!write_command(SPS30_CMD_START_FAN_CLEANING)) { if (!this->write_command(SPS30_CMD_START_FAN_CLEANING)) {
this->status_set_warning(); this->status_set_warning();
ESP_LOGE(TAG, "write error start fan (%d)", this->last_error_); ESP_LOGE(TAG, "Start fan cleaning failed (%d)", this->last_error_);
return false; return false;
} else { } else {
ESP_LOGD(TAG, "Fan auto clean started"); ESP_LOGD(TAG, "Fan auto clean started");

6
esphome/components/sps30/sps30.h
View File

@@ -30,12 +30,12 @@ class SPS30Component : public PollingComponent, public sensirion_common::Sensiri
bool start_fan_cleaning(); bool start_fan_cleaning();
protected: protected:
char serial_number_[17] = {0}; /// Terminating NULL character
uint16_t raw_firmware_version_; uint16_t raw_firmware_version_;
bool start_continuous_measurement_(); char serial_number_[17] = {0}; /// Terminating NULL character
uint8_t skipped_data_read_cycles_ = 0; uint8_t skipped_data_read_cycles_ = 0;
bool start_continuous_measurement_();
enum ErrorCode { enum ErrorCode : uint8_t {
COMMUNICATION_FAILED, COMMUNICATION_FAILED,
FIRMWARE_VERSION_REQUEST_FAILED, FIRMWARE_VERSION_REQUEST_FAILED,
FIRMWARE_VERSION_READ_FAILED, FIRMWARE_VERSION_READ_FAILED,