The SPIDevice is what components using the SPI will create. More...

#include <spi.h>

Inheritance diagram for esphome::spi::SPIDevice< BIT_ORDER, CLOCK_POLARITY, CLOCK_PHASE, DATA_RATE >:

Public Member Functions
	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.

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)

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

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

template<size_t N>
void	transfer_array (std::array< uint8_t, N > &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)

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

Detailed Description

template<SPIBitOrder BIT_ORDER, SPIClockPolarity CLOCK_POLARITY, SPIClockPhase CLOCK_PHASE, SPIDataRate DATA_RATE>
class esphome::spi::SPIDevice< BIT_ORDER, CLOCK_POLARITY, CLOCK_PHASE, DATA_RATE >

The SPIDevice is what components using the SPI will create.

Template Parameters

BIT_ORDER
CLOCK_POLARITY
CLOCK_PHASE
DATA_RATE

Definition at line 427 of file spi.h.

Constructor & Destructor Documentation

◆ SPIDevice() [1/2]

template<SPIBitOrder BIT_ORDER, SPIClockPolarity CLOCK_POLARITY, SPIClockPhase CLOCK_PHASE, SPIDataRate DATA_RATE>

esphome::spi::SPIDevice< BIT_ORDER, CLOCK_POLARITY, CLOCK_PHASE, DATA_RATE >::SPIDevice ( )

inline

Definition at line 429 of file spi.h.

◆ SPIDevice() [2/2]

template<SPIBitOrder BIT_ORDER, SPIClockPolarity CLOCK_POLARITY, SPIClockPhase CLOCK_PHASE, SPIDataRate DATA_RATE>

esphome::spi::SPIDevice< BIT_ORDER, CLOCK_POLARITY, CLOCK_PHASE, DATA_RATE >::SPIDevice	(	SPIComponent *	parent,
		GPIOPin *	cs_pin )

inline

Definition at line 431 of file spi.h.

Member Function Documentation

◆ disable()

template<SPIBitOrder BIT_ORDER, SPIClockPolarity CLOCK_POLARITY, SPIClockPhase CLOCK_PHASE, SPIDataRate DATA_RATE>

void esphome::spi::SPIDevice< BIT_ORDER, CLOCK_POLARITY, CLOCK_PHASE, DATA_RATE >::disable ( )

inline

Definition at line 501 of file spi.h.

◆ enable()

template<SPIBitOrder BIT_ORDER, SPIClockPolarity CLOCK_POLARITY, SPIClockPhase CLOCK_PHASE, SPIDataRate DATA_RATE>

void esphome::spi::SPIDevice< BIT_ORDER, CLOCK_POLARITY, CLOCK_PHASE, DATA_RATE >::enable ( )

inline

Definition at line 499 of file spi.h.

◆ read_array()

template<SPIBitOrder BIT_ORDER, SPIClockPolarity CLOCK_POLARITY, SPIClockPhase CLOCK_PHASE, SPIDataRate DATA_RATE>

void esphome::spi::SPIDevice< BIT_ORDER, CLOCK_POLARITY, CLOCK_PHASE, DATA_RATE >::read_array	(	uint8_t *	data,
		size_t	length )

inline

Definition at line 452 of file spi.h.

◆ read_byte()

template<SPIBitOrder BIT_ORDER, SPIClockPolarity CLOCK_POLARITY, SPIClockPhase CLOCK_PHASE, SPIDataRate DATA_RATE>

uint8_t esphome::spi::SPIDevice< BIT_ORDER, CLOCK_POLARITY, CLOCK_PHASE, DATA_RATE >::read_byte ( )

inline

Definition at line 450 of file spi.h.

◆ set_bit_order()

template<SPIBitOrder BIT_ORDER, SPIClockPolarity CLOCK_POLARITY, SPIClockPhase CLOCK_PHASE, SPIDataRate DATA_RATE>

void esphome::spi::SPIDevice< BIT_ORDER, CLOCK_POLARITY, CLOCK_PHASE, DATA_RATE >::set_bit_order ( SPIBitOrder order )

inline

Definition at line 446 of file spi.h.

◆ set_cs_pin()

template<SPIBitOrder BIT_ORDER, SPIClockPolarity CLOCK_POLARITY, SPIClockPhase CLOCK_PHASE, SPIDataRate DATA_RATE>

