mcp230xx

CircuitPython module for the MCP23017 and MCP23008 I2C I/O extenders.

  • Author(s): Tony DiCola, Red_M (2021)
class adafruit_mcp230xx.mcp230xx.MCP230XX(bus_device, address, chip_select=None, baudrate=100000)

Base class for MCP230xx devices.

mcp23008

CircuitPython module for the MCP23008 I2C I/O extenders.

  • Author(s): Tony DiCola
class adafruit_mcp230xx.mcp23008.MCP23008(i2c, address=<sphinx.ext.autodoc.importer._MockObject object>, reset=True)

Supports MCP23008 instance on specified I2C bus and optionally at the specified I2C address.

get_pin(pin)

Convenience function to create an instance of the DigitalInOut class pointing at the specified pin of this MCP23008 device.

gpio

The raw GPIO output register. Each bit represents the output value of the associated pin (0 = low, 1 = high), assuming that pin has been configured as an output previously.

gppu

The raw GPPU pull-up register. Each bit represents if a pull-up is enabled on the specified pin (1 = pull-up enabled, 0 = pull-up disabled). Note pull-down resistors are NOT supported!

iodir

The raw IODIR direction register. Each bit represents direction of a pin, either 1 for an input or 0 for an output mode.

mcp23017

CircuitPython module for the MCP23017 I2C I/O extenders.

  • Author(s): Tony DiCola
class adafruit_mcp230xx.mcp23017.MCP23017(i2c, address=<sphinx.ext.autodoc.importer._MockObject object>, reset=True)

Supports MCP23017 instance on specified I2C bus and optionally at the specified I2C address.

clear_inta()

Clears port A interrupts.

clear_intb()

Clears port B interrupts.

clear_ints()

Clears interrupts by reading INTCAP.

default_value

The raw DEFVAL interrupt control register. The default comparison value is configured in the DEFVAL register. If enabled (via GPINTEN and INTCON) to compare against the DEFVAL register, an opposite value on the associated pin will cause an interrupt to occur.

get_pin(pin)

Convenience function to create an instance of the DigitalInOut class pointing at the specified pin of this MCP23017 device.

gpio

The raw GPIO output register. Each bit represents the output value of the associated pin (0 = low, 1 = high), assuming that pin has been configured as an output previously.

gpioa

The raw GPIO A output register. Each bit represents the output value of the associated pin (0 = low, 1 = high), assuming that pin has been configured as an output previously.

gpiob

The raw GPIO B output register. Each bit represents the output value of the associated pin (0 = low, 1 = high), assuming that pin has been configured as an output previously.

gppu

The raw GPPU pull-up register. Each bit represents if a pull-up is enabled on the specified pin (1 = pull-up enabled, 0 = pull-up disabled). Note pull-down resistors are NOT supported!

gppua

The raw GPPU A pull-up register. Each bit represents if a pull-up is enabled on the specified pin (1 = pull-up enabled, 0 = pull-up disabled). Note pull-down resistors are NOT supported!

gppub

The raw GPPU B pull-up register. Each bit represents if a pull-up is enabled on the specified pin (1 = pull-up enabled, 0 = pull-up disabled). Note pull-down resistors are NOT supported!

int_cap

Returns a list with the pin values at time of interrupt port A —-> pins 0-7 port B —-> pins 8-15

int_capa

Returns a list of pin values at time of interrupt pins: 0-7

int_capb

Returns a list of pin values at time of interrupt pins: 8-15

int_flag

Returns a list with the pin numbers that caused an interrupt port A —-> pins 0-7 port B —-> pins 8-15

int_flaga

Returns a list of pin numbers that caused an interrupt in port A pins: 0-7

int_flagb

Returns a list of pin numbers that caused an interrupt in port B pins: 8-15

interrupt_configuration

The raw INTCON interrupt control register. The INTCON register controls how the associated pin value is compared for the interrupt-on-change feature. If a bit is set, the corresponding I/O pin is compared against the associated bit in the DEFVAL register. If a bit value is clear, the corresponding I/O pin is compared against the previous value.

interrupt_enable

