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

#include <bme280_base.h>

Inheritance diagram for esphome::bme280_base::BME280Component:

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

void	set_pressure_sensor (sensor::Sensor *pressure_sensor)

void	set_humidity_sensor (sensor::Sensor *humidity_sensor)

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

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

void	set_humidity_oversampling (BME280Oversampling humidity_over_sampling)
	Set the oversampling value for the humidity sensor. Default is 16x. More...

void	set_iir_filter (BME280IIRFilter 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

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 ()

bool	is_ready ()

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_ (const uint8_t data, int32_t t_fine)
	Read the temperature value and store the calculated ambient temperature in t_fine. More...

float	read_pressure_ (const uint8_t *data, int32_t t_fine)
	Read the pressure value in hPa using the provided t_fine value. More...

float	read_humidity_ (const uint8_t *data, int32_t t_fine)
	Read the humidity value in % 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)

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

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
BME280CalibrationData	calibration_

BME280Oversampling	temperature_oversampling_ {BME280_OVERSAMPLING_16X}

BME280Oversampling	pressure_oversampling_ {BME280_OVERSAMPLING_16X}

BME280Oversampling	humidity_oversampling_ {BME280_OVERSAMPLING_16X}

BME280IIRFilter	iir_filter_ {BME280_IIR_FILTER_OFF}

sensor::Sensor *	temperature_sensor_ {nullptr}

sensor::Sensor *	pressure_sensor_ {nullptr}

sensor::Sensor *	humidity_sensor_ {nullptr}

enum esphome::bme280_base::BME280Component::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 BME280 Temperature+Pressure+Humidity sensor.

Definition at line 60 of file bme280_base.h.

Member Enumeration Documentation

◆ ErrorCode

enum esphome::bme280_base::BME280Component::ErrorCode

protected

Enumerator
NONE
COMMUNICATION_FAILED
WRONG_CHIP_ID

Definition at line 106 of file bme280_base.h.

Member Function Documentation

◆ dump_config()

void esphome::bme280_base::BME280Component::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 181 of file bme280_base.cpp.

◆ get_setup_priority()

float esphome::bme280_base::BME280Component::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

Definition at line 204 of file bme280_base.cpp.

◆ read_byte()

virtual bool esphome::bme280_base::BME280Component::read_byte	(	uint8_t	a_register,
		uint8_t *	data
	)

protectedpure virtual

◆ read_byte_16()

virtual bool esphome::bme280_base::BME280Component::read_byte_16	(	uint8_t	a_register,
		uint16_t *	data
	)

protectedpure virtual

◆ read_bytes()

virtual bool esphome::bme280_base::BME280Component::read_bytes	(	uint8_t	a_register,
		uint8_t *	data,
		size_t	len
	)

protectedpure virtual

◆ read_humidity_()

float esphome::bme280_base::BME280Component::read_humidity_	(	const uint8_t *	data,
		int32_t	t_fine
	)

protected

Read the humidity value in % using the provided t_fine value.

Definition at line 309 of file bme280_base.cpp.

◆ read_pressure_()

float esphome::bme280_base::BME280Component::read_pressure_	(	const uint8_t *	data,
		int32_t	t_fine
	)

protected

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

Definition at line 272 of file bme280_base.cpp.

◆ read_s16_le_()

int16_t esphome::bme280_base::BME280Component::read_s16_le_ ( uint8_t a_register )

protected

Definition at line 356 of file bme280_base.cpp.

◆ read_temperature_()

float esphome::bme280_base::BME280Component::read_temperature_	(	const uint8_t *	data,
		int32_t *	t_fine
	)

protected

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

Definition at line 252 of file bme280_base.cpp.

◆ read_u16_le_()

uint16_t esphome::bme280_base::BME280Component::read_u16_le_ ( uint8_t a_register )

protected

Definition at line 351 of file bme280_base.cpp.

◆ read_u8_()

uint8_t esphome::bme280_base::BME280Component::read_u8_ ( uint8_t a_register )

protected

Definition at line 346 of file bme280_base.cpp.

◆ set_humidity_oversampling()

void esphome::bme280_base::BME280Component::set_humidity_oversampling ( BME280Oversampling humidity_over_sampling )

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

Definition at line 342 of file bme280_base.cpp.

