Adafruit_SPIDevice Class Reference

#include <Adafruit_SPIDevice.h>

Public Member Functions
	Adafruit_SPIDevice (int8_t cspin, uint32_t freq=1000000, BusIOBitOrder dataOrder=SPI_BITORDER_MSBFIRST, uint8_t dataMode=SPI_MODE0, SPIClass *theSPI=&SPI)
	Create an SPI device with the given CS pin and settins.
	Adafruit_SPIDevice (int8_t cspin, int8_t sck, int8_t miso, int8_t mosi, uint32_t freq=1000000, BusIOBitOrder dataOrder=SPI_BITORDER_MSBFIRST, uint8_t dataMode=SPI_MODE0)
	Create an SPI device with the given CS pin and settins.
	~Adafruit_SPIDevice ()
	Release memory allocated in constructors.
bool	begin (void)
	Initializes SPI bus and sets CS pin high.
bool	read (uint8_t *buffer, size_t len, uint8_t sendvalue=0xFF)
bool	write (uint8_t *buffer, size_t len, uint8_t *prefix_buffer=NULL, size_t prefix_len=0)
bool	write_then_read (uint8_t *write_buffer, size_t write_len, uint8_t *read_buffer, size_t read_len, uint8_t sendvalue=0xFF)
uint8_t	transfer (uint8_t send)
void	transfer (uint8_t *buffer, size_t len)
	Transfer (send/receive) one byte over hard/soft SPI.
void	beginTransaction (void)
void	endTransaction (void)

Private Attributes
SPIClass *	_spi
SPISettings *	_spiSetting
uint32_t	_freq
BusIOBitOrder	_dataOrder
uint8_t	_dataMode
int8_t	_cs
int8_t	_sck
int8_t	_mosi
int8_t	_miso
BusIO_PortReg *	mosiPort
BusIO_PortReg *	clkPort
BusIO_PortReg *	misoPort
BusIO_PortReg *	csPort
BusIO_PortMask	mosiPinMask
BusIO_PortMask	misoPinMask
BusIO_PortMask	clkPinMask
BusIO_PortMask	csPinMask
bool	_begun

Detailed Description

! The class which defines how we will talk to this device over SPI

Constructor & Destructor Documentation

Adafruit_SPIDevice() [1/2]

Adafruit_SPIDevice::Adafruit_SPIDevice	(	int8_t	cspin,
		uint32_t	freq = 1000000,
		BusIOBitOrder	dataOrder = SPI_BITORDER_MSBFIRST,
		uint8_t	dataMode = SPI_MODE0,
		SPIClass *	theSPI = &SPI )

Create an SPI device with the given CS pin and settins.

Parameters

cspin	The arduino pin number to use for chip select
freq	The SPI clock frequency to use, defaults to 1MHz
dataOrder	The SPI data order to use for bits within each byte, defaults to SPI_BITORDER_MSBFIRST
dataMode	The SPI mode to use, defaults to SPI_MODE0
theSPI	The SPI bus to use, defaults to &theSPI

Adafruit_SPIDevice() [2/2]

Adafruit_SPIDevice::Adafruit_SPIDevice	(	int8_t	cspin,
		int8_t	sckpin,
		int8_t	misopin,
		int8_t	mosipin,
		uint32_t	freq = 1000000,
		BusIOBitOrder	dataOrder = SPI_BITORDER_MSBFIRST,
		uint8_t	dataMode = SPI_MODE0 )

Create an SPI device with the given CS pin and settins.

Parameters

cspin	The arduino pin number to use for chip select
sckpin	The arduino pin number to use for SCK
misopin	The arduino pin number to use for MISO, set to -1 if not used
mosipin	The arduino pin number to use for MOSI, set to -1 if not used
freq	The SPI clock frequency to use, defaults to 1MHz
dataOrder	The SPI data order to use for bits within each byte, defaults to SPI_BITORDER_MSBFIRST
dataMode	The SPI mode to use, defaults to SPI_MODE0

~Adafruit_SPIDevice()

Adafruit_SPIDevice::~Adafruit_SPIDevice

(

)

Release memory allocated in constructors.

Member Function Documentation

begin()

bool Adafruit_SPIDevice::begin

(

void

)

