com.pi4j.gpio.extension.base

Interface AdcGpioProvider

All Superinterfaces:

GpioProvider

All Known Implementing Classes:

AdcGpioProviderBase, MCP3004GpioProvider, MCP3008GpioProvider, MCP3204GpioProvider, MCP3208GpioProvider, MCP3424GpioProvider, MCP3x0xGpioProvider

public interface AdcGpioProvider
extends GpioProvider

This interface defines the required interfaces for an ADC GPIO provider. (analog to digital converter chip)

Author:

Robert Savage

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MONITOR_INTERVAL
static int	DEFAULT_THRESHOLD
static int	INVALID_VALUE
static int	MIN_MONITOR_INTERVAL

Method Summary

Modifier and Type	Method and Description
double	getEventThreshold(GpioPinAnalogInput pin) Get the event threshold value for a given analog input pin.
double	getEventThreshold(Pin pin) Get the event threshold value for a given analog input pin.
double	getImmediateValue(GpioPinAnalogInput pin) This method will perform an immediate data acquisition directly to the ADC chip to get the requested pin's input conversion value.
double	getImmediateValue(Pin pin) This method will perform an immediate data acquisition directly to the ADC chip to get the requested pin's input conversion value.
double	getMaxSupportedValue() Get the maximum supported analog value for the ADC implementation.
double	getMinSupportedValue() Get the minimum supported analog value for the ADC implementation.
boolean	getMonitorEnabled() Get the background monitoring thread's enabled state.
int	getMonitorInterval() Get the background monitoring thread's rate of data acquisition.
float	getPercentValue(GpioPinAnalogInput pin) Get the current value in a percentage of the available range instead of a raw value.
float	getPercentValue(Pin pin) Get the current value in a percentage of the available range instead of a raw value.
void	setEventThreshold(double threshold, GpioPinAnalogInput... pin) Set the event threshold value for a given analog input pin.
void	setEventThreshold(double threshold, Pin... pin) Set the event threshold value for a given analog input pin.
void	setMonitorEnabled(boolean enabled) Set the background monitoring thread's enabled state.
void	setMonitorInterval(int monitorInterval) Change the background monitoring thread's rate of data acquisition.

Methods inherited from interface com.pi4j.io.gpio.GpioProvider

addListener, export, export, getMode, getName, getPullResistance, getPwm, getState, getValue, hasPin, isExported, isShutdown, removeAllListeners, removeListener, setMode, setPullResistance, setPwm, setPwmRange, setState, setValue, shutdown, unexport

Field Detail

MIN_MONITOR_INTERVAL

static final int MIN_MONITOR_INTERVAL

See Also:

Constant Field Values

DEFAULT_MONITOR_INTERVAL

static final int DEFAULT_MONITOR_INTERVAL

See Also:

Constant Field Values

DEFAULT_THRESHOLD

static final int DEFAULT_THRESHOLD

See Also:

Constant Field Values

INVALID_VALUE

static final int INVALID_VALUE

See Also:

Constant Field Values

Method Detail

getEventThreshold

double getEventThreshold(Pin pin)

Get the event threshold value for a given analog input pin. The event threshold value determines how much change in the analog input pin's conversion value must occur before the framework issues an analog input pin change event. A threshold is necessary to prevent a significant number of analog input change events from getting propagated and dispatched for input values that may have an expected range of drift. see the DEFAULT_THRESHOLD constant for the default threshold value.

Parameters:

pin - analog input pin

Returns:

event threshold value for requested analog input pin

getEventThreshold

double getEventThreshold(GpioPinAnalogInput pin)

Get the event threshold value for a given analog input pin. The event threshold value determines how much change in the analog input pin's conversion value must occur before the framework issues an analog input pin change event. A threshold is necessary to prevent a significant number of analog input change events from getting propagated and dispatched for input values that may have an expected range of drift. see the DEFAULT_THRESHOLD constant for the default threshold value.

Parameters:

pin - analog input pin

Returns:

event threshold value for requested analog input pin

setEventThreshold

void setEventThreshold(double threshold,
                       Pin... pin)

Set the event threshold value for a given analog input pin. The event threshold value determines how much change in the analog input pin's conversion value must occur before the framework issues an analog input pin change event. A threshold is necessary to prevent a significant number of analog input change events from getting propagated and dispatched for input values that may have an expected range of drift. see the DEFAULT_THRESHOLD constant for the default threshold value.

Parameters:

threshold - value between 0 and 1023.

pin - analog input pin (vararg, one or more inputs can be defined.)

setEventThreshold

void setEventThreshold(double threshold,
                       GpioPinAnalogInput... pin)

Set the event threshold value for a given analog input pin. The event threshold value determines how much change in the analog input pin's conversion value must occur before the framework issues an analog input pin change event. A threshold is necessary to prevent a significant number of analog input change events from getting propagated and dispatched for input values that may have an expected range of drift. see the DEFAULT_THRESHOLD constant for the default threshold value.

Parameters:

threshold - value between 0 and 1023.

pin - analog input pin (vararg, one or more inputs can be defined.)

getMonitorInterval

int getMonitorInterval()

Get the background monitoring thread's rate of data acquisition. (in milliseconds) The default interval is 100 milliseconds. The minimum supported interval is 50 milliseconds.

Returns:

monitoring interval in milliseconds

setMonitorInterval

void setMonitorInterval(int monitorInterval)

Change the background monitoring thread's rate of data acquisition. (in milliseconds) The default interval is 100 milliseconds. The minimum supported interval is 50 milliseconds.

Parameters:

monitorInterval -

getMonitorEnabled

boolean getMonitorEnabled()

Get the background monitoring thread's enabled state.

Returns:

monitoring enabled or disabled state

setMonitorEnabled

void setMonitorEnabled(boolean enabled)

Set the background monitoring thread's enabled state.

Parameters:

enabled - monitoring enabled or disabled state

getImmediateValue

double getImmediateValue(Pin pin)
                  throws IOException

This method will perform an immediate data acquisition directly to the ADC chip to get the requested pin's input conversion value.

Parameters:

pin - requested input pin to acquire conversion value

Returns:

conversion value for requested analog input pin

Throws:

IOException

getImmediateValue

double getImmediateValue(GpioPinAnalogInput pin)
                  throws IOException

This method will perform an immediate data acquisition directly to the ADC chip to get the requested pin's input conversion value.

Parameters:

pin - requested input pin to acquire conversion value

Returns:

conversion value for requested analog input pin

Throws:

IOException

getMinSupportedValue

double getMinSupportedValue()

Get the minimum supported analog value for the ADC implementation.

Returns:

Returns the minimum supported analog value.

getMaxSupportedValue

double getMaxSupportedValue()

Get the maximum supported analog value for the ADC implementation. (For example, a 10 bit ADC's maximum value is 1023 and a 12-bit ADC's maximum value is 4095.

Returns:

Returns the maximum supported analog value.

getPercentValue

float getPercentValue(Pin pin)

Get the current value in a percentage of the available range instead of a raw value.

Returns:

percentage value between 0 and 100.

getPercentValue

float getPercentValue(GpioPinAnalogInput pin)

Get the current value in a percentage of the available range instead of a raw value.

Returns:

percentage value between 0 and 100.