sfTkISerial.h

Go to the documentation of this file.

 
#pragma once
 
// clang-format off
#include "sfTkError.h"
// clang-format on
 
const sfTkError_t ksfTkErrBaseSerial = 0x2000;
 
const sfTkError_t ksfTkErrSerialNotInit = ksfTkErrFail * (ksfTkErrBaseSerial + 1);
 
const sfTkError_t ksfTkErrSerialTimeout = ksfTkErrFail * (ksfTkErrBaseSerial + 2);
 
const sfTkError_t ksfTkErrSerialNoResponse = ksfTkErrFail * (ksfTkErrBaseSerial + 3);
 
const sfTkError_t ksfTkErrSerialDataTooLong = ksfTkErrFail * (ksfTkErrBaseSerial + 4);
 
const sfTkError_t ksfTkErrSerialNullSettings = ksfTkErrFail * (ksfTkErrBaseSerial + 5);
 
const sfTkError_t ksfTkErrSerialNullBuffer = ksfTkErrFail * (ksfTkErrBaseSerial + 6);
 
const sfTkError_t ksfTkErrSerialUnderRead = ksfTkErrBaseSerial + 7;
 
class sfTkISerial
{
  public:
    sfTkISerial() = default;
    virtual ~sfTkISerial() = default;
 
    virtual sfTkError_t write(const uint8_t *data, size_t length) = 0;
 
    virtual sfTkError_t write(const uint8_t data)
    {
        return write(&data, sizeof(data));
    }
 
    virtual sfTkError_t read(uint8_t *data, size_t length, size_t &readBytes) = 0;
 
    virtual sfTkError_t read(uint8_t &data)
    {
        size_t nRead;
 
        return read(&data, sizeof(data), nRead);
    }
};