sfTkISerial Class Reference

#include <sfTkISerial.h>

Public Member Functions
	sfTkISerial ()=default
virtual	~sfTkISerial ()=default
virtual sfTkError_t	write (const uint8_t *data, size_t length)=0
	Writes an array of bytes to the serial interface. More...
virtual sfTkError_t	write (const uint8_t data)
	Writes a single byte to the serial interface. More...
virtual sfTkError_t	read (uint8_t *data, size_t length, size_t &readBytes)=0
	Reads an array of bytes from the serial interface. More...
virtual sfTkError_t	read (uint8_t &data)
	Read a single byte from the serial interface. More...

Constructor & Destructor Documentation

sfTkISerial()

sfTkISerial::sfTkISerial ( )

default

~sfTkISerial()

virtual sfTkISerial::~sfTkISerial ( )

virtualdefault

Member Function Documentation

read() [1/2]

virtual sfTkError_t sfTkISerial::read ( uint8_t &  data )

inlinevirtual

Read a single byte from the serial interface.

Parameters

data	Byte to be read

Returns

sfTkError_t Returns ksfTkErrOk on success, or ksfTkErrFail code

read() [2/2]

virtual sfTkError_t sfTkISerial::read ( uint8_t *  data, size_t  length, size_t &  readBytes  )

pure virtual

Reads an array of bytes from the serial interface.

Parameters

data	The data buffer to read into
length	The length of the data buffer
readBytes[out]	The number of bytes read

Returns

sfTkError_t Returns ksfTkErrOk on success, or ksfTkErrFail code

write() [1/2]

virtual sfTkError_t sfTkISerial::write ( const uint8_t *  data, size_t  length  )

pure virtual

Writes an array of bytes to the serial interface.

Parameters

data	The data to write
length	The length of the data buffer

Returns

sfTkError_t Returns ksfTkErrOk on success, or ksfTkErrFail code

write() [2/2]

virtual sfTkError_t sfTkISerial::write ( const uint8_t  data )

inlinevirtual

Writes a single byte to the serial interface.

Parameters

data	The data to write

Returns

sfTkError_t Returns ksfTkErrOk on success, or ksfTkErrFail code

---

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

• src/sfTk/sfTkISerial.h