ESPHome  2024.2.0
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
esphome::bmp581::BMP581Component Class Reference

#include <bmp581.h>

Inheritance diagram for esphome::bmp581::BMP581Component:
esphome::PollingComponent esphome::i2c::I2CDevice esphome::Component

Public Member Functions

float get_setup_priority () const override
void dump_config () override
void setup () 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)
void set_pressure_oversampling_config (Oversampling pressure_oversampling)
void set_temperature_iir_filter_config (IIRFilter iir_temperature_level)
void set_pressure_iir_filter_config (IIRFilter iir_pressure_level)
void set_conversion_time (uint8_t conversion_time)
- 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 ()
bool status_has_error ()
void status_set_warning ()
void status_set_error ()
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...
- Public Member Functions inherited from esphome::i2c::I2CDevice
 I2CDevice ()=default
 we use the C++ default constructor More...
void set_i2c_address (uint8_t address)
 We store the address of the device on the bus. More...
void set_i2c_bus (I2CBus *bus)
 we store the pointer to the I2CBus to use More...
I2CRegister reg (uint8_t a_register)
 calls the I2CRegister constructor More...
I2CRegister16 reg16 (uint16_t a_register)
 calls the I2CRegister16 constructor More...
ErrorCode read (uint8_t *data, size_t len)
 reads an array of bytes from the device using an I2CBus More...
ErrorCode read_register (uint8_t a_register, uint8_t *data, size_t len, bool stop=true)
 reads an array of bytes from a specific register in the I²C device More...
ErrorCode read_register16 (uint16_t a_register, uint8_t *data, size_t len, bool stop=true)
 reads an array of bytes from a specific register in the I²C device More...
ErrorCode write (const uint8_t *data, size_t len, bool stop=true)
 writes an array of bytes to a device using an I2CBus More...
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len, bool stop=true)
 writes an array of bytes to a specific register in the I²C device More...
ErrorCode write_register16 (uint16_t a_register, const uint8_t *data, size_t len, bool stop=true)
 write an array of bytes to a specific register in the I²C device More...
bool read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
 Compat APIs All methods below have been added for compatibility reasons. More...
bool read_bytes_raw (uint8_t *data, uint8_t len)
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes (uint8_t a_register)
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes_raw ()
bool read_bytes_16 (uint8_t a_register, uint16_t *data, uint8_t len)
bool read_byte (uint8_t a_register, uint8_t *data, bool stop=true)
optional< uint8_t > read_byte (uint8_t a_register)
bool read_byte_16 (uint8_t a_register, uint16_t *data)
bool write_bytes (uint8_t a_register, const uint8_t *data, uint8_t len, bool stop=true)
bool write_bytes (uint8_t a_register, const std::vector< uint8_t > &data)
template<size_t N>
bool write_bytes (uint8_t a_register, const std::array< uint8_t, N > &data)
bool write_bytes_16 (uint8_t a_register, const uint16_t *data, uint8_t len)
bool write_byte (uint8_t a_register, uint8_t data, bool stop=true)
bool write_byte_16 (uint8_t a_register, uint16_t data)

Protected Types