void esphome::spi::SPIDevice< BIT_ORDER, CLOCK_POLARITY, CLOCK_PHASE, DATA_RATE >::set_cs_pin ( GPIOPin * cs )

inline

Definition at line 442 of file spi.h.

◆ set_data_rate()

template<SPIBitOrder BIT_ORDER, SPIClockPolarity CLOCK_POLARITY, SPIClockPhase CLOCK_PHASE, SPIDataRate DATA_RATE>

void esphome::spi::SPIDevice< BIT_ORDER, CLOCK_POLARITY, CLOCK_PHASE, DATA_RATE >::set_data_rate ( uint32_t data_rate )

inline

Definition at line 444 of file spi.h.

◆ set_mode()

template<SPIBitOrder BIT_ORDER, SPIClockPolarity CLOCK_POLARITY, SPIClockPhase CLOCK_PHASE, SPIDataRate DATA_RATE>

void esphome::spi::SPIDevice< BIT_ORDER, CLOCK_POLARITY, CLOCK_PHASE, DATA_RATE >::set_mode ( SPIMode mode )

inline

Definition at line 448 of file spi.h.

◆ set_spi_parent()

template<SPIBitOrder BIT_ORDER, SPIClockPolarity CLOCK_POLARITY, SPIClockPhase CLOCK_PHASE, SPIDataRate DATA_RATE>

void esphome::spi::SPIDevice< BIT_ORDER, CLOCK_POLARITY, CLOCK_PHASE, DATA_RATE >::set_spi_parent ( SPIComponent * parent )

inline

Definition at line 440 of file spi.h.

◆ spi_setup()

template<SPIBitOrder BIT_ORDER, SPIClockPolarity CLOCK_POLARITY, SPIClockPhase CLOCK_PHASE, SPIDataRate DATA_RATE>

void esphome::spi::SPIDevice< BIT_ORDER, CLOCK_POLARITY, CLOCK_PHASE, DATA_RATE >::spi_setup ( )

inlineoverridevirtual

Reimplemented from esphome::spi::SPIClient.

Definition at line 436 of file spi.h.

◆ spi_teardown()

template<SPIBitOrder BIT_ORDER, SPIClockPolarity CLOCK_POLARITY, SPIClockPhase CLOCK_PHASE, SPIDataRate DATA_RATE>

void esphome::spi::SPIDevice< BIT_ORDER, CLOCK_POLARITY, CLOCK_PHASE, DATA_RATE >::spi_teardown ( )

inlineoverridevirtual

Reimplemented from esphome::spi::SPIClient.

Definition at line 438 of file spi.h.

◆ transfer_array() [1/2]

template<SPIBitOrder BIT_ORDER, SPIClockPolarity CLOCK_POLARITY, SPIClockPhase CLOCK_PHASE, SPIDataRate DATA_RATE>

template<size_t N>

void esphome::spi::SPIDevice< BIT_ORDER, CLOCK_POLARITY, CLOCK_PHASE, DATA_RATE >::transfer_array ( std::array< uint8_t, N > & data )

inline

Definition at line 509 of file spi.h.

◆ transfer_array() [2/2]

template<SPIBitOrder BIT_ORDER, SPIClockPolarity CLOCK_POLARITY, SPIClockPhase CLOCK_PHASE, SPIDataRate DATA_RATE>

void esphome::spi::SPIDevice< BIT_ORDER, CLOCK_POLARITY, CLOCK_PHASE, DATA_RATE >::transfer_array	(	uint8_t *	data,
		size_t	length )

inline

Write the array data, replace with received data.

Parameters

data
length

Definition at line 483 of file spi.h.

◆ transfer_byte()

template<SPIBitOrder BIT_ORDER, SPIClockPolarity CLOCK_POLARITY, SPIClockPhase CLOCK_PHASE, SPIDataRate DATA_RATE>

uint8_t esphome::spi::SPIDevice< BIT_ORDER, CLOCK_POLARITY, CLOCK_PHASE, DATA_RATE >::transfer_byte ( uint8_t data )

inline

Definition at line 485 of file spi.h.

◆ write()

template<SPIBitOrder BIT_ORDER, SPIClockPolarity CLOCK_POLARITY, SPIClockPhase CLOCK_PHASE, SPIDataRate DATA_RATE>

void esphome::spi::SPIDevice< BIT_ORDER, CLOCK_POLARITY, CLOCK_PHASE, DATA_RATE >::write	(	uint16_t	data,
		size_t	num_bits )

