ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
qmp6988.cpp
Go to the documentation of this file.
1#include "qmp6988.h"
3
4#include <cinttypes>
5#include <cmath>
6
7namespace esphome::qmp6988 {
8
9static const uint8_t QMP6988_CHIP_ID = 0x5C;
10
11static const uint8_t QMP6988_CHIP_ID_REG = 0xD1; /* Chip ID confirmation Register */
12static const uint8_t QMP6988_RESET_REG = 0xE0; /* Device reset register */
13static const uint8_t QMP6988_DEVICE_STAT_REG = 0xF3; /* Device state register */
14static const uint8_t QMP6988_CTRLMEAS_REG = 0xF4; /* Measurement Condition Control Register */
15/* data */
16static const uint8_t QMP6988_PRESSURE_MSB_REG = 0xF7; /* Pressure MSB Register */
17static const uint8_t QMP6988_TEMPERATURE_MSB_REG = 0xFA; /* Temperature MSB Reg */
18
19/* compensation calculation */
20static const uint8_t QMP6988_CALIBRATION_DATA_START = 0xA0; /* QMP6988 compensation coefficients */
21static const uint8_t QMP6988_CALIBRATION_DATA_LENGTH = 25;
22
23/* power mode */
24static const uint8_t QMP6988_SLEEP_MODE = 0x00;
25static const uint8_t QMP6988_FORCED_MODE = 0x01;
26static const uint8_t QMP6988_NORMAL_MODE = 0x03;
27
28static const uint8_t QMP6988_CTRLMEAS_REG_MODE_POS = 0;
29static const uint8_t QMP6988_CTRLMEAS_REG_MODE_MSK = 0x03;
30static const uint8_t QMP6988_CTRLMEAS_REG_MODE_LEN = 2;
31
32static const uint8_t QMP6988_CTRLMEAS_REG_OSRST_POS = 5;
33static const uint8_t QMP6988_CTRLMEAS_REG_OSRST_MSK = 0xE0;
34static const uint8_t QMP6988_CTRLMEAS_REG_OSRST_LEN = 3;
35
36static const uint8_t QMP6988_CTRLMEAS_REG_OSRSP_POS = 2;
37static const uint8_t QMP6988_CTRLMEAS_REG_OSRSP_MSK = 0x1C;
38static const uint8_t QMP6988_CTRLMEAS_REG_OSRSP_LEN = 3;
39
40static const uint8_t QMP6988_CONFIG_REG = 0xF1; /*IIR filter co-efficient setting Register*/
41static const uint8_t QMP6988_CONFIG_REG_FILTER_POS = 0;
42static const uint8_t QMP6988_CONFIG_REG_FILTER_MSK = 0x07;
43static const uint8_t QMP6988_CONFIG_REG_FILTER_LEN = 3;
44
45static const uint32_t SUBTRACTOR = 8388608;
46
47ESPHOME_LOG_TAG(TAG, "qmp6988");
48
49// Indexed by QMP6988Oversampling
50PROGMEM_STRING_TABLE(OversamplingStrings, "None", "1x", "2x", "4x", "8x", "16x", "32x", "64x", "UNKNOWN");
51
52[[maybe_unused]] static const LogString *oversampling_to_str(QMP6988Oversampling value) {
53 return OversamplingStrings::get_log_str(static_cast<uint8_t>(value), OversamplingStrings::LAST_INDEX);
54}
55
56// Indexed by QMP6988IIRFilter
57PROGMEM_STRING_TABLE(IIRFilterStrings, "OFF", "2x", "4x", "8x", "16x", "32x", "UNKNOWN");
58
59[[maybe_unused]] static const LogString *iir_filter_to_str(QMP6988IIRFilter value) {
60 return IIRFilterStrings::get_log_str(static_cast<uint8_t>(value), IIRFilterStrings::LAST_INDEX);
61}
62
64 if (this->read_register(QMP6988_CHIP_ID_REG, &(qmp6988_data_.chip_id), 1) != i2c::ERROR_OK) {
65 ESP_LOGE(TAG, "Read chip ID (0xD1) failed");
66 return false;
67 }
68 ESP_LOGV(TAG, "Read chip ID = 0x%x", qmp6988_data_.chip_id);
69
70 return qmp6988_data_.chip_id == QMP6988_CHIP_ID;
71}
72
74 // BITFIELDS temp_COE;
75 uint8_t a_data_uint8_tr[QMP6988_CALIBRATION_DATA_LENGTH] = {0};
76
77 for (uint8_t len = 0; len < QMP6988_CALIBRATION_DATA_LENGTH; len += 1) {
78 if (this->read_register(QMP6988_CALIBRATION_DATA_START + len, &a_data_uint8_tr[len], 1) != i2c::ERROR_OK) {
79 ESP_LOGE(TAG, "Read calibration data (0xA0) error");
80 return false;
81 }
82 }
83
84 qmp6988_data_.qmp6988_cali.COE_a0 =
85 (int32_t) encode_uint32(a_data_uint8_tr[18], a_data_uint8_tr[19], (a_data_uint8_tr[24] & 0x0f) << 4, 0);
86 qmp6988_data_.qmp6988_cali.COE_a0 = qmp6988_data_.qmp6988_cali.COE_a0 >> 12;
87
88 qmp6988_data_.qmp6988_cali.COE_a1 = encode_value<int16_t>(&a_data_uint8_tr[20]);
89 qmp6988_data_.qmp6988_cali.COE_a2 = encode_value<int16_t>(&a_data_uint8_tr[22]);
90
91 qmp6988_data_.qmp6988_cali.COE_b00 =
92 (int32_t) encode_uint32(a_data_uint8_tr[0], a_data_uint8_tr[1], a_data_uint8_tr[24] & 0xf0, 0);
93 qmp6988_data_.qmp6988_cali.COE_b00 = qmp6988_data_.qmp6988_cali.COE_b00 >> 12;
94
95 qmp6988_data_.qmp6988_cali.COE_bt1 = encode_value<int16_t>(&a_data_uint8_tr[2]);
96 qmp6988_data_.qmp6988_cali.COE_bt2 = encode_value<int16_t>(&a_data_uint8_tr[4]);
97 qmp6988_data_.qmp6988_cali.COE_bp1 = encode_value<int16_t>(&a_data_uint8_tr[6]);
98 qmp6988_data_.qmp6988_cali.COE_b11 = encode_value<int16_t>(&a_data_uint8_tr[8]);
99 qmp6988_data_.qmp6988_cali.COE_bp2 = encode_value<int16_t>(&a_data_uint8_tr[10]);
100 qmp6988_data_.qmp6988_cali.COE_b12 = encode_value<int16_t>(&a_data_uint8_tr[12]);
101 qmp6988_data_.qmp6988_cali.COE_b21 = encode_value<int16_t>(&a_data_uint8_tr[14]);
102 qmp6988_data_.qmp6988_cali.COE_bp3 = encode_value<int16_t>(&a_data_uint8_tr[16]);
103
104 ESP_LOGV(TAG,
105 "Calibration data:\n"
106 " COE_a0[%" PRId32 "] COE_a1[%d] COE_a2[%d] COE_b00[%" PRId32 "]\n"
107 " COE_bt1[%d] COE_bt2[%d] COE_bp1[%d] COE_b11[%d]\n"
108 " COE_bp2[%d] COE_b12[%d] COE_b21[%d] COE_bp3[%d]",
109 qmp6988_data_.qmp6988_cali.COE_a0, qmp6988_data_.qmp6988_cali.COE_a1, qmp6988_data_.qmp6988_cali.COE_a2,
110 qmp6988_data_.qmp6988_cali.COE_b00, qmp6988_data_.qmp6988_cali.COE_bt1, qmp6988_data_.qmp6988_cali.COE_bt2,
111 qmp6988_data_.qmp6988_cali.COE_bp1, qmp6988_data_.qmp6988_cali.COE_b11, qmp6988_data_.qmp6988_cali.COE_bp2,
112 qmp6988_data_.qmp6988_cali.COE_b12, qmp6988_data_.qmp6988_cali.COE_b21, qmp6988_data_.qmp6988_cali.COE_bp3);
113
114 qmp6988_data_.ik.a0 = qmp6988_data_.qmp6988_cali.COE_a0; // 20Q4
115 qmp6988_data_.ik.b00 = qmp6988_data_.qmp6988_cali.COE_b00; // 20Q4
116
117 qmp6988_data_.ik.a1 = 3608L * (int32_t) qmp6988_data_.qmp6988_cali.COE_a1 - 1731677965L; // 31Q23
118 qmp6988_data_.ik.a2 = 16889L * (int32_t) qmp6988_data_.qmp6988_cali.COE_a2 - 87619360L; // 30Q47
119
120 qmp6988_data_.ik.bt1 = 2982L * (int64_t) qmp6988_data_.qmp6988_cali.COE_bt1 + 107370906L; // 28Q15
121 qmp6988_data_.ik.bt2 = 329854L * (int64_t) qmp6988_data_.qmp6988_cali.COE_bt2 + 108083093L; // 34Q38
122 qmp6988_data_.ik.bp1 = 19923L * (int64_t) qmp6988_data_.qmp6988_cali.COE_bp1 + 1133836764L; // 31Q20
123 qmp6988_data_.ik.b11 = 2406L * (int64_t) qmp6988_data_.qmp6988_cali.COE_b11 + 118215883L; // 28Q34
124 qmp6988_data_.ik.bp2 = 3079L * (int64_t) qmp6988_data_.qmp6988_cali.COE_bp2 - 181579595L; // 29Q43
125 qmp6988_data_.ik.b12 = 6846L * (int64_t) qmp6988_data_.qmp6988_cali.COE_b12 + 85590281L; // 29Q53
126 qmp6988_data_.ik.b21 = 13836L * (int64_t) qmp6988_data_.qmp6988_cali.COE_b21 + 79333336L; // 29Q60
127 qmp6988_data_.ik.bp3 = 2915L * (int64_t) qmp6988_data_.qmp6988_cali.COE_bp3 + 157155561L; // 28Q65
128 ESP_LOGV(TAG,
129 "Int calibration data:\n"
130 " a0[%" PRId32 "] a1[%" PRId32 "] a2[%" PRId32 "] b00[%" PRId32 "]\n"
131 " bt1[%lld] bt2[%lld] bp1[%lld] b11[%lld]\n"
132 " bp2[%lld] b12[%lld] b21[%lld] bp3[%lld]",
133 qmp6988_data_.ik.a0, qmp6988_data_.ik.a1, qmp6988_data_.ik.a2, qmp6988_data_.ik.b00, qmp6988_data_.ik.bt1,
134 qmp6988_data_.ik.bt2, qmp6988_data_.ik.bp1, qmp6988_data_.ik.b11, qmp6988_data_.ik.bp2, qmp6988_data_.ik.b12,
135 qmp6988_data_.ik.b21, qmp6988_data_.ik.bp3);
136 return true;
137}
138
140 int16_t ret;
141 int64_t wk1, wk2;
142
143 // wk1: 60Q4 // bit size
144 wk1 = ((int64_t) ik->a1 * (int64_t) dt); // 31Q23+24-1=54 (54Q23)
145 wk2 = ((int64_t) ik->a2 * (int64_t) dt) >> 14; // 30Q47+24-1=53 (39Q33)
146 wk2 = (wk2 * (int64_t) dt) >> 10; // 39Q33+24-1=62 (52Q23)
147 wk2 = ((wk1 + wk2) / 32767) >> 19; // 54,52->55Q23 (20Q04)
148 ret = (int16_t) ((ik->a0 + wk2) >> 4); // 21Q4 -> 17Q0
149 return ret;
150}
151
153 int32_t ret;
154 int64_t wk1, wk2, wk3;
155
156 // wk1 = 48Q16 // bit size
157 wk1 = ((int64_t) ik->bt1 * (int64_t) tx); // 28Q15+16-1=43 (43Q15)
158 wk2 = ((int64_t) ik->bp1 * (int64_t) dp) >> 5; // 31Q20+24-1=54 (49Q15)
159 wk1 += wk2; // 43,49->50Q15
160 wk2 = ((int64_t) ik->bt2 * (int64_t) tx) >> 1; // 34Q38+16-1=49 (48Q37)
161 wk2 = (wk2 * (int64_t) tx) >> 8; // 48Q37+16-1=63 (55Q29)
162 wk3 = wk2; // 55Q29
163 wk2 = ((int64_t) ik->b11 * (int64_t) tx) >> 4; // 28Q34+16-1=43 (39Q30)
164 wk2 = (wk2 * (int64_t) dp) >> 1; // 39Q30+24-1=62 (61Q29)
165 wk3 += wk2; // 55,61->62Q29
166 wk2 = ((int64_t) ik->bp2 * (int64_t) dp) >> 13; // 29Q43+24-1=52 (39Q30)
167 wk2 = (wk2 * (int64_t) dp) >> 1; // 39Q30+24-1=62 (61Q29)
168 wk3 += wk2; // 62,61->63Q29
169 wk1 += wk3 >> 14; // Q29 >> 14 -> Q15
170 wk2 = ((int64_t) ik->b12 * (int64_t) tx); // 29Q53+16-1=45 (45Q53)
171 wk2 = (wk2 * (int64_t) tx) >> 22; // 45Q53+16-1=61 (39Q31)
172 wk2 = (wk2 * (int64_t) dp) >> 1; // 39Q31+24-1=62 (61Q30)
173 wk3 = wk2; // 61Q30
174 wk2 = ((int64_t) ik->b21 * (int64_t) tx) >> 6; // 29Q60+16-1=45 (39Q54)
175 wk2 = (wk2 * (int64_t) dp) >> 23; // 39Q54+24-1=62 (39Q31)
176 wk2 = (wk2 * (int64_t) dp) >> 1; // 39Q31+24-1=62 (61Q20)
177 wk3 += wk2; // 61,61->62Q30
178 wk2 = ((int64_t) ik->bp3 * (int64_t) dp) >> 12; // 28Q65+24-1=51 (39Q53)
179 wk2 = (wk2 * (int64_t) dp) >> 23; // 39Q53+24-1=62 (39Q30)
180 wk2 = (wk2 * (int64_t) dp); // 39Q30+24-1=62 (62Q30)
181 wk3 += wk2; // 62,62->63Q30
182 wk1 += wk3 >> 15; // Q30 >> 15 = Q15
183 wk1 /= 32767L;
184 wk1 >>= 11; // Q15 >> 7 = Q4
185 wk1 += ik->b00; // Q4 + 20Q4
186 // wk1 >>= 4; // 28Q4 -> 24Q0
187 ret = (int32_t) wk1;
188 return ret;
189}
190
192 if (!this->write_byte(QMP6988_RESET_REG, 0xe6)) {
193 ESP_LOGE(TAG, "Software Reset (0xe6) failed");
194 }
195 delay(10);
196
197 this->write_byte(QMP6988_RESET_REG, 0x00);
198}
199
201 uint8_t data;
202
203 ESP_LOGD(TAG, "Setting Power mode to: %d", power_mode);
204
205 qmp6988_data_.power_mode = power_mode;
206 this->read_register(QMP6988_CTRLMEAS_REG, &data, 1);
207 data = data & 0xfc;
208 if (power_mode == QMP6988_SLEEP_MODE) {
209 data |= 0x00;
210 } else if (power_mode == QMP6988_FORCED_MODE) {
211 data |= 0x01;
212 } else if (power_mode == QMP6988_NORMAL_MODE) {
213 data |= 0x03;
214 }
215 this->write_byte(QMP6988_CTRLMEAS_REG, data);
216
217 ESP_LOGD(TAG, "Set Power mode 0xf4=0x%x \r\n", data);
218
219 delay(10);
220}
221
223 uint8_t data;
224
225 data = (filter & QMP6988_CONFIG_REG_FILTER_MSK);
226 this->write_byte(QMP6988_CONFIG_REG, data);
227 delay(10);
228}
229
231 uint8_t data;
232
233 this->read_register(QMP6988_CTRLMEAS_REG, &data, 1);
234 data &= 0xe3;
235 data |= (oversampling_p << 2);
236 this->write_byte(QMP6988_CTRLMEAS_REG, data);
237 delay(10);
238}
239
241 uint8_t data;
242
243 this->read_register(QMP6988_CTRLMEAS_REG, &data, 1);
244 data &= 0x1f;
245 data |= (oversampling_t << 5);
246 this->write_byte(QMP6988_CTRLMEAS_REG, data);
247 delay(10);
248}
249
251 float altitude;
252 altitude = (powf((101325 / pressure), 1 / 5.257f) - 1) * (temp + 273.15f) / 0.0065f;
253 this->qmp6988_data_.altitude = altitude;
254}
255
257 uint8_t err = 0;
258 uint32_t p_read, t_read;
259 int32_t p_raw, t_raw;
260 uint8_t a_data_uint8_tr[6] = {0};
261 int32_t t_int, p_int;
262
263 err = this->read_register(QMP6988_PRESSURE_MSB_REG, a_data_uint8_tr, 6);
264 if (!this->status_comm_result(err == i2c::ERROR_OK)) {
265 ESP_LOGE(TAG, "Error reading raw pressure/temp values");
266 return false;
267 }
268
269 p_read = encode_uint24(a_data_uint8_tr[0], a_data_uint8_tr[1], a_data_uint8_tr[2]);
270 p_raw = (int32_t) (p_read - SUBTRACTOR);
271
272 t_read = encode_uint24(a_data_uint8_tr[3], a_data_uint8_tr[4], a_data_uint8_tr[5]);
273 t_raw = (int32_t) (t_read - SUBTRACTOR);
274
275 t_int = this->get_compensated_temperature_(&(qmp6988_data_.ik), t_raw);
276 p_int = this->get_compensated_pressure_(&(qmp6988_data_.ik), p_raw, t_int);
277
278 this->qmp6988_data_.temperature = (float) t_int / 256.0f;
279 this->qmp6988_data_.pressure = (float) p_int / 16.0f;
280 return true;
281}
282
284 if (!this->device_check_()) {
285 this->mark_failed(LOG_STR(ESP_LOG_MSG_COMM_FAIL));
286 return;
287 }
288
289 this->software_reset_();
290 this->get_calibration_data_();
291 this->set_power_mode_(QMP6988_NORMAL_MODE);
295}
296
297void QMP6988Component::dump_config() {
298 ESP_LOGCONFIG(TAG, "QMP6988:");
299 LOG_I2C_DEVICE(this);
300 LOG_UPDATE_INTERVAL(this);
301
302 LOG_SENSOR(" ", "Temperature", this->temperature_sensor_);
303 ESP_LOGCONFIG(TAG, " Temperature Oversampling: %s",
304 LOG_STR_ARG(oversampling_to_str(this->temperature_oversampling_)));
305 LOG_SENSOR(" ", "Pressure", this->pressure_sensor_);
306 ESP_LOGCONFIG(TAG,
307 " Pressure Oversampling: %s\n"
308 " IIR Filter: %s",
309 LOG_STR_ARG(oversampling_to_str(this->pressure_oversampling_)),
310 LOG_STR_ARG(iir_filter_to_str(this->iir_filter_)));
311}
312
313void QMP6988Component::update() {
314 if (!this->calculate_pressure_()) {
315 return;
316 }
317
318 float pressurehectopascals = this->qmp6988_data_.pressure / 100;
319 float temperature = this->qmp6988_data_.temperature;
320
321 ESP_LOGD(TAG, "Temperature=%.2f°C, Pressure=%.2fhPa", temperature, pressurehectopascals);
322 PUBLISH_STATE(this->temperature_sensor_, temperature);
323 PUBLISH_STATE(this->pressure_sensor_, pressurehectopascals);
324}
325
326} // namespace esphome::qmp6988
void mark_failed()
Mark this component as failed.
virtual void setup()
Where the component's initialization should happen.
Definition component.cpp:84
bool status_comm_result(bool ok)
Clears the warning when ok, else sets it with message (default "Communication failed"); returns ok.
bool write_byte(uint8_t a_register, uint8_t data) const
Definition i2c.h:312
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
Definition i2c.cpp:45
void write_filter_(QMP6988IIRFilter filter)
Definition qmp6988.cpp:222
void calculate_altitude_(float pressure, float temp)
Definition qmp6988.cpp:250
int32_t get_compensated_pressure_(qmp6988_ik_data_t *ik, int32_t dp, int16_t tx)
Definition qmp6988.cpp:152
QMP6988Oversampling pressure_oversampling_
Definition qmp6988.h:89
void write_oversampling_pressure_(QMP6988Oversampling oversampling_p)
Definition qmp6988.cpp:230
QMP6988Oversampling temperature_oversampling_
Definition qmp6988.h:88
int16_t get_compensated_temperature_(qmp6988_ik_data_t *ik, int32_t dt)
Definition qmp6988.cpp:139
void set_power_mode_(uint8_t power_mode)
Definition qmp6988.cpp:200
void write_oversampling_temperature_(QMP6988Oversampling oversampling_t)
Definition qmp6988.cpp:240
int ret
PowerMode power_mode
Definition msa3xx.h:3
@ ERROR_OK
No error found during execution of method.
Definition i2c_bus.h:15
struct Qmp6988IkData { int32_t a0, b00; int32_t a1, a2; int64_t bt1, bt2, bp1, b11, bp2, b12, b21, bp3;} qmp6988_ik_data_t
Definition qmp6988.h:54
ESPHOME_LOG_TAG(TAG, "qmp6988")
PROGMEM_STRING_TABLE(OversamplingStrings, "None", "1x", "2x", "4x", "8x", "16x", "32x", "64x", "UNKNOWN")
uint32_t value
Definition hal.cpp:41
const void size_t len
Definition hal.h:68
constexpr uint32_t encode_uint24(uint8_t byte1, uint8_t byte2, uint8_t byte3)
Encode a 24-bit value given three bytes in most to least significant byte order.
Definition helpers.h:1047
constexpr T encode_value(const uint8_t *bytes)
Encode a value from its constituent bytes (from most to least significant) in an array with length si...
Definition helpers.h:1064
constexpr uint32_t encode_uint32(uint8_t byte1, uint8_t byte2, uint8_t byte3, uint8_t byte4)
Encode a 32-bit value given four bytes in most to least significant byte order.
Definition helpers.h:1051
void HOT delay(uint32_t ms)
Definition hal.cpp:85
static void uint32_t
uint16_t temperature
Definition sun_gtil2.cpp:12
uint8_t pressure
Definition tt21100.cpp:7