Package com.digi.android.i2c

Class I2C

java.lang.Object

com.digi.android.i2c.I2C

public class I2C
extends java.lang.Object

Represents an I2C interface from the device. An I2C object lets you access physical module I2C interface to write and read from it.

Objects of this class are immutable. Operations on this class are performed on the underlying I2C-dev interface resulting in actions on the final hardware.

To obtain an instance of the I2C interface you have to use the I2CManager.createI2C(int) method.

See Also:

I2CManager

Method Summary

Modifier and Type	Method	Description
void	close()	Attempts to close the I2C interface.
protected void	finalize()
int	getInterfaceNumber()	Retrieves the I2C interface number.
boolean	isInterfaceOpen()	Retrieves whether interface is open or not.
void	open()	Opens the I2C interface.
byte[]	read(int deviceAddress, int numBytes)	Reads the given amount of bytes from the given slave device address.
byte	readByte(int deviceAddress)	Reads one byte from the given slave device address.
byte[]	transfer(int deviceAddress, byte[] data, int numBytes)	Simultaneously writes the given byte array in the given slave device address and reads the given amount of bytes.
byte[]	transfer(int deviceAddress, byte data, int numBytes)	Simultaneously writes the given byte in the given slave device address and reads the given amount of bytes.
void	write(int deviceAddress, byte wByte)	Writes the given byte in the given slave device address.
void	write(int deviceAddress, byte[] data)	Writes the given byte array in the given slave device address.

Methods inherited from class java.lang.Object

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

Method Detail

open

public void open()
          throws NoSuchInterfaceException,
                 java.io.IOException

Opens the I2C interface.

It does nothing if the interface is already open.

Throws:

java.io.IOException - If there is an error opening the I2C interface.

NoSuchInterfaceException - If the given interface does not exist.

See Also:

close(), isInterfaceOpen()

close

public void close()
           throws java.io.IOException

Attempts to close the I2C interface.

Throws:

java.io.IOException

See Also:

isInterfaceOpen(), open()

isInterfaceOpen

public boolean isInterfaceOpen()

Retrieves whether interface is open or not.

Returns:

true if interface is open, false otherwise.

See Also:

close(), open()

getInterfaceNumber

public int getInterfaceNumber()

Retrieves the I2C interface number.

Returns:

The I2C interface number.

readByte

public byte readByte(int deviceAddress)
              throws java.io.IOException

Reads one byte from the given slave device address.

Parameters:

deviceAddress - Slave device address to read one byte from.

Returns:

The read byte.

Throws:

java.lang.IllegalArgumentException - If deviceAddress < 0.

java.io.IOException - If the interface is closed or an error occurs while reading data from the interface.

See Also:

read(int, int)

read

public byte[] read(int deviceAddress,
                   int numBytes)
            throws java.io.IOException

Reads the given amount of bytes from the given slave device address.

Parameters:

deviceAddress - Slave device address to read bytes from.

numBytes - Amount of bytes to read.

Returns:

The read bytes, null if error.

Throws:

java.lang.IllegalArgumentException - If deviceAddress < 0 or if numBytes < 1.

java.io.IOException - If the interface is closed or an error occurs while reading data from the interface.

See Also:

readByte(int)

write

public void write(int deviceAddress,
                  byte wByte)
           throws java.io.IOException

Writes the given byte in the given slave device address.

Parameters:

deviceAddress - Slave device address to write the byte to.

wByte - Byte to write.

Throws:

java.lang.IllegalArgumentException - If deviceAddress < 0.

java.io.IOException - If the interface is closed or an error occurs while writing data to the interface.

See Also:

write(int, byte[])

write

public void write(int deviceAddress,
                  byte[] data)
           throws java.io.IOException

Writes the given byte array in the given slave device address.

Parameters:

deviceAddress - Slave device address to write the byte array to.

data - Byte array to write.

Throws:

java.lang.IllegalArgumentException - If deviceAddress < 0.

java.io.IOException - If the interface is closed or an error occurs while writing data to the interface.

java.lang.NullPointerException - If data == null.

See Also:

write(int, byte)

transfer

public byte[] transfer(int deviceAddress,
                       byte data,
                       int numBytes)
                throws java.io.IOException

Simultaneously writes the given byte in the given slave device address and reads the given amount of bytes.

Parameters:

deviceAddress - Slave device address to write the byte to and read from.

data - Byte to write.

numBytes - Number of bytes to read after write.

Returns:

The read bytes, null if error.

Throws:

java.lang.IllegalArgumentException - If deviceAddress < 0 or if numBytes < 1.

java.io.IOException - If the interface is closed or an error occurs while writing or reading data from the interface.

See Also:

transfer(int, byte[], int)

transfer

public byte[] transfer(int deviceAddress,
                       byte[] data,
                       int numBytes)
                throws java.io.IOException

Simultaneously writes the given byte array in the given slave device address and reads the given amount of bytes.

Parameters:

deviceAddress - Slave device address to write bytes to and read from.

data - Byte array to write.

numBytes - Number of bytes to read after write.

Returns:

The read bytes, null if error.

Throws:

java.lang.IllegalArgumentException - If deviceAddress < 0 or if numBytes < 1.

java.io.IOException - If the interface is closed or an error occurs while writing or reading data from the interface.

java.lang.NullPointerException - If data == null.

See Also:

transfer(int, byte, int)

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable