cork.net.i2c
Class I2CBusMasterFactory

java.lang.Object
  |
  +--cork.net.i2c.I2CBusMasterFactory

All Implemented Interfaces:

Device

public final class I2CBusMasterFactory

extends java.lang.Object

implements Device

The Factory knows how to create copies of the system BusMaster and how to set its properties. To change the properties of the I2C lines, use the properties specified.

There are 4 properties that can be set in JemBuilder to change the configuration of the I2C bus:

cork.i2c.sda.pin.id={integer}

number; one of the port ID numbers to specify the data line. The default is 8198 (B5).

cork.i2c.scl.pin.id={integer}

number; one of the port ID numbers to specify the clock line. The default is 4102 (B4).

cork.i2c.int.pin.id={integer}

number; one of the port ID numbers to specify the interrupt line. The default is 261 (A0).

cork.i2c.bus.timeout={integer}

number; the timeout in milliseconds for the I2C bus. The default is 500.

The list that follows shows the bit ID/interrupt ID for the specified pin:

• GPIOA_BIT0=261
• GPIOA_BIT1=517
• GPIOA_BIT2=1029
• GPIOA_BIT3=2053
• GPIOA_BIT4=4101
• GPIOA_BIT5=8197
• GPIOA_BIT6=16389
• GPIOA_BIT7=32773
• GPIOB_BIT0=262
• GPIOB_BIT1=518
• GPIOB_BIT2=1030
• GPIOB_BIT3=2054
• GPIOB_BIT4=4102
• GPIOB_BIT5=8198
• GPIOB_BIT6=16390
• GPIOB_BIT7=32774
• GPIOC_BIT0=263
• GPIOC_BIT1=519
• GPIOC_BIT2=1031
• GPIOC_BIT3=2055
• GPIOC_BIT4=4103
• GPIOC_BIT5=8199
• GPIOC_BIT6=16391
• GPIOC_BIT7=32775
• GPIOD_BIT0=264
• GPIOD_BIT1=520
• GPIOD_BIT2=1032
• GPIOD_BIT3=2056
• GPIOD_BIT4=4104
• GPIOD_BIT5=8200
• GPIOD_BIT6=16392
• GPIOD_BIT7=32776
• GPIOE_BIT0=265
• GPIOE_BIT1=521
• GPIOE_BIT2=1033
• GPIOE_BIT3=2057
• GPIOE_BIT4=4105
• GPIOE_BIT5=8201
• GPIOE_BIT6=16393
• GPIOE_BIT7=32777

Version:

0.2.1

Author:

Brill Pappin

Field Summary

static int	DEFAULT_BUS_TIMEOUT The defualt bus timeout value is: 500 millis.
static int	DEFAULT_INTERRUPT_PIN_ID The defualt INT (interrupt) pin is InterruptController.GPIOA_BIT0_INTERRUPT
static int	DEFAULT_SCL_PIN_ID The defualt SCL pin is GpioPin.GPIOB_BIT4
static int	DEFAULT_SDA_PIN_ID The defualt SDA pin is GpioPin.GPIOB_BIT5
static java.lang.String	I2C_BUS_TIMEOUT The system property string to use in order the change the timeout for the I2C bus in milliseconds.
static java.lang.String	I2C_INT_PIN_ID The system property string to use in order the change the INT (interrupt line) pin for the I2C bus.
static java.lang.String	I2C_SCL_PIN_ID The system property string to use in order the change the SCL pin for the I2C bus.
static java.lang.String	I2C_SDA_PIN_ID The system property string to use in order the change the SDA pin for the I2C bus.

Method Summary

static I2CBusMaster	getBusMasterInstance(int compatibility) Returns a singleton instance of the bus master for all devices.
java.lang.String	getDeviceDestription() Gets the destription attribute of the Device object
java.lang.String	getDeviceName() Gets the title attribute of the Device object

Methods inherited from class java.lang.Object

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

Field Detail

I2C_SDA_PIN_ID

public static final java.lang.String I2C_SDA_PIN_ID

The system property string to use in order the change the SDA pin for the I2C bus.

cork.i2c.sda.pin.id

Since:

0.2.0

I2C_SCL_PIN_ID

public static final java.lang.String I2C_SCL_PIN_ID

The system property string to use in order the change the SCL pin for the I2C bus.

cork.i2c.scl.pin.id

Since:

0.2.0

I2C_INT_PIN_ID

public static final java.lang.String I2C_INT_PIN_ID

The system property string to use in order the change the INT (interrupt line) pin for the I2C bus.

cork.i2c.scl.pin.id

Since:

0.2.0

I2C_BUS_TIMEOUT

public static final java.lang.String I2C_BUS_TIMEOUT

The system property string to use in order the change the timeout for the I2C bus in milliseconds.

cork.i2c.bus.timeout

Since:

0.2.0

DEFAULT_SDA_PIN_ID

public static final int DEFAULT_SDA_PIN_ID

The defualt SDA pin is GpioPin.GPIOB_BIT5

Since:

0.2.0

DEFAULT_SCL_PIN_ID

public static final int DEFAULT_SCL_PIN_ID

The defualt SCL pin is GpioPin.GPIOB_BIT4

Since:

0.2.0

DEFAULT_INTERRUPT_PIN_ID

public static final int DEFAULT_INTERRUPT_PIN_ID

The defualt INT (interrupt) pin is InterruptController.GPIOA_BIT0_INTERRUPT

Since:

0.2.0

DEFAULT_BUS_TIMEOUT

public static final int DEFAULT_BUS_TIMEOUT

The defualt bus timeout value is: 500 millis.

Since:

0.2.0

Method Detail

getBusMasterInstance

public static final I2CBusMaster getBusMasterInstance(int compatibility)
                                               throws DeviceException,
                                                      java.lang.IllegalArgumentException

Returns a singleton instance of the bus master for all devices.

Parameters:

compatibility - Description of Parameter

Returns:

I2CBusMaster the BusMaster instance.

Throws:

java.lang.IllegalArgumentException - if the pins where changed via. the system properties, and there was an error getting the pin ID.

DeviceException - Throws a device exception is the pins being used for the I2C bus are already in use by another application.

Since:

0.2.1

getDeviceName

public java.lang.String getDeviceName()

Gets the title attribute of the Device object

Specified by:

getDeviceName in interface Device

Returns:

The title value

Since:

0.1.0

getDeviceDestription

public java.lang.String getDeviceDestription()

Gets the destription attribute of the Device object

Specified by:

getDeviceDestription in interface Device

Returns:

The destription value

Since:

0.1.0