The raw GPINTEN interrupt control register. The GPINTEN register controls the interrupt-on-change feature for each pin. If a bit is set, the corresponding pin is enabled for interrupt-on-change. The DEFVAL and INTCON registers must also be configured if any pins are enabled for interrupt-on-change.

io_control

The raw IOCON configuration register. Bit 1 controls interrupt polarity (1 = active-high, 0 = active-low). Bit 2 is whether irq pin is open drain (1 = open drain, 0 = push-pull). Bit 3 is unused. Bit 4 is whether SDA slew rate is enabled (1 = yes). Bit 5 is if I2C address pointer auto-increments (1 = no). Bit 6 is whether interrupt pins are internally connected (1 = yes). Bit 7 is whether registers are all in one bank (1 = no), this is silently ignored if set to 1.

iodir

The raw IODIR direction register. Each bit represents direction of a pin, either 1 for an input or 0 for an output mode.

iodira

The raw IODIR A direction register. Each bit represents direction of a pin, either 1 for an input or 0 for an output mode.

iodirb

The raw IODIR B direction register. Each bit represents direction of a pin, either 1 for an input or 0 for an output mode.

ipol

The raw IPOL output register. Each bit represents the polarity value of the associated pin (0 = normal, 1 = inverted), assuming that pin has been configured as an input previously.

ipola

The raw IPOL A output register. Each bit represents the polarity value of the associated pin (0 = normal, 1 = inverted), assuming that pin has been configured as an input previously.

ipolb

The raw IPOL B output register. Each bit represents the polarity value of the associated pin (0 = normal, 1 = inverted), assuming that pin has been configured as an input previously.

mcp23sxx

CircuitPython module for the MCP23S17 SPI I/O extenders.

  • Author(s): Romy Bompart (2020), Red_M (2021)
class adafruit_mcp230xx.mcp23sxx.MCP23SXX(spi, address, chip_select, baudrate=100000)

Base class for MCP23Sxx devices.

MCP23S08

CircuitPython module for the MCP23S08 I2C I/O extenders.

  • Author(s): Tony DiCola, Romy Bompart (2020), Red_M (2021)
class adafruit_mcp230xx.mcp23s08.MCP23S08(spi, chip_select, address=<sphinx.ext.autodoc.importer._MockObject object>, reset=True, baudrate=100000)

Supports MCP23S08 instance on specified I2C bus and optionally at the specified I2C address.

get_pin(pin)

Convenience function to create an instance of the DigitalInOut class pointing at the specified pin of this MCP23S08 device.

gpio

The raw GPIO output register. Each bit represents the output value of the associated pin (0 = low, 1 = high), assuming that pin has been configured as an output previously.

gppu

The raw GPPU pull-up register. Each bit represents if a pull-up is enabled on the specified pin (1 = pull-up enabled, 0 = pull-up disabled). Note pull-down resistors are NOT supported!

iodir

The raw IODIR direction register. Each bit represents direction of a pin, either 1 for an input or 0 for an output mode.

MCP23S17

CircuitPython module for the MCP23S17 SPI I/O extenders.

  • Author(s): Tony DiCola, Romy Bompart (2020), Red_M (2021)
class adafruit_mcp230xx.mcp23s17.MCP23S17(spi, chip_select, address=<sphinx.ext.autodoc.importer._MockObject object>, reset=True, baudrate=100000)

Supports MCP23S17 instance on specified SPI bus and optionally at the specified SPI address.

clear_inta()

Clears port A interrupts.

clear_intb()

Clears port B interrupts.

clear_ints()

Clears interrupts by reading INTCAP.

default_value

The raw DEFVAL interrupt control register. The default comparison value is configured in the DEFVAL register. If enabled (via GPINTEN and INTCON) to compare against the DEFVAL register, an opposite value on the associated pin will cause an interrupt to occur.

get_pin(pin)

Convenience function to create an instance of the DigitalInOut class pointing at the specified pin of this MCP23S17 device.

gpio

The raw GPIO output register. Each bit represents the output value of the associated pin (0 = low, 1 = high), assuming that pin has been configured as an output previously.

gpioa

The raw GPIO A output register. Each bit represents the output value of the associated pin (0 = low, 1 = high), assuming that pin has been configured as an output previously.

gpiob

