org.joshvm.j2me.dio.gpio

Class GPIOPinConfig

java.lang.Object

org.joshvm.j2me.dio.gpio.GPIOPinConfig

All Implemented Interfaces:

DeviceConfig, DeviceConfig.HardwareAddressing

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

Nested Class Summary

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

DeviceConfig.HardwareAddressing

Field Summary

Fields

Modifier and Type	Field and Description
static int	DIR_BOTH_INIT_INPUT Bidirectional pin direction with initial input direction.
static int	DIR_BOTH_INIT_OUTPUT Bidirectional pin direction with initial output direction.
static int	DIR_INPUT_ONLY Input pin direction.
static int	DIR_OUTPUT_ONLY Output pin direction.
static int	MODE_INPUT_PULL_DOWN Input pull-down drive mode.
static int	MODE_INPUT_PULL_UP Input pull-up drive mode.
static int	MODE_OUTPUT_OPEN_DRAIN Output open-drain drive mode.
static int	MODE_OUTPUT_PUSH_PULL Output push-pull drive mode.
static int	TRIGGER_BOTH_EDGES Rising edge trigger.
static int	TRIGGER_BOTH_LEVELS Both levels trigger.
static int	TRIGGER_FALLING_EDGE Falling edge trigger.
static int	TRIGGER_HIGH_LEVEL High level trigger.
static int	TRIGGER_LOW_LEVEL Low level trigger.
static int	TRIGGER_NONE No interrupt trigger.
static int	TRIGGER_RISING_EDGE Rising edge trigger.

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

DEFAULT, UNASSIGNED

Constructor Summary

Constructors

Constructor and Description
GPIOPinConfig(int controllerNumber, int pinNumber, int direction, int mode, int trigger, boolean initValue)
GPIOPinConfig(String controllerName, int pinNumber, int direction, int mode, int trigger, boolean initValue)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Checks two GPIOPinConfig objects for equality.
String	getControllerName() Gets the configured controller name (such as its device file name on UNIX systems).
int	getControllerNumber() Gets the configured controller number for the pin.
int	getDirection() Gets the configured pin direction.
int	getDriveMode() Gets the configured pin drive mode.
boolean	getInitValue() Gets the configured initial value of the pin, if configured for output.
int	getPinNumber() Gets the configured pin number.
int	getTrigger() Gets the configured initial pin interrupt trigger.

Methods inherited from class java.lang.Object

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

Field Detail

DIR_BOTH_INIT_INPUT

public static final int DIR_BOTH_INIT_INPUT

Bidirectional pin direction with initial input direction.

See Also:

Constant Field Values

DIR_BOTH_INIT_OUTPUT

public static final int DIR_BOTH_INIT_OUTPUT

Bidirectional pin direction with initial output direction.

See Also:

Constant Field Values

DIR_INPUT_ONLY

public static final int DIR_INPUT_ONLY

Input pin direction.

See Also:

Constant Field Values

DIR_OUTPUT_ONLY

public static final int DIR_OUTPUT_ONLY

Output pin direction.

See Also:

Constant Field Values

MODE_INPUT_PULL_DOWN

public static final int MODE_INPUT_PULL_DOWN

Input pull-down drive mode.

This bit flag can be bitwise-combined (OR) with other drive mode bit flags.

See Also:

Constant Field Values

MODE_INPUT_PULL_UP

public static final int MODE_INPUT_PULL_UP

Input pull-up drive mode.

This bit flag can be bitwise-combined (OR) with other drive mode bit flags.

See Also:

Constant Field Values

MODE_OUTPUT_OPEN_DRAIN

public static final int MODE_OUTPUT_OPEN_DRAIN

Output open-drain drive mode.

This bit flag can be bitwise-combined (OR) with other drive mode bit flags.

See Also:

Constant Field Values

MODE_OUTPUT_PUSH_PULL

public static final int MODE_OUTPUT_PUSH_PULL

Output push-pull drive mode.

This bit flag can be bitwise-combined (OR) with other drive mode bit flags.

See Also:

Constant Field Values

TRIGGER_BOTH_EDGES

public static final int TRIGGER_BOTH_EDGES

Rising edge trigger.

See Also:

Constant Field Values

TRIGGER_BOTH_LEVELS

public static final int TRIGGER_BOTH_LEVELS

Both levels trigger.

See Also:

Constant Field Values

TRIGGER_FALLING_EDGE

public static final int TRIGGER_FALLING_EDGE

Falling edge trigger.

See Also:

Constant Field Values

TRIGGER_HIGH_LEVEL

public static final int TRIGGER_HIGH_LEVEL

High level trigger.

See Also:

Constant Field Values

TRIGGER_LOW_LEVEL

public static final int TRIGGER_LOW_LEVEL

Low level trigger.

See Also:

Constant Field Values

TRIGGER_NONE

public static final int TRIGGER_NONE

No interrupt trigger.

See Also:

Constant Field Values

TRIGGER_RISING_EDGE

public static final int TRIGGER_RISING_EDGE

Rising edge trigger.

See Also:

Constant Field Values

Constructor Detail

GPIOPinConfig

public GPIOPinConfig(int controllerNumber,
             int pinNumber,
             int direction,
             int mode,
             int trigger,
             boolean initValue)

GPIOPinConfig

public GPIOPinConfig(String controllerName,
             int pinNumber,
             int direction,
             int mode,
             int trigger,
             boolean initValue)

Method Detail

getDirection

public int getDirection()

Gets the configured pin direction.

Returns:

the pin direction, one of: DIR_INPUT_ONLY, DIR_OUTPUT_ONLY, DIR_BOTH_INIT_INPUT, DIR_BOTH_INIT_OUTPUT.

getDriveMode

public int getDriveMode()

Gets the configured pin drive mode.

Returns:

the pin drive mode: either UNASSIGNED or a bitwise OR of at least one of : MODE_INPUT_PULL_UP, MODE_INPUT_PULL_DOWN, MODE_OUTPUT_PUSH_PULL, MODE_OUTPUT_OPEN_DRAIN.

getInitValue

public boolean getInitValue()

Gets the configured initial value of the pin, if configured for output.

Returns:

the pin's initial output value; false if configured for input.

getPinNumber

public int getPinNumber()

Gets the configured pin number.

Returns:

the hardware pin's number (a positive or zero integer) or UNASSIGNED.

getControllerNumber

public int getControllerNumber()

Gets the configured controller number for the pin.

Specified by:

getControllerNumber in interface DeviceConfig.HardwareAddressing

Returns:

the hardware port's 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.

getTrigger

public int getTrigger()

Gets the configured initial pin interrupt trigger.

Returns:

the pin interrupt trigger, one of: TRIGGER_NONE, TRIGGER_FALLING_EDGE, TRIGGER_RISING_EDGE, TRIGGER_BOTH_EDGES, TRIGGER_HIGH_LEVEL, TRIGGER_LOW_LEVEL, TRIGGER_BOTH_LEVELS.

equals

public boolean equals(Object obj)

Checks two GPIOPinConfig objects for equality.

Overrides:

equals in class Object

Parameters:

obj - the object to test for equality with this object.

Returns:

true if obj is a GPIOPinConfig and has the same hardware addressing information and configuration parameter values as this GPIOPinConfig object; false otherwise.

See Also:

Boolean.hashCode(), Hashtable