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

#include <bmp280_base.h>

Inheritance diagram for esphome::bmp280_base::BMP280Component:

Public Member Functions
void	set_temperature_sensor (sensor::Sensor *temperature_sensor)

void	set_pressure_sensor (sensor::Sensor *pressure_sensor)

void	set_temperature_oversampling (BMP280Oversampling temperature_over_sampling)
	Set the oversampling value for the temperature sensor. Default is 16x. More...

void	set_pressure_oversampling (BMP280Oversampling pressure_over_sampling)
	Set the oversampling value for the pressure sensor. Default is 16x. More...

void	set_iir_filter (BMP280IIRFilter iir_filter)
	Set the IIR Filter used to increase accuracy, defaults to no IIR Filter. More...

void	setup () override

void	dump_config () override

float	get_setup_priority () const override

void	update () override

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	read_byte_16 (uint8_t a_register, uint16_t *data)=0

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

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

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

void	call_setup () override

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

void	start_poller ()

void	stop_poller ()

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

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

virtual float	get_loop_priority () const
	priority of loop(). More...

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

uint32_t	get_component_state () const

virtual void	mark_failed ()
	Mark this component as failed. More...

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 (const char *message="unspecified")

void	status_set_error (const char *message="unspecified")

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const std::string &name, uint32_t length=5000)

void	status_momentary_error (const std::string &name, uint32_t length=5000)

bool	has_overridden_loop () const

void	set_component_source (const char *source)
	Set where this component was loaded from for some debug messages. More...

const char *	get_component_source () const
	Get the integration where this component was declared as a string. More...

Protected Types
enum	ErrorCode { NONE = 0, COMMUNICATION_FAILED, WRONG_CHIP_ID }

Protected Member Functions
float	read_temperature_ (int32_t *t_fine)
	Read the temperature value and store the calculated ambient temperature in t_fine. More...

float	read_pressure_ (int32_t t_fine)
	Read the pressure value in hPa using the provided t_fine value. More...

uint8_t	read_u8_ (uint8_t a_register)

uint16_t	read_u16_le_ (uint8_t a_register)

int16_t	read_s16_le_ (uint8_t a_register)

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_dump_config ()

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

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

bool	cancel_interval (const std::string &name)
	Cancel an interval function. More...

void	set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
	Set an retry function with a unique name. More...

void	set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)

bool	cancel_retry (const std::string &name)
	Cancel a retry function. More...

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

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

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function. More...

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

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

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty. More...

Protected Attributes
BMP280CalibrationData	calibration_

BMP280Oversampling	temperature_oversampling_ {BMP280_OVERSAMPLING_16X}

BMP280Oversampling	pressure_oversampling_ {BMP280_OVERSAMPLING_16X}

BMP280IIRFilter	iir_filter_ {BMP280_IIR_FILTER_OFF}

sensor::Sensor *	temperature_sensor_ {nullptr}

sensor::Sensor *	pressure_sensor_ {nullptr}

enum esphome::bmp280_base::BMP280Component::ErrorCode	NONE

Protected Attributes inherited from esphome::PollingComponent
uint32_t	update_interval_

Protected Attributes inherited from esphome::Component
uint32_t	component_state_ {0x0000}
	State of this component. More...

float	setup_priority_override_ {NAN}

const char *	component_source_ {nullptr}

Detailed Description

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

Definition at line 53 of file bmp280_base.h.

Member Enumeration Documentation

◆ ErrorCode

enum esphome::bmp280_base::BMP280Component::ErrorCode

protected

Enumerator
NONE
COMMUNICATION_FAILED
WRONG_CHIP_ID

Definition at line 90 of file bmp280_base.h.

Member Function Documentation

◆ dump_config()

void esphome::bmp280_base::BMP280Component::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::bmp280_i2c::BMP280I2CComponent.

Definition at line 131 of file bmp280_base.cpp.

◆ get_setup_priority()

float esphome::bmp280_base::BMP280Component::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

Definition at line 152 of file bmp280_base.cpp.

◆ read_byte()

virtual bool esphome::bmp280_base::BMP280Component::read_byte	(	uint8_t	a_register,
		uint8_t *	data
	)

pure virtual

Implemented in esphome::bmp280_i2c::BMP280I2CComponent.

◆ read_byte_16()

virtual bool esphome::bmp280_base::BMP280Component::read_byte_16	(	uint8_t	a_register,
		uint16_t *	data
	)

pure virtual

Implemented in esphome::bmp280_i2c::BMP280I2CComponent.

◆ read_bytes()

virtual bool esphome::bmp280_base::BMP280Component::read_bytes	(	uint8_t	a_register,
		uint8_t *	data,
		size_t	len
	)

pure virtual

Implemented in esphome::bmp280_i2c::BMP280I2CComponent.

◆ read_pressure_()

float esphome::bmp280_base::BMP280Component::read_pressure_ ( int32_t t_fine )

