org.lsst.ccs.drivers.i2c

Class I2c

java.lang.Object

org.lsst.ccs.drivers.i2c.I2c

public class I2c
extends Object

Routines for communicating with an I2C device

Author:

Owen Saxton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	I2c.ConnType Constants & data.

Constructor Summary

Constructors

Constructor and Description
I2c()

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection.
void	open(I2c.ConnType connType, String ident, int param) Opens a connection.
int	read(int addr) Reads a byte from a device without registers.
int	read(int addr, byte[] buff) Reads multiple bytes from a device without registers.
int	read(int addr, byte[] buff, int count) Reads multiple bytes from a device without registers.
int	read(int addr, int reg, byte[] buff) Reads multiple bytes from a device with 1-byte register numbers.
int	read(int addr, int reg, byte[] buff, int count) Reads multiple bytes from a device with 1-byte register numbers.
int	read2(int addr, int reg, byte[] buff) Reads multiple bytes from a device with 2-byte register numbers.
int	read2(int addr, int reg, byte[] buff, int count) Reads multiple bytes from a device with 2-byte register numbers.
void	setTimeout(double timeout) Sets the read timeout.
void	write(int addr, int value) Writes a byte to a device without registers.
void	write(int addr, int reg, byte[] buff) Writes multiple bytes to a device with 1-byte register numbers.
void	write(int addr, int reg, byte[] buff, int count) Writes multiple bytes to a device with 1-byte register numbers.
void	write2(int addr, int reg, byte[] buff) Writes multiple bytes to a device with 2-byte register numbers.
void	write2(int addr, int reg, byte[] buff, int count) Writes multiple bytes to a device with 2-byte register numbers.

Methods inherited from class java.lang.Object

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

Constructor Detail

I2c

public I2c()

Method Detail

open

public void open(I2c.ConnType connType,
                 String ident,
                 int param)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection.

Parameters:

connType - The enumerated connection type

ident - The identification

param - The parameter

Throws:

org.lsst.ccs.drivers.commons.DriverException

close

public void close()
           throws org.lsst.ccs.drivers.commons.DriverException

Closes the connection.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setTimeout

public void setTimeout(double timeout)
                throws org.lsst.ccs.drivers.commons.DriverException

Sets the read timeout.

Parameters:

timeout - The timeout (secs). 0 means no timeout.

Throws:

org.lsst.ccs.drivers.commons.DriverException

write

public void write(int addr,
                  int value)
           throws org.lsst.ccs.drivers.commons.DriverException

Writes a byte to a device without registers.

Parameters:

addr - The I2C address

value - The byte value to write

Throws:

org.lsst.ccs.drivers.commons.DriverException

read

public int read(int addr)
         throws org.lsst.ccs.drivers.commons.DriverException

Reads a byte from a device without registers.

Parameters:

addr - The I2C address

Returns:

The read value, or -1 if timeout

Throws:

org.lsst.ccs.drivers.commons.DriverException

read

public int read(int addr,
                byte[] buff,
                int count)
         throws org.lsst.ccs.drivers.commons.DriverException

Reads multiple bytes from a device without registers.

Parameters:

addr - The I2C address

buff - The read buffer

count - The number of bytes to read

Returns:

The number of bytes read. If less than count, a timeout occurred.

Throws:

org.lsst.ccs.drivers.commons.DriverException

read

public int read(int addr,
                byte[] buff)
         throws org.lsst.ccs.drivers.commons.DriverException

Reads multiple bytes from a device without registers.

Parameters:

addr - The I2C address

buff - The read buffer

Returns:

The number of bytes read. If less than the buffer size, a timeout occurred.

Throws:

org.lsst.ccs.drivers.commons.DriverException

write

public void write(int addr,
                  int reg,
                  byte[] buff,
                  int count)
           throws org.lsst.ccs.drivers.commons.DriverException

Writes multiple bytes to a device with 1-byte register numbers.

Parameters:

addr - The I2C address

reg - The register number

buff - The write buffer

count - The number of bytes to write

Throws:

org.lsst.ccs.drivers.commons.DriverException

write

public void write(int addr,
                  int reg,
                  byte[] buff)
           throws org.lsst.ccs.drivers.commons.DriverException

Writes multiple bytes to a device with 1-byte register numbers.

Parameters:

addr - The I2C address

reg - The register number

buff - The write buffer

Throws:

org.lsst.ccs.drivers.commons.DriverException

read

public int read(int addr,
                int reg,
                byte[] buff,
                int count)
         throws org.lsst.ccs.drivers.commons.DriverException

Reads multiple bytes from a device with 1-byte register numbers.

Parameters:

addr - The I2C address

reg - The register number

buff - The read buffer

count - The number of bytes to read

Returns:

The number of bytes read. If less than count, a timeout occurred.

Throws:

org.lsst.ccs.drivers.commons.DriverException

read

public int read(int addr,
                int reg,
                byte[] buff)
         throws org.lsst.ccs.drivers.commons.DriverException

Reads multiple bytes from a device with 1-byte register numbers.

Parameters:

addr - The I2C address

reg - The register number

buff - The read buffer

Returns:

The number of bytes read. If less than the buffer size, a timeout occurred.

Throws:

org.lsst.ccs.drivers.commons.DriverException

write2

public void write2(int addr,
                   int reg,
                   byte[] buff,
                   int count)
            throws org.lsst.ccs.drivers.commons.DriverException

Writes multiple bytes to a device with 2-byte register numbers.

Parameters:

addr - The I2C address

reg - The register number

buff - The write buffer

count - The number of bytes to write

Throws:

org.lsst.ccs.drivers.commons.DriverException

write2

public void write2(int addr,
                   int reg,
                   byte[] buff)
            throws org.lsst.ccs.drivers.commons.DriverException

Writes multiple bytes to a device with 2-byte register numbers.

Parameters:

addr - The I2C address

reg - The register number

buff - The write buffer

Throws:

org.lsst.ccs.drivers.commons.DriverException

read2

public int read2(int addr,
                 int reg,
                 byte[] buff,
                 int count)
          throws org.lsst.ccs.drivers.commons.DriverException

Reads multiple bytes from a device with 2-byte register numbers.

Parameters:

addr - The I2C address

reg - The register number

buff - The read buffer

count - The number of bytes to read

Returns:

The number of bytes read. If less than count, a timeout occurred.

Throws:

org.lsst.ccs.drivers.commons.DriverException

read2

public int read2(int addr,
                 int reg,
                 byte[] buff)
          throws org.lsst.ccs.drivers.commons.DriverException

Reads multiple bytes from a device with 2-byte register numbers.

Parameters:

addr - The I2C address

reg - The register number

buff - The read buffer

Returns:

The number of bytes read. If less than the buffer size, a timeout occurred.

Throws:

org.lsst.ccs.drivers.commons.DriverException