exploringBB::BusDevice Class Reference

This class is the parent of I2C and SPI devices, so that devices that use both SPI and I2C interfaces can use those interfaces interchangeably. Because it contains abstract methods, the child classes MUST implement the methods that are listed in this class. More...

#include <BusDevice.h>

Inheritance diagram for exploringBB::BusDevice:

Public Member Functions
	BusDevice (unsigned int bus, unsigned int device)
virtual int	open ()=0
virtual unsigned char	readRegister (unsigned int registerAddress)=0
virtual unsigned char *	readRegisters (unsigned int number, unsigned int fromAddress=0)=0
virtual int	write (unsigned char value)=0
virtual int	writeRegister (unsigned int registerAddress, unsigned char value)=0
virtual void	debugDumpRegisters (unsigned int number=0xff)=0
virtual void	close ()=0
virtual	~BusDevice ()

Protected Attributes
unsigned int	bus
unsigned int	device
int	file

Detailed Description

This class is the parent of I2C and SPI devices, so that devices that use both SPI and I2C interfaces can use those interfaces interchangeably. Because it contains abstract methods, the child classes MUST implement the methods that are listed in this class.

Constructor & Destructor Documentation

exploringBB::BusDevice::BusDevice	(	unsigned int	bus,
		unsigned int	device
	)

Constructor for a generic bus device

Parameters

bus	the bus number
device	the device number

                                                          {
        this->bus = bus;
        this->device = device;
        this->file=-1;
}

exploringBB::BusDevice::~BusDevice ( )

virtual

Destructor is unused

{}

Member Function Documentation

virtual void exploringBB::BusDevice::close ( )

pure virtual

Implemented in exploringBB::SPIDevice, and exploringBB::I2CDevice.

virtual void exploringBB::BusDevice::debugDumpRegisters ( unsigned int  number = 0xff )

pure virtual

Implemented in exploringBB::SPIDevice, and exploringBB::I2CDevice.

virtual int exploringBB::BusDevice::open ( )

pure virtual

Implemented in exploringBB::SPIDevice, and exploringBB::I2CDevice.

virtual unsigned char exploringBB::BusDevice::readRegister ( unsigned int  registerAddress )

pure virtual

Implemented in exploringBB::SPIDevice, and exploringBB::I2CDevice.

virtual unsigned char* exploringBB::BusDevice::readRegisters ( unsigned int  number, unsigned int  fromAddress = 0  )

pure virtual

Implemented in exploringBB::SPIDevice, and exploringBB::I2CDevice.

virtual int exploringBB::BusDevice::write ( unsigned char  value )

pure virtual

Implemented in exploringBB::SPIDevice, and exploringBB::I2CDevice.

virtual int exploringBB::BusDevice::writeRegister ( unsigned int  registerAddress, unsigned char  value  )

pure virtual

Implemented in exploringBB::SPIDevice, and exploringBB::I2CDevice.

Field Documentation

unsigned int exploringBB::BusDevice::bus

protected

the bus number

unsigned int exploringBB::BusDevice::device

protected

the device number on the bus

int exploringBB::BusDevice::file

protected

the file handle to the device

---

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

• /home/molloyd/exploringBB/library/bus/BusDevice.h
• /home/molloyd/exploringBB/library/bus/BusDevice.cpp