com.pi4j.gpio.extension.mcp

Class MCP23S17GpioProvider

java.lang.Object

com.pi4j.io.gpio.GpioProviderBase

com.pi4j.gpio.extension.mcp.MCP23S17GpioProvider

All Implemented Interfaces:

GpioProvider

public class MCP23S17GpioProvider
extends GpioProviderBase
implements GpioProvider

This GPIO provider implements the MCP23S17 SPI GPIO expansion board as native Pi4J GPIO pins. More information about the board can be found here: * http://ww1.microchip.com/downloads/en/DeviceDoc/21952b.pdf

The MCP23S17 is connected via SPI connection to the Raspberry Pi and provides 16 GPIO pins that can be used for either digital input or digital output pins.

Author:

Robert Savage

Field Summary

Fields

Modifier and Type	Field and Description
static byte	ADDRESS_0
static byte	ADDRESS_1
static byte	ADDRESS_2
static byte	ADDRESS_3
static byte	ADDRESS_4
static byte	ADDRESS_5
static byte	ADDRESS_6
static byte	ADDRESS_7
static byte	DEFAULT_ADDRESS
static String	DESCRIPTION
static String	NAME
static byte	READ_FLAG
static int	SPI_SPEED
static byte	WRITE_FLAG

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

cache, DEFAULT_CACHE_SIZE, isshutdown, listeners

Constructor Summary

Constructors

Constructor and Description
MCP23S17GpioProvider(byte spiAddress, int spiChannel)
MCP23S17GpioProvider(byte spiAddress, int spiChannel, int spiSpeed)
MCP23S17GpioProvider(byte spiAddress, int spiChannel, int spiSpeed, byte iocon)
MCP23S17GpioProvider(byte spiAddress, SpiChannel spiChannel)
MCP23S17GpioProvider(byte spiAddress, SpiChannel spiChannel, int spiSpeed)
MCP23S17GpioProvider(byte spiAddress, SpiChannel spiChannel, int spiSpeed, byte iocon)

Method Summary

Modifier and Type	Method and Description
void	export(Pin pin, PinMode mode)
PinMode	getMode(Pin pin)
String	getName()
PinPullResistance	getPullResistance(Pin pin)
PinState	getState(Pin pin)
protected int	read(byte register)
void	setMode(Pin pin, PinMode mode)
void	setPullResistance(Pin pin, PinPullResistance resistance)
void	setState(Pin pin, PinState state)
void	shutdown()
void	unexport(Pin pin)
protected void	write(byte register, byte data)

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

addListener, dispatchPinAnalogValueChangeEvent, dispatchPinDigitalStateChangeEvent, export, getPinCache, getPwm, getValue, hasPin, isExported, isShutdown, removeAllListeners, removeListener, setPwm, setPwmRange, setValue

Methods inherited from class java.lang.Object

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

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

addListener, export, getPwm, getValue, hasPin, isExported, isShutdown, removeAllListeners, removeListener, setPwm, setPwmRange, setValue

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

Constant Field Values

ADDRESS_0

public static final byte ADDRESS_0

See Also:

Constant Field Values

ADDRESS_1

public static final byte ADDRESS_1

See Also:

Constant Field Values

ADDRESS_2

public static final byte ADDRESS_2

See Also:

Constant Field Values

ADDRESS_3

public static final byte ADDRESS_3

See Also:

Constant Field Values

ADDRESS_4

public static final byte ADDRESS_4

See Also:

Constant Field Values

ADDRESS_5

public static final byte ADDRESS_5

See Also:

Constant Field Values

ADDRESS_6

public static final byte ADDRESS_6

See Also:

Constant Field Values

ADDRESS_7

public static final byte ADDRESS_7

See Also:

Constant Field Values

DEFAULT_ADDRESS

public static final byte DEFAULT_ADDRESS

See Also:

Constant Field Values

SPI_SPEED

public static final int SPI_SPEED

See Also:

Constant Field Values

WRITE_FLAG

public static final byte WRITE_FLAG

See Also:

Constant Field Values

READ_FLAG

public static final byte READ_FLAG

See Also:

Constant Field Values

Constructor Detail

MCP23S17GpioProvider

public MCP23S17GpioProvider(byte spiAddress,
                            int spiChannel)
                     throws IOException

Throws:

IOException

MCP23S17GpioProvider

public MCP23S17GpioProvider(byte spiAddress,
                            SpiChannel spiChannel)
                     throws IOException

Throws:

IOException

MCP23S17GpioProvider

public MCP23S17GpioProvider(byte spiAddress,
                            int spiChannel,
                            int spiSpeed)
                     throws IOException

Throws:

IOException

MCP23S17GpioProvider

public MCP23S17GpioProvider(byte spiAddress,
                            SpiChannel spiChannel,
                            int spiSpeed)
                     throws IOException

Throws:

IOException

MCP23S17GpioProvider

public MCP23S17GpioProvider(byte spiAddress,
                            int spiChannel,
                            int spiSpeed,
                            byte iocon)
                     throws IOException

Throws:

IOException

MCP23S17GpioProvider

public MCP23S17GpioProvider(byte spiAddress,
                            SpiChannel spiChannel,
                            int spiSpeed,
                            byte iocon)
                     throws IOException

Throws:

IOException

Method Detail

write

protected void write(byte register,
                     byte data)
              throws IOException

Throws:

IOException

read

protected int read(byte register)
            throws IOException

Throws:

IOException

getName

public String getName()

Specified by:

getName in interface GpioProvider

Specified by:

getName in class GpioProviderBase

export

public void export(Pin pin,
                   PinMode mode)

Specified by:

export in interface GpioProvider

Overrides:

export in class GpioProviderBase

unexport

public void unexport(Pin pin)

Specified by:

unexport in interface GpioProvider

Overrides:

unexport in class GpioProviderBase

setMode

public void setMode(Pin pin,
                    PinMode mode)

Specified by:

setMode in interface GpioProvider

Overrides:

setMode in class GpioProviderBase

getMode

public PinMode getMode(Pin pin)

Specified by:

getMode in interface GpioProvider

Overrides:

getMode in class GpioProviderBase

setState

public void setState(Pin pin,
                     PinState state)

Specified by:

setState in interface GpioProvider

Overrides:

setState in class GpioProviderBase

getState

public PinState getState(Pin pin)

Specified by:

getState in interface GpioProvider

Overrides:

getState in class GpioProviderBase

setPullResistance

public void setPullResistance(Pin pin,
                              PinPullResistance resistance)

Specified by:

setPullResistance in interface GpioProvider

Overrides:

setPullResistance in class GpioProviderBase

getPullResistance

public PinPullResistance getPullResistance(Pin pin)

Specified by:

getPullResistance in interface GpioProvider

Overrides:

getPullResistance in class GpioProviderBase

shutdown

public void shutdown()

Specified by:

shutdown in interface GpioProvider

Overrides:

shutdown in class GpioProviderBase