#include <i2c_bus_host.h>

Inheritance diagram for esphome::i2c::HostI2CBus:

Public Member Functions
	~HostI2CBus () override

void	setup () override

void	dump_config () override

float	get_setup_priority () const override

ErrorCode	write_readv (uint8_t address, const uint8_t write_buffer, size_t write_count, uint8_t read_buffer, size_t read_count) override

void	set_device (const std::string &device)

void	set_scan (bool scan)

void	set_frequency (uint32_t frequency)

const std::string &	get_device () const

Public Member Functions inherited from esphome::i2c::I2CBus
virtual	~I2CBus ()=default

ErrorCode	read (uint8_t address, uint8_t *buffer, size_t len)

ErrorCode	write (uint8_t address, const uint8_t *buffer, size_t len, bool stop=true)

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

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.

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

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)

Protected Member Functions
void	update_error_ (const std::string &error)

ErrorCode	map_errno_to_error_code_ (int err)

Protected Member Functions inherited from esphome::i2c::I2CBus
void	i2c_scan_ ()
	Scans the I2C bus for devices.

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.

virtual void	call_setup ()

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

Protected Attributes
std::string	device_

uint32_t	frequency_ {50000}

int	file_descriptor_ {-1}

bool	initialized_ {false}

std::string	first_error_

Protected Attributes inherited from esphome::i2c::I2CBus
std::vector< std::pair< uint8_t, bool > >	scan_results_
	array containing scan results

bool	scan_ {false}
	Should we scan ? Can be set in the yaml.

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_

Detailed Description

Definition at line 11 of file i2c_bus_host.h.

Constructor & Destructor Documentation

◆ ~HostI2CBus()

esphome::i2c::HostI2CBus::~HostI2CBus ( )

override

Definition at line 21 of file i2c_bus_host.cpp.

Member Function Documentation

◆ dump_config()

void esphome::i2c::HostI2CBus::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 55 of file i2c_bus_host.cpp.

◆ get_device()

const std::string & esphome::i2c::HostI2CBus::get_device ( ) const

inline

Definition at line 26 of file i2c_bus_host.h.

◆ get_setup_priority()

float esphome::i2c::HostI2CBus::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 17 of file i2c_bus_host.h.

◆ map_errno_to_error_code_()

ErrorCode esphome::i2c::HostI2CBus::map_errno_to_error_code_ ( int err )

protected

Definition at line 263 of file i2c_bus_host.cpp.

◆ set_device()

void esphome::i2c::HostI2CBus::set_device ( const std::string & device )

inline

Definition at line 22 of file i2c_bus_host.h.

◆ set_frequency()

void esphome::i2c::HostI2CBus::set_frequency ( uint32_t frequency )

inline

Definition at line 24 of file i2c_bus_host.h.

◆ set_scan()

void esphome::i2c::HostI2CBus::set_scan ( bool scan )

inline

Definition at line 23 of file i2c_bus_host.h.

◆ setup()

void esphome::i2c::HostI2CBus::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 28 of file i2c_bus_host.cpp.

◆ update_error_()

void esphome::i2c::HostI2CBus::update_error_ ( const std::string & error )

protected

Definition at line 285 of file i2c_bus_host.cpp.

◆ write_readv()

ErrorCode esphome::i2c::HostI2CBus::write_readv	(	uint8_t	address,
		const uint8_t *	write_buffer,
		size_t	write_count,
		uint8_t *	read_buffer,
		size_t	read_count )

overridevirtual

Implements esphome::i2c::I2CBus.

Definition at line 75 of file i2c_bus_host.cpp.

Field Documentation

◆ device_

std::string esphome::i2c::HostI2CBus::device_

protected

Definition at line 32 of file i2c_bus_host.h.

◆ file_descriptor_

int esphome::i2c::HostI2CBus::file_descriptor_ {-1}

protected

Definition at line 34 of file i2c_bus_host.h.

◆ first_error_

std::string esphome::i2c::HostI2CBus::first_error_

protected

Definition at line 36 of file i2c_bus_host.h.

◆ frequency_

uint32_t esphome::i2c::HostI2CBus::frequency_ {50000}

protected

Definition at line 33 of file i2c_bus_host.h.

◆ initialized_

bool esphome::i2c::HostI2CBus::initialized_ {false}

protected

Definition at line 35 of file i2c_bus_host.h.

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

esphome/components/i2c/i2c_bus_host.h
esphome/components/i2c/i2c_bus_host.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~HostI2CBus()

Member Function Documentation

◆ dump_config()

◆ get_device()

◆ get_setup_priority()

◆ map_errno_to_error_code_()

◆ set_device()

◆ set_frequency()

◆ set_scan()

◆ setup()

◆ update_error_()

◆ write_readv()

Field Documentation

◆ device_

◆ file_descriptor_

◆ first_error_

◆ frequency_

◆ initialized_