ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
bmp3xx_base.h
Go to the documentation of this file.
1/*
2 based on BMP388_DEV by Martin Lindupp
3 under MIT License (MIT)
4 Copyright (C) Martin Lindupp 2020
5 http://github.com/MartinL1/BMP388_DEV
6*/
8#pragma once
14
15static const uint8_t BMP388_ID = 0x50; // The BMP388 device ID
16static const uint8_t BMP390_ID = 0x60; // The BMP390 device ID
17static const uint8_t RESET_CODE = 0xB6; // The BMP388 reset code
18
20enum {
21 BMP388_CHIP_ID = 0x00, // Chip ID register sub-address
22 BMP388_ERR_REG = 0x02, // Error register sub-address
23 BMP388_STATUS = 0x03, // Status register sub-address
24 BMP388_DATA_0 = 0x04, // Pressure eXtended Least Significant Byte (XLSB) register sub-address
25 BMP388_DATA_1 = 0x05, // Pressure Least Significant Byte (LSB) register sub-address
26 BMP388_DATA_2 = 0x06, // Pressure Most Significant Byte (MSB) register sub-address
27 BMP388_DATA_3 = 0x07, // Temperature eXtended Least Significant Byte (XLSB) register sub-address
28 BMP388_DATA_4 = 0x08, // Temperature Least Significant Byte (LSB) register sub-address
29 BMP388_DATA_5 = 0x09, // Temperature Most Significant Byte (MSB) register sub-address
30 BMP388_SENSORTIME_0 = 0x0C, // Sensor time register 0 sub-address
31 BMP388_SENSORTIME_1 = 0x0D, // Sensor time register 1 sub-address
32 BMP388_SENSORTIME_2 = 0x0E, // Sensor time register 2 sub-address
33 BMP388_EVENT = 0x10, // Event register sub-address
34 BMP388_INT_STATUS = 0x11, // Interrupt Status register sub-address
35 BMP388_INT_CTRL = 0x19, // Interrupt Control register sub-address
36 BMP388_IF_CONFIG = 0x1A, // Interface Configuration register sub-address
37 BMP388_PWR_CTRL = 0x1B, // Power Control register sub-address
38 BMP388_OSR = 0x1C, // Oversampling register sub-address
39 BMP388_ODR = 0x1D, // Output Data Rate register sub-address
40 BMP388_CONFIG = 0x1F, // Configuration register sub-address
41 BMP388_TRIM_PARAMS = 0x31, // Trim parameter registers' base sub-address
42 BMP388_CMD = 0x7E // Command register sub-address
43};
44
46enum OperationMode { SLEEP_MODE = 0x00, FORCED_MODE = 0x01, NORMAL_MODE = 0x03 };
47
57
69
72 SUB_SENSOR(temperature)
73 SUB_SENSOR(pressure)
74
75 public:
76 void setup() override;
77 void dump_config() override;
78 void update() override;
79
81 void set_temperature_oversampling_config(Oversampling temperature_oversampling) {
82 this->temperature_oversampling_ = temperature_oversampling;
83 }
85 void set_pressure_oversampling_config(Oversampling pressure_oversampling) {
86 this->pressure_oversampling_ = pressure_oversampling;
87 }
89 void set_iir_filter_config(IIRFilter iir_filter) { this->iir_filter_ = iir_filter; }
90
92 uint8_t reset();
94 bool start_normal_conversion();
96 bool start_forced_conversion();
98 bool stop_conversion();
100 bool set_pressure_oversampling(Oversampling pressure_oversampling);
102 bool set_temperature_oversampling(Oversampling temperature_oversampling);
104 bool set_iir_filter(IIRFilter iir_filter);
106 bool get_temperature(float &temperature);
108 bool get_pressure(float &pressure);
110 bool get_measurements(float &temperature, float &pressure);
112 bool get_measurement();
114 bool set_mode(OperationMode mode);
116 bool set_oversampling_register(Oversampling pressure_oversampling, Oversampling temperature_oversampling);
118 bool data_ready();
119
120 protected:
125
126 struct { // The BMP388 compensation trim parameters (coefficients)
127 uint16_t param_T1;
128 uint16_t param_T2;
129 int8_t param_T3;
130 int16_t param_P1;
131 int16_t param_P2;
132 int8_t param_P3;
133 int8_t param_P4;
134 uint16_t param_P5;
135 uint16_t param_P6;
136 int8_t param_P7;
137 int8_t param_P8;
138 int16_t param_P9;
139 int8_t param_P10;
140 int8_t param_P11;
141 } __attribute__((packed)) compensation_params_;
142
143 struct FloatParams { // The BMP388 float point compensation trim parameters
144 float param_T1;
145 float param_T2;
146 float param_T3;
147 float param_P1;
148 float param_P2;
149 float param_P3;
150 float param_P4;
151 float param_P5;
152 float param_P6;
153 float param_P7;
154 float param_P8;
155 float param_P9;
159
160 union { // Copy of the BMP388's chip id register
161 struct {
162 uint8_t chip_id_nvm : 4;
163 uint8_t chip_id_fixed : 4;
165 uint8_t reg;
166 } chip_id_ = {.reg = 0};
167
168 union { // Copy of the BMP388's event register
169 struct {
170 uint8_t por_detected : 1;
172 uint8_t reg;
173 } event_ = {.reg = 0};
174
175 union { // Copy of the BMP388's interrupt status register
176 struct {
177 uint8_t fwm_int : 1;
178 uint8_t ffull_int : 1;
179 uint8_t : 1;
180 uint8_t drdy : 1;
182 uint8_t reg;
183 } int_status_ = {.reg = 0};
184
185 union { // Copy of the BMP388's power control register
186 struct {
187 uint8_t press_en : 1;
188 uint8_t temp_en : 1;
189 uint8_t : 2;
190 uint8_t mode : 2;
192 uint8_t reg;
193 } pwr_ctrl_ = {.reg = 0};
194
195 union { // Copy of the BMP388's oversampling register
196 struct {
197 uint8_t osr_p : 3;
198 uint8_t osr_t : 3;
200 uint8_t reg;
201 } osr_ = {.reg = 0};
202
203 union { // Copy of the BMP388's output data rate register
204 struct {
205 uint8_t odr_sel : 5;
207 uint8_t reg;
208 } odr_ = {.reg = 0};
209
210 union { // Copy of the BMP388's configuration register
211 struct {
212 uint8_t : 1;
213 uint8_t iir_filter : 3;
215 uint8_t reg;
216 } config_ = {.reg = 0};
217
218 // Bosch temperature compensation function
219 float bmp388_compensate_temperature_(float uncomp_temp);
220 // Bosch pressure compensation function
221 float bmp388_compensate_pressure_(float uncomp_press, float t_lin);
222
223 // interface specific functions
224 virtual bool read_byte(uint8_t a_register, uint8_t *data) = 0;
225 virtual bool write_byte(uint8_t a_register, uint8_t data) = 0;
226 virtual bool read_bytes(uint8_t a_register, uint8_t *data, size_t len) = 0;
227 virtual bool write_bytes(uint8_t a_register, uint8_t *data, size_t len) = 0;
228};
229
230} // namespace esphome::bmp3xx_base
virtual void setup()
Where the component's initialization should happen.
Definition component.cpp:84
This class simplifies creating components that periodically check a state.
Definition component.h:532
This class implements support for the BMP3XX Temperature+Pressure sensor.
Definition bmp3xx_base.h:71
union esphome::bmp3xx_base::BMP3XXComponent::@24 chip_id_
union esphome::bmp3xx_base::BMP3XXComponent::@28 osr_
struct esphome::bmp3xx_base::BMP3XXComponent::FloatParams compensation_float_params_
union esphome::bmp3xx_base::BMP3XXComponent::@29 odr_
union esphome::bmp3xx_base::BMP3XXComponent::@26 int_status_
union esphome::bmp3xx_base::BMP3XXComponent::@27 pwr_ctrl_
float bmp388_compensate_temperature_(float uncomp_temp)
virtual bool write_byte(uint8_t a_register, uint8_t data)=0
struct esphome::bmp3xx_base::BMP3XXComponent::@24::@31 bit
virtual bool read_bytes(uint8_t a_register, uint8_t *data, size_t len)=0
union esphome::bmp3xx_base::BMP3XXComponent::@30 config_
union esphome::bmp3xx_base::BMP3XXComponent::@25 event_
virtual bool read_byte(uint8_t a_register, uint8_t *data)=0
virtual bool write_bytes(uint8_t a_register, uint8_t *data, size_t len)=0
float bmp388_compensate_pressure_(float uncomp_press, float t_lin)
struct @66::@67 __attribute__
Wake the main loop task from an ISR. ISR-safe.
Definition main_task.h:45
Oversampling
Oversampling bit fields in the control and measurement register.
Definition bmp3xx_base.h:49
OperationMode
Device mode bitfield in the control and measurement register.
Definition bmp3xx_base.h:46
IIRFilter
Infinite Impulse Response (IIR) filter bit field in the configuration register.
Definition bmp3xx_base.h:59
const void size_t len
Definition hal.h:68
uint16_t temperature
Definition sun_gtil2.cpp:12
uint8_t pressure
Definition tt21100.cpp:7