com.diozero.internal.provider.sysfs

Interface I2CSMBusInterface

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

NativeI2CDeviceSMBus, NativeI2CDeviceSysFs

public interface I2CSMBusInterface
extends Closeable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	I2CSMBusInterface.NotSupportedException

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_I2C_BLOCK_SIZE

Method Summary

Modifier and Type	Method and Description
byte[]	blockProcessCall(int register, byte[] data, int length) SMBus Block Write - Block Read Process Call SMBus Block Write - Block Read Process Call was introduced in Revision 2.0 of the specification.
void	close()
short	processCall(int register, short data) SMBus Process Call: This command selects a device register (through the Comm byte), sends 16 bits of data to it, and reads 16 bits of data in return.
byte[]	readBlockData(int register) SMBus Block Read: i2c_smbus_read_block_data() This command reads a block of up to 32 bytes from a device, from a designated register that is specified through the Comm byte.
byte	readByte() SMBus Receive Byte: i2c_smbus_read_byte() This reads a single byte from a device, without specifying a device register.
byte	readByteData(int register) SMBus Read Byte: i2c_smbus_read_byte_data() This reads a single byte from a device, from a designated register.
byte[]	readBytes(int length)
byte[]	readI2CBlockData(int register, int length) I2C Block Read: i2c_smbus_read_i2c_block_data() This command reads a block of bytes from a device, from a designated register that is specified through the Comm byte.
short	readWordData(int register) SMBus Read Word: i2c_smbus_read_word_data() This operation is very like Read Byte; again, data is read from a device, from a designated register that is specified through the Comm byte.
void	writeBlockData(int register, byte[] data) SMBus Block Write: i2c_smbus_write_block_data() The opposite of the Block Read command, this writes up to 32 bytes to a device, to a designated register that is specified through the Comm byte.
void	writeByte(byte data) SMBus Send Byte: i2c_smbus_write_byte() This operation is the reverse of Receive Byte: it sends a single byte to a device.
void	writeByteData(int register, byte data) SMBus Write Byte: i2c_smbus_write_byte_data() This writes a single byte to a device, to a designated register.
void	writeBytes(byte[] data)
void	writeI2CBlockData(int register, byte[] data) I2C Block Write: i2c_smbus_write_i2c_block_data() The opposite of the Block Read command, this writes bytes to a device, to a designated register that is specified through the Comm byte.
void	writeWordData(int register, short data) SMBus Write Word: i2c_smbus_write_word_data() This is the opposite of the Read Word operation.

Field Detail

MAX_I2C_BLOCK_SIZE

static final int MAX_I2C_BLOCK_SIZE

See Also:

Constant Field Values

Method Detail

close

void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

readByte

byte readByte()

SMBus Receive Byte: i2c_smbus_read_byte() This reads a single byte from a device, without specifying a device register. Some devices are so simple that this interface is enough; for others, it is a shorthand if you want to read the same register as in the previous SMBus command. S Addr Rd [A] [Data] NA P

Returns:

Unsigned byte

writeByte

void writeByte(byte data)

SMBus Send Byte: i2c_smbus_write_byte() This operation is the reverse of Receive Byte: it sends a single byte to a device. See Receive Byte for more information. S Addr Wr [A] Data [A] P

Parameters:

data - value to write

readBytes

byte[] readBytes(int length)

writeBytes

void writeBytes(byte[] data)

readByteData

byte readByteData(int register)

SMBus Read Byte: i2c_smbus_read_byte_data() This reads a single byte from a device, from a designated register. The register is specified through the Comm byte. S Addr Wr [A] Comm [A] S Addr Rd [A] [Data] NA P

Parameters:

register - the register to read from

Returns:

data read as unsigned byte

writeByteData

void writeByteData(int register,
                   byte data)