The raw GPIO B output register. Each bit represents the output value of the associated pin (0 = low, 1 = high), assuming that pin has been configured as an output previously.

gppu

The raw GPPU pull-up register. Each bit represents if a pull-up is enabled on the specified pin (1 = pull-up enabled, 0 = pull-up disabled). Note pull-down resistors are NOT supported!

gppua

The raw GPPU A pull-up register. Each bit represents if a pull-up is enabled on the specified pin (1 = pull-up enabled, 0 = pull-up disabled). Note pull-down resistors are NOT supported!

gppub

The raw GPPU B pull-up register. Each bit represents if a pull-up is enabled on the specified pin (1 = pull-up enabled, 0 = pull-up disabled). Note pull-down resistors are NOT supported!

int_flag

Returns a list with the pin numbers that caused an interrupt port A —-> pins 0-7 port B —-> pins 8-15

int_flaga

Returns a list of pin numbers that caused an interrupt in port A pins: 0-7

int_flagb

Returns a list of pin numbers that caused an interrupt in port B pins: 8-15

interrupt_configuration

The raw INTCON interrupt control register. The INTCON register controls how the associated pin value is compared for the interrupt-on-change feature. If a bit is set, the corresponding I/O pin is compared against the associated bit in the DEFVAL register. If a bit value is clear, the corresponding I/O pin is compared against the previous value.

interrupt_enable

The raw GPINTEN interrupt control register. The GPINTEN register controls the interrupt-on-change feature for each pin. If a bit is set, the corresponding pin is enabled for interrupt-on-change. The DEFVAL and INTCON registers must also be configured if any pins are enabled for interrupt-on-change.

io_control

The raw IOCON configuration register. Bit 1 controls interrupt polarity (1 = active-high, 0 = active-low). Bit 2 is whether irq pin is open drain (1 = open drain, 0 = push-pull). Bit 3 is unused. Bit 4 is whether SDA slew rate is enabled (1 = yes). Bit 5 is if SPI address pointer auto-increments (1 = no). Bit 6 is whether interrupt pins are internally connected (1 = yes). Bit 7 is whether registers are all in one bank (1 = no), this is silently ignored if set to 1.

iodir

The raw IODIR direction register. Each bit represents direction of a pin, either 1 for an input or 0 for an output mode.

iodira

The raw IODIR A direction register. Each bit represents direction of a pin, either 1 for an input or 0 for an output mode.

iodirb

The raw IODIR B direction register. Each bit represents direction of a pin, either 1 for an input or 0 for an output mode.

ipol

The raw IPOL output register. Each bit represents the polarity value of the associated pin (0 = normal, 1 = inverted), assuming that pin has been configured as an input previously.

ipola

The raw IPOL A output register. Each bit represents the polarity value of the associated pin (0 = normal, 1 = inverted), assuming that pin has been configured as an input previously.

ipolb

The raw IPOL B output register. Each bit represents the polarity value of the associated pin (0 = normal, 1 = inverted), assuming that pin has been configured as an input previously.

digital_inout

Digital input/output of the MCP230xx.

  • Author(s): Tony DiCola
class adafruit_mcp230xx.digital_inout.DigitalInOut(pin_number, mcp230xx)

Digital input/output of the MCP230xx. The interface is exactly the same as the digitalio.DigitalInOut class, however:

  • MCP230xx family does not support pull-down resistors;
  • MCP23016 does not support pull-up resistors.

Exceptions will be thrown when attempting to set unsupported pull configurations.

direction

The direction of the pin, either True for an input or False for an output.

invert_polarity

The polarity of the pin, either True for an Inverted or False for an normal.

pull

Enable or disable internal pull-up resistors for this pin. A value of digitalio.Pull.UP will enable a pull-up resistor, and None will disable it. Pull-down resistors are NOT supported!

switch_to_input(pull=None, invert_polarity=False, **kwargs)

Switch the pin state to a digital input with the provided starting pull-up resistor state (optional, no pull-up by default) and input polarity. Note that pull-down resistors are NOT supported!

switch_to_output(value=False, **kwargs)

Switch the pin state to a digital output with the provided starting value (True/False for high or low, default is False/low).

value

The value of the pin, either True for high or False for low. Note you must configure as an output or input appropriately before reading and writing this value.