protected

Read the pressure value in hPa using the provided t_fine value.

Definition at line 214 of file bmp280_base.cpp.

◆ read_s16_le_()

int16_t esphome::bmp280_base::BMP280Component::read_s16_le_ ( uint8_t a_register )

protected

Definition at line 270 of file bmp280_base.cpp.

◆ read_temperature_()

float esphome::bmp280_base::BMP280Component::read_temperature_ ( int32_t * t_fine )

protected

Read the temperature value and store the calculated ambient temperature in t_fine.

Definition at line 191 of file bmp280_base.cpp.

◆ read_u16_le_()

uint16_t esphome::bmp280_base::BMP280Component::read_u16_le_ ( uint8_t a_register )

protected

Definition at line 265 of file bmp280_base.cpp.

◆ read_u8_()

uint8_t esphome::bmp280_base::BMP280Component::read_u8_ ( uint8_t a_register )

protected

Definition at line 260 of file bmp280_base.cpp.

◆ set_iir_filter()

void esphome::bmp280_base::BMP280Component::set_iir_filter ( BMP280IIRFilter iir_filter )

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

Definition at line 259 of file bmp280_base.cpp.

◆ set_pressure_oversampling()

void esphome::bmp280_base::BMP280Component::set_pressure_oversampling ( BMP280Oversampling pressure_over_sampling )

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

Definition at line 256 of file bmp280_base.cpp.

◆ set_pressure_sensor()

void esphome::bmp280_base::BMP280Component::set_pressure_sensor ( sensor::Sensor * pressure_sensor )

inline

Definition at line 56 of file bmp280_base.h.

◆ set_temperature_oversampling()

void esphome::bmp280_base::BMP280Component::set_temperature_oversampling ( BMP280Oversampling temperature_over_sampling )

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

Definition at line 253 of file bmp280_base.cpp.

◆ set_temperature_sensor()

void esphome::bmp280_base::BMP280Component::set_temperature_sensor ( sensor::Sensor * temperature_sensor )

inline

Definition at line 55 of file bmp280_base.h.

◆ setup()

void esphome::bmp280_base::BMP280Component::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 59 of file bmp280_base.cpp.

◆ update()

void esphome::bmp280_base::BMP280Component::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 156 of file bmp280_base.cpp.

◆ write_byte()

virtual bool esphome::bmp280_base::BMP280Component::write_byte	(	uint8_t	a_register,
		uint8_t	data
	)

pure virtual

Implemented in esphome::bmp280_i2c::BMP280I2CComponent.

Field Documentation

◆ calibration_

BMP280CalibrationData esphome::bmp280_base::BMP280Component::calibration_

protected

Definition at line 84 of file bmp280_base.h.

◆ iir_filter_

BMP280IIRFilter esphome::bmp280_base::BMP280Component::iir_filter_ {BMP280_IIR_FILTER_OFF}

protected

Definition at line 87 of file bmp280_base.h.

◆ NONE

enum esphome::bmp280_base::BMP280Component::ErrorCode esphome::bmp280_base::BMP280Component::NONE

protected

◆ pressure_oversampling_

BMP280Oversampling esphome::bmp280_base::BMP280Component::pressure_oversampling_ {BMP280_OVERSAMPLING_16X}

protected

Definition at line 86 of file bmp280_base.h.

◆ pressure_sensor_

sensor::Sensor* esphome::bmp280_base::BMP280Component::pressure_sensor_ {nullptr}

protected

Definition at line 89 of file bmp280_base.h.

◆ temperature_oversampling_

BMP280Oversampling esphome::bmp280_base::BMP280Component::temperature_oversampling_ {BMP280_OVERSAMPLING_16X}

protected

Definition at line 85 of file bmp280_base.h.

◆ temperature_sensor_

sensor::Sensor* esphome::bmp280_base::BMP280Component::temperature_sensor_ {nullptr}

protected

Definition at line 88 of file bmp280_base.h.

The documentation for this class was generated from the following files:

/opt/build/esphome/esphome/components/bmp280_base/bmp280_base.h
/opt/build/esphome/esphome/components/bmp280_base/bmp280_base.cpp

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ ErrorCode

Member Function Documentation

◆ dump_config()

◆ get_setup_priority()

◆ read_byte()

◆ read_byte_16()

◆ read_bytes()

◆ read_pressure_()

◆ read_s16_le_()

◆ read_temperature_()

◆ read_u16_le_()

◆ read_u8_()

◆ set_iir_filter()

◆ set_pressure_oversampling()

◆ set_pressure_sensor()

◆ set_temperature_oversampling()

◆ set_temperature_sensor()

◆ setup()

◆ update()

◆ write_byte()

Field Documentation

◆ calibration_

◆ iir_filter_

◆ NONE

◆ pressure_oversampling_

◆ pressure_sensor_

◆ temperature_oversampling_

◆ temperature_sensor_