apra::I2C_Bus Class Reference

#include <I2CBus.h>

Public Member Functions
	I2C_Bus (string i2cPath, bool shouldPrint)
virtual	~I2C_Bus ()
I2CError	openBus ()
void	closeBus ()
void	setSize (uint8_t registerSize, uint8_t dataSize)
I2CError	writeOnce (uint8_t chipAddress, uint64_t registerAddress, uint64_t data)
I2CError	readOnce (uint8_t chipAddress, uint64_t registerAddress, uint64_t &data)
I2CError	writeOnI2C (uint8_t chipAddress, uint64_t registerAddress, uint64_t data)
I2CError	readOnI2C (uint8_t chipAddress, uint64_t registerAddress, uint64_t &data)
I2CError	genericWrite (uint8_t chipAddress, vector< uint8_t > registerAddress, vector< uint8_t > data)
I2CError	genericRead (uint8_t chipAddress, vector< uint8_t > registerAddress, vector< uint8_t > &readData)
bool	isI2CExecRecommended ()

Detailed Description

Definition at line 23 of file I2CBus.h.

Constructor & Destructor Documentation

I2C_Bus()

I2C_Bus::I2C_Bus	(	string	i2cPath,
		bool	shouldPrint
	)

Definition at line 26 of file I2CBus.cpp.

~I2C_Bus()

I2C_Bus::~I2C_Bus ( )

virtual

Definition at line 33 of file I2CBus.cpp.

Member Function Documentation

closeBus()

void I2C_Bus::closeBus

(

)

Definition at line 69 of file I2CBus.cpp.

Referenced by readOnce(), apra::I2C_Interface::reSetupI2CBus(), writeOnce(), and apra::I2C_Interface::~I2C_Interface().

genericRead()

I2CError I2C_Bus::genericRead	(	uint8_t	chipAddress,
		vector< uint8_t >	registerAddress,
		vector< uint8_t > &	readData
	)

Definition at line 140 of file I2CBus.cpp.

References apra::GenericError::getMessage(), MONOTIMEUS, and apra::READ_ERROR.

Referenced by apra::I2C_Interface::performCompareRead(), apra::I2C_Interface::performRead(), and readOnI2C().

genericWrite()

I2CError I2C_Bus::genericWrite	(	uint8_t	chipAddress,
		vector< uint8_t >	registerAddress,
		vector< uint8_t >	data
	)

Definition at line 80 of file I2CBus.cpp.

References apra::GenericError::getMessage(), MONOTIMEUS, and apra::WRITE_ERROR.

Referenced by apra::I2C_Interface::performWrite(), and writeOnI2C().

isI2CExecRecommended()

bool I2C_Bus::isI2CExecRecommended

(

)

Definition at line 37 of file I2CBus.cpp.

References CONSEQUENT_I2C_TIME_LIMIT_US, and MONOCURRTIME.

openBus()

I2CError I2C_Bus::openBus

(

)

Definition at line 49 of file I2CBus.cpp.

References apra::OPEN_BUS_ERROR.

Referenced by apra::I2C_Interface::I2C_Interface(), readOnce(), apra::I2C_Interface::reSetupI2CBus(), and writeOnce().

readOnce()

I2CError I2C_Bus::readOnce	(	uint8_t	chipAddress,
		uint64_t	registerAddress,
		uint64_t &	data
	)

Definition at line 228 of file I2CBus.cpp.

References closeBus(), apra::GenericError::isError(), openBus(), and readOnI2C().

readOnI2C()

I2CError I2C_Bus::readOnI2C	(	uint8_t	chipAddress,
		uint64_t	registerAddress,
		uint64_t &	data
	)

Definition at line 260 of file I2CBus.cpp.

References apra::BUS_UNOPENED, apra::Utils::combineBytes(), apra::Utils::extractBytes(), genericRead(), and apra::GenericError::isError().

Referenced by readOnce().

setSize()

void I2C_Bus::setSize	(	uint8_t	registerSize,
		uint8_t	dataSize
	)

Definition at line 43 of file I2CBus.cpp.

Referenced by apra::I2C_Interface::performCompareRead(), apra::I2C_Interface::performRead(), and apra::I2C_Interface::performWrite().

writeOnce()

I2CError I2C_Bus::writeOnce	(	uint8_t	chipAddress,
		uint64_t	registerAddress,
		uint64_t	data
	)

Definition at line 216 of file I2CBus.cpp.

References closeBus(), apra::GenericError::isError(), openBus(), and writeOnI2C().

writeOnI2C()

I2CError I2C_Bus::writeOnI2C	(	uint8_t	chipAddress,
		uint64_t	registerAddress,
		uint64_t	data
	)

Definition at line 240 of file I2CBus.cpp.

References apra::BUS_UNOPENED, apra::Utils::extractBytes(), and genericWrite().

Referenced by writeOnce().

---

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

• includes/utils/I2CBus.h
• src/utils/I2CBus.cpp