Driver::SPI::Arduino::Master Class Reference

This class implements the SPI interface using the Arduino Framework. More...

Detailed Description

This class implements the SPI interface using the Arduino Framework.

Note: The Pin assignments for SCK, MOSI, MISO are set/determined by the Arduino framework when it creates the SPI, SPI1, SPI2, etc. instances.

#include <Master.h>

Inheritance diagram for Driver::SPI::Arduino::Master:

Collaboration diagram for Driver::SPI::Arduino::Master:

Classes
struct	SPIConfig_T
	SPI Settings (note: needed because the SPISettings class does not allow changing the baudrate once instantiated) More...

Public Member Functions
	Master (SPIClass &spiInstance, SPIConfig_T spiConfig)
	Constructor.
bool	start (size_t newBaudRateHz=0) noexcept
	See Driver::SPI::Master.
void	stop () noexcept
	See Driver::SPI::Master.
bool	transfer (size_t numBytes, const void *srcData, void *dstData=nullptr) noexcept
	See Driver::SPI::Master.
Public Member Functions inherited from Driver::SPI::Master
virtual	~Master ()
	Virtual destructor.

Protected Attributes
SPIClass &	m_spiDevice
	Handle the Arduino driver instance.
SPIConfig_T	m_spiConfig
	Handle the SPI configuration.
uint8_t	m_buf [OPTION_DRIVER_SPI_ARDUINO_OUTPUT_ONLY_BUF_SIZE]
	Temporary buffer need to performing transfer since the Arduino SPI interface uses a single buffer for writing/reading data.
bool	m_started
	Track my started state.

Constructor & Destructor Documentation

Master()

Driver::SPI::Arduino::Master::Master	(	SPIClass &	spiInstance,
		SPIConfig_T	spiConfig
	)

Constructor.

Member Function Documentation

start()

bool Driver::SPI::Arduino::Master::start ( size_t  newBaudRateHz = 0 )

virtualnoexcept

See Driver::SPI::Master.

Implements Driver::SPI::Master.

stop()

void Driver::SPI::Arduino::Master::stop ( )

virtualnoexcept

See Driver::SPI::Master.

Implements Driver::SPI::Master.

transfer()

bool Driver::SPI::Arduino::Master::transfer ( size_t  numBytes, const void *  srcData, void *  dstData = nullptr  )

virtualnoexcept

See Driver::SPI::Master.

Implements Driver::SPI::Master.

Member Data Documentation

m_buf

uint8_t Driver::SPI::Arduino::Master::m_buf[OPTION_DRIVER_SPI_ARDUINO_OUTPUT_ONLY_BUF_SIZE]

protected

Temporary buffer need to performing transfer since the Arduino SPI interface uses a single buffer for writing/reading data.

m_spiConfig

SPIConfig_T Driver::SPI::Arduino::Master::m_spiConfig

protected

Handle the SPI configuration.

m_spiDevice

SPIClass& Driver::SPI::Arduino::Master::m_spiDevice

protected

Handle the Arduino driver instance.

m_started

bool Driver::SPI::Arduino::Master::m_started

protected

Track my started state.

---

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

• Driver/SPI/Arduino/Master.h