Module com.pi4j

Package com.pi4j.io.i2c

Interface I2C

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

Modifier and Type	Method	Description
default int	bus()	I2C Bus Address
void	close()	close.
default int	device()	I2C Device Address
<T> T	execute(Callable<T> action)	Executes the given runnable on the I2C bus, locking the bus for the duration of the given task
default int	getBus()	I2C Bus Address
default int	getDevice()	I2C Device Address
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
static 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
default int	writeRead(byte[] writeBuffer, byte[] readBuffer)	Method to perform a write of the given buffer, and then a read into the given buffer
default int	writeRead(byte[] writeBuffer, int writeSize, int writeOffset, byte[] readBuffer, int readSize, int readOffset)	Method to perform a write of the given buffer, and then a read into the given buffer

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, 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, 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.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, shutdown

Method Details

close

void close()

close.

Specified by:

close in interface AutoCloseable

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.

writeRead

default int writeRead(byte[] writeBuffer,
 byte[] readBuffer)

Method to perform a write of the given buffer, and then a read into the given buffer

Parameters:

writeBuffer - the buffer to write

readBuffer - the buffer to read into

Returns:

the number of bytes read

writeRead

default int writeRead(byte[] writeBuffer,
 int writeSize,
 int writeOffset,
 byte[] readBuffer,
 int readSize,
 int readOffset)

Method to perform a write of the given buffer, and then a read into the given buffer

Parameters:

writeBuffer - the buffer to write respecting the given length and offset

writeSize - the number of bytes to write

writeOffset - the offset of the array to write

readBuffer - the buffer into which to read the bytes

readSize - the number of bytes to read

readOffset - the offset in the read buffer at which to insert the read bytes

Returns:

the number of bytes read

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

execute

<T> T execute(Callable<T> action)

Executes the given runnable on the I2C bus, locking the bus for the duration of the given task

Parameters:

action - the action to perform, returning a value