enum  ErrorCode {

Protected Member Functions

bool check_data_readiness_ ()
bool prime_iir_filter_ ()
bool read_temperature_ (float &temperature)
bool read_temperature_and_pressure_ (float &temperature, float &pressure)
bool reset_ ()
bool start_measurement_ ()
bool write_iir_settings_ (IIRFilter temperature_iir, IIRFilter pressure_iir)
bool write_interrupt_source_settings_ (bool data_ready_enable)
bool write_oversampling_settings_ (Oversampling temperature_oversampling, Oversampling pressure_oversampling)
bool write_power_mode_ (OperationMode mode)
- 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

sensor::Sensortemperature_sensor_ {nullptr}
sensor::Sensorpressure_sensor_ {nullptr}
Oversampling temperature_oversampling_
Oversampling pressure_oversampling_
IIRFilter iir_temperature_level_
IIRFilter iir_pressure_level_
uint8_t conversion_time_
enum esphome::bmp581::BMP581Component::ErrorCode NONE
union {
   struct {
      uint8_t   drdy_data_reg_en: 1
      uint8_t   fifo_full_en: 1
      uint8_t   fifo_ths_en: 1
      uint8_t   oor_p_en: 1
   }   bit
   uint8_t   reg
int_source_ = {.reg = 0}
union {
   struct {
      uint8_t   drdy_data_reg: 1
      uint8_t   fifo_full: 1
      uint8_t   fifo_ths: 1
      uint8_t   oor_p: 1
      uint8_t   por: 1
   }   bit
   uint8_t   reg
int_status_ = {.reg = 0}
union {
   struct {
      uint8_t   status_core_rdy: 1
      uint8_t   status_nvm_rdy: 1
      uint8_t   status_nvm_err: 1
      uint8_t   status_nvm_cmd_err: 1
      uint8_t   status_boot_err_corrected: 1
      uint8_t   __pad0__: 2
      uint8_t   st_crack_pass: 1
   }   bit
   uint8_t   reg
status_ = {.reg = 0}
union {
   struct {
      uint8_t   comp_pt_en: 2
      uint8_t   iir_flush_forced_en: 1
      uint8_t   shdw_sel_iir_t: 1
      uint8_t   fifo_sel_iir_t: 1
      uint8_t   shdw_sel_iir_p: 1
      uint8_t   fifo_sel_iir_p: 1
      uint8_t   oor_sel_iir_p: 1
   }   bit
   uint8_t   reg
dsp_config_ = {.reg = 0}
union {
   struct {
      uint8_t   set_iir_t: 3
      uint8_t   set_iir_p: 3
   }   bit
   uint8_t   reg
iir_config_ = {.reg = 0}
union {
   struct {
      uint8_t   osr_t: 3
      uint8_t   osr_p: 3
      uint8_t   press_en: 1
   }   bit
   uint8_t   reg
osr_config_ = {.reg = 0}
union {
   struct {
      uint8_t   pwr_mode: 2
      uint8_t   odr: 5
      uint8_t   deep_dis: 1
   }   bit
   uint8_t   reg
odr_config_ = {.reg = 0}
- 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}
- Protected Attributes inherited from esphome::i2c::I2CDevice
uint8_t address_ {0x00}
 store the address of the device on the bus More...
I2CBusbus_ {nullptr}
 pointer to I2CBus instance More...

Detailed Description

Definition at line 62 of file bmp581.h.

Member Enumeration Documentation

◆ ErrorCode


Definition at line 131 of file bmp581.h.

Member Function Documentation

◆ check_data_readiness_()

bool esphome::bmp581::BMP581Component::check_data_readiness_ ( )

Definition at line 344 of file bmp581.cpp.

◆ dump_config()

void esphome::bmp581::BMP581Component::dump_config ( )

Reimplemented from esphome::Component.

Definition at line 68 of file bmp581.cpp.

◆ get_setup_priority()

float esphome::bmp581::BMP581Component::get_setup_priority ( ) const

Reimplemented from esphome::Component.

Definition at line 64 of file bmp581.h.

◆ prime_iir_filter_()

bool esphome::bmp581::BMP581Component::prime_iir_filter_ ( )

Definition at line 378 of file bmp581.cpp.

◆ read_temperature_()

bool esphome::bmp581::BMP581Component::read_temperature_ ( float &  temperature)

Definition at line 439 of file bmp581.cpp.

◆ read_temperature_and_pressure_()

bool esphome::bmp581::BMP581Component::read_temperature_and_pressure_ ( float &  temperature,
float &  pressure 

Definition at line 467 of file bmp581.cpp.

◆ reset_()

bool esphome::bmp581::BMP581Component::reset_ ( )

Definition at line 500 of file bmp581.cpp.

◆ set_conversion_time()

void esphome::bmp581::BMP581Component::set_conversion_time ( uint8_t  conversion_time)

Definition at line 86 of file bmp581.h.

◆ set_pressure_iir_filter_config()

void esphome::bmp581::BMP581Component::set_pressure_iir_filter_config ( IIRFilter  iir_pressure_level)

Definition at line 84 of file bmp581.h.

◆ set_pressure_oversampling_config()

void esphome::bmp581::BMP581Component::set_pressure_oversampling_config ( Oversampling  pressure_oversampling)

Definition at line 77 of file bmp581.h.

◆ set_pressure_sensor()

void esphome::bmp581::BMP581Component::set_pressure_sensor ( sensor::Sensor pressure_sensor)

Definition at line 72 of file bmp581.h.

◆ set_temperature_iir_filter_config()

void esphome::bmp581::BMP581Component::set_temperature_iir_filter_config ( IIRFilter  iir_temperature_level)

Definition at line 81 of file bmp581.h.

◆ set_temperature_oversampling_config()

void esphome::bmp581::BMP581Component::set_temperature_oversampling_config ( Oversampling  temperature_oversampling)

Definition at line 74 of file bmp581.h.

◆ set_temperature_sensor()

void esphome::bmp581::BMP581Component::set_temperature_sensor ( sensor::Sensor temperature_sensor)

Definition at line 71 of file bmp581.h.

◆ setup()

void esphome::bmp581::BMP581Component::setup ( )

6) Configure and prime IIR Filter(s), if enabled //

Reimplemented from esphome::Component.

Definition at line 112 of file bmp581.cpp.

◆ start_measurement_()

bool esphome::bmp581::BMP581Component::start_measurement_ ( )

Definition at line 527 of file bmp581.cpp.

◆ update()

void esphome::bmp581::BMP581Component::update ( )

Implements esphome::PollingComponent.

Definition at line 267 of file bmp581.cpp.

◆ write_iir_settings_()

bool esphome::bmp581::BMP581Component::write_iir_settings_ ( IIRFilter  temperature_iir,
IIRFilter  pressure_iir 

Definition at line 538 of file bmp581.cpp.

◆ write_interrupt_source_settings_()

bool esphome::bmp581::BMP581Component::write_interrupt_source_settings_ ( bool  data_ready_enable)

Definition at line 564 of file bmp581.cpp.

◆ write_oversampling_settings_()

bool esphome::bmp581::BMP581Component::write_oversampling_settings_ ( Oversampling  temperature_oversampling,
Oversampling  pressure_oversampling 

Definition at line 574 of file bmp581.cpp.

◆ write_power_mode_()

bool esphome::bmp581::BMP581Component::write_power_mode_ ( OperationMode  mode)

Definition at line 585 of file bmp581.cpp.

Field Documentation

◆ __pad0__

uint8_t esphome::bmp581::BMP581Component::__pad0__

Definition at line 171 of file bmp581.h.

◆ bit [1/7]

struct { ... } esphome::bmp581::BMP581Component::bit

◆ bit [2/7]

struct { ... } esphome::bmp581::BMP581Component::bit

◆ bit [3/7]

struct { ... } esphome::bmp581::BMP581Component::bit

◆ bit [4/7]

struct { ... } esphome::bmp581::BMP581Component::bit

◆ bit [5/7]

struct { ... } esphome::bmp581::BMP581Component::bit

◆ bit [6/7]

struct { ... } esphome::bmp581::BMP581Component::bit

◆ bit [7/7]

struct { ... } esphome::bmp581::BMP581Component::bit

◆ comp_pt_en

uint8_t esphome::bmp581::BMP581Component::comp_pt_en

Definition at line 180 of file bmp581.h.

◆ conversion_time_

uint8_t esphome::bmp581::BMP581Component::conversion_time_

Definition at line 100 of file bmp581.h.

◆ deep_dis

uint8_t esphome::bmp581::BMP581Component::deep_dis

Definition at line 215 of file bmp581.h.

◆ drdy_data_reg

uint8_t esphome::bmp581::BMP581Component::drdy_data_reg

Definition at line 154 of file bmp581.h.

◆ drdy_data_reg_en

uint8_t esphome::bmp581::BMP581Component::drdy_data_reg_en

Definition at line 143 of file bmp581.h.

◆ dsp_config_

union { ... } esphome::bmp581::BMP581Component::dsp_config_

◆ fifo_full

uint8_t esphome::bmp581::BMP581Component::fifo_full

Definition at line 155 of file bmp581.h.

◆ fifo_full_en

uint8_t esphome::bmp581::BMP581Component::fifo_full_en

Definition at line 144 of file bmp581.h.

◆ fifo_sel_iir_p

uint8_t esphome::bmp581::BMP581Component::fifo_sel_iir_p

Definition at line 185 of file bmp581.h.

◆ fifo_sel_iir_t

uint8_t esphome::bmp581::BMP581Component::fifo_sel_iir_t

Definition at line 183 of file bmp581.h.

◆ fifo_ths

uint8_t esphome::bmp581::BMP581Component::fifo_ths

Definition at line 156 of file bmp581.h.

◆ fifo_ths_en

uint8_t esphome::bmp581::BMP581Component::fifo_ths_en

Definition at line 145 of file bmp581.h.

◆ iir_config_

union { ... } esphome::bmp581::BMP581Component::iir_config_

◆ iir_flush_forced_en

uint8_t esphome::bmp581::BMP581Component::iir_flush_forced_en

Definition at line 181 of file bmp581.h.

◆ iir_pressure_level_

IIRFilter esphome::bmp581::BMP581Component::iir_pressure_level_

Definition at line 96 of file bmp581.h.

◆ iir_temperature_level_

IIRFilter esphome::bmp581::BMP581Component::iir_temperature_level_

Definition at line 95 of file bmp581.h.

◆ int_source_

union { ... } esphome::bmp581::BMP581Component::int_source_

◆ int_status_

union { ... } esphome::bmp581::BMP581Component::int_status_


enum esphome::bmp581::BMP581Component::ErrorCode esphome::bmp581::BMP581Component::NONE

◆ odr

uint8_t esphome::bmp581::BMP581Component::odr

Definition at line 214 of file bmp581.h.

◆ odr_config_

union { ... } esphome::bmp581::BMP581Component::odr_config_

◆ oor_p

uint8_t esphome::bmp581::BMP581Component::oor_p

Definition at line 157 of file bmp581.h.

◆ oor_p_en

uint8_t esphome::bmp581::BMP581Component::oor_p_en

Definition at line 146 of file bmp581.h.

◆ oor_sel_iir_p

uint8_t esphome::bmp581::BMP581Component::oor_sel_iir_p

Definition at line 186 of file bmp581.h.

◆ osr_config_

union { ... } esphome::bmp581::BMP581Component::osr_config_

◆ osr_p

uint8_t esphome::bmp581::BMP581Component::osr_p

Definition at line 204 of file bmp581.h.

◆ osr_t

uint8_t esphome::bmp581::BMP581Component::osr_t

Definition at line 203 of file bmp581.h.

◆ por

uint8_t esphome::bmp581::BMP581Component::por

Definition at line 158 of file bmp581.h.

◆ press_en

uint8_t esphome::bmp581::BMP581Component::press_en

Definition at line 205 of file bmp581.h.

◆ pressure_oversampling_

Oversampling esphome::bmp581::BMP581Component::pressure_oversampling_

Definition at line 93 of file bmp581.h.

◆ pressure_sensor_

sensor::Sensor* esphome::bmp581::BMP581Component::pressure_sensor_ {nullptr}

Definition at line 90 of file bmp581.h.

◆ pwr_mode

uint8_t esphome::bmp581::BMP581Component::pwr_mode

Definition at line 213 of file bmp581.h.

◆ reg

uint8_t esphome::bmp581::BMP581Component::reg

Definition at line 148 of file bmp581.h.

◆ set_iir_p

uint8_t esphome::bmp581::BMP581Component::set_iir_p

Definition at line 195 of file bmp581.h.

◆ set_iir_t

uint8_t esphome::bmp581::BMP581Component::set_iir_t

Definition at line 194 of file bmp581.h.

◆ shdw_sel_iir_p

uint8_t esphome::bmp581::BMP581Component::shdw_sel_iir_p

Definition at line 184 of file bmp581.h.

◆ shdw_sel_iir_t

uint8_t esphome::bmp581::BMP581Component::shdw_sel_iir_t

Definition at line 182 of file bmp581.h.

◆ st_crack_pass

uint8_t esphome::bmp581::BMP581Component::st_crack_pass

Definition at line 172 of file bmp581.h.

◆ status_

union { ... } esphome::bmp581::BMP581Component::status_

◆ status_boot_err_corrected

uint8_t esphome::bmp581::BMP581Component::status_boot_err_corrected

Definition at line 170 of file bmp581.h.

◆ status_core_rdy

uint8_t esphome::bmp581::BMP581Component::status_core_rdy

Definition at line 166 of file bmp581.h.

◆ status_nvm_cmd_err

uint8_t esphome::bmp581::BMP581Component::status_nvm_cmd_err

Definition at line 169 of file bmp581.h.

◆ status_nvm_err

uint8_t esphome::bmp581::BMP581Component::status_nvm_err

Definition at line 168 of file bmp581.h.

◆ status_nvm_rdy

uint8_t esphome::bmp581::BMP581Component::status_nvm_rdy

Definition at line 167 of file bmp581.h.

◆ temperature_oversampling_

Oversampling esphome::bmp581::BMP581Component::temperature_oversampling_

Definition at line 92 of file bmp581.h.

◆ temperature_sensor_

sensor::Sensor* esphome::bmp581::BMP581Component::temperature_sensor_ {nullptr}

Definition at line 89 of file bmp581.h.

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