The WeikaiComponent class stores the information global to the WeiKai component and provides methods to set/access this information. More...

#include <weikai.h>

Inheritance diagram for esphome::weikai::WeikaiComponent:

Public Member Functions
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 ()

virtual WeikaiRegister &	reg (uint8_t reg, uint8_t channel)=0
	Factory method to create a Register object.

Public Member Functions inherited from esphome::Component
virtual void	setup ()
	Where the component's initialization should happen.

virtual void	dump_config ()

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.

	ESPDEPRECATED ("Use mark_failed(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void mark_failed(const char *message)

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

void	status_set_warning (const LogString *message)

void	status_set_error ()

	ESPDEPRECATED ("Use status_set_error(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void status_set_error(const char *message)

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const char *name, uint32_t length=5000)
	Set warning status flag and automatically clear it after a timeout.

void	status_momentary_error (const char *name, uint32_t length=5000)
	Set error status flag and automatically clear it after a timeout.

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)

Protected Member Functions
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 (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 (uint32_t id)

bool	cancel_interval (InternalSchedulerID id)

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const char *name

	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t id

	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t initial_wait_time

ESPDEPRECATED("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const std	ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const char *name)

	ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(uint32_t id)

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 (uint32_t id)

bool	cancel_timeout (InternalSchedulerID id)

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 (uint32_t id)

Protected Attributes
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
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_interval(const std voi	set_interval )(const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_interval(const std boo	cancel_interval )(const char *name)
	Cancel an interval function.

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t	initial_wait_time

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t	max_attempts

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> &&	f

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

uint32_t	initial_wait_time

uint32_t uint8_t	max_attempts

uint32_t uint8_t std::function< RetryResult(uint8_t)> &&	f

uint32_t uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

uint8_t	max_attempts

uint8_t std::function< RetryResult(uint8_t)> &&	f

uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_timeout(const std voi	set_timeout )(const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_timeout(const std boo	cancel_timeout )(const char *name)
	Cancel a timeout function.

ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") void defer(const std voi	defer )(const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_defer(const std boo	cancel_defer )(const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

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.

Detailed Description

The WeikaiComponent class stores the information global to the WeiKai component and provides methods to set/access this information.

It is also the container of the WeikaiChannel children objects. This class is derived from esphome::Component class.

Definition at line 196 of file weikai.h.

Constructor & Destructor Documentation

◆ ~WeikaiComponent()

virtual esphome::weikai::WeikaiComponent::~WeikaiComponent ( )

inlinevirtual

virtual destructor

Definition at line 199 of file weikai.h.

Member Function Documentation

◆ get_name()

const char * esphome::weikai::WeikaiComponent::get_name ( )

inline

Get the name of the component.

Returns: the name

Definition at line 215 of file weikai.h.

◆ get_setup_priority()

float esphome::weikai::WeikaiComponent::get_setup_priority ( ) const

inlineoverrideprotectedvirtual

Get the priority of the component.

Returns: the priority

The priority is set below setup_priority::BUS because we use the spi/i2c busses (which has a priority of BUS) to communicate and the WeiKai therefore it is seen by our client almost as if it was a bus.

Reimplemented from esphome::Component.

Definition at line 236 of file weikai.h.

◆ loop()

void esphome::weikai::WeikaiComponent::loop ( )

overridevirtual

override the Component loop()

Reimplemented from esphome::Component.

Definition at line 98 of file weikai.cpp.

◆ page1()

bool esphome::weikai::WeikaiComponent::page1 ( )

inline

Definition at line 220 of file weikai.h.

◆ read_pin_val_()

bool esphome::weikai::WeikaiComponent::read_pin_val_ ( uint8_t pin )

protected

Helper method to read the value of a pin.

Definition at line 205 of file weikai.cpp.

◆ reg()

virtual WeikaiRegister & esphome::weikai::WeikaiComponent::reg	(	uint8_t	reg,
		uint8_t	channel )

pure virtual

Factory method to create a Register object.

Parameters

reg	address of the register
channel	channel associated with this register

Returns: a reference to WeikaiRegister

Implemented in esphome::weikai_i2c::WeikaiComponentI2C, and esphome::weikai_spi::WeikaiComponentSPI.

◆ set_crystal()

void esphome::weikai::WeikaiComponent::set_crystal ( uint32_t crystal )

inline

store crystal frequency

Parameters

crystal frequency

Definition at line 203 of file weikai.h.

◆ set_name()

void esphome::weikai::WeikaiComponent::set_name ( std::string && name )

inline

store the name for the component

Parameters

name	the name as defined by the python code generator

Definition at line 211 of file weikai.h.

◆ set_pin_direction_()

void esphome::weikai::WeikaiComponent::set_pin_direction_	(	uint8_t	pin,
		gpio::Flags	flags )

protected

Helper method to set the pin mode of a pin.

Definition at line 225 of file weikai.cpp.

◆ set_test_mode()

void esphome::weikai::WeikaiComponent::set_test_mode ( int test_mode )

inline

store if the component is in test mode

Parameters

test_mode 0=normal mode any other values mean component in test mode

Definition at line 207 of file weikai.h.

◆ write_pin_val_()

void esphome::weikai::WeikaiComponent::write_pin_val_	(	uint8_t	pin,
		bool	value )

protected

Helper method to write the value of a pin.

Definition at line 213 of file weikai.cpp.

Field Documentation

◆ children_

std::vector<WeikaiChannel *> esphome::weikai::WeikaiComponent::children_ {}

protected

the list of WeikaiChannel UART children

Definition at line 263 of file weikai.h.

◆ crystal_

uint32_t esphome::weikai::WeikaiComponent::crystal_

protected

crystal value;

Definition at line 260 of file weikai.h.

◆ input_state_

uint8_t esphome::weikai::WeikaiComponent::input_state_ {0x00}

protected

input pin states: 1 means HIGH, 0 means LOW

Definition at line 259 of file weikai.h.

◆ name_

std::string esphome::weikai::WeikaiComponent::name_

protected

name of entity

Definition at line 264 of file weikai.h.

◆ output_state_

uint8_t esphome::weikai::WeikaiComponent::output_state_ {0x00}

protected

output state: 1 means HIGH, 0 means LOW

Definition at line 258 of file weikai.h.

◆ page1_

bool esphome::weikai::WeikaiComponent::page1_ {false}

protected

set to true when in "page1 mode"

Definition at line 262 of file weikai.h.

◆ pin_config_

uint8_t esphome::weikai::WeikaiComponent::pin_config_ {0x00}

protected

pin config mask: 1 means OUTPUT, 0 means INPUT

Definition at line 257 of file weikai.h.

◆ test_mode_

int esphome::weikai::WeikaiComponent::test_mode_

protected

test mode value (0 -> no tests)

Definition at line 261 of file weikai.h.

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

esphome/components/weikai/weikai.h
esphome/components/weikai/weikai.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~WeikaiComponent()

Member Function Documentation

◆ get_name()

◆ get_setup_priority()

◆ loop()

◆ page1()

◆ read_pin_val_()

◆ reg()

◆ set_crystal()

◆ set_name()

◆ set_pin_direction_()

◆ set_test_mode()

◆ write_pin_val_()

Field Documentation

◆ children_

◆ crystal_

◆ input_state_

◆ name_

◆ output_state_

◆ page1_

◆ pin_config_

◆ test_mode_