HWSPI Class Reference

#include <yspi.h>

Inheritance diagram for HWSPI:

Public Member Functions
	HWSPI (uint8_t SSpin, uint32_t clockF, uint8_t bitOrder, uint8_t dataMode)
virtual void	setSS (uint8_t highLow) const
virtual void	beginTransaction () const
virtual uint8_t	transfer (uint8_t data) const
virtual void	endTransaction () const

Protected Attributes
const uint8_t	SS
const SPISettings	settings

Constructor & Destructor Documentation

HWSPI::HWSPI	(	uint8_t	SSpin,
		uint32_t	clockF,
		uint8_t	bitOrder,
		uint8_t	dataMode
	)

Class constructor.

Parameters

SSpin	the Slave Select pin ID
clockF	the clock frequency to us
bitOrder	either MSBFIRST or LSBFIRST
dataMode	theSPI mode to use eg SPI_MODE0

Returns

an instance.

Member Function Documentation

void HWSPI::beginTransaction ( ) const

virtual

See also

virtual void YSPI::beginTransaction() const = 0;

Implements YSPI.

void HWSPI::endTransaction ( ) const

virtual

See also

virtual void YSPI::endTransaction() const = 0;

Implements YSPI.

void HWSPI::setSS ( uint8_t  highLow ) const

virtual

See also

virtual void YSPI::setSS(uint8_t highLow) const = 0;

Implements YSPI.

uint8_t HWSPI::transfer ( uint8_t  data ) const

virtual

See also

virtual uint8_t YSPI::transfer(uint8_t data) const = 0;

Implements YSPI.

Field Documentation

const SPISettings HWSPI::settings

protected

SPI Settings struct as per SPI library

const uint8_t HWSPI::SS

protected

Slave Select pin ID

---

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

• /home/bob/Desktop/temp/Yannick/PhD_Support/temp/SPI/RPI/Python/serialApp/SerialSlave2560/yspi.h
• /home/bob/Desktop/temp/Yannick/PhD_Support/temp/SPI/RPI/Python/serialApp/SerialSlave2560/hwSPI.cpp