Header file for the SparkFun Toolkit Device Bus Interface Definition. More...

#include "sfToolkit.h"
#include <stddef.h>

Include dependency graph for sfTkIBus.h:

This graph shows which files directly or indirectly include this file:

Classes
class	sfTkIBus
	Interface that defines the communication bus for the SparkFun Electronics Toolkit. More...

Variables
const sfTkError_t	ksfTkErrBusNotInit = ksfTkErrFail * (ksfTkErrBaseBus + 1)
	Define our error codes for the bus. Note Errors are negative, warnings/info positive, but keep the same increment on the base. More...

const sfTkError_t	ksfTkErrBusTimeout = ksfTkErrFail * (ksfTkErrBaseBus + 2)
	Returned when a bus system times out. More...

const sfTkError_t	ksfTkErrBusNoResponse = ksfTkErrFail * (ksfTkErrBaseBus + 3)
	Returned when a bus system does not respond. More...

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

const sfTkError_t	ksfTkErrBusNullSettings = ksfTkErrFail * (ksfTkErrBaseBus + 5)
	Returned when the bus settings are null, invalid or on set/initialised. More...

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

const sfTkError_t	ksfTkErrBusUnderRead = ksfTkErrBaseBus + 7
	Returned when the bus is under read. Warning. More...

const sfTkError_t	ksfTkErrBusNotEnabled = ksfTkErrBaseBus + 8
	Returned when the bus is not enabled. Warning. More...

Detailed Description

Header file for the SparkFun Toolkit Device Bus Interface Definition.

This file contains the interface declaration for the Communication Bus Interface

Author: SparkFun Electronics

Date: 2024-2025

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

SPDX-License-Identifier: MIT

Variable Documentation

◆ ksfTkErrBusDataTooLong

const sfTkError_t ksfTkErrBusDataTooLong = ksfTkErrFail * (ksfTkErrBaseBus + 4)

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

◆ ksfTkErrBusNoResponse

const sfTkError_t ksfTkErrBusNoResponse = ksfTkErrFail * (ksfTkErrBaseBus + 3)

Returned when a bus system does not respond.

◆ ksfTkErrBusNotEnabled

const sfTkError_t ksfTkErrBusNotEnabled = ksfTkErrBaseBus + 8

Returned when the bus is not enabled. Warning.

◆ ksfTkErrBusNotInit

const sfTkError_t ksfTkErrBusNotInit = ksfTkErrFail * (ksfTkErrBaseBus + 1)

Define our error codes for the bus. Note Errors are negative, warnings/info positive, but keep the same increment on the base.

Error code for when a bus system is not initalized.

◆ ksfTkErrBusNullBuffer

const sfTkError_t ksfTkErrBusNullBuffer = ksfTkErrFail * (ksfTkErrBaseBus + 6)

Returned when the buffer is null or invalid.

◆ ksfTkErrBusNullSettings

const sfTkError_t ksfTkErrBusNullSettings = ksfTkErrFail * (ksfTkErrBaseBus + 5)

Returned when the bus settings are null, invalid or on set/initialised.

◆ ksfTkErrBusTimeout

const sfTkError_t ksfTkErrBusTimeout = ksfTkErrFail * (ksfTkErrBaseBus + 2)

Returned when a bus system times out.

◆ ksfTkErrBusUnderRead

const sfTkError_t ksfTkErrBusUnderRead = ksfTkErrBaseBus + 7

Returned when the bus is under read. Warning.

Classes

Variables