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:

Public Member Functions
weikai::WeikaiRegister &	reg (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

void	set_crystal (uint32_t crystal)
	store crystal frequency

void	set_test_mode (int test_mode)
	store if the component is in test mode

void	set_name (std::string &&name)
	store the name for the component

const char *	get_name ()
	Get the name of the component.

void	loop () override
	override the Component loop()

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

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.

virtual void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const char *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 (const char *message=nullptr)

void	status_set_warning (const LogString *message)

void	status_set_error (const char *message=nullptr)

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 LogString *source)
	Set where this component was loaded from for some debug messages.

const LogString *	get_component_log_str () const
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time)

Public Member Functions inherited from esphome::i2c::I2CDevice
	I2CDevice ()=default
	we use the C++ default constructor

void	set_i2c_address (uint8_t address)
	We store the address of the device on the bus.

uint8_t	get_i2c_address () const
	Returns the I2C address of the object.

void	set_i2c_bus (I2CBus *bus)
	we store the pointer to the I2CBus to use

I2CRegister	reg (uint8_t a_register)
	calls the I2CRegister constructor

I2CRegister16	reg16 (uint16_t a_register)
	calls the I2CRegister16 constructor

ErrorCode	read (uint8_t *data, size_t len) const
	reads an array of bytes from the device using an I2CBus

ErrorCode	read_register (uint8_t a_register, uint8_t *data, size_t len)
	reads an array of bytes from a specific register in the I²C device

ErrorCode	read_register16 (uint16_t a_register, uint8_t *data, size_t len)
	reads an array of bytes from a specific register in the I²C device

ErrorCode	write (const uint8_t *data, size_t len) const
	writes an array of bytes to a device using an I2CBus

ErrorCode	write_read (const uint8_t write_data, size_t write_len, uint8_t read_data, size_t read_len) const
	writes an array of bytes to a device, then reads an array, as a single transaction

ErrorCode	write_register (uint8_t a_register, const uint8_t *data, size_t len) const
	writes an array of bytes to a specific register in the I²C device

ErrorCode	write_register16 (uint16_t a_register, const uint8_t *data, size_t len) const
	write an array of bytes to a specific register in the I²C device

bool	read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
	Compat APIs All methods below have been added for compatibility reasons.

bool	read_bytes_raw (uint8_t *data, uint8_t len) const

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)

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

bool	write_bytes (uint8_t a_register, const std::vector< uint8_t > &data) const

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

bool	write_byte (uint8_t a_register, uint8_t data) const

bool	write_byte_16 (uint8_t a_register, uint16_t data) const

	ESPDEPRECATED ("The stop argument is no longer used. This will be removed from ESPHome 2026.3.0", "2025.9.0") ErrorCode read_register(uint8_t a_register

	ESPDEPRECATED ("The stop argument is no longer used. This will be removed from ESPHome 2026.3.0", "2025.9.0") ErrorCode read_register16(uint16_t a_register

	ESPDEPRECATED ("The stop argument is no longer used; use write_read() for consecutive write and read. This will be " "removed from ESPHome 2026.3.0", "2025.9.0") ErrorCode write(const uint8_t *data

	ESPDEPRECATED ("The stop argument is no longer used; use write_read() for consecutive write and read. This will be " "removed from ESPHome 2026.3.0", "2025.9.0") ErrorCode write_register(uint8_t a_register

	ESPDEPRECATED ("The stop argument is no longer used; use write_read() for consecutive write and read. This will be " "removed from ESPHome 2026.3.0", "2025.9.0") ErrorCode write_register16(uint16_t a_register

Data Fields
uint8_t	base_address_
	base address of I2C device

WeikaiRegisterI2C	reg_i2c_ {this, 0, 0}
	init to this component

Data Fields inherited from esphome::i2c::I2CDevice
uint8_t *	data

uint8_t size_t	len

uint8_t size_t bool	stop

size_t	len

size_t bool stop	const { return this->write(data, len)

const uint8_t *	data

const uint8_t size_t	len

const uint8_t size_t bool stop	const

Additional Inherited Members
Protected Member Functions inherited from esphome::weikai::WeikaiComponent
float	get_setup_priority () const override
	Get the priority of the component.

bool	read_pin_val_ (uint8_t pin)
	Helper method to read the value of a pin.

void	write_pin_val_ (uint8_t pin, bool value)
	Helper method to write the value of a pin.

void	set_pin_direction_ (uint8_t pin, gpio::Flags flags)
	Helper method to set the pin mode of a pin.

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_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

void	set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

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 interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function.

bool	cancel_interval (const char *name)

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.

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.

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

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 timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function.

bool	cancel_timeout (const char *name)

void	defer (const std::string &name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

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.

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty.

Protected Attributes inherited from esphome::weikai::WeikaiComponent
uint8_t	pin_config_ {0x00}
	pin config mask: 1 means OUTPUT, 0 means INPUT

uint8_t	output_state_ {0x00}
	output state: 1 means HIGH, 0 means LOW

uint8_t	input_state_ {0x00}
	input pin states: 1 means HIGH, 0 means LOW

uint32_t	crystal_
	crystal value;

int	test_mode_
	test mode value (0 -> no tests)

bool	page1_ {false}
	set to true when in "page1 mode"

std::vector< WeikaiChannel * >	children_ {}
	the list of WeikaiChannel UART children

std::string	name_
	name of entity

Protected Attributes inherited from esphome::Component
const LogString *	component_source_ {nullptr}

uint16_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
	Warn if blocked for this many ms (max 65.5s)

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 Bits 5-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

Protected Attributes inherited from esphome::i2c::I2CDevice
uint8_t	address_ {0x00}
	store the address of the device on the bus

I2CBus *	bus_ {nullptr}
	pointer to I2CBus instance

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 161 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:

esphome/components/weikai_i2c/weikai_i2c.h
esphome/components/weikai_i2c/weikai_i2c.cpp

Public Member Functions

Data Fields

Additional Inherited Members