ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
esphome::i2c::SoftwareI2CBus Class Referencefinal

Bit-banged I2C controller for LibreTiny chips without an Arduino Wire implementation (BK72xx). More...

#include <i2c_bus_software.h>

Inheritance diagram for esphome::i2c::SoftwareI2CBus:
esphome::i2c::I2CBus esphome::Component

Public Member Functions

void setup () override
 
void dump_config () 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
 
float get_setup_priority () const override
 
void set_scan (bool scan)
 
void set_sda_pin (InternalGPIOPin *sda_pin)
 
void set_scl_pin (InternalGPIOPin *scl_pin)
 
void set_frequency (uint32_t frequency)
 
ErrorCode switch_frequency (uint32_t frequency) override
 
uint32_t get_frequency () const override
 
void set_timeout (uint32_t timeout)
 Maximum time in microseconds a device may hold SCL low (clock stretching).
 
- 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 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)
 

Protected Member Functions

bool recover_ ()
 
void update_half_period_ ()
 
void start_ ()
 
void stop_ ()
 
bool release_scl_ ()
 
bool write_byte_ (uint8_t data)
 Shift out one byte, returns true if the device acknowledged it.
 
uint8_t read_byte_ (bool ack)
 
- Protected Member Functions inherited from esphome::i2c::I2CBus
void i2c_scan_ ()
 Scans the I2C bus for devices.
 
void dump_scan_results_ ()
 Logs the scan results at config level, if the bus was scanned.
 
- 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.
 
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

InternalGPIOPin * sda_pin_ {nullptr}
 
InternalGPIOPin * scl_pin_ {nullptr}
 
uint32_t frequency_ {100000}
 
uint32_t timeout_ {1000}
 
uint32_t half_period_us_ {5}
 
bool timed_out_ {false}
 
bool recovered_ {false}
 
bool initialized_ {false}
 
bool bus_stuck_ {false}
 
- 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
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_
 

Additional Inherited Members

- Data Fields inherited from esphome::Component
uint32_t length = 5000)
 

Detailed Description

Bit-banged I2C controller for LibreTiny chips without an Arduino Wire implementation (BK72xx).

SDA and SCL can be any two GPIO pins; both lines are driven open-drain style (pulled low or released), so the bus needs pull-ups (the internal pull-up is enabled while released).

Definition at line 14 of file i2c_bus_software.h.

Member Function Documentation

◆ dump_config()

void esphome::i2c::SoftwareI2CBus::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 43 of file i2c_bus_software.cpp.

◆ get_frequency()

uint32_t esphome::i2c::SoftwareI2CBus::get_frequency ( ) const
inlineoverridevirtual

Reimplemented from esphome::i2c::I2CBus.

Definition at line 28 of file i2c_bus_software.h.

◆ get_setup_priority()

float esphome::i2c::SoftwareI2CBus::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 20 of file i2c_bus_software.h.

◆ read_byte_()

uint8_t esphome::i2c::SoftwareI2CBus::read_byte_ ( bool ack)
protected

Definition at line 177 of file i2c_bus_software.cpp.

◆ recover_()

bool esphome::i2c::SoftwareI2CBus::recover_ ( )
protected

Definition at line 72 of file i2c_bus_software.cpp.

◆ release_scl_()

bool esphome::i2c::SoftwareI2CBus::release_scl_ ( )
protected

Definition at line 105 of file i2c_bus_software.cpp.

◆ set_frequency()

void esphome::i2c::SoftwareI2CBus::set_frequency ( uint32_t frequency)
inline

Definition at line 25 of file i2c_bus_software.h.

◆ set_scan()

void esphome::i2c::SoftwareI2CBus::set_scan ( bool scan)
inline

Definition at line 22 of file i2c_bus_software.h.

◆ set_scl_pin()

void esphome::i2c::SoftwareI2CBus::set_scl_pin ( InternalGPIOPin * scl_pin)
inline

Definition at line 24 of file i2c_bus_software.h.

◆ set_sda_pin()

void esphome::i2c::SoftwareI2CBus::set_sda_pin ( InternalGPIOPin * sda_pin)
inline

Definition at line 23 of file i2c_bus_software.h.

◆ set_timeout()

void esphome::i2c::SoftwareI2CBus::set_timeout ( uint32_t timeout)
inline

Maximum time in microseconds a device may hold SCL low (clock stretching).

Definition at line 31 of file i2c_bus_software.h.

◆ setup()

void esphome::i2c::SoftwareI2CBus::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 24 of file i2c_bus_software.cpp.

◆ start_()

void esphome::i2c::SoftwareI2CBus::start_ ( )
protected

Definition at line 117 of file i2c_bus_software.cpp.

◆ stop_()

void esphome::i2c::SoftwareI2CBus::stop_ ( )
protected

Definition at line 137 of file i2c_bus_software.cpp.

◆ switch_frequency()

ErrorCode esphome::i2c::SoftwareI2CBus::switch_frequency ( uint32_t frequency)
overridevirtual

Reimplemented from esphome::i2c::I2CBus.

Definition at line 63 of file i2c_bus_software.cpp.

◆ update_half_period_()

void esphome::i2c::SoftwareI2CBus::update_half_period_ ( )
protected

Definition at line 58 of file i2c_bus_software.cpp.

◆ write_byte_()

bool esphome::i2c::SoftwareI2CBus::write_byte_ ( uint8_t data)
protected

Shift out one byte, returns true if the device acknowledged it.

Definition at line 153 of file i2c_bus_software.cpp.

◆ write_readv()

ErrorCode esphome::i2c::SoftwareI2CBus::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 200 of file i2c_bus_software.cpp.

Field Documentation

◆ bus_stuck_

bool esphome::i2c::SoftwareI2CBus::bus_stuck_ {false}
protected

Definition at line 50 of file i2c_bus_software.h.

◆ frequency_

uint32_t esphome::i2c::SoftwareI2CBus::frequency_ {100000}
protected

Definition at line 44 of file i2c_bus_software.h.

◆ half_period_us_

uint32_t esphome::i2c::SoftwareI2CBus::half_period_us_ {5}
protected

Definition at line 46 of file i2c_bus_software.h.

◆ initialized_

bool esphome::i2c::SoftwareI2CBus::initialized_ {false}
protected

Definition at line 49 of file i2c_bus_software.h.

◆ recovered_

bool esphome::i2c::SoftwareI2CBus::recovered_ {false}
protected

Definition at line 48 of file i2c_bus_software.h.

◆ scl_pin_

InternalGPIOPin* esphome::i2c::SoftwareI2CBus::scl_pin_ {nullptr}
protected

Definition at line 43 of file i2c_bus_software.h.

◆ sda_pin_

InternalGPIOPin* esphome::i2c::SoftwareI2CBus::sda_pin_ {nullptr}
protected

Definition at line 42 of file i2c_bus_software.h.

◆ timed_out_

bool esphome::i2c::SoftwareI2CBus::timed_out_ {false}
protected

Definition at line 47 of file i2c_bus_software.h.

◆ timeout_

uint32_t esphome::i2c::SoftwareI2CBus::timeout_ {1000}
protected

Definition at line 45 of file i2c_bus_software.h.


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