Initializes SPI bus and sets CS pin high.

Returns

Always returns true because there's no way to test success of SPI init

beginTransaction()

void Adafruit_SPIDevice::beginTransaction

(

void

)

endTransaction()

void Adafruit_SPIDevice::endTransaction

(

void

)

read()

bool Adafruit_SPIDevice::read	(	uint8_t *	buffer,
		size_t	len,
		uint8_t	sendvalue = 0xFF )

transfer() [1/2]

void Adafruit_SPIDevice::transfer	(	uint8_t *	buffer,
		size_t	len )

Transfer (send/receive) one byte over hard/soft SPI.

Parameters

buffer	The buffer to send and receive at the same time
len	The number of bytes to transfer

Transfer (send/receive) one byte over hard/soft SPI

Parameters

send	The byte to send

Returns

The byte received while transmitting

Manually begin a transaction (calls beginTransaction if hardware SPI)

Manually end a transaction (calls endTransaction if hardware SPI)

Write a buffer or two to the SPI device.

Parameters

buffer	Pointer to buffer of data to write
len	Number of bytes from buffer to write
prefix_buffer	Pointer to optional array of data to write before buffer.
prefix_len	Number of bytes from prefix buffer to write

Returns

Always returns true because there's no way to test success of SPI writes

Read from SPI into a buffer from the SPI device.

Parameters

buffer	Pointer to buffer of data to read into
len	Number of bytes from buffer to read.
sendvalue	The 8-bits of data to write when doing the data read, defaults to 0xFF

Returns

Always returns true because there's no way to test success of SPI writes

Write some data, then read some data from SPI into another buffer. The buffers can point to same/overlapping locations. This does not transmit-receive at the same time!

Parameters

write_buffer	Pointer to buffer of data to write from
write_len	Number of bytes from buffer to write.
read_buffer	Pointer to buffer of data to read into.
read_len	Number of bytes from buffer to read.
sendvalue	The 8-bits of data to write when doing the data read, defaults to 0xFF

Returns

Always returns true because there's no way to test success of SPI writes

transfer() [2/2]

uint8_t Adafruit_SPIDevice::transfer

(

uint8_t

send

)

write()

bool Adafruit_SPIDevice::write	(	uint8_t *	buffer,
		size_t	len,
		uint8_t *	prefix_buffer = NULL,
		size_t	prefix_len = 0 )

write_then_read()

bool Adafruit_SPIDevice::write_then_read	(	uint8_t *	write_buffer,
		size_t	write_len,
		uint8_t *	read_buffer,
		size_t	read_len,
		uint8_t	sendvalue = 0xFF )

Member Data Documentation

_begun

bool Adafruit_SPIDevice::_begun

private

_cs

int8_t Adafruit_SPIDevice::_cs

private

_dataMode

uint8_t Adafruit_SPIDevice::_dataMode

private

_dataOrder

BusIOBitOrder Adafruit_SPIDevice::_dataOrder

private

_freq

uint32_t Adafruit_SPIDevice::_freq

private

_miso

int8_t Adafruit_SPIDevice::_miso

private

_mosi

int8_t Adafruit_SPIDevice::_mosi

private

_sck

int8_t Adafruit_SPIDevice::_sck

private

_spi

SPIClass* Adafruit_SPIDevice::_spi

private

_spiSetting

SPISettings* Adafruit_SPIDevice::_spiSetting

private

clkPinMask

BusIO_PortMask Adafruit_SPIDevice::clkPinMask

private

clkPort

BusIO_PortReg * Adafruit_SPIDevice::clkPort

private

csPinMask

BusIO_PortMask Adafruit_SPIDevice::csPinMask

private

csPort

BusIO_PortReg * Adafruit_SPIDevice::csPort

private

misoPinMask

BusIO_PortMask Adafruit_SPIDevice::misoPinMask

private

misoPort

BusIO_PortReg * Adafruit_SPIDevice::misoPort

private

mosiPinMask

BusIO_PortMask Adafruit_SPIDevice::mosiPinMask

private

mosiPort

BusIO_PortReg* Adafruit_SPIDevice::mosiPort

private

---

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

• Adafruit_SPIDevice.h
• Adafruit_SPIDevice.cpp