This class implements support for the BMP3XX Temperature+Pressure sensor. More...

#include <bmp3xx_base.h>

Inheritance diagram for esphome::bmp3xx_base::BMP3XXComponent:

Data Structures
struct	FloatParams

Public Member Functions
void	setup () override

void	dump_config () override

void	update () override

void	set_temperature_sensor (sensor::Sensor *temperature_sensor)

void	set_pressure_sensor (sensor::Sensor *pressure_sensor)

void	set_temperature_oversampling_config (Oversampling temperature_oversampling)
	Set the oversampling value for the temperature sensor. Default is 16x.

void	set_pressure_oversampling_config (Oversampling pressure_oversampling)
	Set the oversampling value for the pressure sensor. Default is 16x.

void	set_iir_filter_config (IIRFilter iir_filter)
	Set the IIR Filter used to increase accuracy, defaults to no IIR Filter.

uint8_t	reset ()
	Soft reset the sensor.

bool	start_normal_conversion ()
	Start continuous measurement in NORMAL_MODE.

bool	start_forced_conversion ()
	Start a one shot measurement in FORCED_MODE.

bool	stop_conversion ()
	Stop the conversion and return to SLEEP_MODE.

bool	set_pressure_oversampling (Oversampling pressure_oversampling)
	Set the pressure oversampling: OFF, X1, X2, X4, X8, X16, X32.

bool	set_temperature_oversampling (Oversampling temperature_oversampling)
	Set the temperature oversampling: OFF, X1, X2, X4, X8, X16, X32.

bool	set_iir_filter (IIRFilter iir_filter)
	Set the IIR filter setting: OFF, 2, 3, 8, 16, 32.

bool	get_temperature (float &temperature)
	Get a temperature measurement.

bool	get_pressure (float &pressure)
	Get a pressure measurement.

bool	get_measurements (float &temperature, float &pressure)
	Get a temperature and pressure measurement.

bool	get_measurement ()
	Get a temperature and pressure measurement.

bool	set_mode (OperationMode mode)
	Set the barometer mode.

bool	set_oversampling_register (Oversampling pressure_oversampling, Oversampling temperature_oversampling)
	Set the BMP388 oversampling register.

bool	data_ready ()
	Checks if a measurement is ready.

Public Member Functions inherited from esphome::PollingComponent
	PollingComponent ()

	PollingComponent (uint32_t update_interval)
	Initialize this polling component with the given update interval in ms.

void	set_update_interval (uint32_t update_interval)
	Manually set the update interval in ms for this polling object.

void	call_setup () override

virtual uint32_t	get_update_interval () const
	Get the update interval in ms of this sensor.

void	start_poller ()

void	stop_poller ()

Public Member Functions inherited from esphome::Component
virtual void	loop ()
	This method will be called repeatedly.

virtual float	get_setup_priority () const
	priority of setup().

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

virtual bool	teardown ()
	Called during teardown to allow component to gracefully finish operations.

virtual void	on_powerdown ()
	Called after teardown is complete to power down hardware.

uint8_t	get_component_state () const

void	reset_to_construction_state ()
	Reset this component back to the construction state to allow setup to run again.

bool	is_in_loop_state () const
	Check if this component has completed setup and is in the loop state.

bool	is_idle () const
	Check if this component is idle.

void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const LogString *message)

void	disable_loop ()
	Disable this component's loop.

void	enable_loop ()
	Enable this component's loop.

void	enable_loop_soon_any_context ()
	Thread and ISR-safe version of enable_loop() that can be called from any context.

bool	is_failed () const

bool	is_ready () const

virtual bool	can_proceed ()

bool	status_has_warning () const

bool	status_has_error () const

void	status_set_warning ()

void	status_set_warning (const char *message)

void	status_set_warning (const LogString *message)

void	status_set_error ()

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const char *name, uint32_t length=5000)
	Set warning status flag and automatically clear it after a timeout.

