- 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.common.IdentityBase
description, id, logger, metadata, name
-
-
Constructor Summary
Constructors Constructor Description I2CBase(I2CProvider provider, I2CConfig config)
Constructor for I2CBase.
-
Method Summary
All Methods Instance Methods Concrete Methods 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 registerboolean
isOpen()
I2C Device Communication State is OPENI2C
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.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.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
-
-
-
-
Constructor Detail
-
I2CBase
public I2CBase(I2CProvider provider, I2CConfig config)
Constructor for I2CBase.
- Parameters:
provider
- aI2CProvider
object.config
- aI2CConfig
object.
-
-
Method Detail
-
isOpen
public boolean isOpen()
I2C Device Communication State is OPEN
-
close
public void close()
close.
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceI2C
-
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 interfaceI2C
- Parameters:
address
- a int.- Returns:
- a
I2CRegister
object.
-
shutdown
public I2C shutdown(Context context) throws ShutdownException
shutdown.
- Specified by:
shutdown
in interfaceLifecycle
- Overrides:
shutdown
in classIOBase<I2C,I2CConfig,I2CProvider>
- Parameters:
context
- aContext
object.- Returns:
- a T object.
- Throws:
ShutdownException
- if an error occurs during shutdown.
-
-