jdk.dio

Interface DeviceConfig<P extends Device<? super P>>

Type Parameters:

P - the device type the configuration is defined for.

All Known Implementing Classes:

ADCChannelConfig, ATDeviceConfig, DACChannelConfig, GenericDeviceConfig, GPIOPinConfig, GPIOPortConfig, I2CDeviceConfig, MMIODeviceConfig, PulseCounterConfig, PWMChannelConfig, SPIDeviceConfig, UARTConfig, WatchdogTimerConfig

public interface DeviceConfig<P extends Device<? super P>>

The DeviceConfig class is a tagging interface for all device configuration classes.

A device configuration contains the following elements:

Hardware Addressing Information

Information required to address the device. Examples are an I2C bus number and an I2C slave device address or a GPIO controller number and pin index.

Static Configuration Parameters

Configuration parameters that must be set before the device is opened and which may not be changed afterwards. Examples are an SPI slave device clock mode or word length.

Dynamic Configuration Parameters

Configuration parameters for which a default value may be set before the device is opened and which may still be changed while the device is open. Dynamic configuration parameters can be changed after the device is open through methods of Device sub-interfaces. Examples are a UART baud rate or the current direction of a bidirectional GPIO pin.

DeviceConfig instances should be immutable.
A compliant implementation of this specification MUST ensure that information encapsulated in a DeviceConfig instance cannot be altered while it is handling it and SHOULD either create its own private copy of the instance or of the information it contains.

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

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

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DeviceConfig.HardwareAddressing The HardwareAddressing interface defines an abstraction of an hardware addressing information common on different platforms.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT Used to indicate that the default value of a configuration parameter should be used.

Field Detail

DEFAULT

static final int DEFAULT

Used to indicate that the default value of a configuration parameter should be used.

See Also:

Constant Field Values