jeans/esphome
jeans/esphome
1
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2025-07-29 14:46:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

[tsl2561, tsl2591] Shorten log messages (#9034)

Browse Source
This commit is contained in:
Keith Burzinski 2025-06-09 00:45:17 -05:00 committed by GitHub
parent ff406f8e11
commit 99c368fe62
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 17 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
esphome/components/tsl2561/tsl2561.cpp
View File

@ -67,7 +67,7 @@ void TSL2561Sensor::update() {
float TSL2561Sensor::calculate_lx_(uint16_t ch0, uint16_t ch1) { float TSL2561Sensor::calculate_lx_(uint16_t ch0, uint16_t ch1) {
if ((ch0 == 0xFFFF) || (ch1 == 0xFFFF)) { if ((ch0 == 0xFFFF) || (ch1 == 0xFFFF)) {
ESP_LOGW(TAG, "TSL2561 sensor is saturated."); ESP_LOGW(TAG, "Sensor is saturated");
return NAN; return NAN;
} }

37
esphome/components/tsl2591/tsl2591.cpp
View File

@ -26,13 +26,13 @@ static const char *const TAG = "tsl2591.sensor";
void TSL2591Component::enable() { void TSL2591Component::enable() {
// Enable the device by setting the control bit to 0x01. Also turn on ADCs. // Enable the device by setting the control bit to 0x01. Also turn on ADCs.
if (!this->write_byte(TSL2591_COMMAND_BIT | TSL2591_REGISTER_ENABLE, TSL2591_ENABLE_POWERON | TSL2591_ENABLE_AEN)) { if (!this->write_byte(TSL2591_COMMAND_BIT | TSL2591_REGISTER_ENABLE, TSL2591_ENABLE_POWERON | TSL2591_ENABLE_AEN)) {
ESP_LOGE(TAG, "Failed I2C write during enable()"); ESP_LOGE(TAG, "I2C write failed");
} }
} }
void TSL2591Component::disable() { void TSL2591Component::disable() {
if (!this->write_byte(TSL2591_COMMAND_BIT | TSL2591_REGISTER_ENABLE, TSL2591_ENABLE_POWEROFF)) { if (!this->write_byte(TSL2591_COMMAND_BIT | TSL2591_REGISTER_ENABLE, TSL2591_ENABLE_POWEROFF)) {
ESP_LOGE(TAG, "Failed I2C write during disable()"); ESP_LOGE(TAG, "I2C write failed");
} }
} }
@ -43,6 +43,7 @@ void TSL2591Component::disable_if_power_saving_() {
} }
void TSL2591Component::setup() { void TSL2591Component::setup() {
ESP_LOGCONFIG(TAG, "Running setup for address 0x%02X", this->address_);
switch (this->component_gain_) { switch (this->component_gain_) {
case TSL2591_CGAIN_LOW: case TSL2591_CGAIN_LOW:
this->gain_ = TSL2591_GAIN_LOW; this->gain_ = TSL2591_GAIN_LOW;
@ -61,21 +62,15 @@ void TSL2591Component::setup() {
break; break;
} }
uint8_t address = this->address_;
ESP_LOGI(TAG, "Setting up TSL2591 sensor at I2C address 0x%02X", address);
uint8_t id; uint8_t id;
if (!this->read_byte(TSL2591_COMMAND_BIT | TSL2591_REGISTER_DEVICE_ID, &id)) { if (!this->read_byte(TSL2591_COMMAND_BIT | TSL2591_REGISTER_DEVICE_ID, &id)) {
ESP_LOGE(TAG, "Failed I2C read during setup()"); ESP_LOGE(TAG, "I2C read failed");
this->mark_failed(); this->mark_failed();
return; return;
} }
if (id != 0x50) { if (id != 0x50) {
ESP_LOGE(TAG, ESP_LOGE(TAG, "Unknown chip ID");
"Could not find the TSL2591 sensor. The ID register of the device at address 0x%02X reported 0x%02X "
"instead of 0x50.",
address, id);
this->mark_failed(); this->mark_failed();
return; return;
} }
@ -177,7 +172,7 @@ void TSL2591Component::interval_function_for_update_() {
uint64_t now = millis(); uint64_t now = millis();
ESP_LOGD(TAG, "Elapsed %3llu ms; still waiting for valid ADC", (now - this->interval_start_)); ESP_LOGD(TAG, "Elapsed %3llu ms; still waiting for valid ADC", (now - this->interval_start_));
if (now > this->interval_timeout_) { if (now > this->interval_timeout_) {
ESP_LOGW(TAG, "Interval timeout for TSL2591 '%s' expired before ADCs became valid.", this->name_); ESP_LOGW(TAG, "Interval timeout for '%s' expired before ADCs became valid", this->name_);
this->cancel_interval(interval_name); this->cancel_interval(interval_name);
} }
return; return;
@ -238,7 +233,7 @@ void TSL2591Component::set_integration_time_and_gain(TSL2591IntegrationTime inte
this->gain_ = gain; this->gain_ = gain;
if (!this->write_byte(TSL2591_COMMAND_BIT | TSL2591_REGISTER_CONTROL, if (!this->write_byte(TSL2591_COMMAND_BIT | TSL2591_REGISTER_CONTROL,
this->integration_time_ | this->gain_)) { // NOLINT this->integration_time_ | this->gain_)) { // NOLINT
ESP_LOGE(TAG, "Failed I2C write during set_integration_time_and_gain()"); ESP_LOGE(TAG, "I2C write failed");
} }
// The ADC values can be confused if gain or integration time are changed in the middle of a cycle. // The ADC values can be confused if gain or integration time are changed in the middle of a cycle.
// So, we unconditionally disable the device to turn the ADCs off. When re-enabling, the ADCs // So, we unconditionally disable the device to turn the ADCs off. When re-enabling, the ADCs
@ -258,7 +253,7 @@ float TSL2591Component::get_setup_priority() const { return setup_priority::DATA
bool TSL2591Component::is_adc_valid() { bool TSL2591Component::is_adc_valid() {
uint8_t status; uint8_t status;
if (!this->read_byte(TSL2591_COMMAND_BIT | TSL2591_REGISTER_STATUS, &status)) { if (!this->read_byte(TSL2591_COMMAND_BIT | TSL2591_REGISTER_STATUS, &status)) {
ESP_LOGE(TAG, "Failed I2C read during is_adc_valid()"); ESP_LOGE(TAG, "I2C read failed");
return false; return false;
} }
return status & 0x01; return status & 0x01;
@ -284,7 +279,7 @@ uint32_t TSL2591Component::get_combined_illuminance() {
if (!avalid) { if (!avalid) {
// still not valid after a sutiable delay // still not valid after a sutiable delay
// we don't mark the device as failed since it might come around in the future (probably not :-() // we don't mark the device as failed since it might come around in the future (probably not :-()
ESP_LOGE(TAG, "tsl2591 device '%s' did not return valid readings.", this->name_); ESP_LOGE(TAG, "Device '%s' returned invalid readings", this->name_);
this->disable_if_power_saving_(); this->disable_if_power_saving_();
return 0; return 0;
} }
@ -298,20 +293,20 @@ uint32_t TSL2591Component::get_combined_illuminance() {
uint16_t ch0_16; uint16_t ch0_16;
uint16_t ch1_16; uint16_t ch1_16;
if (!this->read_byte(TSL2591_COMMAND_BIT | TSL2591_REGISTER_CHAN0_LOW, &ch0low)) { if (!this->read_byte(TSL2591_COMMAND_BIT | TSL2591_REGISTER_CHAN0_LOW, &ch0low)) {
ESP_LOGE(TAG, "Failed I2C read during get_combined_illuminance()"); ESP_LOGE(TAG, "I2C read failed");
return 0; return 0;
} }
if (!this->read_byte(TSL2591_COMMAND_BIT | TSL2591_REGISTER_CHAN0_HIGH, &ch0high)) { if (!this->read_byte(TSL2591_COMMAND_BIT | TSL2591_REGISTER_CHAN0_HIGH, &ch0high)) {
ESP_LOGE(TAG, "Failed I2C read during get_combined_illuminance()"); ESP_LOGE(TAG, "I2C read failed");
return 0; return 0;
} }
ch0_16 = (ch0high << 8) | ch0low; ch0_16 = (ch0high << 8) | ch0low;
if (!this->read_byte(TSL2591_COMMAND_BIT | TSL2591_REGISTER_CHAN1_LOW, &ch1low)) { if (!this->read_byte(TSL2591_COMMAND_BIT | TSL2591_REGISTER_CHAN1_LOW, &ch1low)) {
ESP_LOGE(TAG, "Failed I2C read during get_combined_illuminance()"); ESP_LOGE(TAG, "I2C read failed");
return 0; return 0;
} }
if (!this->read_byte(TSL2591_COMMAND_BIT | TSL2591_REGISTER_CHAN1_HIGH, &ch1high)) { if (!this->read_byte(TSL2591_COMMAND_BIT | TSL2591_REGISTER_CHAN1_HIGH, &ch1high)) {
ESP_LOGE(TAG, "Failed I2C read during get_combined_illuminance()"); ESP_LOGE(TAG, "I2C read failed");
return 0; return 0;
} }
ch1_16 = (ch1high << 8) | ch1low; ch1_16 = (ch1high << 8) | ch1low;
@ -338,7 +333,7 @@ uint16_t TSL2591Component::get_illuminance(TSL2591SensorChannel channel, uint32_
return ((combined_illuminance & 0xFFFF) - (combined_illuminance >> 16)); return ((combined_illuminance & 0xFFFF) - (combined_illuminance >> 16));
} }
// unknown channel! // unknown channel!
ESP_LOGE(TAG, "TSL2591Component::get_illuminance() caller requested an unknown channel: %d", channel); ESP_LOGE(TAG, "get_illuminance() caller requested an unknown channel: %d", channel);
return 0; return 0;
} }
@ -361,13 +356,13 @@ float TSL2591Component::get_calculated_lux(uint16_t full_spectrum, uint16_t infr
uint16_t max_count = (this->integration_time_ == TSL2591_INTEGRATION_TIME_100MS ? 36863 : 65535); uint16_t max_count = (this->integration_time_ == TSL2591_INTEGRATION_TIME_100MS ? 36863 : 65535);
if ((full_spectrum == max_count) || (infrared == max_count)) { if ((full_spectrum == max_count) || (infrared == max_count)) {
// Signal an overflow // Signal an overflow
ESP_LOGW(TAG, "Apparent saturation on TSL2591 (%s). You could reduce the gain or integration time.", this->name_); ESP_LOGW(TAG, "Apparent saturation on '%s'; try reducing the gain or integration time", this->name_);
return NAN; return NAN;
} }
if ((full_spectrum == 0) && (infrared == 0)) { if ((full_spectrum == 0) && (infrared == 0)) {
// trivial conversion; avoids divide by 0 // trivial conversion; avoids divide by 0
ESP_LOGW(TAG, "Zero reading on both TSL2591 (%s) sensors. Is the device having a problem?", this->name_); ESP_LOGW(TAG, "Zero reading on both '%s' sensors", this->name_);
return 0.0F; return 0.0F;
} }