-
- All Superinterfaces:
AutoCloseable
,Describable
,I2CRegisterDataReader
,I2CRegisterDataReaderWriter
,I2CRegisterDataWriter
,Identity
,IO<I2C,I2CConfig,I2CProvider>
,IODataReader
,IODataWriter
,Lifecycle
,Readable
- All Known Implementing Classes:
I2CBase
public interface I2C extends IO<I2C,I2CConfig,I2CProvider>, IODataWriter, IODataReader, I2CRegisterDataReaderWriter, AutoCloseable
I2C I/O Interface for Pi4J I2C Bus/Device Communications- Version:
- $Id: $Id
- Author:
- Robert Savage Based on previous contributions from: Daniel Sendula, RasPelikan
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default int
bus()
I2C Bus Addressvoid
close()
close.default int
device()
I2C Device Addressdefault int
getBus()
I2C Bus Addressdefault int
getDevice()
I2C Device AddressI2CRegister
getRegister(int address)
Get an encapsulated interface for reading and writing to a specific I2C device registerboolean
isOpen()
I2C Device Communication State is OPENstatic I2CConfigBuilder
newConfigBuilder(Context context)
newConfigBuilder.default I2CRegister
register(int address)
I2C Device Register Get an encapsulated interface for reading and writing to a specific I2C device 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
describe, 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, shutdown
-
-
-
-
Method Detail
-
close
void close()
close.
- Specified by:
close
in interfaceAutoCloseable
-
newConfigBuilder
static I2CConfigBuilder newConfigBuilder(Context context)
newConfigBuilder.
- Parameters:
context
-Context
- Returns:
- a
I2CConfigBuilder
object.
-
device
default int device()
I2C Device Address- Returns:
- The I2C device address for which this instance is constructed for.
-
bus
default int bus()
I2C Bus Address- Returns:
- The I2C bus address for which this instance is constructed for.
-
isOpen
boolean isOpen()
I2C Device Communication State is OPEN- Returns:
- The I2C device communication state
-
getBus
default int getBus()
I2C Bus Address- Returns:
- The I2C bus address for which this instance is constructed for.
-
getDevice
default int getDevice()
I2C Device Address- Returns:
- The I2C device address for which this instance is constructed for.
-
getRegister
I2CRegister getRegister(int address)
Get an encapsulated interface for reading and writing to a specific I2C device register- Parameters:
address
- a int.- Returns:
- a
I2CRegister
object.
-
register
default I2CRegister register(int address)
I2C Device Register Get an encapsulated interface for reading and writing to a specific I2C device register- Parameters:
address
- the (16-bit) device register address- Returns:
- an instance of I2CRegister for the provided register address
-
-