sfTkArdSPI.h

Go to the documentation of this file.

 
#pragma once
 
#include "sfTkArduino.h"
#include <SPI.h>
#include <sfTk/sfTkISPI.h>
 
class sfTkArdSPI : public sfTkISPI
{
  public:
    sfTkArdSPI(void) : _spiPort(nullptr)
    {
    }
 
    sfTkArdSPI(uint8_t csPin) : sfTkISPI(csPin)
    {
    }
    sfTkArdSPI(sfTkArdSPI const &rhs) : sfTkISPI(), _spiPort{rhs._spiPort}, _sfeSPISettings{rhs._sfeSPISettings}
    {
    }
 
    sfTkArdSPI &operator=(const sfTkArdSPI &rhs)
    {
        _spiPort = rhs._spiPort;
        _sfeSPISettings = rhs._sfeSPISettings;
        return *this;
    }
 
    sfTkError_t init(bool bInit = false);
 
    sfTkError_t init(uint8_t csPin, bool bInit = false);
 
    sfTkError_t init(SPIClass &spiPort, SPISettings &busSPISettings, uint8_t csPin, bool bInit = false);
 
    sfTkError_t writeRegion(const uint8_t *data, size_t length);
 
    sfTkError_t writeRegister(uint8_t *devReg, size_t regLength, const uint8_t *data, size_t length);
 
    sfTkError_t writeRegister(uint16_t devReg, const uint8_t *data, size_t length);
 
    sfTkError_t writeRegister(uint16_t devReg, const uint16_t *data, size_t length);
 
    sfTkError_t readRegister(uint8_t *devReg, size_t regLength, uint8_t *data, size_t numBytes, size_t &readBytes,
                             uint32_t read_delay = 0);
 
    virtual sfTkError_t readRegister(uint16_t reg, uint8_t *data, size_t numBytes, size_t &readBytes);
 
    virtual sfTkError_t readRegister(uint16_t reg, uint16_t *data, size_t length, size_t &readWords);
 
    // For overloaded virtual methods, make sure to elevate our subclass methods.
    using sfTkIBus::readRegister;
    using sfTkIBus::writeRegister;
 
  protected:
    // note: The instance data is protected, allowing access if a sub-class is
    //      created to implement a special read/write routine
    //
    SPIClass *_spiPort;
 
    SPISettings _sfeSPISettings;
};