diff --git a/adafruit_mcp230xx/mcp23008.py b/adafruit_mcp230xx/mcp23008.py index 5ffc4e9..aaf3239 100644 --- a/adafruit_mcp230xx/mcp23008.py +++ b/adafruit_mcp230xx/mcp23008.py @@ -10,6 +10,15 @@ CircuitPython module for the MCP23008 I2C I/O extenders. * Author(s): Tony DiCola + +Implementation Notes +-------------------- + +**Hardware:** + +* `MCP23008 - i2c 8 input/output port expander + `_ + """ from micropython import const diff --git a/adafruit_mcp230xx/mcp23017.py b/adafruit_mcp230xx/mcp23017.py index 637a77c..6ffc056 100644 --- a/adafruit_mcp230xx/mcp23017.py +++ b/adafruit_mcp230xx/mcp23017.py @@ -12,6 +12,18 @@ CircuitPython module for the MCP23017 I2C I/O extenders. * Author(s): Tony DiCola + +Implementation Notes +-------------------- + +**Hardware:** + +* `MCP23017 - i2c 16 input/output port expander + `_ + +* `Adafruit MCP23017 I2C GPIO Expander Breakout - STEMMA QT / Qwiic + `_ + """ from micropython import const diff --git a/docs/api.rst b/docs/api.rst index f92e30a..181ba82 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,12 +4,18 @@ .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) .. use this format as the module name: "adafruit_foo.foo" +.. automodule:: adafruit_mcp230xx.mcp23xxx + :members: + .. automodule:: adafruit_mcp230xx.mcp230xx :members: .. automodule:: adafruit_mcp230xx.mcp23008 :members: +.. automodule:: adafruit_mcp230xx.mcp23016 + :members: + .. automodule:: adafruit_mcp230xx.mcp23017 :members: diff --git a/docs/examples.rst b/docs/examples.rst index 56a9367..ff6423c 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -7,6 +7,50 @@ Ensure your device works with this simple test. :caption: examples/mcp230xx_simpletest.py :linenos: +MCP23Sxx Simple test +--------------------- + +Simple demo of reading and writing the digital I/O of the MCP2300xx as if +they were native CircuitPython digital inputs/outputs. + .. literalinclude:: ../examples/mcp23Sxx_simpletest.py :caption: examples/mcp23Sxx_simpletest.py :linenos: + +MCP230xx Event detect interrupt +------------------------------- + +Example showing the event detect interrupt feature + + +.. literalinclude:: ../examples/mcp230xx_event_detect_interrupt.py + :caption: examples/mcp230xx_event_detect_interrupt.py + :linenos: + +MCP23Sxx Event detect interrupt +------------------------------- + +Example showing the event detect interrupt feature + + +.. literalinclude:: ../examples/mcp23Sxx_event_detect_interrupt.py + :caption: examples/mcp23Sxx_event_detect_interrupt.py + :linenos: + +MCP230xx LEDs and Buttons +------------------------------- + +LEDs and buttons example for the MCP230xx + +.. literalinclude:: ../examples/mcp230xx_leds_and_buttons.py + :caption: examples/mcp230xx_leds_and_buttons.py + :linenos: + +MCP23Sxx LEDs and Buttons +----------------------------- + +LEDs and buttons example for the MCP23Sxx + +.. literalinclude:: ../examples/mcp230xx_leds_and_buttons_irq.py + :caption: examples/mcp230xx_leds_and_buttons_irq.py + :linenos: