com.pi4j.gpio.extension.mcp

Class MCP3204GpioProvider

java.lang.Object

com.pi4j.io.gpio.GpioProviderBase

com.pi4j.gpio.extension.base.AdcGpioProviderBase

com.pi4j.gpio.extension.mcp.MCP3x0xGpioProvider

com.pi4j.gpio.extension.mcp.MCP3204GpioProvider

All Implemented Interfaces:

AdcGpioProvider, GpioProvider

public class MCP3204GpioProvider
extends MCP3x0xGpioProvider
implements AdcGpioProvider

This GPIO provider implements the MCP3204 SPI GPIO expansion board as native Pi4J GPIO pins. It is a 12-bit ADC providing 4 input channels.

The MCP3204 is connected via SPI connection to the Raspberry Pi and provides 4 GPIO pins that can be used for analog input pins. The values returned are in the range 0-4095 (12 bit value). Note: This implementation currently only supports single-ended inputs.

Author:

pojd, Hendrik Motza

Field Summary

Fields

Modifier and Type	Field and Description
static String	DESCRIPTION
static int	INPUT_COUNT
static String	NAME
static int	RESOLUTION

Fields inherited from class com.pi4j.gpio.extension.mcp.MCP3x0xGpioProvider

MAX_VALUE, MIN_VALUE

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
MCP3204GpioProvider(SpiChannel channel) Create new instance of this MCP3204 provider with background monitoring and pin notification events enabled.
MCP3204GpioProvider(SpiChannel channel, int speed) Create new instance of this MCP3204 provider with background monitoring and pin notification events enabled.
MCP3204GpioProvider(SpiChannel channel, int speed, SpiMode mode) Create new instance of this MCP3204 provider with background monitoring and pin notification events enabled.
MCP3204GpioProvider(SpiChannel channel, int speed, SpiMode mode, boolean enableBackgroundMonitoring) Create new instance of this MCP3204 provider.
MCP3204GpioProvider(SpiChannel channel, SpiMode mode) Create new instance of this MCP3204 provider with background monitoring and pin notification events enabled.

Method Summary

Modifier and Type	Method and Description
String	getName()

Methods inherited from class com.pi4j.gpio.extension.mcp.MCP3x0xGpioProvider

getImmediateValue, getMaxSupportedValue, getMinSupportedValue

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

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

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, getImmediateValue, getMaxSupportedValue, getMinSupportedValue, 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, shutdown, 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

INPUT_COUNT

public static final int INPUT_COUNT

See Also:

Constant Field Values

RESOLUTION

public static final int RESOLUTION

See Also:

Constant Field Values

Constructor Detail

MCP3204GpioProvider

public MCP3204GpioProvider(SpiChannel channel)
                    throws IOException

Create new instance of this MCP3204 provider with background monitoring and pin notification events enabled.

Parameters:

channel - spi channel the MCP3204 is connected to

Throws:

IOException - if an error occurs during initialization of the SpiDevice

MCP3204GpioProvider

public MCP3204GpioProvider(SpiChannel channel,
                           int speed)
                    throws IOException

Create new instance of this MCP3204 provider with background monitoring and pin notification events enabled.

Parameters:

channel - spi channel the MCP3204 is connected to

speed - spi speed to communicate with MCP3204

Throws:

IOException - if an error occurs during initialization of the SpiDevice

MCP3204GpioProvider

public MCP3204GpioProvider(SpiChannel channel,
                           SpiMode mode)
                    throws IOException

Create new instance of this MCP3204 provider with background monitoring and pin notification events enabled.

Parameters:

channel - spi channel the MCP3204 is connected to

mode - spi mode to communicate with MCP3204

Throws:

IOException - if an error occurs during initialization of the SpiDevice

MCP3204GpioProvider

public MCP3204GpioProvider(SpiChannel channel,
                           int speed,
                           SpiMode mode)
                    throws IOException

Create new instance of this MCP3204 provider with background monitoring and pin notification events enabled.

Parameters:

channel - spi channel the MCP3204 is connected to

speed - spi speed to communicate with MCP3204

mode - spi mode to communicate with MCP3204

Throws:

IOException - if an error occurs during initialization of the SpiDevice

MCP3204GpioProvider

public MCP3204GpioProvider(SpiChannel channel,
                           int speed,
                           SpiMode mode,
                           boolean enableBackgroundMonitoring)
                    throws IOException

Create new instance of this MCP3204 provider. Optionally enable or disable background monitoring and pin notification events.

Parameters:

channel - spi channel the MCP3204 is connected to

speed - spi speed to communicate with MCP3204

mode - spi mode to communicate with MCP3204

enableBackgroundMonitoring - if enabled, then a background thread will be created to constantly acquire the ADC input values and publish pin change listeners if the value change is beyond the configured threshold.

Throws:

IOException - if an error occurs during initialization of the SpiDevice

Method Detail

getName

public String getName()

Specified by:

getName in interface GpioProvider

Specified by:

getName in class GpioProviderBase