| Package | Description |
|---|---|
| com.oracle.deviceaccess |
Provides interfaces and classes for device I/O access and control.
|
| com.oracle.deviceaccess.adc |
Interfaces and classes for reading analog inputs using an Analog to Digital Converter (ADC).
|
| com.oracle.deviceaccess.atcmd |
Interfaces and classes for controlling a Data Communication Equipment such as a modem or a
cellular module using AT commands.
|
| com.oracle.deviceaccess.counter |
Interfaces and classes for counting pulses (or events) on a digital input line.
|
| com.oracle.deviceaccess.dac |
Interfaces and classes for writing analog outputs using a Digital to Analog Converter (DAC).
|
| com.oracle.deviceaccess.generic |
Interfaces and classes for controlling devices using generic I/O operations.
|
| com.oracle.deviceaccess.gpio |
Interfaces and classes for reading and writing from/to GPIO (General Purpose Input Output) pins
and ports of the device.
|
| com.oracle.deviceaccess.i2cbus |
Interfaces and classes for I2C (Inter-Integrated Circuit Bus) device access.
|
| com.oracle.deviceaccess.mmio |
Interfaces and classes for performing memory-mapped I/O.
|
| com.oracle.deviceaccess.modem |
Interfaces and classes for controlling MODEM signals.
|
| com.oracle.deviceaccess.pwm |
Interfaces and classes for generating PWM pulses on a digital output line.
|
| com.oracle.deviceaccess.spi |
Service-provider classes for the
com.oracle.deviceaccess package. |
| com.oracle.deviceaccess.spibus |
Interfaces and classes for SPI (Serial Peripheral Interface Bus) device access.
|
| com.oracle.deviceaccess.uart |
Interfaces and classes for controlling and reading and writing from/to Universal Asynchronous Receiver/Transmitter
(UART), with optional Modem signals control.
|
| com.oracle.deviceaccess.watchdog |
Interfaces and classes for using system watchdog timers (WDT).
|
| Modifier and Type | Method and Description |
|---|---|
static <P extends Peripheral<? super P>> |
PeripheralManager.open(java.lang.Class<P> intf,
PeripheralConfig<? super P> config)
Opens a
Peripheral instance of the specified type with the specified hardware
addressing information and configuration. |
static <P extends Peripheral<? super P>> |
PeripheralManager.open(java.lang.Class<P> intf,
PeripheralConfig<? super P> config,
int mode)
Opens a
Peripheral instance of the specified type with the specified hardware
addressing information and configuration. |
static <P extends Peripheral<? super P>> |
PeripheralManager.open(int id)
Looks up and opens a
Peripheral instance for the provided numerical ID. |
static <P extends Peripheral<? super P>> |
PeripheralManager.open(int id,
java.lang.Class<P> intf)
Looks up and opens a
Peripheral instance for the provided numerical ID and type. |
static <P extends Peripheral<? super P>> |
PeripheralManager.open(int id,
java.lang.Class<P> intf,
int mode)
Looks up and opens a
Peripheral instance for the provided numerical ID and type. |
static <P extends Peripheral<? super P>> |
PeripheralManager.open(int id,
int mode)
Looks up and opens a
Peripheral instance for the provided numerical ID. |
static <P extends Peripheral<? super P>> |
PeripheralManager.open(PeripheralConfig<? super P> config)
Opens a
Peripheral instance with the specified hardware addressing information and
configuration. |
static <P extends Peripheral<? super P>> |
PeripheralManager.open(PeripheralConfig<? super P> config,
int mode)
Opens a
Peripheral instance with the specified hardware addressing information and
configuration. |
static <P extends Peripheral<? super P>> |
PeripheralManager.open(java.lang.String name,
java.lang.Class<P> intf,
int mode,
java.lang.String... properties)
Looks up and opens a
Peripheral instance for the specified name, type and/or
properties. |
static <P extends Peripheral<? super P>> |
PeripheralManager.open(java.lang.String name,
java.lang.Class<P> intf,
java.lang.String... properties)
Looks up and opens a
Peripheral instance for the specified name, type and/or
properties. |
void |
Peripheral.tryLock(int timeout)
Attempts to lock for (platform-wide) exclusive access the underlying peripheral device
resource.
|
| Modifier and Type | Method and Description |
|---|---|
int |
ADCChannel.acquire()
Reads the current raw sampled input value of this channel.
|
void |
ADCChannel.acquire(java.nio.IntBuffer dst)
Reads a sequence of raw sampled input values from this channel and copies them into the
provided buffer.
|
int |
ADCChannel.getMaxValue()
Returns the maximum raw value this channel can convert.
|
int |
ADCChannel.getMinSamplingInterval()
Gets the minimum input sampling interval (in microseconds) that can be set using
setSamplingInterval. |
int |
ADCChannel.getMinValue()
Returns the minimum raw value this channel can convert.
|
int |
ADCChannel.getSamplingInterval()
Gets the input sampling interval (in microseconds).
|
double |
ADCChannel.getVRefValue()
Returns the Reference Voltage value of this ADC channel.
|
void |
ADCChannel.setSamplingInterval(int interval)
Sets the input sampling interval (in microseconds).
|
void |
ADCChannel.startAcquisition(java.nio.IntBuffer dst,
AcquisitionRoundListener listener)
Starts asynchronous analog input acquisition on this channel and reads a series of raw
sampled input values.
|
void |
ADCChannel.startAcquisition(java.nio.IntBuffer dst1,
java.nio.IntBuffer dst2,
AcquisitionRoundListener listener)
Starts asynchronous analog input acquisition on this channel and reads a series of raw
sampled input values.
|
void |
ADCChannel.startMonitoring(int low,
int high,
MonitoringListener listener)
Starts monitoring this channel analog input and asynchronously notifies the provided
MonitoringListener instance when this channel's raw sampled input value gets out of
or back in the specified range (as defined by a low and a high threshold value). |
void |
ADCChannel.stopAcquisition()
Stops the asynchronous analog input acquisition on this channel as started by a call to one
of the
startAcquisition methods. |
void |
ADCChannel.stopMonitoring()
Stops the range monitoring of this channel analog input as started by a call to the
startMonitoring method. |
| Modifier and Type | Method and Description |
|---|---|
void |
ATDevice.abortCommand(java.lang.String abortSequence)
Aborts the currently executing command by sending the provided
abortSequence. |
void |
ATDevice.escapeToCommandMode()
When in data mode, calling this method will try to switch to command mode such as (depending
on the underlying AT device) by sending
"+++" escape sequence. |
int |
ATDevice.getMaxCommandLength()
Returns the maximum length of the command string that can be processed by the underlying AT
parser.
|
boolean |
ATDevice.isConnected()
Queries if this AT device has an opened data connection.
|
boolean |
ATDevice.isInCommandMode()
Queries if this AT device is in command mode.
|
DataConnection |
ATDevice.openDataConnection(java.lang.String cmd,
CommandResponseHandler crHandler,
DataConnectionHandler dcHandler)
Opens a data connection by issuing the specified AT command and optionally handles the
response and the opened connection asynchronously.
|
java.lang.String |
ATDevice.sendCommand(java.lang.String cmd)
Sends an AT command and wait for the response.
|
void |
ATDevice.sendCommand(java.lang.String cmd,
CommandResponseHandler handler)
Sends an AT command and handle the response asynchronously.
|
void |
ATDevice.setUnsolicitedResponseHandler(UnsolicitedResponseHandler handler)
Registers a handler for handling Unsolicited Result Code responses.
|
| Modifier and Type | Method and Description |
|---|---|
int |
PulseCounter.getCount()
Gets the pulse count measured so far during the current (if still active) or previous
counting session.
|
void |
PulseCounter.resetCounting()
Resets the current count value.
|
void |
PulseCounter.resumeCounting()
Resumes the counting starting from the frozen count value.
|
void |
PulseCounter.startCounting()
Starts a pulse counting session.
|
void |
PulseCounter.startCounting(int limit,
long interval,
CountingListener listener)
Starts an asynchronous pulse counting session.
|
void |
PulseCounter.stopCounting()
Stops the pulse counting and freezes the current count value.
|
void |
PulseCounter.suspendCounting()
Suspends the pulse counting and freezes the current count value.
|
| Modifier and Type | Method and Description |
|---|---|
void |
DACChannel.generate(int value)
Writes the provided raw output value to this channel.
|
void |
DACChannel.generate(java.nio.IntBuffer src)
Writes
count raw output values from the provided buffer to this channel for
conversion. |
int |
DACChannel.getMaxValue()
Returns the maximum raw value this channel can convert.
|
int |
DACChannel.getMinSamplingInterval()
Gets the minimum output sampling interval (in microseconds) that can be set using
setSamplingInterval. |
int |
DACChannel.getMinValue()
Returns the minimum raw value this channel can convert.
|
int |
DACChannel.getSamplingInterval()
Gets the output sampling interval (in microseconds).
|
double |
DACChannel.getVRefValue()
Returns the Reference Voltage value of this DAC channel.
|
void |
DACChannel.setSamplingInterval(int interval)
Sets the output sampling interval (in microseconds).
|
void |
DACChannel.startGeneration(java.nio.IntBuffer src,
GenerationRoundListener listener)
Starts asynchronous analog output generation on this channel from a series of raw output
values (samples).
|
void |
DACChannel.startGeneration(java.nio.IntBuffer src1,
java.nio.IntBuffer src2,
GenerationRoundListener listener)
Starts asynchronous analog output generation on this channel from a series of raw output
values (samples).
|
void |
DACChannel.stopGeneration()
Stops the asynchronous analog output generation on this channel as started by a call to one
of the
startGeneration methods. |
| Modifier and Type | Method and Description |
|---|---|
<T> T |
GenericDevice.getControl(GenericDeviceControl<T> control)
Gets the value of the specified control.
|
int |
GenericBufferIODevice.read(java.nio.ByteBuffer dst)
Reads a sequence of bytes from this device into the given buffer.
|
int |
GenericBufferIODevice.read(int skip,
java.nio.ByteBuffer dst)
Reads a sequence of bytes from this device into the given buffer, skipping the first
skip bytes read. |
<T> void |
GenericDevice.setControl(GenericDeviceControl<T> control,
T value)
Sets the value of the specified control.
|
void |
GenericDevice.setEventListener(int eventId,
GenericEventListener listener)
Registers a
GenericEventListener instance to monitor native events of the designated
type fired by the peripheral device associated to this GenericDevice object. |
int |
GenericBufferIODevice.write(java.nio.ByteBuffer src)
Writes a sequence of bytes to this device from the given buffer.
|
| Modifier and Type | Method and Description |
|---|---|
int |
GPIOPort.getDirection()
Returns the current direction of this GPIO port.
|
int |
GPIOPin.getDirection()
Returns the current direction of this GPIO pin.
|
int |
GPIOPort.getMaxValue()
Returns the maximum value of this GPIO port.
|
int |
GPIOPin.getTrigger()
Returns the current pin interrupt trigger.
|
int |
GPIOPort.getValue()
Returns the current value of this GPIO port.
|
boolean |
GPIOPin.getValue()
Returns the current value of this GPIO pin.
|
void |
GPIOPort.setDirection(int direction)
Sets this GPIO port for output or input.
|
void |
GPIOPin.setDirection(int direction)
Sets this GPIO pin for output or input.
|
void |
GPIOPin.setTrigger(int trigger)
Sets this GPIO pin trigger mode.
|
void |
GPIOPin.setValue(boolean value)
Sets the value of this GPIO pin.
|
void |
GPIOPort.setValue(int value)
Sets the value of this GPIO port.
|
| Modifier and Type | Method and Description |
|---|---|
void |
I2CDevice.begin()
Demarcates the beginning of an I2C transaction so that the subsequent read and write
operations will be part of the same I2C combined message.
|
void |
I2CDevice.end()
Demarcates the end of a transaction hence ending the I2C combined message.
|
int |
I2CDevice.read()
Reads one byte of data from this slave device.
|
int |
I2CDevice.read(java.nio.ByteBuffer dst)
Reads a sequence of bytes from this slave device into the given buffer.
|
int |
I2CDevice.read(int skip,
java.nio.ByteBuffer dst)
Reads a sequence of bytes from this device into the given buffer, skipping the first
skip bytes read. |
int |
I2CDevice.read(int subaddress,
int subaddressSize,
java.nio.ByteBuffer dst)
Reads a sequence of bytes from a subaddress or register address of this slave device into the
given buffer.
|
int |
I2CDevice.read(int subaddress,
int subaddressSize,
int skip,
java.nio.ByteBuffer dst)
Reads a sequence of bytes from a subaddress or register address of this device into the given
buffer, skipping the first
skip bytes read. |
int[] |
I2CCombinedMessage.transfer()
Transfers this combined message.
|
int |
I2CDevice.write(java.nio.ByteBuffer src)
Writes a sequence of bytes to this slave device from the given buffer.
|
void |
I2CDevice.write(int srcData)
Writes one byte to this slave device.
|
int |
I2CDevice.write(int subaddress,
int subaddressSize,
java.nio.ByteBuffer src)
Writes a sequence of bytes to a subaddress or register address of this slave device from the
given buffer.
|
| Modifier and Type | Method and Description |
|---|---|
void |
RawRegister.and(T value)
Sets the value at the memory area associated with this object to the result of performing a logical AND of the
value at the memory area with the argument value.
|
java.nio.ByteBuffer |
RawBlock.asDirectBuffer()
Gets the complete memory area this
RawBlock is mapped to as a direct ByteBuffer. |
void |
RawRegister.clearBit(int index)
Clears (sets to
0) the designated bit value at the memory area associated with this object. |
void |
RawRegister.clearBits(T mask)
Clears (sets to
0) the specified bits at the memory area associated with this object. |
T |
RawRegister.get()
Gets the value at the memory area associated with this object.
|
RawBlock |
MMIODevice.getAsRawBlock()
Gets the complete memory area this device is mapped to as a
RawBlock instance. |
RawBlock |
MMIODevice.getBlock(java.lang.String name)
Gets the designated memory block.
|
int |
MMIODevice.getByteOrdering()
Returns the byte ordering of this memory-mapped peripheral device.
|
<T extends java.lang.Number> |
MMIODevice.getRegister(java.lang.String name,
java.lang.Class<T> type)
Gets the designated register holding a value of the designated type.
|
boolean |
RawRegister.isBitSet(int index)
Checks whether the designated bit value at the memory area associated with this object is set (equal to
1
) |
void |
RawRegister.or(T value)
Sets the value at the memory area associated with this object to the result of performing a logical OR of the
value at the memory area with the argument value.
|
void |
RawRegister.set(T value)
Sets the value at the memory area associated with this object.
|
void |
RawRegister.setBit(int index)
Sets (to
1) the designated bit value at the memory area associated with this object. |
void |
RawRegister.setBits(T mask)
Sets (to
1) the specified bits at the memory area associated with this object. |
void |
MMIODevice.setMMIOEventListener(int eventId,
int capturedIndex,
java.nio.ByteBuffer captureBuffer,
MMIOEventListener listener)
Registers a
MMIOEventListener instance to monitor native events of the designated type fired by the
peripheral device mapped to this MMIODevice object and capture the content of designated memory
area. |
void |
MMIODevice.setMMIOEventListener(int eventId,
MMIOEventListener listener)
Registers a
MMIOEventListener instance to monitor native events of the designated type fired by the
peripheral device mapped to this MMIODevice object. |
void |
MMIODevice.setMMIOEventListener(int eventId,
java.lang.String capturedName,
MMIOEventListener listener)
Registers a
MMIOEventListener instance to monitor native events of the designated type fired by the
peripheral device mapped to this MMIODevice object and capture the content of designated register
or block. |
void |
RawRegister.xor(T value)
Sets the value at the memory area associated with this object to the result of performing a logical XOR of the
value at the memory area with the argument value.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
ModemSignalsControl.getSignalState(int signalID)
Gets the state of the designated signal.
|
void |
ModemSignalsControl.setSignalChangeListener(ModemSignalListener<P> listener,
int signals)
Registers a
ModemSignalListener instance which will get asynchronously notified when one of the
designated signals changes. |
void |
ModemSignalsControl.setSignalState(int signalID,
boolean state)
Sets or clears the designated signal.
|
| Modifier and Type | Method and Description |
|---|---|
void |
PWMChannel.generate(java.nio.IntBuffer src)
Generates a pulse train containing
count pulses of the specified widths. |
void |
PWMChannel.generate(int width,
int count)
Generates a pulse train containing the specified count of pulses of the specified width.
|
int |
PWMChannel.getMaxPulsePeriod()
Gets the maximum pulse period of this PWM channel (in microseconds) that can bet set by a call to
setPulsePeriod. |
int |
PWMChannel.getMinPulsePeriod()
Gets the minimum pulse period of this PWM channel (in microseconds) that can bet set by a call to
setPulsePeriod. |
int |
PWMChannel.getPulsePeriod()
Gets the pulse period of this PWM channel (in microseconds).
|
void |
PWMChannel.setPulsePeriod(int period)
Sets the pulse period of this PWM channel.
|
void |
PWMChannel.startGeneration(int width)
Starts an asynchronous pulse train generation session - continuously generating pulses of the specified width
until explicitly stopped.
|
void |
PWMChannel.startGeneration(java.nio.IntBuffer src,
GenerationRoundListener listener)
Starts asynchronous pulse train generation in successive rounds - initially generating pulses of the specified
widths up to the specified initial count - as indicated by the number of remaining elements in the provided
buffer.
|
void |
PWMChannel.startGeneration(java.nio.IntBuffer src1,
java.nio.IntBuffer src2,
GenerationRoundListener listener)
Starts asynchronous pulse train generation in successive rounds.
|
void |
PWMChannel.startGeneration(int width,
int count,
GenerationListener listener)
Starts an asynchronous pulse train generation session - generating pulses of the specified width up to the
specified count.
|
void |
PWMChannel.stopGeneration()
Stops (cancels) the currently active pulse generation session.
|
| Modifier and Type | Method and Description |
|---|---|
AbstractPeripheral<? super P> |
PeripheralProvider.open(PeripheralConfig<? super P> config,
java.lang.String[] properties,
int mode)
Opens a
Peripheral instance with the specified properties, configuration and access mode. |
void |
AbstractPeripheral.tryLock(int timeout)
Attempts to lock for (platform-wide) exclusive access the underlying
peripheral device resource.
|
| Modifier and Type | Method and Description |
|---|---|
void |
SPIDevice.begin()
Demarcates the beginning of an SPI transaction so that this slave's Select line (SS) will be remain asserted
during the subsequent read and write operations and until the transaction ends.
|
void |
SPIDevice.end()
Demarcates the end of a transaction hence ending the assertion of this slave's Select line (SS).
|
int |
SPIDevice.getWordLength()
Gets the transfer word length in bits supported by this slave device.
|
int |
SPIDevice.read()
Reads one data word of up to 32 bits from this slave device.
|
int |
SPIDevice.read(java.nio.ByteBuffer dst)
Reads a sequence of bytes from this slave device into the given buffer.
|
int |
SPIDevice.read(int skip,
java.nio.ByteBuffer dst)
Reads a sequence of bytes from this device into the given buffer, skipping the first
skip bytes read. |
int |
SPIDevice.write(java.nio.ByteBuffer src)
Writes a sequence of bytes to this slave device from the given buffer.
|
void |
SPIDevice.write(int txData)
Writes one data word of up to 32 bits to this slave device.
|
int |
SPIDevice.writeAndRead(java.nio.ByteBuffer src,
java.nio.ByteBuffer dst)
Exchanges (transmits and receives) data with this slave device.
|
int |
SPIDevice.writeAndRead(java.nio.ByteBuffer src,
int skip,
java.nio.ByteBuffer dst)
Exchanges (transmits and receives) data with this slave device skipping the specified number of bytes received.
|
int |
SPIDevice.writeAndRead(int txData)
Exchanges (transmits and receives) one data word of up to 32 bits with this slave device.
|
| Modifier and Type | Method and Description |
|---|---|
void |
UART.generateBreak(int duration)
Generates a break condition for the specified duration.
|
int |
UART.getBaudRate()
Gets the current baud rate.
|
int |
UART.getDataBits()
Gets the current number of bits per character.
|
int |
UART.getParity()
Gets the current parity.
|
int |
UART.getReceiveTimeout()
Gets the current receive timeout.
|
int |
UART.getReceiveTriggerLevel()
Gets the current receive trigger level.
|
int |
UART.getStopBits()
Gets the current number of stop bits per character.
|
int |
UART.read(java.nio.ByteBuffer dst)
Reads a sequence of bytes from this UART into the given buffer.
|
void |
UART.setBaudRate(int baudRate)
Sets the baud rate.
|
void |
UART.setDataBits(int dataBits)
Sets the number of bits per character.
|
void |
UART.setEventListener(int eventId,
UARTEventListener listener)
Registers a
UARTEventListener instance to monitor input data availability, input buffer overrun and/or
empty output buffer conditions. |
void |
UART.setParity(int parity)
Sets the parity.
|
void |
UART.setReceiveTimeout(int timeout)
Sets the receive timeout.
|
void |
UART.setReceiveTriggerLevel(int level)
Sets the receive trigger level.
|
void |
UART.setStopBits(int stopBits)
Sets the number of stop bits per character.
|
void |
UART.startReading(java.nio.ByteBuffer dst1,
java.nio.ByteBuffer dst2,
InputRoundListener<UART,java.nio.ByteBuffer> listener)
Starts asynchronous reading in successive rounds.
|
void |
UART.startReading(java.nio.ByteBuffer dst,
InputRoundListener<UART,java.nio.ByteBuffer> listener)
Starts asynchronous reading in successive rounds - reading data into the provided
buffer.
|
void |
UART.startWriting(java.nio.ByteBuffer src1,
java.nio.ByteBuffer src2,
OutputRoundListener<UART,java.nio.ByteBuffer> listener)
Starts asynchronous writing in successive rounds.
|
void |
UART.startWriting(java.nio.ByteBuffer src,
OutputRoundListener<UART,java.nio.ByteBuffer> listener)
Starts asynchronous writing in successive rounds - initially writing the data remaining in the provided
buffer.
|
void |
UART.stopReading()
Stops (cancels) the currently active reading session.
|
void |
UART.stopWriting()
Stops (cancels) the currently active writing session.
|
int |
UART.write(java.nio.ByteBuffer src)
Writes a sequence of bytes to this UART from the given buffer.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
WatchdogTimer.causedLastReboot()
Checks if the last device reboot (or JVM restart) was caused by the watchdog timing out.
|
long |
WatchdogTimer.getMaxTimeout()
Gets the maximum timeout that can be set for the watchdog timer.
|
long |
WatchdogTimer.getTimeout()
Get the current timeout for the watchdog timer.
|
void |
WatchdogTimer.refresh()
Refreshes the watchdog timer.
|
void |
WatchdogTimer.start(long timeout)
Starts the watchdog timer with the specified timeout.
|
void |
WatchdogTimer.stop()
Stops this watchdog timer.
|
Copyright © 2012, 2014, Oracle and/or its affiliates. All rights reserved.
Legal Notices