ESPHome  2024.11.1
Public Member Functions | Data Fields
esphome::weikai_i2c::WeikaiComponentI2C Class Reference

The WeikaiComponentI2C class stores the information to the WeiKai component connected through an I2C bus. More...

#include <weikai_i2c.h>

Inheritance diagram for esphome::weikai_i2c::WeikaiComponentI2C:
esphome::weikai::WeikaiComponent esphome::i2c::I2CDevice esphome::Component

Public Member Functions

weikai::WeikaiRegisterreg (uint8_t reg, uint8_t channel) override
 
void setup () override
 
void dump_config () override
 
- Public Member Functions inherited from esphome::weikai::WeikaiComponent
virtual ~WeikaiComponent ()
 virtual destructor More...
 
void set_crystal (uint32_t crystal)
 store crystal frequency More...
 
void set_test_mode (int test_mode)
 store if the component is in test mode More...
 
void set_name (std::string &&name)
 store the name for the component More...
 
const char * get_name ()
 Get the name of the component. More...
 
void loop () override
 override the Component loop() More...
 
bool page1 ()
 
- Public Member Functions inherited from esphome::Component
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...
 
- Public Member Functions inherited from esphome::i2c::I2CDevice
 I2CDevice ()=default
 we use the C++ default constructor More...
 
void set_i2c_address (uint8_t address)
 We store the address of the device on the bus. More...
 
void set_i2c_bus (I2CBus *bus)
 we store the pointer to the I2CBus to use More...
 
I2CRegister reg (uint8_t a_register)
 calls the I2CRegister constructor More...
 
I2CRegister16 reg16 (uint16_t a_register)
 calls the I2CRegister16 constructor More...
 
ErrorCode read (uint8_t *data, size_t len)
 reads an array of bytes from the device using an I2CBus More...
 
ErrorCode read_register (uint8_t a_register, uint8_t *data, size_t len, bool stop=true)
 reads an array of bytes from a specific register in the I²C device More...
 
ErrorCode read_register16 (uint16_t a_register, uint8_t *data, size_t len, bool stop=true)
 reads an array of bytes from a specific register in the I²C device More...
 
ErrorCode write (const uint8_t *data, size_t len, bool stop=true)
 writes an array of bytes to a device using an I2CBus More...
 
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len, bool stop=true)
 writes an array of bytes to a specific register in the I²C device More...
 
ErrorCode write_register16 (uint16_t a_register, const uint8_t *data, size_t len, bool stop=true)
 write an array of bytes to a specific register in the I²C device More...
 
bool read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
 Compat APIs All methods below have been added for compatibility reasons. More...
 
bool read_bytes_raw (uint8_t *data, uint8_t len)
 
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, bool stop=true)
 
optional< uint8_t > read_byte (uint8_t a_register)
 
bool read_byte_16 (uint8_t a_register, uint16_t *data)
 
bool write_bytes (uint8_t a_register, const uint8_t *data, uint8_t len, bool stop=true)
 
bool write_bytes (uint8_t a_register, const std::vector< uint8_t > &data)
 
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)
 
bool write_byte (uint8_t a_register, uint8_t data, bool stop=true)
 
bool write_byte_16 (uint8_t a_register, uint16_t data)
 

Data Fields

uint8_t base_address_
 base address of I2C device More...
 
WeikaiRegisterI2C reg_i2c_ {this, 0, 0}
 init to this component More...
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::weikai::WeikaiComponent
float get_setup_priority () const override
 Get the priority of the component. More...
 
bool read_pin_val_ (uint8_t pin)
 Helper method to read the value of a pin. More...
 
void write_pin_val_ (uint8_t pin, bool value)
 Helper method to write the value of a pin. More...
 
void set_pin_direction_ (uint8_t pin, gpio::Flags flags)
 Helper method to set the pin mode of a pin. More...
 
void test_gpio_input_ ()
 
void test_gpio_output_ ()
 
- 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...
 
- Protected Attributes inherited from esphome::weikai::WeikaiComponent
uint8_t pin_config_ {0x00}
 pin config mask: 1 means OUTPUT, 0 means INPUT More...
 
uint8_t output_state_ {0x00}
 output state: 1 means HIGH, 0 means LOW More...
 
uint8_t input_state_ {0x00}
 input pin states: 1 means HIGH, 0 means LOW More...
 
uint32_t crystal_
 crystal value; More...
 
int test_mode_
 test mode value (0 -> no tests) More...
 
bool page1_ {false}
 set to true when in "page1 mode" More...
 
std::vector< WeikaiChannel * > children_ {}
 the list of WeikaiChannel UART children More...
 
std::string name_
 name of entity 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}
 
- Protected Attributes inherited from esphome::i2c::I2CDevice
uint8_t address_ {0x00}
 store the address of the device on the bus More...
 
I2CBusbus_ {nullptr}
 pointer to I2CBus instance More...
 

Detailed Description

The WeikaiComponentI2C class stores the information to the WeiKai component connected through an I2C bus.

Definition at line 42 of file weikai_i2c.h.

Member Function Documentation

◆ dump_config()

void esphome::weikai_i2c::WeikaiComponentI2C::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 162 of file weikai_i2c.cpp.

◆ reg()

weikai::WeikaiRegister& esphome::weikai_i2c::WeikaiComponentI2C::reg ( uint8_t  reg,
uint8_t  channel 
)
inlineoverridevirtual

Implements esphome::weikai::WeikaiComponent.

Definition at line 44 of file weikai_i2c.h.

◆ setup()

void esphome::weikai_i2c::WeikaiComponentI2C::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 142 of file weikai_i2c.cpp.

Field Documentation

◆ base_address_

uint8_t esphome::weikai_i2c::WeikaiComponentI2C::base_address_

base address of I2C device

Definition at line 56 of file weikai_i2c.h.

◆ reg_i2c_

WeikaiRegisterI2C esphome::weikai_i2c::WeikaiComponentI2C::reg_i2c_ {this, 0, 0}

init to this component

Definition at line 57 of file weikai_i2c.h.


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