#include <i2c_bus_esp_idf.h>

Inheritance diagram for esphome::i2c::IDFI2CBus:

Public Member Functions
void	setup () override

void	dump_config () override

ErrorCode	readv (uint8_t address, ReadBuffer *buffers, size_t cnt) override

ErrorCode	writev (uint8_t address, WriteBuffer *buffers, size_t cnt, bool stop) override

float	get_setup_priority () const override

void	set_scan (bool scan)

void	set_sda_pin (uint8_t sda_pin)

void	set_sda_pullup_enabled (bool sda_pullup_enabled)

void	set_scl_pin (uint8_t scl_pin)

void	set_scl_pullup_enabled (bool scl_pullup_enabled)

void	set_frequency (uint32_t frequency)

void	set_timeout (uint32_t timeout)

Public Member Functions inherited from esphome::i2c::I2CBus
virtual ErrorCode	read (uint8_t address, uint8_t *buffer, size_t len)
	Creates a ReadBuffer and calls the virtual readv() method to read bytes into this buffer. More...

virtual ErrorCode	write (uint8_t address, const uint8_t *buffer, size_t len)

virtual ErrorCode	write (uint8_t address, const uint8_t *buffer, size_t len, bool stop)
	Creates a WriteBuffer and calls the writev() method to send the bytes from this buffer. More...

virtual ErrorCode	writev (uint8_t address, WriteBuffer *buffers, size_t cnt)

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

bool	is_ready () const

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 Attributes
i2c_port_t	port_

uint8_t	sda_pin_

bool	sda_pullup_enabled_

uint8_t	scl_pin_

bool	scl_pullup_enabled_

uint32_t	frequency_

uint32_t	timeout_ = 0

bool	initialized_ = false

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

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

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}

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

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_setup ()

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...

Detailed Description

Definition at line 18 of file i2c_bus_esp_idf.h.

Member Function Documentation

◆ dump_config()

void esphome::i2c::IDFI2CBus::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 74 of file i2c_bus_esp_idf.cpp.

◆ get_setup_priority()

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

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 24 of file i2c_bus_esp_idf.h.

◆ readv()

ErrorCode esphome::i2c::IDFI2CBus::readv	(	uint8_t	address,
		ReadBuffer *	buffers,
		size_t	cnt
	)

overridevirtual

Implements esphome::i2c::I2CBus.

Definition at line 109 of file i2c_bus_esp_idf.cpp.

◆ set_frequency()

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

inline

Definition at line 31 of file i2c_bus_esp_idf.h.

◆ set_scan()

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

inline

Definition at line 26 of file i2c_bus_esp_idf.h.

◆ set_scl_pin()

void esphome::i2c::IDFI2CBus::set_scl_pin ( uint8_t scl_pin )

inline

Definition at line 29 of file i2c_bus_esp_idf.h.

◆ set_scl_pullup_enabled()

void esphome::i2c::IDFI2CBus::set_scl_pullup_enabled ( bool scl_pullup_enabled )

inline

Definition at line 30 of file i2c_bus_esp_idf.h.

◆ set_sda_pin()

void esphome::i2c::IDFI2CBus::set_sda_pin ( uint8_t sda_pin )

inline

Definition at line 27 of file i2c_bus_esp_idf.h.

◆ set_sda_pullup_enabled()

void esphome::i2c::IDFI2CBus::set_sda_pullup_enabled ( bool sda_pullup_enabled )

inline

Definition at line 28 of file i2c_bus_esp_idf.h.

◆ set_timeout()

void esphome::i2c::IDFI2CBus::set_timeout ( uint32_t timeout )

inline

Definition at line 32 of file i2c_bus_esp_idf.h.

◆ setup()

void esphome::i2c::IDFI2CBus::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 16 of file i2c_bus_esp_idf.cpp.

◆ writev()

ErrorCode esphome::i2c::IDFI2CBus::writev	(	uint8_t	address,
		WriteBuffer *	buffers,
		size_t	cnt,
		bool	stop
	)

overridevirtual

Implements esphome::i2c::I2CBus.

Definition at line 178 of file i2c_bus_esp_idf.cpp.

Field Documentation

◆ frequency_

uint32_t esphome::i2c::IDFI2CBus::frequency_

protected

Definition at line 44 of file i2c_bus_esp_idf.h.

◆ initialized_

bool esphome::i2c::IDFI2CBus::initialized_ = false

protected

Definition at line 46 of file i2c_bus_esp_idf.h.

◆ port_

i2c_port_t esphome::i2c::IDFI2CBus::port_

protected

Definition at line 39 of file i2c_bus_esp_idf.h.

◆ scl_pin_

uint8_t esphome::i2c::IDFI2CBus::scl_pin_

protected

Definition at line 42 of file i2c_bus_esp_idf.h.

◆ scl_pullup_enabled_

bool esphome::i2c::IDFI2CBus::scl_pullup_enabled_

protected

Definition at line 43 of file i2c_bus_esp_idf.h.

◆ sda_pin_

uint8_t esphome::i2c::IDFI2CBus::sda_pin_

protected

Definition at line 40 of file i2c_bus_esp_idf.h.

◆ sda_pullup_enabled_

bool esphome::i2c::IDFI2CBus::sda_pullup_enabled_

protected

Definition at line 41 of file i2c_bus_esp_idf.h.

◆ timeout_

uint32_t esphome::i2c::IDFI2CBus::timeout_ = 0

protected

Definition at line 45 of file i2c_bus_esp_idf.h.

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

/opt/build/esphome/esphome/components/i2c/i2c_bus_esp_idf.h
/opt/build/esphome/esphome/components/i2c/i2c_bus_esp_idf.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ dump_config()

◆ get_setup_priority()

◆ readv()

◆ set_frequency()

◆ set_scan()

◆ set_scl_pin()

◆ set_scl_pullup_enabled()

◆ set_sda_pin()

◆ set_sda_pullup_enabled()

◆ set_timeout()

◆ setup()

◆ writev()

Field Documentation

◆ frequency_

◆ initialized_

◆ port_

◆ scl_pin_

◆ scl_pullup_enabled_

◆ sda_pin_

◆ sda_pullup_enabled_

◆ timeout_