jdk.dio.gpio

Class GPIOPortConfig

java.lang.Object

jdk.dio.gpio.GPIOPortConfig

All Implemented Interfaces:

DeviceConfig<GPIOPort>

public final class GPIOPortConfig
extends java.lang.Object
implements DeviceConfig<GPIOPort>

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

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

An instance of GPIOPortConfig can be passed to the DeviceManager.open(DeviceConfig) or DeviceManager.open(Class, DeviceConfig) method to open the designated GPIO port with the specified configuration. A InvalidDeviceConfigException is thrown when attempting to open a device with an invalid or unsupported configuration.

Note that the interrupt trigger of a GPIO port is defined by the interrupt trigger(s) configured for its pins (see GPIOPinConfig.getTrigger).

See Also:

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

Nested Class Summary

Nested classes/interfaces inherited from interface jdk.dio.DeviceConfig

DeviceConfig.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.

Fields inherited from interface jdk.dio.DeviceConfig

DEFAULT

Constructor Summary

Constructors

Constructor and Description
GPIOPortConfig(int direction, int initValue, GPIOPinConfig[] pins) Creates a new GPIOPortConfig with the specified hardware addressing information and configuration parameters.

Method Summary

Methods

Modifier and Type	Method and Description
int	getDirection() Gets the configured port direction.
int	getInitValue() Gets the configured default/initial value of the port, if configured for output.
GPIOPinConfig[]	getPinConfigs() Gets the configured configurations of the pins composing the port (in the exact same order they compose the port).
GPIOPin[]	getPins() Gets the pins composing the port (in the exact same order they compose the port).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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

Constructor Detail

GPIOPortConfig

public GPIOPortConfig(int direction,
              int initValue,
              GPIOPinConfig[] pins)

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

Note that if the access modes (exclusive or shared) supported by the designated GPIOPins are incompatible with those required by the underlying GPIOPort device or device driver, attempting to open the GPIOPort device using this configuration may result in a InvalidDeviceConfigException to be thrown.

Parameters:

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

initValue - the initial value of the port when initially set for output.

pins - the pin configurations in the exact same order they compose the port.

Throws:

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

• direction is not one of the defined values;
• pins.length is 0;
• if any of the provided pin configurations does not support the specified direction.

java.lang.NullPointerException - if pins is null.

Method Detail

getDirection

public int getDirection()

Gets the configured port direction.

Returns:

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

getInitValue

public int getInitValue()

Gets the configured default/initial value of the port, if configured for output.

Returns:

the port's default/initial output value.

getPinConfigs

public GPIOPinConfig[] getPinConfigs()

Gets the configured configurations of the pins composing the port (in the exact same order they compose the port).

Returns:

the pins composing the port (a defensive copy is returned).

getPins

public GPIOPin[] getPins()

Gets the pins composing the port (in the exact same order they compose the port).

A concurrent runtime change of the dynamic configuration parameters of any of the pins composing the port (such as of its direction) may result in IOException being thrown by port operations.

Returns:

the pins composing the port (a defensive copy is returned); or null if this GPIOPortConfig instance is not associated to an actual GPIOPort instance - that is the GPIOPortConfig instance was not retrieved from a call to getDescriptor().getConfiguration() on the GPIOPort instance.