EspSpi Class Reference

#include <esp32_spi.h>

Public Member Functions
	EspSpi (int8_t busId=-1, int8_t csPin=-1, int8_t dcPin=-1, int8_t clk=-1, int8_t mosi=-1, uint32_t frequency=8000000)
void	begin ()
void	end ()
void	start ()
void	stop ()
void	send (uint8_t data)
void	sendBuffer (const uint8_t *buffer, uint16_t size)
	Sends bytes to SSD1306 device. More...

Detailed Description

Class implements spi support for esp32 platform

Definition at line 39 of file esp32_spi.h.

Constructor & Destructor Documentation

EspSpi()

EspSpi::EspSpi ( int8_t  busId = -1, int8_t  csPin = -1, int8_t  dcPin = -1, int8_t  clk = -1, int8_t  mosi = -1, uint32_t  frequency = 8000000  )

explicit

Creates instance of spi implementation for ESP platform

Parameters

busId	number of SPI bus to use: HSPI_HOST, VSPI_HOST
csPin	pin number to use as chip select, can be -1
dcPin	pin to use as data command control pin
clk	pin to use as clock spi pin
mosi	pin to use as master output spi pin
frequency	frequency in HZ to run spi bus on

Member Function Documentation

begin()

void EspSpi::begin

(

)

Initializes spi interface

end()

void EspSpi::end

(

)

Closes spi interface

send()

void EspSpi::send

(

uint8_t

data

)

Sends byte to SSD1306 device

Parameters

data	- byte to send

sendBuffer()

void EspSpi::sendBuffer	(	const uint8_t *	buffer,
		uint16_t	size
	)

Sends bytes to SSD1306 device.

Sends bytes to SSD1306 device. This functions gives ~ 30% performance increase than ssd1306_intf.send.

Parameters

buffer	- bytes to send
size	- number of bytes to send

start()

void EspSpi::start

(

)

Starts communication with SSD1306 display.

stop()

void EspSpi::stop

(

)

Ends communication with SSD1306 display.

---

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

• src/lcd_hal/esp/esp32_spi.h