org.joshvm.j2me.dio.i2cbus

Class I2CDeviceConfig

java.lang.Object

org.joshvm.j2me.dio.i2cbus.I2CDeviceConfig

All Implemented Interfaces:

DeviceConfig, DeviceConfig.HardwareAddressing

public final class I2CDeviceConfig
extends Object
implements DeviceConfig, DeviceConfig.HardwareAddressing

The I2CDeviceConfig class encapsulates the hardware addressing information, and static and dynamic configuration parameters of an I2C slave device.

Some hardware addressing, static or dynamic configuration parameters may be set to UNASSIGNED or null (see Unassigned, Default or Unused Parameter Values).

An instance of I2CDeviceConfig can be passed to the open(DeviceConfig, ...) and open(Class, DeviceConfig, ...) methods of the DeviceManager to open the designated I2C slave device with the specified configuration. A InvalidDeviceConfigException is thrown when attempting to open a device with an invalid or unsupported configuration.

Since:

1.0

See Also:

DeviceManager.open(DeviceConfig), DeviceManager.open(DeviceConfig, int), DeviceManager#open(Class, DeviceConfig), DeviceManager#open(Class, DeviceConfig, int)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	I2CDeviceConfig.Builder The Builder class allows for creating and initializing I2CDeviceConfig objects.

Nested classes/interfaces inherited from interface org.joshvm.j2me.dio.DeviceConfig

DeviceConfig.HardwareAddressing

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADDR_SIZE_10 10 bit slave address.
static int	ADDR_SIZE_7 7 bit slave address.

Fields inherited from interface org.joshvm.j2me.dio.DeviceConfig

DEFAULT, UNASSIGNED

Constructor Summary

Constructors

Constructor and Description
I2CDeviceConfig(int controllerNumber, int address, int addressSize, int clockFrequency) Deprecated. As of 1.1, use I2CDeviceConfig.Builder instead.
I2CDeviceConfig(String controllerName, int address, int addressSize, int clockFrequency) Deprecated. As of 1.1, use I2CDeviceConfig.Builder instead.

Method Summary

Methods

Modifier and Type	Method and Description
int	getAddress() Gets the configured address of the I2C slave device.
int	getAddressSize() Gets the configured address size of the I2C slave device.
int	getClockFrequency() Gets the configured clock frequency (in Hz) supported by the I2C slave device.
String	getControllerName() Gets the configured controller name (such as its device file name on UNIX systems).
int	getControllerNumber() Gets the configured controller number (the controller number the I2C bus adapter the I2C slave device is connected to).
int	getInputBufferSize() Gets the requested input buffer size.
int	getOutputBufferSize() Gets the requested or allocated output buffer size.

Methods inherited from class java.lang.Object

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

Field Detail

ADDR_SIZE_7

public static final int ADDR_SIZE_7

7 bit slave address.

See Also:

Constant Field Values

ADDR_SIZE_10

public static final int ADDR_SIZE_10

10 bit slave address.

See Also:

Constant Field Values

Constructor Detail

I2CDeviceConfig

public I2CDeviceConfig(int controllerNumber,
               int address,
               int addressSize,
               int clockFrequency)

Deprecated. As of 1.1, use I2CDeviceConfig.Builder instead.

Creates a new I2CDeviceConfig with the specified hardware addressing information and configuration parameters.

The controller name is set to null. The requested input and output buffer sizes are set to UNASSIGNED.

Parameters:

controllerNumber - the number of the bus the slave device is connected to (a positive or zero integer) or UNASSIGNED.

address - the address of the slave device on the bus (a positive or zero integer, strictly lesser than 2^addressSize).

addressSize - the address size: ADDR_SIZE_7 bits, ADDR_SIZE_10 bits.

clockFrequency - the clock frequency of the slave device in Hz (a positive integer) or UNASSIGNED.

Throws:

IllegalArgumentException - if any of the following is true:

• controllerNumber is not in the defined range;
• address is not in the defined range;
• addressSize is not in the defined range;
• clockFrequency is not in the defined range.

I2CDeviceConfig

public I2CDeviceConfig(String controllerName,
               int address,
               int addressSize,
               int clockFrequency)

Deprecated. As of 1.1, use I2CDeviceConfig.Builder instead.

Creates a new I2CDeviceConfig with the specified hardware addressing information and configuration parameters.

The controller number is set to UNASSIGNED. The requested input and output buffer sizes are set to UNASSIGNED.

Parameters:

controllerName - the name of the bus the slave device is connected to (such as its device file name on UNIX systems).

address - the address of the slave device on the bus (a positive or zero integer, strictly lesser than 2^addressSize).

addressSize - the address size: ADDR_SIZE_7 bits, ADDR_SIZE_10 bits.

clockFrequency - the clock frequency of the slave device in Hz (a positive integer) or UNASSIGNED.

Throws:

IllegalArgumentException - if any of the following is true:

• address is not in the defined range;
• addressSize is not in the defined range;
• clockFrequency is not in the defined range.

NullPointerException - if controllerName is null.

Method Detail

getAddress

public int getAddress()

Gets the configured address of the I2C slave device.

Returns:

the address of the slave device on the bus (a positive or zero integer).

getAddressSize

public int getAddressSize()

Gets the configured address size of the I2C slave device.

Returns:

the address size: ADDR_SIZE_7 bits, ADDR_SIZE_10 bits or UNASSIGNED.

getControllerNumber

public int getControllerNumber()

Gets the configured controller number (the controller number the I2C bus adapter the I2C slave device is connected to).

Specified by:

getControllerNumber in interface DeviceConfig.HardwareAddressing

Returns:

the controller number (a positive or zero integer) or UNASSIGNED.

getControllerName

public String getControllerName()

Gets the configured controller name (such as its device file name on UNIX systems).

Specified by:

getControllerName in interface DeviceConfig.HardwareAddressing

Returns:

the controller name or null.

getInputBufferSize

public int getInputBufferSize()

Gets the requested input buffer size. The platform/underlying driver may or may not allocate the requested size for the input buffer. When querying the configuration of an opened or registered device the allocated buffer size is returned.

Returns:

the requested or allocated input buffer size (a positive or zero integer) or UNASSIGNED.

Since:

1.1

getOutputBufferSize

public int getOutputBufferSize()

Gets the requested or allocated output buffer size. The platform/underlying driver may or may not allocate the requested size for the output buffer. When querying the configuration of an opened or registered device the allocated buffer size is returned.

Returns:

the requested or allocated output buffer size (a positive or zero integer) or UNASSIGNED.

Since:

1.1

getClockFrequency

public int getClockFrequency()

Gets the configured clock frequency (in Hz) supported by the I2C slave device.

Returns:

the clock frequency of the slave device in Hz (a positive integer) or UNASSIGNED.