Module com.pi4j

Package com.pi4j.io.i2c

Class I2CBase

java.lang.Object

com.pi4j.common.IdentityBase

com.pi4j.io.IOBase<I2C,I2CConfig,I2CProvider>

com.pi4j.io.i2c.I2CBase

All Implemented Interfaces:

Describable, Identity, Lifecycle, Extension, I2C, I2CRegisterDataReader, I2CRegisterDataReaderWriter, I2CRegisterDataWriter, IO<I2C,I2CConfig,I2CProvider>, IODataReader, IODataWriter, AutoCloseable, Readable

public abstract class I2CBase
extends IOBase<I2C,I2CConfig,I2CProvider>
implements I2C

Abstract I2CBase class.

Version:

$Id: $Id

Author:

Robert Savage (http://www.savagehomeautomation.com)

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	isOpen

Fields inherited from class com.pi4j.io.IOBase

config, provider

Fields inherited from class com.pi4j.common.IdentityBase

description, id, logger, metadata, name

Constructor Summary

Constructors

Constructor	Description
I2CBase(I2CProvider provider, I2CConfig config)	Constructor for I2CBase.

Method Summary

Modifier and Type	Method	Description
void	close()	close.
I2CRegister	getRegister(int address)	Get an encapsulated interface for reading and writing to a specific I2C device register
boolean	isOpen()	I2C Device Communication State is OPEN
I2C	shutdown(Context context)	shutdown.

Methods inherited from class com.pi4j.io.IOBase

config, describe, description, initialize, name, provider

Methods inherited from class com.pi4j.common.IdentityBase

description, id, metadata, name

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.pi4j.io.i2c.I2C

bus, device, getBus, getDevice, register

Methods inherited from interface com.pi4j.io.i2c.I2CRegisterDataReader

readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegisterByte, readRegisterByteBuffer, readRegisterByteBuffer, readRegisterCharArray, readRegisterCharArray, readRegisterCharArray, readRegisterCharArray, readRegisterCharBuffer, readRegisterCharBuffer, readRegisterCharBuffer, readRegisterCharBuffer, readRegisterNBytes, readRegisterNBytes, readRegisterString, readRegisterString, readRegisterString, readRegisterString, readRegisterWord

Methods inherited from interface com.pi4j.io.i2c.I2CRegisterDataReaderWriter

writeReadRegisterWord

Methods inherited from interface com.pi4j.io.i2c.I2CRegisterDataWriter

write, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegisterWord

Methods inherited from interface com.pi4j.common.Identity

description, getDescription, getId, getMetadata, getName, id, metadata, name

Methods inherited from interface com.pi4j.io.IO

config, description, name, provider, type

Methods inherited from interface com.pi4j.io.IODataReader

getInputStream, in, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, readByte, readByteBuffer, readByteBuffer, readCharArray, readCharArray, readCharArray, readCharArray, readCharBuffer, readCharBuffer, readCharBuffer, readCharBuffer, readNBytes, readNBytes, readString, readString, readString, readString

Methods inherited from interface com.pi4j.io.IODataWriter

getOutputStream, out, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write

Methods inherited from interface com.pi4j.common.Lifecycle

initialize

Field Detail

isOpen

protected boolean isOpen

Constructor Detail

I2CBase

public I2CBase(I2CProvider provider,
               I2CConfig config)

Constructor for I2CBase.

Parameters:

provider - a I2CProvider object.

config - a I2CConfig object.

Method Detail

isOpen

public boolean isOpen()

I2C Device Communication State is OPEN

Specified by:

isOpen in interface I2C

Returns:

The I2C device communication state

close

public void close()

close.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface I2C

getRegister

public I2CRegister getRegister(int address)

Get an encapsulated interface for reading and writing to a specific I2C device register Get an encapsulated interface for reading and writing to a specific I2C device register

Specified by:

getRegister in interface I2C

Parameters:

address - a int.

Returns:

a I2CRegister object.

shutdown

public I2C shutdown(Context context)
             throws ShutdownException

shutdown.

Specified by:

shutdown in interface Lifecycle

Overrides:

shutdown in class IOBase<I2C,I2CConfig,I2CProvider>

Parameters:

context - a Context object.

Returns:

a T object.

Throws:

ShutdownException - if an error occurs during shutdown.