◆ set_humidity_sensor()

void esphome::bme280_base::BME280Component::set_humidity_sensor ( sensor::Sensor * humidity_sensor )

inline

Definition at line 64 of file bme280_base.h.

◆ set_iir_filter()

void esphome::bme280_base::BME280Component::set_iir_filter ( BME280IIRFilter iir_filter )

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

Definition at line 345 of file bme280_base.cpp.

◆ set_pressure_oversampling()

void esphome::bme280_base::BME280Component::set_pressure_oversampling ( BME280Oversampling pressure_over_sampling )

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

Definition at line 339 of file bme280_base.cpp.

◆ set_pressure_sensor()

void esphome::bme280_base::BME280Component::set_pressure_sensor ( sensor::Sensor * pressure_sensor )

inline

Definition at line 63 of file bme280_base.h.

◆ set_temperature_oversampling()

void esphome::bme280_base::BME280Component::set_temperature_oversampling ( BME280Oversampling temperature_over_sampling )

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

Definition at line 336 of file bme280_base.cpp.

◆ set_temperature_sensor()

void esphome::bme280_base::BME280Component::set_temperature_sensor ( sensor::Sensor * temperature_sensor )

inline

Definition at line 62 of file bme280_base.h.

◆ setup()

void esphome::bme280_base::BME280Component::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 90 of file bme280_base.cpp.

◆ update()

void esphome::bme280_base::BME280Component::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 208 of file bme280_base.cpp.

◆ write_byte()

virtual bool esphome::bme280_base::BME280Component::write_byte	(	uint8_t	a_register,
		uint8_t	data
	)

protectedpure virtual

Field Documentation

◆ calibration_

BME280CalibrationData esphome::bme280_base::BME280Component::calibration_

protected

Definition at line 98 of file bme280_base.h.

◆ humidity_oversampling_

BME280Oversampling esphome::bme280_base::BME280Component::humidity_oversampling_ {BME280_OVERSAMPLING_16X}

protected

Definition at line 101 of file bme280_base.h.

◆ humidity_sensor_

sensor::Sensor* esphome::bme280_base::BME280Component::humidity_sensor_ {nullptr}

protected

Definition at line 105 of file bme280_base.h.

◆ iir_filter_

BME280IIRFilter esphome::bme280_base::BME280Component::iir_filter_ {BME280_IIR_FILTER_OFF}

protected

Definition at line 102 of file bme280_base.h.

◆ NONE

enum esphome::bme280_base::BME280Component::ErrorCode esphome::bme280_base::BME280Component::NONE

protected

◆ pressure_oversampling_

BME280Oversampling esphome::bme280_base::BME280Component::pressure_oversampling_ {BME280_OVERSAMPLING_16X}

protected

Definition at line 100 of file bme280_base.h.

◆ pressure_sensor_

sensor::Sensor* esphome::bme280_base::BME280Component::pressure_sensor_ {nullptr}

protected

Definition at line 104 of file bme280_base.h.

◆ temperature_oversampling_

BME280Oversampling esphome::bme280_base::BME280Component::temperature_oversampling_ {BME280_OVERSAMPLING_16X}

protected

Definition at line 99 of file bme280_base.h.

◆ temperature_sensor_

sensor::Sensor* esphome::bme280_base::BME280Component::temperature_sensor_ {nullptr}

protected

Definition at line 103 of file bme280_base.h.

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

/opt/build/esphome/esphome/components/bme280_base/bme280_base.h
/opt/build/esphome/esphome/components/bme280_base/bme280_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_humidity_()

◆ read_pressure_()

◆ read_s16_le_()

◆ read_temperature_()

◆ read_u16_le_()

◆ read_u8_()

◆ set_humidity_oversampling()

◆ set_humidity_sensor()

◆ set_iir_filter()

◆ set_pressure_oversampling()

◆ set_pressure_sensor()

◆ set_temperature_oversampling()

◆ set_temperature_sensor()

◆ setup()

◆ update()

◆ write_byte()

Field Documentation

◆ calibration_

◆ humidity_oversampling_

◆ humidity_sensor_

◆ iir_filter_

◆ NONE

◆ pressure_oversampling_

◆ pressure_sensor_

◆ temperature_oversampling_

◆ temperature_sensor_