Header file for the SparkFun Toolkit Base Serial Interface Definition. More...

#include "sfTkError.h"

Include dependency graph for sfTkISerial.h:

Variables
const sfTkError_t	ksfTkErrBaseSerial = 0x2000
	A base value for serial errors. All serial errors are greater than this value, in the 2000 range. More...

const sfTkError_t	ksfTkErrSerialNotInit = ksfTkErrFail * (ksfTkErrBaseSerial + 1)
	Error code for when a serial system is not initalized. More...

const sfTkError_t	ksfTkErrSerialTimeout = ksfTkErrFail * (ksfTkErrBaseSerial + 2)
	Returned when a serial interface times out. More...

const sfTkError_t	ksfTkErrSerialNoResponse = ksfTkErrFail * (ksfTkErrBaseSerial + 3)
	Returned when a serial interface does not respond. More...

const sfTkError_t	ksfTkErrSerialDataTooLong = ksfTkErrFail * (ksfTkErrBaseSerial + 4)
	Returned when the data to be sent is too long or received is too short. More...

const sfTkError_t	ksfTkErrSerialNullSettings = ksfTkErrFail * (ksfTkErrBaseSerial + 5)
	Returned when the serial settings are null, invalid, or on set/initialized. More...

const sfTkError_t	ksfTkErrSerialNullBuffer = ksfTkErrFail * (ksfTkErrBaseSerial + 6)
	Returned when the buffer is null or invalid. More...

const sfTkError_t	ksfTkErrSerialUnderRead = ksfTkErrBaseSerial + 7
	Returned when the bus is under read. Warning. More...

Detailed Description

Header file for the SparkFun Toolkit Base Serial Interface Definition.

This file contains the interface declaration for basic serial read/write.

Copyright: Copyright (c) 2025, SparkFun Electronics Inc. This project is released under the MIT License.

SPDX-License-Identifier: MIT

Variable Documentation

const sfTkError_t ksfTkErrBaseSerial = 0x2000

A base value for serial errors. All serial errors are greater than this value, in the 2000 range.

const sfTkError_t ksfTkErrSerialDataTooLong = ksfTkErrFail * (ksfTkErrBaseSerial + 4)

Returned when the data to be sent is too long or received is too short.

const sfTkError_t ksfTkErrSerialNoResponse = ksfTkErrFail * (ksfTkErrBaseSerial + 3)

Returned when a serial interface does not respond.

Error code for when a serial system is not initalized.

const sfTkError_t ksfTkErrSerialNullBuffer = ksfTkErrFail * (ksfTkErrBaseSerial + 6)

Returned when the buffer is null or invalid.

const sfTkError_t ksfTkErrSerialNullSettings = ksfTkErrFail * (ksfTkErrBaseSerial + 5)

Returned when the serial settings are null, invalid, or on set/initialized.

Returned when a serial interface times out.

const sfTkError_t ksfTkErrSerialUnderRead = ksfTkErrBaseSerial + 7

Returned when the bus is under read. Warning.