Contain general payload transfer API for an SPI device. More...
#include <fastarduino/spi.h>
Protected Member Functions | |
| AbstractSPIDevice (const AbstractSPIDevice &)=delete | |
| AbstractSPIDevice & | operator= (const AbstractSPIDevice &)=delete |
| uint8_t | transfer (uint8_t data) |
| Transfer one byte to the currently selected SPI slave device through MOSI pin, and get the byte returned by the device through MISO pin. More... | |
| void | transfer (uint8_t *data, uint16_t size) |
| Transfer an array of payload data to the currently selected SPI slave device through MOSI pin, and get all data bytes simultaneously received from that device through MISO pin. More... | |
| void | transfer (const uint8_t *data, uint16_t size) |
| Transfer an array of payload data to the currently selected SPI slave device through MOSI pin; any data bytes simultaneously received from that device through MISO pin are lost. More... | |
| void | transfer (uint8_t *data, uint16_t size, uint8_t sent) |
Transfer the provided byte sent several times to the currently selected SPI slave device through MOSI pin, and get all data bytes simultaneously received from that device through MISO pin. More... | |
| void | transfer (uint16_t size, uint8_t sent) |
Transfer the provided byte sent several times to the currently selected SPI slave device through MOSI pin; any data bytes simultaneously received from that device through MISO pin are lost. More... | |
Detailed Description
Contain general payload transfer API for an SPI device.
This is not supposed to be used directly, as it does not include start/end transfer methods. SPI device implementers shall use SPIDevice template class instead.
- See also
- SPIDevice
Member Function Documentation
◆ transfer() [1/5]
|
inlineprotected |
Transfer one byte to the currently selected SPI slave device through MOSI pin, and get the byte returned by the device through MISO pin.
- Parameters
-
data the byte to transmit to slave device
- Returns
- the byte received from slave device
◆ transfer() [2/5]
|
inlineprotected |
Transfer an array of payload data to the currently selected SPI slave device through MOSI pin, and get all data bytes simultaneously received from that device through MISO pin.
- Parameters
-
data pointer to the payload to transmit; is also the placeholder for payload simultaneously returned by the slave. size the payload size
◆ transfer() [3/5]
|
inlineprotected |
Transfer an array of payload data to the currently selected SPI slave device through MOSI pin; any data bytes simultaneously received from that device through MISO pin are lost.
- Parameters
-
data pointer to the payload to transmit size the payload size
◆ transfer() [4/5]
|
inlineprotected |
Transfer the provided byte sent several times to the currently selected SPI slave device through MOSI pin, and get all data bytes simultaneously received from that device through MISO pin.
This method is useful when you have requested information from the slave device and then you must always send the same byte to receive all requested information: with this method, you do not need to initialize data with sent size times.
- Parameters
-
data placeholder for the payload returned by the slave whilst transmitting sizetimes thesentbytesize the number of times to transmit sentbyte to the SPI slavesent the data byte to transmit several times
◆ transfer() [5/5]
|
inlineprotected |
Transfer the provided byte sent several times to the currently selected SPI slave device through MOSI pin; any data bytes simultaneously received from that device through MISO pin are lost.
- Parameters
-
size the number of times to transmit sentbyte to the SPI slavesent the data byte to transmit several times
The documentation for this class was generated from the following file:
- fastarduino/spi.h
