functions::DataFunction Class Reference

A DataFunction class wraps SPI communication over the digital bus. More...

#include <functions.h>

Inheritance diagram for functions::DataFunction:

Collaboration diagram for functions::DataFunction:

Public Member Functions
	DataFunction (bus::addr_t address, const SPISettings &spiSettings)
void	begin_communication () const
void	end_communication () const
Public Member Functions inherited from functions::Function
	Function (bus::addr_t address)

Public Attributes
const SPISettings &	spi_settings
Public Attributes inherited from functions::Function
const bus::addr_t	address

Protected Member Functions
void	transfer (const void *mosi_buf, void *miso_buf, size_t count) const
uint8_t	transfer8 (uint8_t data_in) const
uint16_t	transfer16 (uint16_t data_in) const
uint32_t	transfer32 (uint32_t data_in) const

Static Protected Member Functions
static SPIClass &	get_raw_spi ()

Detailed Description

A DataFunction class wraps SPI communication over the digital bus.

The communication is configured at constructor level, while the transfer functions basically decorate the Arduino/Teensyduino SPIClass access with hardware bus addressing.

Definition at line 47 of file functions.h.

Constructor & Destructor Documentation

DataFunction()

functions::DataFunction::DataFunction	(	bus::addr_t	address,
		const SPISettings &	spiSettings )

Definition at line 16 of file functions.cpp.

Member Function Documentation

begin_communication()

void functions::DataFunction::begin_communication

(

)

const

Definition at line 19 of file functions.cpp.

Referenced by MetadataMemory74LVC138AD::read_from_hardware().

end_communication()

void functions::DataFunction::end_communication

(

)

const

Definition at line 117 of file functions.cpp.

References bus::spi.

Referenced by MetadataMemory74LVC138AD::read_from_hardware().

get_raw_spi()

SPIClass & functions::DataFunction::get_raw_spi ( )

staticprotected

Definition at line 149 of file functions.cpp.

References bus::spi.

transfer()

void functions::DataFunction::transfer ( const void * mosi_buf, void * miso_buf, size_t count ) const

protected

Definition at line 122 of file functions.cpp.

References bus::spi.

Referenced by functions::SR74HCT595::transfer(), and functions::UMatrixFunction::transfer().

transfer16()

uint16_t functions::DataFunction::transfer16 ( uint16_t data_in ) const

protected

Definition at line 135 of file functions.cpp.

References bus::spi.

Referenced by functions::TMP127Q1::read_temperature(), and functions::SR74HCT595::transfer16().

transfer32()

uint32_t functions::DataFunction::transfer32 ( uint32_t data_in ) const

protected

Definition at line 142 of file functions.cpp.

References bus::spi.

Referenced by functions::SR74HCT595::transfer32().

transfer8()

uint8_t functions::DataFunction::transfer8 ( uint8_t data_in ) const

protected

Definition at line 128 of file functions.cpp.

References bus::spi.

Referenced by functions::SR74HC16X::read8(), functions::EEPROM25AA02::set_write_enable(), and functions::SR74HCT595::transfer8().

Member Data Documentation

spi_settings

const SPISettings& functions::DataFunction::spi_settings

Definition at line 52 of file functions.h.

---

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

• lib/hardware/src/bus/functions.h
• lib/hardware/src/bus/functions.cpp