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.power |
Interfaces and classes for power management of peripheral devices.
|
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 |
---|---|
void |
Transactional.begin()
Demarcates the beginning of a transaction.
|
void |
Transactional.end()
Demarcates the end of a transaction.
|
static Peripheral |
PeripheralManager.open(java.lang.Class intf,
PeripheralConfig config)
Opens a
Peripheral instance of the specified type with the specified hardware addressing information and
configuration. |
static Peripheral |
PeripheralManager.open(int id)
Looks up and opens a
Peripheral instance for the provided numerical ID. |
static Peripheral |
PeripheralManager.open(int id,
java.lang.Class intf)
Looks up and opens a
Peripheral instance for the provided numerical ID and type. |
static Peripheral |
PeripheralManager.open(PeripheralConfig config)
Opens a
Peripheral instance with the specified hardware addressing information and configuration. |
static Peripheral |
PeripheralManager.open(java.lang.String name,
java.lang.Class intf,
java.lang.String[] properties)
Looks up and opens a
Peripheral instance for the specified name, type and/or properties. |
Modifier and Type | Method and Description |
---|---|
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
ADCChannel.setSamplingInterval(int) . |
int |
ADCChannel.getMinValue()
Returns the minimum raw value this channel can convert.
|
int |
ADCChannel.getSamplingInterval()
Gets the input sampling interval (in microseconds).
|
int |
ADCChannel.getValue()
Reads the current raw sampled input value of this channel.
|
void |
ADCChannel.getValues(int[] buffer,
int offset,
int count)
Reads
count raw sampled input values from this channel and copies them into the designated array. |
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(int[] buffer,
int offset,
int count,
boolean doubleBuffering,
AcquisitionListener 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 the
startAcquisition method. |
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 |
---|---|
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
DACChannel.setSamplingInterval(int) . |
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.setValue(int value)
Writes the provided raw output value to this channel.
|
void |
DACChannel.setValues(int[] buffer,
int offset,
int count)
Writes
count raw output values from the designated array to this channel for conversion. |
void |
DACChannel.startGeneration(int[] buffer,
int offset,
int count,
boolean doubleBuffering,
GenerationListener 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 the
startGeneration method. |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
GenericDevice.getControl(int id)
Gets the value of the specified control.
|
java.io.InputStream |
GenericStreamIODevice.getInputStream()
Returns an input stream to this device.
|
java.io.OutputStream |
GenericStreamIODevice.getOutputStream()
Returns an output stream to this device.
|
int |
GenericBufferIODevice.read(byte[] rxBuf,
int rxOff,
int rxLen)
Reads up to
rxLen bytes of data from this device into an array of bytes. |
int |
GenericBufferIODevice.read(int skip,
byte[] rxBuf,
int rxOff,
int rxLen)
Reads up to
rxLen bytes of data from this device into an array of bytes skipping the first skip
bytes read. |
void |
GenericDevice.setControl(int id,
java.lang.Object 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. |
void |
GenericBufferIODevice.write(byte[] txBuf,
int txOff,
int txLen)
Writes to this device
txLen bytes from buffer txBuf . |
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 |
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.setInputListener(PinListener listener)
Registers a
PinListener instance which will get asynchronously notified when this GPIO pin's value
changes and according to the current trigger mode (see GPIOPinConfig.getTrigger() ). |
void |
GPIOPort.setInputListener(PortListener listener)
Registers a
PortListener instance which will get asynchronously notified when this GPIO port's value
changes. |
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(byte[] dstBuf,
int dstOff,
int dstLen)
Reads up to
dstLen bytes of data from this slave device into an array of bytes. |
int |
I2CDevice.read(int skip,
byte[] dstBuf,
int dstOff,
int dstLen)
Reads up to
dstLen bytes of data from this slave device into an array of bytes skipping the first
skip bytes read. |
int |
I2CDevice.read(int subaddress,
int subaddressSize,
byte[] dstBuf,
int dstOff,
int dstLen)
Reads up to
dstLen bytes of data from a subaddress or register address of this slave device into an array
of bytes. |
int |
I2CDevice.read(int subaddress,
int subaddressSize,
int skip,
byte[] dstBuf,
int dstOff,
int dstLen)
Reads up to
dstLen bytes of data from a subaddress or register address of this slave device into an array
of bytes skipping the first skip bytes read. |
void |
I2CDevice.write(byte[] srcBuf,
int srcOff,
int srcLen)
Writes to this slave device
srcLen bytes from buffer srcBuf . |
void |
I2CDevice.write(int srcData)
Writes one byte to this slave device.
|
void |
I2CDevice.write(int subaddress,
int subaddressSize,
byte[] srcBuf,
int srcOff,
int srcLen)
Writes to a subaddress or register address of this slave device
srcLen bytes from buffer srcBuf . |
Modifier and Type | Method and Description |
---|---|
short |
RawShort.get()
Gets the
short value at the memory area associated with this object. |
int |
RawInt.get()
Gets the
int value at the memory area associated with this object. |
byte |
RawByte.get()
Gets the
byte 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.
|
byte |
RawBlock.getByte(int index)
Reads the
byte at the given index in the raw memory area associated with this object. |
int |
MMIODevice.getByteOrdering()
Returns the byte ordering of this memory-mapped peripheral device.
|
RawByte |
MMIODevice.getByteRegister(java.lang.String name)
Gets the designated register holding a
byte value. |
void |
RawBlock.getBytes(int index,
byte[] dst,
int offset,
int length)
Reads
byte s starting at the given index in the raw memory area associated with this object. |
int |
RawBlock.getInt(int index)
Reads the
int at the given index in the raw memory area associated with this object. |
RawInt |
MMIODevice.getIntRegister(java.lang.String name)
Gets the designated register holding a
int value. |
void |
RawBlock.getInts(int index,
int[] dst,
int offset,
int length)
Reads
int s starting at the given index in the raw memory area associated with this object. |
short |
RawBlock.getShort(int index)
Reads the
short at the given index in the raw memory area associated with this object. |
RawShort |
MMIODevice.getShortRegister(java.lang.String name)
Gets the designated register holding a
short value. |
void |
RawBlock.getShorts(int index,
short[] dst,
int offset,
int length)
Reads
short s starting at the given index in the raw memory area associated with this object. |
int |
RawBlock.getSize()
Gets the size in bytes of the raw memory area associated with this object.
|
void |
RawByte.set(byte value)
Sets the
byte value at the memory area associated with this object. |
void |
RawInt.set(int value)
Sets the
int value at the memory area associated with this object. |
void |
RawShort.set(short value)
Sets the
short value at the memory area associated with this object. |
void |
RawBlock.setByte(int index,
byte value)
Writes the given
byte at the given index in the raw memory area associated with this object. |
void |
RawBlock.setBytes(int index,
byte[] src,
int offset,
int length)
Writes
byte s starting at the given index in the raw memory area associated with this object. |
void |
RawBlock.setInt(int index,
int value)
Writes the given
int at the given index in the raw memory area associated with this object. |
void |
RawBlock.setInts(int index,
int[] src,
int offset,
int length)
Writes
int s starting at the given index in the raw memory area associated with this object. |
void |
MMIODevice.setMMIOEventListener(int eventId,
byte[] captureBuffer,
int capturedIndex,
int capturedLength,
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 |
RawBlock.setShort(int index,
short value)
Writes the given
short at the given index in the raw memory area associated with this object. |
void |
RawBlock.setShorts(int index,
short[] src,
int offset,
int length)
Writes
short s starting at the given index in the raw memory area associated with this object. |
Modifier and Type | Method and Description |
---|---|
boolean |
ModemSignalsControl.getSignalState(int signalID)
Gets the state of the designated signal.
|
void |
ModemSignalsControl.setSignalChangeListener(ModemSignalListener 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 |
PowerManaged.disablePowerSaving()
Disables application-dictated power saving for the
Peripheral instance. |
void |
PowerManaged.enablePowerSaving(int powerStates)
Enables application-dictated power saving for the
Peripheral instance. |
void |
PowerManaged.enablePowerSaving(int powerStates,
PowerSavingHandler handler)
Enables application-dictated power saving for the
Peripheral instance and registers a
PowerSavingHandler instance to get asynchronously notified when the power management facility is about to
change the power state of the Peripheral instance, hence allowing the application to veto the power state
change on the peripheral. |
int |
PowerManaged.getPowerState()
Returns the current power state of the
Peripheral instance. |
long |
PowerManaged.requestPowerStateChange(int powerState,
long duration)
Requests the change of the peripheral's current power state to the specified power state for the specified
duration.
|
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(byte[] rxBuf,
int rxOff,
int rxLen)
Receives/reads up to
rxLen bytes of data from this slave device into an array of bytes. |
int |
SPIDevice.read(int skip,
byte[] rxBuf,
int rxOff,
int rxLen)
Receives/reads up to
rxLen bytes of data from this slave device into an array of bytes skipping the first
skip bytes read. |
void |
SPIDevice.write(byte[] txBuf,
int txOff,
int txLen)
Transmits/writes data to this slave device.
|
void |
SPIDevice.write(int txData)
Writes one data word of up to 32 bits to this slave device.
|
int |
SPIDevice.writeAndRead(byte[] txBuf,
int txOff,
int txLen,
byte[] rxBuf,
int rxOff,
int rxLen)
Exchanges (transmits and receives) data with this slave device.
|
int |
SPIDevice.writeAndRead(byte[] txBuf,
int txOff,
int txLen,
int skip,
byte[] rxBuf,
int rxOff,
int rxLen)
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 |
---|---|
int |
UART.getBaudRate()
Gets the current baud rate.
|
int |
UART.getDataBits()
Gets the current number of bits per character.
|
java.io.InputStream |
UART.getInputStream()
Gets this
UART 's input stream. |
java.io.OutputStream |
UART.getOutputStream()
Gets this
UART 's output stream. |
int |
UART.getParity()
Gets the current parity.
|
int |
UART.getStopBits()
Gets the current number of stop bits per character.
|
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.setStopBits(int stopBits)
Sets the number of stop bits per character.
|
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 |
WindowedWatchdogTimer.getClosedWindowTimeout()
Get the current closed window delay for the watchdog timer.
|
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 |
WindowedWatchdogTimer.start(long timeout)
Starts the watchdog timer with the specified timeout and with a closed window delay set to
0 . |
void |
WatchdogTimer.start(long timeout)
Starts the watchdog timer with the specified timeout.
|
void |
WindowedWatchdogTimer.start(long closedWindowDelay,
long timeout)
Starts the windowed watchdog timer with the specified closed window time and timeout.
|
void |
WatchdogTimer.stop()
Stops this watchdog timer.
|
Copyright (c) 2012, Oracle and/or its affiliates. All Rights Reserved. Use of this specification is subject to license terms.