Package jdk.dio.adc

Interfaces and classes for reading analog inputs using an Analog to Digital Converter (ADC).

See: Description

Interface Summary

Interface	Description
AcquisitionRoundListener	The AcquisitionRoundListener interface defines methods for getting notified of the availability of sampled input values.
ADCChannel	The ADCChannel interface provides methods for controlling an ADC (Analog to Digital Converter) channel.
MonitoringListener	The MonitoringListener interface defines methods for getting notified of ADC channel under- and over-threshold input value conditions as well as device errors.

Class Summary

Class	Description
ADCChannelConfig	The ADCChannelConfig class encapsulates the hardware addressing information, and static and dynamic configuration parameters of an ADC channel.
ADCPermission	The ADCPermission class defines permissions for ADC channel access.
MonitoringEvent	The MonitoringEvent class encapsulates ADC channel under- and over-threshold value conditions.

Exception Summary

Exception	Description
InvalidInputSamplingRateException	Thrown by an instance of ADCChannel in case the requested sampling rate is higher than the maximum sampling rate the ADC device can support.

Package jdk.dio.adc Description

Interfaces and classes for reading analog inputs using an Analog to Digital Converter (ADC).

One ADC converter can have several channels. Each channel can sample a continuous input voltage and convert it to a numerical value.

In order to access and control a specific ADC channel, an application should first open and obtain an ADCChannel instance for the ADC channel the application wants to access and control, using its numerical ID, name, type (interface) and/or properties:

Using its ID

 ADCChannel channel = DeviceManager.open(8);
 

Using its name and interface

 ADCChannel channel = DeviceManager.open("TEMPERATURE", ADCChannel.class, null);
 

Once the device opened, the application can read or monitor sampled input values using methods of the ADCChannel interface such as the acquire method.

 int temp = channel.acquire();
 

When done, the application should call the ADCChannel.close method to close ADC channel.

 channel.close();
 

The following sample codes give examples of using the ADC API:

 class ADCAcquisition implements AcquisitionRoundListener {
 
     private ADCChannel channel = null;
 
     public void start(int channelID) throws IOException, NonAvailableDeviceException, DeviceNotFoundException {
         channel = (ADCChannel) DeviceManager.open(channelID);
         channel.setSamplingInterval(100); // every 100 milliseconds
         int[] values = new int[10];
         channel.startAcquisition(IntBuffer.wrap(values), this);
     }
 
     public void inputRoundCompleted(RoundCompletionEvent<ADCChannel, IntBuffer> event) {
         IntBuffer buffer = event.getBuffer();
         while (buffer.hasRemaining()) {
             int value = buffer.get();
             // Handle value...
         }
     }
 
     public void stop() throws IOException {
         if (channel != null) {
             channel.stopAcquisition();
             channel.close();
         }
     }
 
     public void failed(Throwable exception, ADCChannel source) {
          // Ignored
     }
 }
 

 class ADCThreshold implements MonitoringListener {
 
     private ADCChannel channel = null;
 
     public void start(int channelID, int low, int high) throws IOException, NonAvailableDeviceException,
             DeviceNotFoundException {
         channel = (ADCChannel) DeviceManager.open(channelID);
         channel.setSamplingInterval(100); // every 100 milliseconds
         channel.startMonitoring(low, high, this);
     }
 
     public void thresholdReached(MonitoringEvent event) {
         if (event.getType() == MonitoringEvent.OUT_OF_RANGE) {
             int value = event.acquire();
             // Handle condition...
         }
     }
 
     public void stop() throws IOException {
         if (channel != null) {
             channel.stopMonitoring();
             channel.close();
         }
     }
 
     public void failed(Throwable exception, ADCChannel source) {
          // Ignored
     }
 }
 

Because of performance issue, procedures handling analog inputs, and especially event listeners, should be implemented to be as fast as possible.

Unless otherwise noted, passing a null argument to a constructor or method in any class or interface in this package will cause a NullPointerException to be thrown.