#include <spi.h>

Inheritance diagram for esphome::spi::SPIComponent:

Public Member Functions
SPIDelegate *	register_device (SPIClient device, SPIMode mode, SPIBitOrder bit_order, uint32_t data_rate, GPIOPin cs_pin)

void	unregister_device (SPIClient *device)

void	set_clk (GPIOPin *clk)

void	set_miso (GPIOPin *sdi)

void	set_mosi (GPIOPin *sdo)

void	set_data_pins (std::vector< uint8_t > pins)

void	set_interface (SPIInterface interface)

void	set_interface_name (const char *name)

float	get_setup_priority () const override

void	setup () override

void	dump_config () override

size_t	get_bus_width () const

Public Member Functions inherited from esphome::Component
virtual void	loop ()
	This method will be called repeatedly.

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

uint32_t	get_component_state () const

virtual void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const char *message)

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.

const char *	get_component_source () const
	Get the integration where this component was declared as a string.

bool	should_warn_of_blocking (uint32_t blocking_time)

Static Protected Member Functions
static SPIBus *	get_bus (SPIInterface interface, GPIOPin clk, GPIOPin sdo, GPIOPin *sdi, const std::vector< uint8_t > &data_pins)

Protected Attributes
GPIOPin *	clk_pin_ {nullptr}

GPIOPin *	sdi_pin_ {nullptr}

GPIOPin *	sdo_pin_ {nullptr}

std::vector< uint8_t >	data_pins_ {}

SPIInterface	interface_ {}

bool	using_hw_ {false}

const char *	interface_name_ {nullptr}

SPIBus *	spi_bus_ {}

std::map< SPIClient , SPIDelegate >	devices_

Protected Attributes inherited from esphome::Component
uint32_t	component_state_ {0x0000}
	State of this component.

float	setup_priority_override_ {NAN}

const char *	component_source_ {nullptr}

uint32_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}

std::string	error_message_ {}

Additional Inherited Members
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.

void	set_interval (uint32_t interval, std::function< void()> &&f)

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

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

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

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

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

Definition at line 334 of file spi.h.

Member Function Documentation

◆ dump_config()

void esphome::spi::SPIComponent::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 67 of file spi.cpp.

◆ get_bus()

SPIBus * esphome::spi::SPIComponent::get_bus	(	SPIInterface	interface,
		GPIOPin *	clk,
		GPIOPin *	sdo,
		GPIOPin *	sdi,
		const std::vector< uint8_t > &	data_pins )

staticprotected

Definition at line 88 of file spi_arduino.cpp.

◆ get_bus_width()

size_t esphome::spi::SPIComponent::get_bus_width ( ) const

inline

Definition at line 358 of file spi.h.

◆ get_setup_priority()

float esphome::spi::SPIComponent::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 354 of file spi.h.

◆ register_device()

SPIDelegate * esphome::spi::SPIComponent::register_device	(	SPIClient *	device,
		SPIMode	mode,
		SPIBitOrder	bit_order,
		uint32_t	data_rate,
		GPIOPin *	cs_pin )

Definition at line 18 of file spi.cpp.

◆ set_clk()

void esphome::spi::SPIComponent::set_clk ( GPIOPin * clk )

inline

Definition at line 340 of file spi.h.

◆ set_data_pins()

void esphome::spi::SPIComponent::set_data_pins ( std::vector< uint8_t > pins )

inline

Definition at line 345 of file spi.h.

◆ set_interface()

void esphome::spi::SPIComponent::set_interface ( SPIInterface interface )

inline

Definition at line 347 of file spi.h.

◆ set_interface_name()

void esphome::spi::SPIComponent::set_interface_name ( const char * name )

inline

Definition at line 352 of file spi.h.

◆ set_miso()

void esphome::spi::SPIComponent::set_miso ( GPIOPin * sdi )

inline

Definition at line 342 of file spi.h.

◆ set_mosi()

void esphome::spi::SPIComponent::set_mosi ( GPIOPin * sdo )

inline

Definition at line 344 of file spi.h.

◆ setup()

void esphome::spi::SPIComponent::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 38 of file spi.cpp.

◆ unregister_device()

void esphome::spi::SPIComponent::unregister_device ( SPIClient * device )

Definition at line 29 of file spi.cpp.

Field Documentation

◆ clk_pin_

GPIOPin* esphome::spi::SPIComponent::clk_pin_ {nullptr}

protected

Definition at line 366 of file spi.h.

◆ data_pins_

std::vector<uint8_t> esphome::spi::SPIComponent::data_pins_ {}

protected

Definition at line 369 of file spi.h.

◆ devices_

std::map<SPIClient *, SPIDelegate *> esphome::spi::SPIComponent::devices_

protected

Definition at line 375 of file spi.h.

◆ interface_

SPIInterface esphome::spi::SPIComponent::interface_ {}

protected

Definition at line 371 of file spi.h.

◆ interface_name_

const char* esphome::spi::SPIComponent::interface_name_ {nullptr}

protected

Definition at line 373 of file spi.h.

◆ sdi_pin_

GPIOPin* esphome::spi::SPIComponent::sdi_pin_ {nullptr}

protected

Definition at line 367 of file spi.h.

◆ sdo_pin_

GPIOPin* esphome::spi::SPIComponent::sdo_pin_ {nullptr}

protected

Definition at line 368 of file spi.h.

◆ spi_bus_

SPIBus* esphome::spi::SPIComponent::spi_bus_ {}

protected

Definition at line 374 of file spi.h.

◆ using_hw_

bool esphome::spi::SPIComponent::using_hw_ {false}

protected

Definition at line 372 of file spi.h.

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

esphome/components/spi/spi.h
esphome/components/spi/spi.cpp
esphome/components/spi/spi_arduino.cpp
esphome/components/spi/spi_esp_idf.cpp

Public Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ dump_config()

◆ get_bus()

◆ get_bus_width()

◆ get_setup_priority()

◆ register_device()

◆ set_clk()

◆ set_data_pins()

◆ set_interface()

◆ set_interface_name()

◆ set_miso()

◆ set_mosi()

◆ setup()

◆ unregister_device()

Field Documentation

◆ clk_pin_

◆ data_pins_

◆ devices_

◆ interface_

◆ interface_name_

◆ sdi_pin_

◆ sdo_pin_

◆ spi_bus_

◆ using_hw_