io.silverspoon.bulldog.core.gpio

Interface AnalogInput

All Superinterfaces:

PinFeature

All Known Implementing Classes:

AbstractAnalogInput

public interface AnalogInput
extends PinFeature

This interface specified the operations that can be used on a Pin that is configured as an analog input.

Method Summary

Methods

Modifier and Type	Method and Description
double	read() Reads the voltage that is currently applied to the pin.
double[]	sample(int amountSamples) Grabs a number of readings from the analog input in short succession.
double[]	sample(int amountSamples, float frequency) Grabs a number of readings from the analog input, sampled with the specified frequency.
Future<double[]>	sampleAsync(int amountSamples) Grabs a number of readings asynchronously from the analog input in short succession.
Future<double[]>	sampleAsync(int amountSamples, float frequency) Grabs a number of readings asynchronously from the analog input, sampled with the specified frequency.
void	startMonitor(int periodMicroSeconds, ThresholdListener listener) Start a monitor on the analog input.
void	stopMonitor() Stops the monitor that currently listens on the pin.

Methods inherited from interface io.silverspoon.bulldog.core.gpio.PinFeature

activate, blockPin, getName, getPin, isActivatedFeature, isBlocking, isSetup, isTorndownOnShutdown, setTeardownOnShutdown, setup, teardown, unblockPin

Method Detail

read

double read()

Reads the voltage that is currently applied to the pin.

Returns:

A value ranging from 0.0 to 1.0. This is the percentage of the voltage reference value that is currently applied on this pin.

sample

double[] sample(int amountSamples)

Grabs a number of readings from the analog input in short succession.

Parameters:

amountSamples - the amount samples to be taken

Returns:

an array of values ranging between 0.0 and 1.0. These represent the percentage of the voltage reference that were supplied to the pin when the measurement was taken.

sample

double[] sample(int amountSamples,
              float frequency)

Grabs a number of readings from the analog input, sampled with the specified frequency.

Parameters:

amountSamples - the amount samples to be taken

frequency - the frequency that should be used for sampling

Returns:

an array of values ranging between 0.0 and 1.0. These represent the percentage of the voltage reference that were supplied to the pin when the measurement was taken.

sampleAsync

Future<double[]> sampleAsync(int amountSamples)

Grabs a number of readings asynchronously from the analog input in short succession. The program will continue execution while the samples are being taken.

Parameters:

amountSamples - the amount samples to be taken

Returns:

A future containing an array of the sampled values. These values range between 0.0 and 1.0, which represents the percentage of the reference voltage that has been measured.

sampleAsync

Future<double[]> sampleAsync(int amountSamples,
                           float frequency)

Grabs a number of readings asynchronously from the analog input, sampled with the specified frequency. The program will continue execution while the samples are being taken.

Parameters:

amountSamples - the amount samples to be taken

frequency - the frequency that should be used for sampling

Returns:

A future containing an array of the sampled values. These values range between 0.0 and 1.0, which represents the percentage of the reference voltage that has been measured.

startMonitor

void startMonitor(int periodMicroSeconds,
                ThresholdListener listener)

Start a monitor on the analog input. It will check the value on the analog input periodically, as specified with the periodMicroSeconds argument. When the threshold has been reached the listener's thresholdReached method will be called.

Parameters:

periodMicroSeconds - the period micro seconds

listener - the listener

stopMonitor

void stopMonitor()

Stops the monitor that currently listens on the pin.