sfTkArdI2C.h

Go to the documentation of this file.

 
#pragma once
 
#include <Arduino.h>
#include <Wire.h>
 
// Include our platform I2C interface definition.
#include "sfTkArduino.h"
#include <sfTk/sfTkII2C.h>
 
class sfTkArdI2C : public sfTkII2C
{
  public:
    sfTkArdI2C(void) : _i2cPort(nullptr), _bufferChunkSize{kDefaultBufferChunk}
    {
    }
    sfTkArdI2C(uint8_t addr) : sfTkII2C(addr)
    {
    }
 
    sfTkArdI2C(sfTkArdI2C const &rhs) : sfTkII2C(), _i2cPort{rhs._i2cPort}
    {
    }
 
    sfTkArdI2C &operator=(const sfTkArdI2C &rhs)
    {
        _i2cPort = rhs._i2cPort;
        return *this;
    }
 
    sfTkError_t init();
 
    sfTkError_t init(uint8_t addr);
 
    sfTkError_t init(TwoWire &wirePort, uint8_t addr, bool bInit = false);
 
    sfTkError_t ping();
 
    sfTkError_t writeRegister(uint8_t *devReg, size_t regLength, const uint8_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);
    // Buffer size chunk getter/setter
    void setBufferChunkSize(size_t theChunk)
    {
        if (theChunk > 0)
            _bufferChunkSize = theChunk;
    }
 
    size_t bufferChunkSize(void)
    {
        return _bufferChunkSize;
    }
 
    // For overloaded virtual methods, make sure our subclass methods appear on this object
    using sfTkIBus::readRegister;
    using sfTkIBus::writeRegister;
 
  protected:
    // note: The wire port is protected, allowing access if a sub-class is
    //      created to implement a special read/write routine
    //
    TwoWire *_i2cPort;
 
  private:
    static constexpr size_t kDefaultBufferChunk = 32;
 
    size_t _bufferChunkSize;
};