com.digi.android.adc

Class ADC

java.lang.Object

com.digi.android.adc.ADC

public class ADC
extends java.lang.Object

This class represents an ADC channel.

An ADC channel allows you to read ADC samples from a physical board or module pin.

To obtain an instance of one ADC channel you have to use the ADCManager.createADC(int) method.

See Also:

ADCManager

Method Summary

Modifier and Type	Method and Description
int	getChannel() Returns the channel number of this ADC.
int	getValue() Returns the current ADC channel value.
void	registerListener(IADCListener listener) Registers the given listener to periodically receive ADC samples.
void	startSampling(int samplingRate) Starts reading samples with the specified sampling rate.
void	stopSampling() Stops the sampling process.
void	unregisterListener(IADCListener listener) Unregisters the given listener to stop receiving ADC channel samples.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getChannel

public int getChannel()

Returns the channel number of this ADC.

Returns:

The channel number of this ADC.

getValue

public int getValue()
             throws java.io.IOException

Returns the current ADC channel value.

Returns:

The current ADC channel value.

Throws:

java.io.IOException - If there is an error reading the ADC value.

registerListener

public void registerListener(IADCListener listener)

Registers the given listener to periodically receive ADC samples.

If the given listener is already registered, this method does nothing.

The listener will start receiving samples as soon as the startSampling(int) method is called. No more samples will be received after calling stopSampling() method.

Parameters:

listener - The listener to be registered.

Throws:

java.lang.NullPointerException - If listener == null.

See Also:

startSampling(int), stopSampling(), unregisterListener(IADCListener)

unregisterListener

public void unregisterListener(IADCListener listener)

Unregisters the given listener to stop receiving ADC channel samples.

If the given listener is not registered, this method does nothing.

Parameters:

listener - The listener to be unregistered.

Throws:

java.lang.NullPointerException - If listener == null.

See Also:

registerListener(IADCListener), startSampling(int), stopSampling()

startSampling

public void startSampling(int samplingRate)

Starts reading samples with the specified sampling rate.

Samples are read until the process is stopped using the stopSampling() method. The read samples are notified to the registered listeners.

It does nothing if the channel process is already running.

Parameters:

samplingRate - Time in milliseconds between samples.

Throws:

java.lang.IllegalArgumentException - If sampling <= 0.

See Also:

registerListener(IADCListener), stopSampling(), unregisterListener(IADCListener)

stopSampling

public void stopSampling()

Stops the sampling process.

It does nothing if the sampling process is not running.

See Also:

registerListener(IADCListener), startSampling(int), unregisterListener(IADCListener)