ESPHome 2026.4.0-dev
Loading...
Searching...
No Matches
esphome::bmp581_spi::BMP581SPIComponent Class Reference

#include <bmp581_spi.h>

Inheritance diagram for esphome::bmp581_spi::BMP581SPIComponent:
esphome::bmp581_base::BMP581Component esphome::spi::SPIDevice< spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_HIGH, spi::CLOCK_PHASE_TRAILING, spi::DATA_RATE_200KHZ > esphome::PollingComponent esphome::spi::SPIClient esphome::Component

Public Member Functions

void setup () override
 
bool bmp_read_byte (uint8_t a_register, uint8_t *data) override
 
bool bmp_write_byte (uint8_t a_register, uint8_t data) override
 
bool bmp_read_bytes (uint8_t a_register, uint8_t *data, size_t len) override
 
bool bmp_write_bytes (uint8_t a_register, uint8_t *data, size_t len) override
 
void dump_config () override
 
- Public Member Functions inherited from esphome::bmp581_base::BMP581Component
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.
 
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.
 
 ESPDEPRECATED ("Use mark_failed(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void mark_failed(const char *message)
 
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 ()
 
 ESPDEPRECATED ("Use status_set_error(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void status_set_error(const char *message)
 
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)
 
- Public Member Functions inherited from esphome::spi::SPIDevice< spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_HIGH, spi::CLOCK_PHASE_TRAILING, spi::DATA_RATE_200KHZ >
 SPIDevice ()
 
 SPIDevice (SPIComponent *parent, GPIOPin *cs_pin)
 
void spi_setup () override
 
void spi_teardown () override
 
void set_spi_parent (SPIComponent *parent)
 
void set_cs_pin (GPIOPin *cs)
 
void set_data_rate (uint32_t data_rate)
 
void set_bit_order (SPIBitOrder order)
 
void set_mode (SPIMode mode)
 
uint8_t read_byte ()
 
void read_array (uint8_t *data, size_t length)
 
void write (uint16_t data, size_t num_bits)
 Write a single data item, up to 32 bits.
 
void write_cmd_addr_data (size_t cmd_bits, uint32_t cmd, size_t addr_bits, uint32_t address, const uint8_t *data, size_t length, uint8_t bus_width=1)
 
void write_byte (uint8_t data)
 
void transfer_array (uint8_t *data, size_t length)
 Write the array data, replace with received data.
 
void transfer_array (std::array< uint8_t, N > &data)
 
uint8_t transfer_byte (uint8_t data)
 
void write_byte16 (uint16_t data)
 Write 16 bit data.
 
void write_array16 (const uint16_t *data, size_t length)
 Write an array of data as 16 bit values, byte-swapping if required.
 
void enable ()
 
void disable ()
 
void write_array (const uint8_t *data, size_t length)
 
void write_array (const std::array< uint8_t, N > &data)
 
void write_array (const std::vector< uint8_t > &data)
 
- Public Member Functions inherited from esphome::spi::SPIClient
 SPIClient (SPIBitOrder bit_order, SPIMode mode, uint32_t data_rate)
 
bool spi_is_ready ()
 
void set_release_device (bool release)
 
void set_write_only (bool write_only)
 

Protected Member Functions

void activate_interface () override
 
- Protected Member Functions inherited from esphome::bmp581_base::BMP581Component
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
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 (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 (uint32_t id)
 
bool cancel_interval (InternalSchedulerID id)
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const char *name
 
 ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t id
 
 ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t initial_wait_time
 
ESPDEPRECATED("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const std ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const char *name)
 
 ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(uint32_t id)
 
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 (uint32_t id)
 
bool cancel_timeout (InternalSchedulerID id)
 
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 (uint32_t id)
 
void status_clear_warning_slow_path_ ()
 
void status_clear_error_slow_path_ ()
 

Additional Inherited Members

- Data Fields inherited from esphome::bmp581_base::BMP581Component
- Protected Types inherited from esphome::bmp581_base::BMP581Component
enum  ErrorCode {
  NONE = 0 , ERROR_COMMUNICATION_FAILED , ERROR_WRONG_CHIP_ID , ERROR_SENSOR_STATUS ,
  ERROR_SENSOR_RESET , ERROR_PRIME_IIR_FAILED
}
 
- Protected Attributes inherited from esphome::bmp581_base::BMP581Component
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_base::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   : 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
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_interval(const std voi set_interval )(const char *name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name.
 
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_interval(const std boo cancel_interval )(const char *name)
 Cancel an interval function.
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t initial_wait_time
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t max_attempts
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> && f
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> float backoff_increase_factor = 1.0f)
 
uint32_t initial_wait_time
 
uint32_t uint8_t max_attempts
 
uint32_t uint8_t std::function< RetryResult(uint8_t)> && f
 
uint32_t uint8_t std::function< RetryResult(uint8_t)> float backoff_increase_factor = 1.0f)
 
uint8_t max_attempts
 
uint8_t std::function< RetryResult(uint8_t)> && f
 
uint8_t std::function< RetryResult(uint8_t)> float backoff_increase_factor = 1.0f)
 
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_timeout(const std voi set_timeout )(const char *name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name.
 
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_timeout(const std boo cancel_timeout )(const char *name)
 Cancel a timeout function.
 
ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") void defer(const std voi defer )(const char *name, std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_defer(const std boo cancel_defer )(const char *name)
 Cancel a defer callback using the specified name, name must not be empty.
 
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_
 
- Protected Attributes inherited from esphome::spi::SPIClient
SPIBitOrder bit_order_ {BIT_ORDER_MSB_FIRST}
 
SPIMode mode_ {MODE0}
 
uint32_t data_rate_ {1000000}
 
SPIComponentparent_ {nullptr}
 
GPIOPincs_ {nullptr}
 
bool release_device_ {false}
 
bool write_only_ {false}
 
SPIDelegatedelegate_ {SPIDelegate::NULL_DELEGATE}
 

Detailed Description

Definition at line 9 of file bmp581_spi.h.

Member Function Documentation

◆ activate_interface()

void esphome::bmp581_spi::BMP581SPIComponent::activate_interface ( )
overrideprotectedvirtual

Reimplemented from esphome::bmp581_base::BMP581Component.

Definition at line 28 of file bmp581_spi.cpp.

◆ bmp_read_byte()

bool esphome::bmp581_spi::BMP581SPIComponent::bmp_read_byte ( uint8_t a_register,
uint8_t * data )
overridevirtual

Implements esphome::bmp581_base::BMP581Component.

Definition at line 42 of file bmp581_spi.cpp.

◆ bmp_read_bytes()

bool esphome::bmp581_spi::BMP581SPIComponent::bmp_read_bytes ( uint8_t a_register,
uint8_t * data,
size_t len )
overridevirtual

Implements esphome::bmp581_base::BMP581Component.

Definition at line 58 of file bmp581_spi.cpp.

◆ bmp_write_byte()

bool esphome::bmp581_spi::BMP581SPIComponent::bmp_write_byte ( uint8_t a_register,
uint8_t data )
overridevirtual

Implements esphome::bmp581_base::BMP581Component.

Definition at line 50 of file bmp581_spi.cpp.

◆ bmp_write_bytes()

bool esphome::bmp581_spi::BMP581SPIComponent::bmp_write_bytes ( uint8_t a_register,
uint8_t * data,
size_t len )
overridevirtual

Implements esphome::bmp581_base::BMP581Component.

Definition at line 66 of file bmp581_spi.cpp.

◆ dump_config()

void esphome::bmp581_spi::BMP581SPIComponent::dump_config ( )
overridevirtual

Reimplemented from esphome::bmp581_base::BMP581Component.

Definition at line 18 of file bmp581_spi.cpp.

◆ setup()

void esphome::bmp581_spi::BMP581SPIComponent::setup ( )
overridevirtual

Reimplemented from esphome::bmp581_base::BMP581Component.

Definition at line 23 of file bmp581_spi.cpp.


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