The WeikaiComponentSPI class stores the information to the WeiKai component connected through an SPI bus. More...

#include <weikai_spi.h>

Inheritance diagram for esphome::weikai_spi::WeikaiComponentSPI:

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::spi::SPIDevice< spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_LOW, spi::CLOCK_PHASE_LEADING, spi::DATA_RATE_1MHZ >
	SPIDevice ()

	SPIDevice (SPIComponent parent, GPIOPin cs_pin)

void	spi_setup () override

void	spi_teardown () override

void	set_spi_parent (SPIComponent *parent)

void	set_cs_pin (GPIOPin *cs)

void	set_data_rate (uint32_t data_rate)

void	set_bit_order (SPIBitOrder order)

void	set_mode (SPIMode mode)

uint8_t	read_byte ()

void	read_array (uint8_t *data, size_t length)

void	write (uint16_t data, size_t num_bits)
	Write a single data item, up to 32 bits.

void	write_cmd_addr_data (size_t cmd_bits, uint32_t cmd, size_t addr_bits, uint32_t address, const uint8_t *data, size_t length, uint8_t bus_width=1)

void	write_byte (uint8_t data)

void	transfer_array (uint8_t *data, size_t length)
	Write the array data, replace with received data.

void	transfer_array (std::array< uint8_t, N > &data)

uint8_t	transfer_byte (uint8_t data)

void	write_byte16 (uint16_t data)
	Write 16 bit data.

void	write_array16 (const uint16_t *data, size_t length)
	Write an array of data as 16 bit values, byte-swapping if required.

void	enable ()

void	disable ()

void	write_array (const uint8_t *data, size_t length)

void	write_array (const std::array< uint8_t, N > &data)

void	write_array (const std::vector< uint8_t > &data)

Public Member Functions inherited from esphome::spi::SPIClient
	SPIClient (SPIBitOrder bit_order, SPIMode mode, uint32_t data_rate)

bool	spi_is_ready ()

void	set_release_device (bool release)

void	set_write_only (bool write_only)

Protected Attributes
WeikaiRegisterSPI	reg_spi_ {this, 0, 0}
	init to this component

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::spi::SPIClient
SPIBitOrder	bit_order_ {BIT_ORDER_MSB_FIRST}

SPIMode	mode_ {MODE0}

uint32_t	data_rate_ {1000000}

SPIComponent *	parent_ {nullptr}

GPIOPin *	cs_ {nullptr}

bool	release_device_ {false}

bool	write_only_ {false}

SPIDelegate *	delegate_ {SPIDelegate::NULL_DELEGATE}

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.

Detailed Description

The WeikaiComponentSPI class stores the information to the WeiKai component connected through an SPI bus.

Definition at line 36 of file weikai_spi.h.

Member Function Documentation

◆ dump_config()

void esphome::weikai_spi::WeikaiComponentSPI::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 175 of file weikai_spi.cpp.

◆ reg()

weikai::WeikaiRegister & esphome::weikai_spi::WeikaiComponentSPI::reg	(	uint8_t	reg,
		uint8_t	channel )

inlineoverridevirtual

Implements esphome::weikai::WeikaiComponent.

Definition at line 40 of file weikai_spi.h.

◆ setup()

void esphome::weikai_spi::WeikaiComponentSPI::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 157 of file weikai_spi.cpp.

Field Documentation

◆ reg_spi_

WeikaiRegisterSPI esphome::weikai_spi::WeikaiComponentSPI::reg_spi_ {this, 0, 0}

protected

init to this component

Definition at line 50 of file weikai_spi.h.

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

esphome/components/weikai_spi/weikai_spi.h
esphome/components/weikai_spi/weikai_spi.cpp

Public Member Functions

Protected Attributes