void	status_momentary_error (const char *name, uint32_t length=5000)
	Set error status flag and automatically clear it after a timeout.

bool	has_overridden_loop () const

const LogString *	get_component_log_str () const ESPHOME_ALWAYS_INLINE
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)

Protected Types
enum	ErrorCode { NONE = 0 , ERROR_COMMUNICATION_FAILED , ERROR_WRONG_CHIP_ID , ERROR_SENSOR_STATUS , ERROR_SENSOR_RESET }

Protected Member Functions
struct {

uint16_t param_T1

uint16_t param_T2

int8_t param_T3

int16_t param_P1

int16_t param_P2

int8_t param_P3

int8_t param_P4

uint16_t param_P5

uint16_t param_P6

int8_t param_P7

int8_t param_P8

int16_t param_P9

int8_t param_P10

int8_t param_P11

}	__attribute__ ((packed)) compensation_params_

float	bmp388_compensate_temperature_ (float uncomp_temp)

float	bmp388_compensate_pressure_ (float uncomp_press, float t_lin)

virtual bool	read_byte (uint8_t a_register, uint8_t *data)=0

virtual bool	write_byte (uint8_t a_register, uint8_t data)=0

virtual bool	read_bytes (uint8_t a_register, uint8_t *data, size_t len)=0

virtual bool	write_bytes (uint8_t a_register, uint8_t *data, size_t len)=0

Protected Member Functions inherited from esphome::Component
friend	void::setup ()

friend	void::original_setup ()

void	set_component_source_ (uint8_t index)
	Set where this component was loaded from for some debug messages.

void	call_dump_config_ ()

void	enable_loop_slow_path_ ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

bool	set_status_flag_ (uint8_t flag)
	Helper to set a status LED flag on both this component and the app.

void	set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a const char* name.

void	set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a numeric ID (zero heap allocation).

void	set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f)

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const char *name)
	Cancel an interval function.

bool	cancel_interval (uint32_t id)

bool	cancel_interval (InternalSchedulerID id)

void	set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a const char* name.

void	set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a numeric ID (zero heap allocation).

void	set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f)

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const char *name)
	Cancel a timeout function.

bool	cancel_timeout (uint32_t id)

bool	cancel_timeout (InternalSchedulerID id)

