ESPHome  2022.11.3
Public Member Functions | Protected Attributes
esphome::i2c::ArduinoI2CBus Class Reference

#include <i2c_bus_arduino.h>

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

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_scl_pin (uint8_t scl_pin)
 
void set_frequency (uint32_t frequency)
 
- Public Member Functions inherited from esphome::i2c::I2CBus
virtual ErrorCode read (uint8_t address, uint8_t *buffer, size_t len)
 
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)
 
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 ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
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

TwoWire * wire_
 
uint8_t sda_pin_
 
uint8_t scl_pin_
 
uint32_t frequency_
 
bool initialized_ = false
 
- Protected Attributes inherited from esphome::i2c::I2CBus
std::vector< std::pair< uint8_t, bool > > scan_results_
 
bool scan_ {false}
 
- 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_ ()
 
- 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()> &&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()> &&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_arduino.h.

Member Function Documentation

◆ dump_config()

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

Reimplemented from esphome::Component.

Definition at line 51 of file i2c_bus_arduino.cpp.

◆ get_setup_priority()

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

Reimplemented from esphome::Component.

Definition at line 24 of file i2c_bus_arduino.h.

◆ readv()

ErrorCode esphome::i2c::ArduinoI2CBus::readv ( uint8_t  address,
ReadBuffer buffers,
size_t  cnt 
)
overridevirtual

Implements esphome::i2c::I2CBus.

Definition at line 83 of file i2c_bus_arduino.cpp.

◆ set_frequency()

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

Definition at line 29 of file i2c_bus_arduino.h.

◆ set_scan()

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

Definition at line 26 of file i2c_bus_arduino.h.

◆ set_scl_pin()

void esphome::i2c::ArduinoI2CBus::set_scl_pin ( uint8_t  scl_pin)
inline

Definition at line 28 of file i2c_bus_arduino.h.

◆ set_sda_pin()

void esphome::i2c::ArduinoI2CBus::set_sda_pin ( uint8_t  sda_pin)
inline

Definition at line 27 of file i2c_bus_arduino.h.

◆ setup()

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

Reimplemented from esphome::Component.

Definition at line 14 of file i2c_bus_arduino.cpp.

◆ writev()

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

Implements esphome::i2c::I2CBus.

Definition at line 121 of file i2c_bus_arduino.cpp.

Field Documentation

◆ frequency_

uint32_t esphome::i2c::ArduinoI2CBus::frequency_
protected

Definition at line 39 of file i2c_bus_arduino.h.

◆ initialized_

bool esphome::i2c::ArduinoI2CBus::initialized_ = false
protected

Definition at line 40 of file i2c_bus_arduino.h.

◆ scl_pin_

uint8_t esphome::i2c::ArduinoI2CBus::scl_pin_
protected

Definition at line 38 of file i2c_bus_arduino.h.

◆ sda_pin_

uint8_t esphome::i2c::ArduinoI2CBus::sda_pin_
protected

Definition at line 37 of file i2c_bus_arduino.h.

◆ wire_

TwoWire* esphome::i2c::ArduinoI2CBus::wire_
protected

Definition at line 36 of file i2c_bus_arduino.h.


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