jdk.dio

Interface DeviceConfig.HardwareAddressing

All Known Implementing Classes:

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

Enclosing interface:

DeviceConfig<P extends Device<? super P>>

public static interface DeviceConfig.HardwareAddressing

The HardwareAddressing interface defines an abstraction of an hardware addressing information common on different platforms.

When a device's HardwareAddressing contains both a specific controller number (see getControllerNumber) and a specific controller name (see getControllerName) a compliant implementation of this specification MUST only use the controller number for addressing the device and for permission checks.

Since:

1.0

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getControllerName() Gets the controller name (such as a device file name on UNIX systems).
int	getControllerNumber() Gets the controller number.

Method Detail

getControllerNumber

int getControllerNumber()

Gets the controller number.

Returns:

the controller number (a positive or zero integer) or UNASSIGNED if no specific value is requested or no actual value is assigned (see Unassigned, Default or Unused Parameter Values).

getControllerName

java.lang.String getControllerName()

Gets the controller name (such as a device file name on UNIX systems).

Returns:

the controller name or null if no specific value is requested or no actual value is assigned (see Unassigned, Default or Unused Parameter Values).