com.oracle.deviceaccess

Interface Peripheral

All Known Subinterfaces:

ADCChannel, ATDevice, ATModem, DACChannel, GenericBufferIODevice, GenericDevice, GenericStreamIODevice, GPIOPin, GPIOPort, I2CDevice, MMIODevice, ModemUART, PulseCounter, SPIDevice, UART, WatchdogTimer, WindowedWatchdogTimer

public interface Peripheral

The Peripheral interface represents peripheral devices in the system. This interface provides generic methods for handling peripherals.
All peripherals must implement the Peripheral interface.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BIG_ENDIAN Big-endian byte or bit ordering.
static int	LITTLE_ENDIAN Little-endian byte or bit ordering.
static int	MIXED_ENDIAN Mixed-endian (non-standard) byte ordering.
static int	UNDEFINED_ID Undefined peripheral numerical ID.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes and releases the underlying peripheral device, making it available to other applications.
int	getID() Returns the numerical ID of the underlying peripheral device.
java.lang.String	getName() Returns the name of the underlying peripheral device.
java.lang.String[]	getProperties() The properties of this peripheral device.
boolean	isOpen() Indicates whether or not this peripheral is open/available to the calling application.

Field Detail

BIG_ENDIAN

static final int BIG_ENDIAN

Big-endian byte or bit ordering.

See Also:

Constant Field Values

LITTLE_ENDIAN

static final int LITTLE_ENDIAN

Little-endian byte or bit ordering.

See Also:

Constant Field Values

MIXED_ENDIAN

static final int MIXED_ENDIAN

Mixed-endian (non-standard) byte ordering.

See Also:

Constant Field Values

UNDEFINED_ID

static final int UNDEFINED_ID

Undefined peripheral numerical ID.

See Also:

Constant Field Values

Method Detail

close

void close()
           throws java.io.IOException

Closes and releases the underlying peripheral device, making it available to other applications. Once released, subsequent operations on that very same Peripheral instance will result in a PeripheralNotAvailableException being thrown.

This method has no effects if the peripheral device has already been closed.

Throws:

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

getID

int getID()

Returns the numerical ID of the underlying peripheral device. If the peripheral has been opened with an ad-hoc configuration such as by calling PeripheralManager.open(java.lang.Class, com.oracle.deviceaccess.PeripheralConfig) the this peripheral's numerical ID is undefined.

Returns:

this peripheral's numerical ID or UNDEFINED_ID if none is defined.

getName

java.lang.String getName()

Returns the name of the underlying peripheral device. A name is a descriptive version of the peripheral ID. For example, "LED1".

Returns:

this peripheral's name or null if none is defined.

getProperties

java.lang.String[] getProperties()

The properties of this peripheral device.

Returns:

a String array (a defensive copy) of the peripheral device properties or an empty String array if none are defined.

isOpen

boolean isOpen()

Indicates whether or not this peripheral is open/available to the calling application.

Returns:

true if, and only if, this peripheral is open; false otherwise.