ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
esphome::ms8607::MS8607Component Class Referencefinal

Temperature, pressure, and humidity sensor. More...

#include <ms8607.h>

Inheritance diagram for esphome::ms8607::MS8607Component:
esphome::PollingComponent esphome::i2c::I2CDevice esphome::Component

Protected Member Functions

void try_reset_ ()
 Attempt to reset both I2C devices, retrying with backoff on failure.
 
bool read_calibration_values_from_prom_ ()
 Read and CRC-check the PROM calibration values; marks the component failed on error.
 
bool read_adc_ (uint32_t &value)
 Read a 24-bit converted ADC value, either D1 (pressure) or D2 (temperature)
 
void request_read_temperature_ ()
 Start async temperature read.
 
void read_temperature_ ()
 Process async temperature read, publish it and hand off to pressure or humidity.
 
bool request_read_pressure_ (uint32_t d2_raw_temperature)
 Start async pressure read; false if the request failed.
 
void read_pressure_ (uint32_t d2_raw_temperature)
 Process async pressure read and publish it.
 
void finish_update_ (float temperature)
 Read humidity if it is configured, otherwise end the update cycle.
 
void request_read_humidity_ (float temperature)
 start async humidity read
 
void read_humidity_ (float temperature)
 process async humidity read
 
void finalize_update_ ()
 End the update cycle, setting or clearing the warning from update_ok_.
 
- 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.
 
bool set_error_flag_ (const LogString *message)
 Set the error flag and log it; true when it was not set before.
 
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

MS8607HumidityDevice * humidity_device_ {nullptr}
 I2CDevice object to communicate with secondary I2C address for the humidity sensor.
 
CalibrationValues calibration_values_ {}
 This device's pressure & temperature calibration values, read from PROM.
 
bool setup_complete_ {false}
 Set once the PROM calibration values have been read.
 
uint8_t reset_interval_ {5}
 
uint8_t reset_attempts_remaining_ {3}
 
bool update_ok_ {true}
 False once any step of the current update cycle failed.
 
- 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_
 
- Protected Attributes inherited from esphome::i2c::I2CDevice
I2CBus * bus_ {nullptr}
 pointer to I2CBus instance
 
uint8_t address_ {0x00}
 store the address of the device on the bus
 

Additional Inherited Members

- 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 last before a reboot or deep sleep 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)
 
bool ESPHOME_ALWAYS_INLINE setup_check (bool ok)
 Marks the component failed with message (default "Communication failed") unless ok; returns ok.
 
bool ESPHOME_ALWAYS_INLINE setup_check (bool ok, 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)
 
bool status_comm_result (bool ok)
 Clears the warning when ok, else sets it with message (default "Communication failed"); returns ok.
 
bool status_comm_result (bool ok, const LogString *message)
 
void status_set_error ()
 
void status_set_error (const LogString *message)
 
void status_clear_warning ()
 
void status_clear_error ()
 
 ESPDEPRECATED ("Use status_momentary_warning() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_warning(const char *name
 
void status_momentary_warning (uint32_t length=5000)
 Set warning status flag and clear it after length ms.
 
void status_momentary_warning (const LogString *message, uint32_t length=5000)
 
 ESPDEPRECATED ("Use status_momentary_error() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_error(const char *name
 
void status_momentary_error (uint32_t length=5000)
 Set error status flag and clear it after length ms.
 
void status_momentary_error (const LogString *message, uint32_t length=5000)
 
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)
 
- Public Member Functions inherited from esphome::i2c::I2CDevice
 I2CDevice ()=default
 we use the C++ default constructor
 
void set_i2c_address (uint8_t address)
 We store the address of the device on the bus.
 
uint8_t get_i2c_address () const
 Returns the I2C address of the object.
 
void set_i2c_bus (I2CBus *bus)
 we store the pointer to the I2CBus to use
 
I2CRegister reg (uint8_t a_register)
 calls the I2CRegister constructor
 
I2CRegister16 reg16 (uint16_t a_register)
 calls the I2CRegister16 constructor
 
ErrorCode read (uint8_t *data, size_t len) const
 reads an array of bytes from the device using an I2CBus
 
ErrorCode read_register (uint8_t a_register, uint8_t *data, size_t len)
 reads an array of bytes from a specific register in the I²C device
 
ErrorCode read_register16 (uint16_t a_register, uint8_t *data, size_t len)
 reads an array of bytes from a specific register in the I²C device
 
ErrorCode write (const uint8_t *data, size_t len) const
 writes an array of bytes to a device using an I2CBus
 
ErrorCode write_read (const uint8_t *write_data, size_t write_len, uint8_t *read_data, size_t read_len) const
 writes an array of bytes to a device, then reads an array, as a single transaction
 
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len) const
 writes an array of bytes to a specific register in the I²C device
 
ErrorCode write_register16 (uint16_t a_register, const uint8_t *data, size_t len) const
 write an array of bytes to a specific register in the I²C device
 
bool write_registers (const I2CRegValue *table, size_t count) const
 Write each register and value of table in order, stopping at the first failure.
 
template<size_t N>
bool write_registers (const I2CRegValue(&table)[N]) const
 
bool check_chip_id (Component *component, uint8_t a_register, uint8_t expected, uint8_t mask=0xFF)
 Read the 8-bit ID at a_register and accept it when it matches expected in the bits set in mask.
 
bool read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
 Compat APIs All methods below have been added for compatibility reasons.
 
bool read_bytes_raw (uint8_t *data, uint8_t len) const
 
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)
 
optional< uint8_t > read_byte (uint8_t a_register)
 
