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, static or dynamic configuration parameters may be set to UNASSIGNED or null (see Unassigned, Default or Unused Parameter Values).

An instance of GPIOPortConfig can be passed to the open(DeviceConfig, ...) and open(Class, DeviceConfig, ...) methods of the DeviceManager 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.

The value change notification trigger of a GPIO port is defined by the interrupt trigger(s) configured for its pins (see GPIOPinConfig.getTrigger). Any of the GPIOPins configured with an interrupt trigger (other than GPIOPinConfig.TRIGGER_NONE) that compose a GPIOPort may trigger a notification for that GPIOPort.

The following sample code illustrates how a 4-pin GPIO port configuration may be built with pins from the same GPIO controller:

 GPIOPinConfig.Builder builder = new GPIOPinConfig.Builder()
     .setControllerNumber(1)
     .setDirection(GPIOPinConfig.DIR_OUTPUT_ONLY)
     .setDriveMode(GPIOPinConfig.MODE_OUTPUT_PUSH_PULL);
 GPIOPortConfig config = new GPIOPortConfig(GPIOPortConfig.DIR_OUTPUT_ONLY, 0x0,
      builder.setPinNumber(0).build(),
      builder.setPinNumber(1).build(),
      builder.setPinNumber(2).build(),
      builder.setPinNumber(3).build()
 );
 

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/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, UNASSIGNED

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
static GPIOPortConfig	deserialize(java.io.InputStream in) Creates a new GPIOPortConfig whose state is deserialized from the specified InputStream.
boolean	equals(java.lang.Object obj) Checks two GPIOPortConfig objects for equality.
int	getDirection() Gets the configured port direction.
int	getInitValue() Gets the configured 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() Deprecated. As of 1.1, replaced by GPIOPort.getPins.
int	hashCode() Returns the hash code value for this object.
int	serialize(java.io.OutputStream out) Serializes the state of this GPIOPortConfig object to the specified OutputStream.

Methods inherited from class java.lang.Object

clone, 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

Constructor Detail

GPIOPortConfig

public GPIOPortConfig(int direction,
              int initValue,
              GPIOPinConfig... pins)

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

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; more precisely:
  • if direction is DIR_BOTH_INIT_INPUT or DIR_BOTH_INIT_OUTPUT and any of the provided pin configurations' direction is GPIOPinConfig.DIR_INPUT_ONLY or GPIOPinConfig.DIR_OUTPUT_ONLY;
  • if direction is DIR_INPUT_ONLY and any of the provided pin configurations' direction is GPIOPinConfig.DIR_OUTPUT_ONLY;
  • if direction is DIR_OUTPUT_ONLY and any of the provided pin configurations' direction is GPIOPinConfig.DIR_INPUT_ONLY;

java.lang.NullPointerException - if pins is null.

Method Detail

deserialize

public static GPIOPortConfig deserialize(java.io.InputStream in)
                                  throws java.io.IOException

Creates a new GPIOPortConfig whose state is deserialized from the specified InputStream. This method may be invoked to restore the state of a GPIOPortConfig object from a persistent store.

Parameters:

in - the stream to read from.

Returns:

a new GPIOPortConfig instance.

Throws:

java.io.IOException - if an I/O error occurs or if the provided stream does not contain a representation of a GPIOPortConfig object.

Since:

1.1

serialize

public int serialize(java.io.OutputStream out)
              throws java.io.IOException

Serializes the state of this GPIOPortConfig object to the specified OutputStream. This method may be invoked by the DeviceManager to save the state of this GPIOPortConfig object to a persistent store.

Specified by:

serialize in interface DeviceConfig<GPIOPort>

Parameters:

out - the stream to write to.

Returns:

the number of bytes written to the stream.

Throws:

java.io.IOException - if an I/O error occurs.

Since:

1.1

See Also:

DeviceProvider.deserialize(java.io.InputStream)

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 initial value of the port, if configured for output.

Returns:

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

@Deprecated
public GPIOPin[] getPins()

Deprecated. As of 1.1, replaced by GPIOPort.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.

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 GPIOPortConfig 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 GPIOPortConfig and has the same configuration parameter values as this GPIOPortConfig object; false otherwise.