MCP23xxx (Device I/O Zero - Core 0.12 API)

java.lang.Object

com.diozero.internal.provider.AbstractDeviceFactory

com.diozero.internal.provider.mcp23xxx.MCP23xxx

All Implemented Interfaces:: GpioExpander, InputEventListener<DigitalInputEvent>, DeviceFactoryInterface, GpioDeviceFactoryInterface, PwmOutputDeviceFactoryInterface, java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:: MCP23x08, MCP23x17

public abstract class MCP23xxx
extends AbstractDeviceFactory
implements GpioDeviceFactoryInterface, PwmOutputDeviceFactoryInterface, InputEventListener<DigitalInputEvent>, GpioExpander

Support for both MCP23008 and MCP23017 GPIO expansion boards.

Field Summary

Fields

Modifier and Type Field Description

static int INTERRUPT_GPIO_NOT_SET

Fields inherited from class com.diozero.internal.provider.AbstractDeviceFactory
closed, deviceStates

Constructor Summary

Constructors
Constructor	Description
`MCP23xxx(int numPorts, java.lang.String deviceName)`
`MCP23xxx(int numPorts, java.lang.String deviceName, int interruptGpio)`
`MCP23xxx(int numPorts, java.lang.String deviceName, int interruptGpioA, int interruptGpioB)`

Method Summary

Modifier and Type	Method	Description
`void`	`close()`
`void`	`closeGpio(int gpio)`
`GpioDigitalInputDeviceInterface`	`createDigitalInputDevice(java.lang.String key, PinInfo pin_info, GpioPullUpDown pud, GpioEventTrigger trigger)`
`GpioDigitalInputOutputDeviceInterface`	`createDigitalInputOutputDevice(java.lang.String key, PinInfo pin_info, DeviceMode mode)`
`GpioDigitalOutputDeviceInterface`	`createDigitalOutputDevice(java.lang.String key, PinInfo pin_info, boolean initialValue)`
`PwmOutputDeviceInterface`	`createPwmOutputDevice(java.lang.String key, PinInfo pinInfo, int pwmFrequency, float initialValue)`
`int`	`getBoardPwmFrequency()`
`protected abstract int`	`getDefValReg(int port)`
`protected abstract int`	`getGPIntEnReg(int port)`
`protected abstract int`	`getGPIOReg(int port)`
`protected abstract int`	`getGPPullUpReg(int port)`
`protected abstract int`	`getIntCapReg(int port)`
`protected abstract int`	`getIntConReg(int port)`
`protected abstract int`	`getIntFReg(int port)`
`protected abstract int`	`getIOConReg(int port)`
`protected abstract int`	`getIODirReg(int port)`
`protected abstract int`	`getIPolReg(int port)`
`java.lang.String`	`getName()`
`protected abstract int`	`getOLatReg(int port)`
`boolean`	`getValue(int gpio)`
`byte`	`getValues(int port)`
`protected void`	`initialise()`
`protected abstract byte`	`readByte(int register)`
`void`	`setBoardPwmFrequency(int frequency)`
`void`	`setDirections(int port, byte directions)`
`protected void`	`setInputMode(int gpio, GpioPullUpDown pud, GpioEventTrigger trigger)`
`protected void`	`setOutputMode(int gpio)`
`void`	`setValue(int gpio, boolean value)`
`void`	`setValues(int port, byte values)`
`void`	`valueChanged(DigitalInputEvent event)`
`protected abstract void`	`writeByte(int register, byte value)`

Methods inherited from class com.diozero.internal.provider.AbstractDeviceFactory

createI2CKey, createPinKey, createSpiKey, deviceClosed, deviceOpened, getDevice, getDevice, isClosed, isDeviceOpened

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.diozero.internal.provider.DeviceFactoryInterface

createI2CKey, createPinKey, createSpiKey, deviceClosed, deviceOpened, getBoardPinInfo, getDevice, getDevice, isClosed, isDeviceOpened

Methods inherited from interface com.diozero.internal.provider.GpioDeviceFactoryInterface

provisionDigitalInputDevice, provisionDigitalInputOutputDevice, provisionDigitalOutputDevice

Methods inherited from interface com.diozero.internal.provider.PwmOutputDeviceFactoryInterface

provisionPwmOutputDevice

Field Details
- INTERRUPT_GPIO_NOT_SET
  
  public static final int INTERRUPT_GPIO_NOT_SET
  
  See Also:
  
  Constant Field Values
Constructor Details
- MCP23xxx
  
  public MCP23xxx(int numPorts, java.lang.String deviceName) throws RuntimeIOException
  
  Throws:
  
  RuntimeIOException
