com.oracle.deviceaccess.gpio

Class GPIOPinConfig

java.lang.Object

com.oracle.deviceaccess.gpio.GPIOPinConfig

All Implemented Interfaces:

PeripheralConfig<GPIOPin>, PeripheralConfig.HardwareAddressing

public final class GPIOPinConfig
extends java.lang.Object
implements PeripheralConfig<GPIOPin>, PeripheralConfig.HardwareAddressing

The GPIOPinConfig class encapsulates the hardware addressing information, and static and dynamic configuration parameters of a GPIO pin.

Some hardware addressing parameter, and static and dynamic configuration parameters may be set to PeripheralConfig.DEFAULT. Whether such default settings are supported is platform- as well as peripheral driver-dependent.

An instance of GPIOPinConfig can be passed to the PeripheralManager.open(PeripheralConfig) or PeripheralManager.open(Class, PeripheralConfig) method to open the designated GPIO pin with the specified configuration. A PeripheralConfigInvalidException is thrown when attempting to open a peripheral device with an invalid or unsupported configuration.

See Also:

PeripheralManager.open(PeripheralConfig), PeripheralManager.open(Class, PeripheralConfig)

Nested Class Summary

Nested classes/interfaces inherited from interface com.oracle.deviceaccess.PeripheralConfig

PeripheralConfig.HardwareAddressing

Field Summary

Fields

Modifier and Type	Field and Description
static int	DIR_BOTH_INIT_INPUT Bidirectional port direction with initial input direction.
static int	DIR_BOTH_INIT_OUTPUT Bidirectional port direction with initial output direction.
static int	DIR_INPUT_ONLY Input port direction.
static int	DIR_OUTPUT_ONLY Output port 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 com.oracle.deviceaccess.PeripheralConfig

DEFAULT

Constructor Summary

Constructors

Constructor and Description
GPIOPinConfig(int deviceNumber, int pinNumber, int direction, int mode, int trigger, boolean initValue) Creates a new GPIOPinConfig with the specified hardware addressing information and configuration parameters.
GPIOPinConfig(java.lang.String deviceName, int pinNumber, int direction, int mode, int trigger, boolean initValue) Creates a new GPIOPinConfig with the specified hardware addressing information and configuration parameters.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Checks two GPIOPinConfig objects for equality.
java.lang.String	getDeviceName() Gets the configured device name (such as to its device file name on UNIX systems).
int	getDeviceNumber() Gets the configured device 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.
int	hashCode() Returns the hash code value for this object.

Methods inherited from class java.lang.Object

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

Field Detail

DIR_BOTH_INIT_INPUT

public static final int DIR_BOTH_INIT_INPUT

Bidirectional port direction with initial input direction.

See Also:

Constant Field Values

DIR_BOTH_INIT_OUTPUT

public static final int DIR_BOTH_INIT_OUTPUT

Bidirectional port direction with initial output direction.

See Also:

Constant Field Values

DIR_INPUT_ONLY

public static final int DIR_INPUT_ONLY

Input port direction.

See Also:

Constant Field Values

DIR_OUTPUT_ONLY

public static final int DIR_OUTPUT_ONLY

Output port 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 deviceNumber,
             int pinNumber,
             int direction,
             int mode,
             int trigger,
             boolean initValue)

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

Parameters:

deviceNumber - the hardware port's number (a positive or zero integer) or PeripheralConfig.DEFAULT.

pinNumber - the hardware pin's number (a positive or zero integer) or PeripheralConfig.DEFAULT.

direction - the allowed and initial direction of the pin, one of: DIR_INPUT_ONLY, DIR_OUTPUT_ONLY, DIR_BOTH_INIT_INPUT, DIR_BOTH_INIT_OUTPUT.

mode - the drive mode of the pin: either PeripheralConfig.DEFAULT 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; if the pin can be set in both input and output direction then the mode must specify both an input drive mode and an output drive mode (bit mask).

trigger - the initial interrupt trigger events, one of: TRIGGER_NONE, TRIGGER_FALLING_EDGE, TRIGGER_RISING_EDGE, TRIGGER_BOTH_EDGES, TRIGGER_HIGH_LEVEL, TRIGGER_LOW_LEVEL, TRIGGER_BOTH_LEVELS.

initValue - the initial value of the pin when initially set for output; ignored otherwise.

Throws:

java.lang.IllegalArgumentException - if any of the following is true:

• deviceNumber is not in the defined range;
• pinNumber is not in the defined range;
• direction is not one of the defined values;
• trigger is not one of the defined values;
• mode does not designate any mode (i.e. equals 0);
• mode designates more than one input or output drive mode;
• mode does not designates a drive mode for or designates a drive mode incompatible with the direction(s) designated by direction.

GPIOPinConfig

public GPIOPinConfig(java.lang.String deviceName,
             int pinNumber,
             int direction,
             int mode,
             int trigger,
             boolean initValue)

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

Parameters:

deviceName - the device name (such as to its device file name on UNIX systems).

pinNumber - the hardware pin's number (a positive or zero integer) or PeripheralConfig.DEFAULT.

direction - the allowed and initial direction of the pin, one of: DIR_INPUT_ONLY, DIR_OUTPUT_ONLY, DIR_BOTH_INIT_INPUT, DIR_BOTH_INIT_OUTPUT.

mode - the drive mode of the pin: either PeripheralConfig.DEFAULT 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; if the pin can be set in both input and output direction then the mode must specify both an input drive mode and an output drive mode (bit mask).

trigger - the initial interrupt trigger events, one of: TRIGGER_NONE, TRIGGER_FALLING_EDGE, TRIGGER_RISING_EDGE, TRIGGER_BOTH_EDGES, TRIGGER_HIGH_LEVEL, TRIGGER_LOW_LEVEL, TRIGGER_BOTH_LEVELS.

initValue - the initial value of the pin when initially set for output; ignored otherwise.

Throws:

java.lang.IllegalArgumentException - if any of the following is true:

• pinNumber is not in the defined range;
• direction is not one of the defined values;
• trigger is not one of the defined values;
• mode does not designate any mode (i.e. equals 0);
• mode designates more than one input or output drive mode;
• mode does not designates a drive mode for or designates a drive mode incompatible with the direction(s) designated by direction.

java.lang.NullPointerException - if deviceName is null.

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 PeripheralConfig.DEFAULT 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 PeripheralConfig.DEFAULT.

getDeviceNumber

public int getDeviceNumber()

Gets the configured device number for the pin.

Specified by:

getDeviceNumber in interface PeripheralConfig.HardwareAddressing

Returns:

the hardware port's number (a positive or zero integer) or PeripheralConfig.DEFAULT.

getDeviceName

public java.lang.String getDeviceName()

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

Specified by:

getDeviceName in interface PeripheralConfig.HardwareAddressing

Returns:

the device 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.

hashCode

public int hashCode()

Returns the hash code value for this object.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for this object.

equals

public boolean equals(java.lang.Object obj)

Checks two GPIOPinConfig objects for equality.

Overrides:

equals in class java.lang.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.