void	defer (const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call with a const char* name.

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call.

void	defer (uint32_t id, std::function< void()> &&f)
	Defer a callback with a numeric ID (zero heap allocation)

bool	cancel_defer (const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

bool	cancel_defer (uint32_t id)

void	status_clear_warning_slow_path_ ()

void	status_clear_error_slow_path_ ()

Protected Attributes
Oversampling	temperature_oversampling_ {OVERSAMPLING_X16}

Oversampling	pressure_oversampling_ {OVERSAMPLING_X16}

IIRFilter	iir_filter_ {IIR_FILTER_OFF}

OperationMode	operation_mode_ {FORCED_MODE}

sensor::Sensor *	temperature_sensor_ {nullptr}

sensor::Sensor *	pressure_sensor_ {nullptr}

enum esphome::bmp3xx_base::BMP3XXComponent::ErrorCode	NONE

struct esphome::bmp3xx_base::BMP3XXComponent::FloatParams	compensation_float_params_

union {

struct {

uint8_t chip_id_nvm: 4

uint8_t chip_id_fixed: 4

} bit

uint8_t reg

}	chip_id_ = {.reg = 0}

union {

struct {

uint8_t por_detected: 1

} bit

uint8_t reg

}	event_ = {.reg = 0}

union {

struct {

uint8_t fwm_int: 1

uint8_t ffull_int: 1

uint8_t : 1

uint8_t drdy: 1

} bit

uint8_t reg

}	int_status_ = {.reg = 0}

union {

struct {

uint8_t press_en: 1

uint8_t temp_en: 1

uint8_t : 2

uint8_t mode: 2

} bit

uint8_t reg

}	pwr_ctrl_ = {.reg = 0}

union {

struct {

uint8_t osr_p: 3

uint8_t osr_t: 3

} bit

uint8_t reg

}	osr_ = {.reg = 0}

union {

struct {

uint8_t odr_sel: 5

} bit

uint8_t reg

}	odr_ = {.reg = 0}

union {

struct {

uint8_t : 1

uint8_t iir_filter: 3

} bit

uint8_t reg

}	config_ = {.reg = 0}

Protected Attributes inherited from esphome::PollingComponent
uint32_t	update_interval_

Protected Attributes inherited from esphome::Component
uint8_t	component_source_index_ {0}
	Index into component source PROGMEM lookup table (0 = not set)

uint8_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
	Warn threshold in centiseconds (max 2550ms)

uint8_t	component_state_ {0x00}
	State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

ComponentRuntimeStats	runtime_stats_

Detailed Description

This class implements support for the BMP3XX Temperature+Pressure sensor.

Definition at line 71 of file bmp3xx_base.h.

Member Enumeration Documentation

◆ ErrorCode

enum esphome::bmp3xx_base::BMP3XXComponent::ErrorCode

protected

Enumerator
NONE
ERROR_COMMUNICATION_FAILED
ERROR_WRONG_CHIP_ID
ERROR_SENSOR_STATUS
ERROR_SENSOR_RESET

Definition at line 127 of file bmp3xx_base.h.

Member Function Documentation

◆ attribute()

struct esphome::bmp3xx_base::BMP3XXComponent::@23 esphome::bmp3xx_base::BMP3XXComponent::__attribute__ ( (packed) )

protected

◆ bmp388_compensate_pressure_()

float esphome::bmp3xx_base::BMP3XXComponent::bmp388_compensate_pressure_	(	float	uncomp_press,
		float	t_lin )

protected

Definition at line 340 of file bmp3xx_base.cpp.

◆ bmp388_compensate_temperature_()

float esphome::bmp3xx_base::BMP3XXComponent::bmp388_compensate_temperature_ ( float uncomp_temp )

protected

Definition at line 334 of file bmp3xx_base.cpp.

◆ data_ready()

bool esphome::bmp3xx_base::BMP3XXComponent::data_ready ( )

Checks if a measurement is ready.

Definition at line 306 of file bmp3xx_base.cpp.

◆ dump_config()

void esphome::bmp3xx_base::BMP3XXComponent::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 121 of file bmp3xx_base.cpp.

◆ get_measurement()

bool esphome::bmp3xx_base::BMP3XXComponent::get_measurement ( )

Get a temperature and pressure measurement.

◆ get_measurements()

bool esphome::bmp3xx_base::BMP3XXComponent::get_measurements	(	float &	temperature,
		float &	pressure )

Get a temperature and pressure measurement.

Definition at line 266 of file bmp3xx_base.cpp.

◆ get_pressure()

bool esphome::bmp3xx_base::BMP3XXComponent::get_pressure ( float & pressure )

Get a pressure measurement.

Definition at line 260 of file bmp3xx_base.cpp.

◆ get_temperature()

bool esphome::bmp3xx_base::BMP3XXComponent::get_temperature ( float & temperature )

Get a temperature measurement.

Definition at line 241 of file bmp3xx_base.cpp.

◆ read_byte()

virtual bool esphome::bmp3xx_base::BMP3XXComponent::read_byte	(	uint8_t	a_register,
		uint8_t *	data )

protectedpure virtual

◆ read_bytes()

virtual bool esphome::bmp3xx_base::BMP3XXComponent::read_bytes	(	uint8_t	a_register,
		uint8_t *	data,
		size_t	len )

protectedpure virtual

◆ reset()

uint8_t esphome::bmp3xx_base::BMP3XXComponent::reset ( )

Soft reset the sensor.

Definition at line 202 of file bmp3xx_base.cpp.

◆ set_iir_filter()

bool esphome::bmp3xx_base::BMP3XXComponent::set_iir_filter ( IIRFilter iir_filter )

Set the IIR filter setting: OFF, 2, 3, 8, 16, 32.

Definition at line 235 of file bmp3xx_base.cpp.

◆ set_iir_filter_config()

void esphome::bmp3xx_base::BMP3XXComponent::set_iir_filter_config ( IIRFilter iir_filter )

inline

Set the IIR Filter used to increase accuracy, defaults to no IIR Filter.

Definition at line 89 of file bmp3xx_base.h.

◆ set_mode()

bool esphome::bmp3xx_base::BMP3XXComponent::set_mode ( OperationMode mode )

Set the barometer mode.

Definition at line 293 of file bmp3xx_base.cpp.

◆ set_oversampling_register()

bool esphome::bmp3xx_base::BMP3XXComponent::set_oversampling_register	(	Oversampling	pressure_oversampling,
		Oversampling	temperature_oversampling )

Set the BMP388 oversampling register.

Definition at line 299 of file bmp3xx_base.cpp.

◆ set_pressure_oversampling()

bool esphome::bmp3xx_base::BMP3XXComponent::set_pressure_oversampling ( Oversampling pressure_oversampling )

Set the pressure oversampling: OFF, X1, X2, X4, X8, X16, X32.

Definition at line 223 of file bmp3xx_base.cpp.

◆ set_pressure_oversampling_config()

void esphome::bmp3xx_base::BMP3XXComponent::set_pressure_oversampling_config ( Oversampling pressure_oversampling )

inline

Set the oversampling value for the pressure sensor. Default is 16x.

Definition at line 85 of file bmp3xx_base.h.

◆ set_pressure_sensor()

void esphome::bmp3xx_base::BMP3XXComponent::set_pressure_sensor ( sensor::Sensor * pressure_sensor )

inline

Definition at line 78 of file bmp3xx_base.h.

◆ set_temperature_oversampling()

bool esphome::bmp3xx_base::BMP3XXComponent::set_temperature_oversampling ( Oversampling temperature_oversampling )

Set the temperature oversampling: OFF, X1, X2, X4, X8, X16, X32.

Definition at line 229 of file bmp3xx_base.cpp.

◆ set_temperature_oversampling_config()

void esphome::bmp3xx_base::BMP3XXComponent::set_temperature_oversampling_config ( Oversampling temperature_oversampling )

inline

Set the oversampling value for the temperature sensor. Default is 16x.

Definition at line 81 of file bmp3xx_base.h.

◆ set_temperature_sensor()

void esphome::bmp3xx_base::BMP3XXComponent::set_temperature_sensor ( sensor::Sensor * temperature_sensor )

inline

Definition at line 77 of file bmp3xx_base.h.

◆ setup()

void esphome::bmp3xx_base::BMP3XXComponent::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 43 of file bmp3xx_base.cpp.

◆ start_forced_conversion()

bool esphome::bmp3xx_base::BMP3XXComponent::start_forced_conversion ( )

Start a one shot measurement in FORCED_MODE.

Definition at line 211 of file bmp3xx_base.cpp.

◆ start_normal_conversion()

bool esphome::bmp3xx_base::BMP3XXComponent::start_normal_conversion ( )

Start continuous measurement in NORMAL_MODE.

◆ stop_conversion()

bool esphome::bmp3xx_base::BMP3XXComponent::stop_conversion ( )

Stop the conversion and return to SLEEP_MODE.

Definition at line 220 of file bmp3xx_base.cpp.

◆ update()

void esphome::bmp3xx_base::BMP3XXComponent::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 157 of file bmp3xx_base.cpp.

◆ write_byte()

virtual bool esphome::bmp3xx_base::BMP3XXComponent::write_byte	(	uint8_t	a_register,
		uint8_t	data )

protectedpure virtual

◆ write_bytes()

virtual bool esphome::bmp3xx_base::BMP3XXComponent::write_bytes	(	uint8_t	a_register,
		uint8_t *	data,
		size_t	len )

protectedpure virtual

Field Documentation