11static const size_t VEML_REG_SIZE = 2;
13static float reduce_to_zero(
float a,
float b) {
return (a > b) ? (a - b) : 0; }
16template<
typename T,
size_t size> T
get_next(
const uint16_t (&array)[
size],
const T
val) {
18 size_t idx = std::numeric_limits<size_t>::max();
19 while (idx == std::numeric_limits<size_t>::max() && i <
size) {
26 if (idx == std::numeric_limits<size_t>::max() || i + 1 >=
size)
31template<
typename T,
size_t size> T
get_prev(
const uint16_t (&array)[
size],
const T
val) {
33 size_t idx = std::numeric_limits<size_t>::max();
34 while (idx == std::numeric_limits<size_t>::max() && i > 0) {
41 if (idx == std::numeric_limits<size_t>::max() || i == 0)
73static float get_gain_coeff(
Gain gain) {
75 alignas(4)
static constexpr float GAIN_FLOAT[
GAINS_COUNT] PROGMEM = {1.0f, 2.0f, 0.125f, 0.25f};
76 return GAIN_FLOAT[
gain & 0b11];
81static const LogString *get_gain_str(
Gain gain) {
82 return GainStrings::get_log_str(
gain & 0b11, GainStrings::LAST_INDEX);
88 this->
mark_failed(LOG_STR(
"Sensor configuration failed"));
90 this->state_ = State::INITIAL_SETUP_COMPLETED;
100 " Integration time: %d ms",
104 " Lux compensation: %s\n"
105 " Glass attenuation factor: %f",
107 LOG_UPDATE_INTERVAL(
this);
109 LOG_SENSOR(
" ",
"ALS channel lux", this->ambient_light_sensor_);
110 LOG_SENSOR(
" ",
"ALS channel counts", this->ambient_light_counts_sensor_);
111 LOG_SENSOR(
" ",
"WHITE channel lux", this->white_sensor_);
112 LOG_SENSOR(
" ",
"WHITE channel counts", this->white_counts_sensor_);
113 LOG_SENSOR(
" ",
"FAKE_IR channel lux", this->infrared_sensor_);
114 LOG_SENSOR(
" ",
"Actual gain", this->actual_gain_sensor_);
115 LOG_SENSOR(
" ",
"Actual integration time", this->actual_integration_time_sensor_);
119 if (this->
is_ready() && this->state_ == State::IDLE) {
120 ESP_LOGV(TAG,
"Update: Initiating new data collection");
132 ESP_LOGV(TAG,
"Update: Component not ready yet");
139 if (this->state_ == State::INITIAL_SETUP_COMPLETED) {
147 switch (this->state_) {
152 case State::COLLECTING_DATA:
154 this->state_ = (err ==
i2c::ERROR_OK) ? State::DATA_COLLECTED : State::IDLE;
157 case State::COLLECTING_DATA_AUTO:
158 case State::DATA_COLLECTED:
160 this->state_ = State::READY_TO_PUBLISH_PART_1;
164 this->state_ = State::ADJUSTMENT_IN_PROGRESS;
168 [
this]() { this->state_ = State::READY_TO_APPLY_ADJUSTMENTS; });
170 this->state_ = State::IDLE;
175 case State::ADJUSTMENT_IN_PROGRESS:
179 case State::READY_TO_APPLY_ADJUSTMENTS:
182 this->state_ = State::ADJUSTMENT_IN_PROGRESS;
186 [
this]() { this->state_ = State::COLLECTING_DATA; });
188 this->state_ = State::IDLE;
192 case State::READY_TO_PUBLISH_PART_1:
200 this->state_ = State::READY_TO_PUBLISH_PART_2;
203 case State::READY_TO_PUBLISH_PART_2:
205 this->state_ = State::READY_TO_PUBLISH_PART_3;
208 case State::READY_TO_PUBLISH_PART_3:
210 this->state_ = State::IDLE;
222 ESP_LOGV(TAG,
"Configure");
228 als_conf.ALS_GAIN = this->
gain_;
230 als_conf.ALS_SD =
true;
231 ESP_LOGV(TAG,
"Shutdown before config. ALS_CONF_0 to 0x%04X", als_conf.raw);
234 ESP_LOGW(TAG,
"Failed to shutdown, I2C error %d", err);
239 als_conf.ALS_SD =
false;
240 ESP_LOGV(TAG,
"Turning on. Setting ALS_CONF_0 to 0x%04X", als_conf.raw);
243 ESP_LOGW(TAG,
"Failed to turn on, I2C error %d", err);
250 ESP_LOGV(TAG,
"Setting PSM to 0x%04X", psm.raw);
253 ESP_LOGW(TAG,
"Failed to set PSM, I2C error %d", err);
261 ESP_LOGV(TAG,
"Reconfigure time and gain (%d ms, %s) %s", get_itime_ms(time), LOG_STR_ARG(get_gain_str(
gain)),
262 shutdown ? LOG_STR_LITERAL(
"Shutting down") : LOG_STR_LITERAL(
"Turning back on"));
268 als_conf.ALS_SD = shutdown;
269 als_conf.ALS_INT_EN =
false;
271 als_conf.ALS_IT = time;
272 als_conf.ALS_GAIN =
gain;
275 ESP_LOGW(TAG,
"%s failed", shutdown ? LOG_STR_LITERAL(
"Shutdown") : LOG_STR_LITERAL(
"Turn on"));
284 ESP_LOGW(TAG,
"Error reading ALS register, err = %d", als_err);
289 ESP_LOGW(TAG,
"Error reading WHITE register, err = %d", white_err);
295 ESP_LOGW(TAG,
"Error reading ALS_CONF_0 register, err = %d", white_err);
297 data.actual_time = conf.ALS_IT;
298 data.actual_gain = conf.ALS_GAIN;
300 ESP_LOGV(TAG,
"Data from sensors: ALS = %d, WHITE = %d, Gain = %s, Time = %d ms", data.als_counts, data.white_counts,
301 LOG_STR_ARG(get_gain_str(data.actual_gain)), get_itime_ms(data.actual_time));
302 return std::max(als_err, white_err);
308 if (this->state_ == State::COLLECTING_DATA_AUTO)
315 static constexpr uint16_t LOW_INTENSITY_THRESHOLD = 100;
316 static constexpr uint16_t HIGH_INTENSITY_THRESHOLD = 10000;
323 if (data.als_counts <= LOW_INTENSITY_THRESHOLD) {
325 if (next_gain != data.actual_gain) {
326 data.actual_gain = next_gain;
330 if (next_time != data.actual_time) {
331 data.actual_time = next_time;
334 }
else if (data.als_counts >= HIGH_INTENSITY_THRESHOLD) {
336 if (prev_gain != data.actual_gain) {
337 data.actual_gain = prev_gain;
341 if (prev_time != data.actual_time) {
342 data.actual_time = prev_time;
353 static const float MAX_GAIN = 2.0f;
354 static const float MAX_ITIME_MS = 800.0f;
355 static const float MAX_LX_RESOLUTION = 0.0036f;
356 float lux_resolution = (MAX_ITIME_MS / (float) get_itime_ms(data.actual_time)) *
357 (MAX_GAIN / get_gain_coeff(data.actual_gain)) * MAX_LX_RESOLUTION;
358 ESP_LOGV(TAG,
"Lux resolution for (%d, %s) = %.4f ", get_itime_ms(data.actual_time),
359 LOG_STR_ARG(get_gain_str(data.actual_gain)), lux_resolution);
361 data.als_lux = lux_resolution * (float) data.als_counts;
362 data.white_lux = lux_resolution * (float) data.white_counts;
363 data.fake_infrared_lux = reduce_to_zero(data.white_lux, data.als_lux);
365 ESP_LOGV(TAG,
"%s mode - ALS = %.1f lx, WHITE = %.1f lx, FAKE_IR = %.1f lx",
367 data.white_lux, data.fake_infrared_lux);
373 auto &local_data = data;
381 auto compensate = [&local_data](
float &lux) {
382 auto calculate_high_lux_compensation = [](
float lux_veml) ->
float {
383 return (((6.0135e-13f * lux_veml - 9.3924e-9f) * lux_veml + 8.1488e-5f) * lux_veml + 1.0023f) * lux_veml;
387 lux = calculate_high_lux_compensation(lux);
391 compensate(data.als_lux);
392 compensate(data.white_lux);
393 data.fake_infrared_lux = reduce_to_zero(data.white_lux, data.als_lux);
395 ESP_LOGV(TAG,
"Lux compensation - ALS = %.1f lx, WHITE = %.1f lx, FAKE_IR = %.1f lx", data.als_lux, data.white_lux,
396 data.fake_infrared_lux);
403 ESP_LOGV(TAG,
"Glass attenuation - ALS = %.1f lx, WHITE = %.1f lx, FAKE_IR = %.1f lx", data.als_lux, data.white_lux,
404 data.fake_infrared_lux);
408 PUBLISH_STATE(this->ambient_light_sensor_, data.als_lux);
409 PUBLISH_STATE(this->white_sensor_, data.white_lux);
413 PUBLISH_STATE(this->infrared_sensor_, data.fake_infrared_lux);
414 PUBLISH_STATE(this->ambient_light_counts_sensor_, data.als_counts);
415 PUBLISH_STATE(this->white_counts_sensor_, data.white_counts);
419 PUBLISH_STATE(this->actual_gain_sensor_, get_gain_coeff(data.actual_gain));
420 PUBLISH_STATE(this->actual_integration_time_sensor_, get_itime_ms(data.actual_time));
void mark_failed()
Mark this component as failed.
void status_set_warning()
void set_timeout(const char *name, uint32_t timeout, std::function< void()> &&f)
Set a timeout function with a const char* name.
void status_clear_warning()
ErrorCode write_register(uint8_t a_register, const uint8_t *data, size_t len) const
writes an array of bytes to a specific register in the I²C device
ErrorCode read_register(uint8_t a_register, uint8_t *data, size_t len)
reads an array of bytes from a specific register in the I²C device
void publish_data_part_1_(Readings &data)
bool lux_compensation_enabled_
float glass_attenuation_factor_
void dump_config() override
void publish_data_part_2_(Readings &data)
void publish_data_part_3_(Readings &data)
IntegrationTime integration_time_
void apply_glass_attenuation_(Readings &data)
bool are_adjustments_required_(Readings &data)
SUB_SENSOR(ambient_light) SUB_SENSOR(ambient_light_counts) SUB_SENSOR(white) SUB_SENSOR(white_counts) SUB_SENSOR(infrared) SUB_SENSOR(actual_gain) SUB_SENSOR(actual_integration_time) protected struct esphome::veml7700::VEML7700Component::Readings readings_
ErrorCode reconfigure_time_and_gain_(IntegrationTime time, Gain gain, bool shutdown)
void apply_lux_calculation_(Readings &data)
bool automatic_mode_enabled_
void apply_lux_compensation_(Readings &data)
ErrorCode read_sensor_output_(Readings &data)
ErrorCode
Error codes returned by I2CBus and I2CDevice methods.
@ ERROR_OK
No error found during execution of method.
T get_prev(const uint16_t(&array)[size], const T val)
PROGMEM_STRING_TABLE(GainStrings, "1x", "2x", "1/8x", "1/4x")
T get_next(const uint16_t(&array)[size], const T val)
ESPHOME_LOG_TAG(TAG, "veml7700")
const uint8_t INTEGRATION_TIMES_COUNT
const uint8_t GAINS_COUNT
uint16_t progmem_read_uint16(const uint16_t *addr)
void HOT delay(uint32_t ms)
IntegrationTime actual_time