ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
bh1745.cpp
Go to the documentation of this file.
1#include "bh1745.h"
2#include <cinttypes>
3#include <cmath>
5#include "esphome/core/log.h"
6
7namespace esphome::bh1745 {
8
9ESPHOME_LOG_TAG(TAG, "bh1745");
10
11static constexpr uint8_t REG_SYSTEM_CONTROL = 0x40;
12static constexpr uint8_t REG_MODE_CONTROL1 = 0x41;
13static constexpr uint8_t REG_MODE_CONTROL2 = 0x42;
14static constexpr uint8_t REG_MODE_CONTROL3 = 0x44;
15static constexpr uint8_t REG_RED_DATA_LSB = 0x50;
16static constexpr uint8_t REG_INTERRUPT = 0x60;
17static constexpr uint8_t REG_TH_LSB = 0x62;
18static constexpr uint8_t REG_MANUFACTURER_ID = 0x92;
19
20static constexpr uint8_t MANUFACTURER_ID = 0xE0;
21static constexpr uint8_t PART_ID = 0b001011;
22static constexpr uint8_t SYSTEM_CONTROL_PART_ID_MASK = 0x3F;
23static constexpr uint8_t SYSTEM_CONTROL_SW_RESET = 0x80;
24static constexpr uint8_t MODE_CONTROL2_RGBC_EN = 0x10;
25static constexpr uint8_t MODE_CONTROL2_VALID = 0x80;
26static constexpr uint8_t MODE_CONTROL3_VALUE = 0x02; // the datasheet says always write 0x02
27static constexpr uint8_t INTERRUPT_ENABLE = 0x01;
28
29static constexpr uint8_t BH1745_CHANNELS = 4;
30static constexpr uint32_t RESET_DELAY_MS = 100;
31static constexpr uint32_t BASE_MEAS_TIME_MS = 160;
32
33static uint32_t get_measurement_time_ms(MeasurementTime time) {
34 return BASE_MEAS_TIME_MS << static_cast<uint8_t>(time);
35}
36
37static uint8_t get_adc_gain(AdcGain gain) {
38 return gain == AdcGain::ADC_GAIN_16X ? 16 : 1 + static_cast<uint8_t>(gain);
39}
40
41static float calculate_lux(uint16_t red, uint16_t green, bool low_clear_ratio, float scale) {
42 if (green == 0)
43 return 0.0f;
44 float lx = low_clear_ratio ? 0.202f * red + 0.766f * green : 0.159f * red + 0.646f * green;
45 return lx * scale;
46}
47
48static float calculate_cct(uint16_t red, uint16_t green, uint16_t blue, bool low_clear_ratio) {
49 if (green == 0)
50 return 0.0f;
51 float all = static_cast<float>(static_cast<uint32_t>(red) + green + blue);
52 float r_ratio = red / all;
53 float b_ratio = blue / all;
54 float ct;
55 if (low_clear_ratio) {
56 float b_eff = std::fmin(b_ratio * 3.13f, 1.0f);
57 ct = ((1.0f - b_eff) * 12746.0f * std::exp(-2.911f * r_ratio)) + (b_eff * 1637.0f * std::exp(4.865f * b_ratio));
58 } else {
59 float b_eff = std::fmin(b_ratio * 10.67f, 1.0f);
60 ct = ((1.0f - b_eff) * 16234.0f * std::exp(-2.781f * r_ratio)) + (b_eff * 1882.0f * std::exp(4.448f * b_ratio));
61 }
62 return clamp_at_most(ct, 10000.0f);
63}
64
66 if (!this->check_chip_id(this, REG_MANUFACTURER_ID, MANUFACTURER_ID))
67 return;
68 uint8_t system_control;
69 if (!this->read_byte(REG_SYSTEM_CONTROL, &system_control) ||
70 (system_control & SYSTEM_CONTROL_PART_ID_MASK) != PART_ID) {
71 this->mark_failed(LOG_STR("Wrong part ID"));
72 return;
73 }
74 if (!this->write_byte(REG_SYSTEM_CONTROL, SYSTEM_CONTROL_SW_RESET)) {
75 this->mark_failed(LOG_STR(ESP_LOG_MSG_COMM_FAIL));
76 return;
77 }
78
79 // Light lost behind glass is scaled back up, as the other light sensors do
80 this->lux_scale_ = 160.0f * this->glass_attenuation_factor_ /
81 (get_adc_gain(this->adc_gain_) * get_measurement_time_ms(this->measurement_time_));
82
83 this->set_timeout(RESET_DELAY_MS, [this]() {
84 if (this->interrupt_output_) {
85 // High threshold 0 and low threshold 0xFFFF (low byte first) make the interrupt condition always
86 // true, so the INT pin simply follows the enable bit, which drives the breakout's LEDs.
87 static constexpr uint8_t THRESHOLDS[4] = {0x00, 0x00, 0xFF, 0xFF};
88 if (!this->write_bytes(REG_TH_LSB, THRESHOLDS, sizeof(THRESHOLDS))) {
89 this->mark_failed(LOG_STR(ESP_LOG_MSG_COMM_FAIL));
90 return;
91 }
92 }
93 // RGBC_EN makes the chip measure continuously; update() reads the latest result.
94 if (!this->write_byte(REG_MODE_CONTROL1, static_cast<uint8_t>(this->measurement_time_)) ||
95 !this->write_byte(REG_MODE_CONTROL2, static_cast<uint8_t>(this->adc_gain_) | MODE_CONTROL2_RGBC_EN) ||
96 !this->write_byte(REG_MODE_CONTROL3, MODE_CONTROL3_VALUE)) {
97 this->mark_failed(LOG_STR(ESP_LOG_MSG_COMM_FAIL));
98 return;
99 }
100 this->busy_ = false;
101 });
102}
103
104void BH1745Component::dump_config() {
105 ESP_LOGCONFIG(TAG,
106 "BH1745:\n"
107 " Gain: %ux\n"
108 " Integration time: %" PRIu32 " ms\n"
109 " Glass attenuation factor: %.2f",
110 get_adc_gain(this->adc_gain_), get_measurement_time_ms(this->measurement_time_),
112 LOG_I2C_DEVICE(this);
113 LOG_UPDATE_INTERVAL(this);
114
115 LOG_SENSOR(" ", "Red Counts", this->red_counts_sensor_);
116 LOG_SENSOR(" ", "Green Counts", this->green_counts_sensor_);
117 LOG_SENSOR(" ", "Blue Counts", this->blue_counts_sensor_);
118 LOG_SENSOR(" ", "Clear Counts", this->clear_counts_sensor_);
119 LOG_SENSOR(" ", "Illuminance", this->illuminance_sensor_);
120 LOG_SENSOR(" ", "Color Temperature", this->color_temperature_sensor_);
121}
122
123void BH1745Component::update() {
124 if (this->busy_)
125 return;
126
127 // Reading MODE_CONTROL2 clears VALID, so read it only once per poll.
128 uint8_t mode_control2;
129 if (!this->read_byte(REG_MODE_CONTROL2, &mode_control2)) {
130 this->status_set_warning(LOG_STR(ESP_LOG_MSG_COMM_FAIL));
131 return;
132 }
133 if ((mode_control2 & MODE_CONTROL2_VALID) == 0)
134 return;
135
136 uint16_t buffer[BH1745_CHANNELS];
137 if (!this->status_comm_result(this->read_bytes_16_le(REG_RED_DATA_LSB, buffer, BH1745_CHANNELS)))
138 return;
139
140 const uint16_t red = buffer[0];
141 const uint16_t green = buffer[1];
142 const uint16_t blue = buffer[2];
143 const uint16_t clear = buffer[3];
144 ESP_LOGV(TAG, "Red: %u, Green: %u, Blue: %u, Clear: %u", red, green, blue, clear);
145
146 PUBLISH_STATE(this->red_counts_sensor_, red);
147 PUBLISH_STATE(this->green_counts_sensor_, green);
148 PUBLISH_STATE(this->blue_counts_sensor_, blue);
149 PUBLISH_STATE(this->clear_counts_sensor_, clear);
150
151 // The datasheet picks its coefficients by whether clear / green < 0.160 (= 4 / 25).
152 const bool low_clear_ratio = static_cast<uint32_t>(clear) * 25 < static_cast<uint32_t>(green) * 4;
153 PUBLISH_STATE(this->illuminance_sensor_, calculate_lux(red, green, low_clear_ratio, this->lux_scale_));
154 PUBLISH_STATE(this->color_temperature_sensor_, calculate_cct(red, green, blue, low_clear_ratio));
155}
156
157void BH1745Component::set_interrupt_state(bool on) {
158 if (this->is_failed())
159 return;
160 if (!this->write_byte(REG_INTERRUPT, on ? INTERRUPT_ENABLE : 0x00)) {
161 this->status_set_warning();
162 }
163}
164
165} // namespace esphome::bh1745
void mark_failed()
Mark this component as failed.
virtual void setup()
Where the component's initialization should happen.
Definition component.cpp:84
bool is_failed() const
Definition component.h:287
bool status_comm_result(bool ok)
Clears the warning when ok, else sets it with message (default "Communication failed"); returns ok.
void set_timeout(const char *name, uint32_t timeout, std::function< void()> &&f)
Set a timeout function with a const char* name.
Definition component.cpp:96
MeasurementTime measurement_time_
Definition bh1745.h:48
bool check_chip_id(Component *component, uint8_t a_register, uint8_t expected, uint8_t mask=0xFF)
Read the 8-bit ID at a_register and accept it when it matches expected in the bits set in mask.
Definition i2c.h:232
bool read_bytes_16_le(uint8_t a_register, uint16_t *data, uint8_t len)
Read len 16-bit values stored least significant byte first; no conversion is compiled on little-endia...
Definition i2c.h:284
bool write_byte(uint8_t a_register, uint8_t data) const
Definition i2c.h:312
bool read_byte(uint8_t a_register, uint8_t *data)
Definition i2c.h:272
bool write_bytes(uint8_t a_register, const uint8_t *data, uint8_t len) const
Definition i2c.h:298
uint32_t buffer
Definition gif.cpp:50
AlsGain501 gain
ESPHOME_LOG_TAG(TAG, "bh1745")
T clamp_at_most(T value, U max)
Definition helpers.h:2576
static void uint32_t