bool read_byte_16 (uint8_t a_register, uint16_t *data)
 
bool read_bytes_16_le (uint8_t a_register, uint16_t *data, uint8_t len)
 Read len 16-bit values stored least significant byte first; no conversion is compiled on little-endian hosts.
 
bool read_bytes_16_le (uint8_t a_register, int16_t *data, uint8_t len)
 
bool read_byte_16_le (uint8_t a_register, uint16_t *data)
 Read a 16-bit value stored least significant byte first.
 
bool write_bytes (uint8_t a_register, const uint8_t *data, uint8_t len) const
 
bool write_bytes (uint8_t a_register, const std::vector< uint8_t > &data) const
 
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) const
 
bool write_byte (uint8_t a_register, uint8_t data) const
 
bool write_byte_16 (uint8_t a_register, uint16_t data) const
 
bool write_byte_16_le (uint8_t a_register, uint16_t data) const
 Write a 16-bit value least significant byte first.
 
bool update_register (uint8_t a_register, uint8_t mask, uint8_t value)
 Read a register, replace the bits in mask with those of value and write it back.
 
- Data Fields inherited from esphome::Component
uint32_t length = 5000)
 

Detailed Description

Temperature, pressure, and humidity sensor.

By default, the MS8607 measures sensors at the highest resolution. A potential enhancement would be to expose the resolution as a configurable setting. A lower resolution speeds up ADC conversion time & uses less power.

Datasheet: https://www.te.com/commerce/DocumentDelivery/DDEController?Action=showdoc&DocId=Data+Sheet%7FMS8607-02BA01%7FB3%7Fpdf%7FEnglish%7FENG_DS_MS8607-02BA01_B3.pdf%7FCAT-BLPS0018

Other implementations:

Definition at line 68 of file ms8607.h.

Member Function Documentation

◆ finalize_update_()

void esphome::ms8607::MS8607Component::finalize_update_ ( )
protected

End the update cycle, setting or clearing the warning from update_ok_.

Definition at line 371 of file ms8607.cpp.

◆ finish_update_()

void esphome::ms8607::MS8607Component::finish_update_ ( float temperature)
protected

Read humidity if it is configured, otherwise end the update cycle.

Definition at line 311 of file ms8607.cpp.

◆ read_adc_()

bool esphome::ms8607::MS8607Component::read_adc_ ( uint32_t & value)
protected

Read a 24-bit converted ADC value, either D1 (pressure) or D2 (temperature)

Definition at line 227 of file ms8607.cpp.

◆ read_calibration_values_from_prom_()

bool esphome::ms8607::MS8607Component::read_calibration_values_from_prom_ ( )
protected

Read and CRC-check the PROM calibration values; marks the component failed on error.

Definition at line 153 of file ms8607.cpp.

◆ read_humidity_()

void esphome::ms8607::MS8607Component::read_humidity_ ( float temperature)
protected

process async humidity read

Definition at line 332 of file ms8607.cpp.

◆ read_pressure_()

void esphome::ms8607::MS8607Component::read_pressure_ ( uint32_t d2_raw_temperature)
protected

Process async pressure read and publish it.

Takes the raw temperature rather than the compensated one so the timeout callback fits in std::function's inline storage

Definition at line 287 of file ms8607.cpp.

◆ read_temperature_()

void esphome::ms8607::MS8607Component::read_temperature_ ( )
protected

Process async temperature read, publish it and hand off to pressure or humidity.

Definition at line 248 of file ms8607.cpp.

◆ request_read_humidity_()

void esphome::ms8607::MS8607Component::request_read_humidity_ ( float temperature)
protected

start async humidity read

Definition at line 320 of file ms8607.cpp.

◆ request_read_pressure_()

bool esphome::ms8607::MS8607Component::request_read_pressure_ ( uint32_t d2_raw_temperature)
protected

Start async pressure read; false if the request failed.

Definition at line 274 of file ms8607.cpp.

◆ request_read_temperature_()

void esphome::ms8607::MS8607Component::request_read_temperature_ ( )
protected

Start async temperature read.

Definition at line 235 of file ms8607.cpp.

◆ try_reset_()

void esphome::ms8607::MS8607Component::try_reset_ ( )
protected

Attempt to reset both I2C devices, retrying with backoff on failure.

Definition at line 69 of file ms8607.cpp.

Field Documentation

◆ calibration_values_

CalibrationValues esphome::ms8607::MS8607Component::calibration_values_ {}
protected

This device's pressure & temperature calibration values, read from PROM.

Definition at line 115 of file ms8607.h.

◆ humidity_device_

MS8607HumidityDevice* esphome::ms8607::MS8607Component::humidity_device_ {nullptr}
protected

I2CDevice object to communicate with secondary I2C address for the humidity sensor.

The MS8607 only has one set of I2C pins, despite using two different addresses. Set exactly when the humidity sensor is configured. Default address for humidity is 0x40

Definition at line 112 of file ms8607.h.

◆ reset_attempts_remaining_

uint8_t esphome::ms8607::MS8607Component::reset_attempts_remaining_ {3}
protected

Definition at line 120 of file ms8607.h.

◆ reset_interval_

uint8_t esphome::ms8607::MS8607Component::reset_interval_ {5}
protected

Definition at line 119 of file ms8607.h.

◆ setup_complete_

bool esphome::ms8607::MS8607Component::setup_complete_ {false}
protected

Set once the PROM calibration values have been read.

Definition at line 118 of file ms8607.h.

◆ update_ok_

bool esphome::ms8607::MS8607Component::update_ok_ {true}
protected

False once any step of the current update cycle failed.

Definition at line 122 of file ms8607.h.


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