inline

Write a single data item, up to 32 bits.

Parameters

data	The data
num_bits	The number of bits to write. The lower num_bits of data will be sent.

Definition at line 459 of file spi.h.

◆ write_array() [1/3]

template<SPIBitOrder BIT_ORDER, SPIClockPolarity CLOCK_POLARITY, SPIClockPhase CLOCK_PHASE, SPIDataRate DATA_RATE>

template<size_t N>

void esphome::spi::SPIDevice< BIT_ORDER, CLOCK_POLARITY, CLOCK_PHASE, DATA_RATE >::write_array ( const std::array< uint8_t, N > & data )

inline

Definition at line 505 of file spi.h.

◆ write_array() [2/3]

template<SPIBitOrder BIT_ORDER, SPIClockPolarity CLOCK_POLARITY, SPIClockPhase CLOCK_PHASE, SPIDataRate DATA_RATE>

void esphome::spi::SPIDevice< BIT_ORDER, CLOCK_POLARITY, CLOCK_PHASE, DATA_RATE >::write_array ( const std::vector< uint8_t > & data )

inline

Definition at line 507 of file spi.h.

◆ write_array() [3/3]

template<SPIBitOrder BIT_ORDER, SPIClockPolarity CLOCK_POLARITY, SPIClockPhase CLOCK_PHASE, SPIDataRate DATA_RATE>

void esphome::spi::SPIDevice< BIT_ORDER, CLOCK_POLARITY, CLOCK_PHASE, DATA_RATE >::write_array	(	const uint8_t *	data,
		size_t	length )

inline

Definition at line 503 of file spi.h.

◆ write_array16()

template<SPIBitOrder BIT_ORDER, SPIClockPolarity CLOCK_POLARITY, SPIClockPhase CLOCK_PHASE, SPIDataRate DATA_RATE>

void esphome::spi::SPIDevice< BIT_ORDER, CLOCK_POLARITY, CLOCK_PHASE, DATA_RATE >::write_array16	(	const uint16_t *	data,
		size_t	length )

inline

Write an array of data as 16 bit values, byte-swapping if required.

Use of this should be avoided as it is horribly slow.

Parameters

data
length

Definition at line 497 of file spi.h.

◆ write_byte()

template<SPIBitOrder BIT_ORDER, SPIClockPolarity CLOCK_POLARITY, SPIClockPhase CLOCK_PHASE, SPIDataRate DATA_RATE>

void esphome::spi::SPIDevice< BIT_ORDER, CLOCK_POLARITY, CLOCK_PHASE, DATA_RATE >::write_byte ( uint8_t data )

inline

Definition at line 476 of file spi.h.

◆ write_byte16()

template<SPIBitOrder BIT_ORDER, SPIClockPolarity CLOCK_POLARITY, SPIClockPhase CLOCK_PHASE, SPIDataRate DATA_RATE>

void esphome::spi::SPIDevice< BIT_ORDER, CLOCK_POLARITY, CLOCK_PHASE, DATA_RATE >::write_byte16 ( uint16_t data )

inline

Write 16 bit data.

The driver will byte-swap if required.

Definition at line 489 of file spi.h.

◆ write_cmd_addr_data()

template<SPIBitOrder BIT_ORDER, SPIClockPolarity CLOCK_POLARITY, SPIClockPhase CLOCK_PHASE, SPIDataRate DATA_RATE>

void esphome::spi::SPIDevice< BIT_ORDER, CLOCK_POLARITY, CLOCK_PHASE, DATA_RATE >::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 )

inline

Definition at line 471 of file spi.h.

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

esphome/components/spi/spi.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SPIDevice() [1/2]

◆ SPIDevice() [2/2]

Member Function Documentation

◆ disable()

◆ enable()

◆ read_array()

◆ read_byte()

◆ set_bit_order()

◆ set_cs_pin()

◆ set_data_rate()

◆ set_mode()

◆ set_spi_parent()

◆ spi_setup()

◆ spi_teardown()

◆ transfer_array() [1/2]

◆ transfer_array() [2/2]

◆ transfer_byte()

◆ write()

◆ write_array() [1/3]

◆ write_array() [2/3]

◆ write_array() [3/3]

◆ write_array16()

◆ write_byte()

◆ write_byte16()

◆ write_cmd_addr_data()