SMBus Write Byte: i2c_smbus_write_byte_data() This writes a single byte to a device, to a designated register. The register is specified through the Comm byte. This is the opposite of the Read Byte operation. S Addr Wr [A] Comm [A] Data [A] P

Parameters:

register - the register to write to

data - value to write

readWordData

short readWordData(int register)

SMBus Read Word: i2c_smbus_read_word_data() This operation is very like Read Byte; again, data is read from a device, from a designated register that is specified through the Comm byte. But this time, the data is a complete word (16 bits). S Addr Wr [A] Comm [A] S Addr Rd [A] [DataLow] A [DataHigh] NA P

Parameters:

register - the register to read from

Returns:

data read as unsigned short

writeWordData

void writeWordData(int register,
                   short data)

SMBus Write Word: i2c_smbus_write_word_data() This is the opposite of the Read Word operation. 16 bits of data is written to a device, to the designated register that is specified through the Comm byte. S Addr Wr [A] Comm [A] DataLow [A] DataHigh [A] P

Parameters:

register - the register to write to

data - value to write

processCall

short processCall(int register,
                  short data)

SMBus Process Call: This command selects a device register (through the Comm byte), sends 16 bits of data to it, and reads 16 bits of data in return. S Addr Wr [A] Comm [A] DataLow [A] DataHigh [A] S Addr Rd [A] [DataLow] A [DataHigh] NA P

Parameters:

register - the register to write to / read from

data - value to write

Returns:

data read

readBlockData

byte[] readBlockData(int register)

SMBus Block Read: i2c_smbus_read_block_data() This command reads a block of up to 32 bytes from a device, from a designated register that is specified through the Comm byte. The amount of data is specified by the device in the Count byte. S Addr Wr [A] Comm [A] S Addr Rd [A] [Count] A [Data] A [Data] A ... A [Data] NA P

Parameters:

register - the register to read from

Returns:

data read

writeBlockData

void writeBlockData(int register,
                    byte[] data)

SMBus Block Write: i2c_smbus_write_block_data() The opposite of the Block Read command, this writes up to 32 bytes to a device, to a designated register that is specified through the Comm byte. The amount of data is specified in the Count byte. S Addr Wr [A] Comm [A] Count [A] Data [A] Data [A] ... [A] Data [A] P

Parameters:

register - the register to write to

data - values to write

blockProcessCall

byte[] blockProcessCall(int register,
                        byte[] data,
                        int length)

SMBus Block Write - Block Read Process Call SMBus Block Write - Block Read Process Call was introduced in Revision 2.0 of the specification. This command selects a device register (through the Comm byte), sends 1 to 31 bytes of data to it, and reads 1 to 31 bytes of data in return. S Addr Wr [A] Comm [A] Count [A] Data [A] ... S Addr Rd [A] [Count] A [Data] ... A P

Parameters:

register - the register to write to

data - data to write

length - Length

Returns:

data read

readI2CBlockData

byte[] readI2CBlockData(int register,
                        int length)

I2C Block Read: i2c_smbus_read_i2c_block_data() This command reads a block of bytes from a device, from a designated register that is specified through the Comm byte. S Addr Wr [A] Comm [A] S Addr Rd [A] [Data] A [Data] A ... A [Data] NA P Functionality flag: I2C_FUNC_SMBUS_READ_I2C_BLOCK

Parameters:

register - the register to read from

length - amount of data to read

Returns:

values to read

writeI2CBlockData

void writeI2CBlockData(int register,
                       byte[] data)

I2C Block Write: i2c_smbus_write_i2c_block_data() The opposite of the Block Read command, this writes bytes to a device, to a designated register that is specified through the Comm byte. Note that command lengths of 0, 2, or more bytes are supported as they are indistinguishable from data. S Addr Wr [A] Comm [A] Data [A] Data [A] ... [A] Data [A] P Functionality flag: I2C_FUNC_SMBUS_WRITE_I2C_BLOCK

Parameters:

register - the register to write to

data - values to write