com.pi4j.gpio.extension.mcp

Class MCP3424GpioProvider

java.lang.Object

com.pi4j.io.gpio.GpioProviderBase

com.pi4j.gpio.extension.base.AdcGpioProviderBase

com.pi4j.gpio.extension.mcp.MCP3424GpioProvider

All Implemented Interfaces:

AdcGpioProvider, GpioProvider

public class MCP3424GpioProvider
extends AdcGpioProviderBase
implements AdcGpioProvider

This GPIO provider implements the MCP3424 I2C GPIO expansion board as native Pi4J GPIO pins. It is a 18-bit ADC providing 4 sigma/delta input channels. More information about the board can be found here: http://ww1.microchip.com/downloads/en/DeviceDoc/22088c.pdf

The MCP3424 is connected via I2C connection to the Raspberry Pi and provides 4 analog input channels. The values returned are in the range [-131072:131071] (max 18 bit value).

Author:

Alexander Falkenstern

Field Summary

Fields

Modifier and Type	Field and Description
static String	DESCRIPTION
static String	NAME

Fields inherited from class com.pi4j.gpio.extension.base.AdcGpioProviderBase

allPins, conversionDelay, monitor, monitorInterval, threshold

Fields inherited from class com.pi4j.io.gpio.GpioProviderBase

cache, DEFAULT_CACHE_SIZE, isshutdown, listeners

Fields inherited from interface com.pi4j.gpio.extension.base.AdcGpioProvider

DEFAULT_MONITOR_INTERVAL, DEFAULT_THRESHOLD, INVALID_VALUE, MIN_MONITOR_INTERVAL

Constructor Summary

Constructors

Constructor and Description
MCP3424GpioProvider(I2CBus bus, int address)
MCP3424GpioProvider(I2CBus bus, int address, int resolution, int gain)
MCP3424GpioProvider(int busNumber, int address)
MCP3424GpioProvider(int busNumber, int address, int resolution, int gain)

Method Summary

Modifier and Type	Method and Description
double	getAnalogValue(GpioPinAnalogInput pin) Get the requested analog input pin's conversion value.
double	getAnalogValue(Pin pin) Get the requested analog input pin's 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.
String	getName()
void	setGain(int gain)
void	setResolution(int resolution)
void	shutdown() This method is used by the framework to shutdown the background monitoring thread if needed when the program exits.

Methods inherited from class com.pi4j.gpio.extension.base.AdcGpioProviderBase

getEventThreshold, getEventThreshold, getImmediateValue, getMonitorEnabled, getMonitorInterval, getPercentValue, getPercentValue, getValue, setEventThreshold, setEventThreshold, setMonitorEnabled, setMonitorInterval

Methods inherited from class com.pi4j.io.gpio.GpioProviderBase

addListener, dispatchPinAnalogValueChangeEvent, dispatchPinDigitalStateChangeEvent, export, export, getMode, getPinCache, getPullResistance, getPwm, getState, hasPin, isExported, isShutdown, removeAllListeners, removeListener, setMode, setPullResistance, setPwm, setPwmRange, setState, setValue, unexport

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.pi4j.gpio.extension.base.AdcGpioProvider

getEventThreshold, getEventThreshold, getImmediateValue, getMonitorEnabled, getMonitorInterval, getPercentValue, getPercentValue, setEventThreshold, setEventThreshold, setMonitorEnabled, setMonitorInterval

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

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

Constant Field Values

Constructor Detail

MCP3424GpioProvider

public MCP3424GpioProvider(int busNumber,
                           int address)
                    throws I2CFactory.UnsupportedBusNumberException,
                           IOException

Throws:

I2CFactory.UnsupportedBusNumberException

IOException

MCP3424GpioProvider

public MCP3424GpioProvider(int busNumber,
                           int address,
                           int resolution,
                           int gain)
                    throws I2CFactory.UnsupportedBusNumberException,
                           IOException

Throws:

I2CFactory.UnsupportedBusNumberException

IOException

MCP3424GpioProvider

public MCP3424GpioProvider(I2CBus bus,
                           int address)
                    throws I2CFactory.UnsupportedBusNumberException,
                           IOException

Throws:

I2CFactory.UnsupportedBusNumberException

IOException

MCP3424GpioProvider

public MCP3424GpioProvider(I2CBus bus,
                           int address,
                           int resolution,
                           int gain)
                    throws I2CFactory.UnsupportedBusNumberException,
                           IOException

Throws:

I2CFactory.UnsupportedBusNumberException

IOException

Method Detail

setGain

public void setGain(int gain)
             throws IllegalArgumentException

Throws:

IllegalArgumentException

setResolution

public void setResolution(int resolution)
                   throws IllegalArgumentException

Throws:

IllegalArgumentException

shutdown

public void shutdown()

Description copied from class: AdcGpioProviderBase

This method is used by the framework to shutdown the background monitoring thread if needed when the program exits.

Specified by:

shutdown in interface GpioProvider

Overrides:

shutdown in class AdcGpioProviderBase

getName

public String getName()

Specified by:

getName in interface GpioProvider

Specified by:

getName in class GpioProviderBase

getAnalogValue

public double getAnalogValue(Pin pin)

Get the requested analog input pin's conversion value.

Parameters:

pin - to get conversion values for

Returns:

analog input pin value in Volt

getAnalogValue

public double getAnalogValue(GpioPinAnalogInput pin)

Get the requested analog input pin's conversion value.

Parameters:

pin - to get conversion values for

Returns:

analog input pin value in Volt

getImmediateValue

public 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.

Specified by:

getImmediateValue in interface AdcGpioProvider

Specified by:

getImmediateValue in class AdcGpioProviderBase

Parameters:

pin - requested input pin to acquire conversion value

Returns:

conversion value for requested analog input pin

Throws:

IOException

getMinSupportedValue

public double getMinSupportedValue()

Get the minimum supported analog value for the ADC implementation.

Specified by:

getMinSupportedValue in interface AdcGpioProvider

Returns:

Returns the minimum supported analog value.

getMaxSupportedValue

public 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.

Specified by:

getMaxSupportedValue in interface AdcGpioProvider

Returns:

Returns the maximum supported analog value.