- MCP23xxx
  
  public MCP23xxx(int numPorts, java.lang.String deviceName, int interruptGpio) throws RuntimeIOException
  
  Throws:
  
  RuntimeIOException
- MCP23xxx
  
  public MCP23xxx(int numPorts, java.lang.String deviceName, int interruptGpioA, int interruptGpioB) throws RuntimeIOException
  
  Throws:
  
  RuntimeIOException
Method Details
- getName
  
  public final java.lang.String getName()
  
  Specified by:
  
  getName in interface DeviceFactoryInterface
- initialise
  
  protected final void initialise()
- createDigitalInputDevice
  
  public GpioDigitalInputDeviceInterface createDigitalInputDevice(java.lang.String key, PinInfo pin_info, GpioPullUpDown pud, GpioEventTrigger trigger)
  
  Specified by:
  
  createDigitalInputDevice in interface GpioDeviceFactoryInterface
- createDigitalOutputDevice
  
  public GpioDigitalOutputDeviceInterface createDigitalOutputDevice(java.lang.String key, PinInfo pin_info, boolean initialValue)
  
  Specified by:
  
  createDigitalOutputDevice in interface GpioDeviceFactoryInterface
- createDigitalInputOutputDevice
  
  public GpioDigitalInputOutputDeviceInterface createDigitalInputOutputDevice(java.lang.String key, PinInfo pin_info, DeviceMode mode)
  
  Specified by:
  
  createDigitalInputOutputDevice in interface GpioDeviceFactoryInterface
- createPwmOutputDevice
  
  public PwmOutputDeviceInterface createPwmOutputDevice(java.lang.String key, PinInfo pinInfo, int pwmFrequency, float initialValue)
  
  Specified by:
  
  createPwmOutputDevice in interface PwmOutputDeviceFactoryInterface
- getBoardPwmFrequency
  
  public int getBoardPwmFrequency()
  
  Specified by:
  
  getBoardPwmFrequency in interface PwmOutputDeviceFactoryInterface
- setBoardPwmFrequency
  
  public void setBoardPwmFrequency(int frequency)
  
  Specified by:
  
  setBoardPwmFrequency in interface PwmOutputDeviceFactoryInterface
- setInputMode
  
  protected void setInputMode(int gpio, GpioPullUpDown pud, GpioEventTrigger trigger)
- setOutputMode
  
  protected void setOutputMode(int gpio)
- getValue
  
  public boolean getValue(int gpio) throws RuntimeIOException
  
  Throws:
  
  RuntimeIOException
- setValue
  
  public void setValue(int gpio, boolean value) throws RuntimeIOException
  
  Throws:
  
  RuntimeIOException
- close
  
  public void close() throws RuntimeIOException
  
  Specified by:
  
  close in interface java.lang.AutoCloseable
  
  Specified by:
  
  close in interface java.io.Closeable
  
  Specified by:
  
  close in interface DeviceFactoryInterface
  
  Specified by:
  
  close in interface GpioExpander
  
  Overrides:
  
  close in class AbstractDeviceFactory
  
  Throws:
  
  RuntimeIOException
- closeGpio
  
  public void closeGpio(int gpio) throws RuntimeIOException
  
  Throws:
  
  RuntimeIOException
- valueChanged
  
  public void valueChanged(DigitalInputEvent event)
  
  Specified by:
  
  valueChanged in interface InputEventListener<DigitalInputEvent>
- getIODirReg
  
  protected abstract int getIODirReg(int port)
- getIPolReg
  
  protected abstract int getIPolReg(int port)
- getGPIntEnReg
  
  protected abstract int getGPIntEnReg(int port)
- getDefValReg
  
  protected abstract int getDefValReg(int port)
- getIntConReg
  
  protected abstract int getIntConReg(int port)
- getIOConReg
  
  protected abstract int getIOConReg(int port)
- getGPPullUpReg
  
  protected abstract int getGPPullUpReg(int port)
- getIntFReg
  
  protected abstract int getIntFReg(int port)
- getIntCapReg
  
  protected abstract int getIntCapReg(int port)
- getGPIOReg
  
  protected abstract int getGPIOReg(int port)
- getOLatReg
  
  protected abstract int getOLatReg(int port)
- readByte
  
  protected abstract byte readByte(int register)
- writeByte
  
  protected abstract void writeByte(int register, byte value)
- setDirections
  
  public final void setDirections(int port, byte directions)
  
  Specified by:
  
  setDirections in interface GpioExpander
- getValues
  
  public byte getValues(int port)
- setValues
  
  public final void setValues(int port, byte values)
  
  Specified by:
  
  setValues in interface GpioExpander