Skip to content

Commit 28dea2c

Browse files
committed
updating_docs
1 parent 5ecd32a commit 28dea2c

File tree

4 files changed

+71
-0
lines changed

4 files changed

+71
-0
lines changed

adafruit_mcp230xx/mcp23008.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,15 @@
1010
CircuitPython module for the MCP23008 I2C I/O extenders.
1111
1212
* Author(s): Tony DiCola
13+
14+
Implementation Notes
15+
--------------------
16+
17+
**Hardware:**
18+
19+
* `MCP23008 - i2c 8 input/output port expander
20+
<https://www.adafruit.com/product/593>`_
21+
1322
"""
1423

1524
from micropython import const

adafruit_mcp230xx/mcp23017.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,18 @@
1212
CircuitPython module for the MCP23017 I2C I/O extenders.
1313
1414
* Author(s): Tony DiCola
15+
16+
Implementation Notes
17+
--------------------
18+
19+
**Hardware:**
20+
21+
* `MCP23017 - i2c 16 input/output port expander
22+
<https://www.adafruit.com/product/732>`_
23+
24+
* `Adafruit MCP23017 I2C GPIO Expander Breakout - STEMMA QT / Qwiic
25+
<https://www.adafruit.com/product/5346>`_
26+
1527
"""
1628

1729
from micropython import const

docs/api.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,18 @@
44
.. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
55
.. use this format as the module name: "adafruit_foo.foo"
66
7+
.. automodule:: adafruit_mcp230xx.mcp23xxx
8+
:members:
9+
710
.. automodule:: adafruit_mcp230xx.mcp230xx
811
:members:
912

1013
.. automodule:: adafruit_mcp230xx.mcp23008
1114
:members:
1215

16+
.. automodule:: adafruit_mcp230xx.mcp23016
17+
:members:
18+
1319
.. automodule:: adafruit_mcp230xx.mcp23017
1420
:members:
1521

docs/examples.rst

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,50 @@ Ensure your device works with this simple test.
77
:caption: examples/mcp230xx_simpletest.py
88
:linenos:
99

10+
MCP23Sxx Simple test
11+
---------------------
12+
13+
Simple demo of reading and writing the digital I/O of the MCP2300xx as if
14+
they were native CircuitPython digital inputs/outputs.
15+
1016
.. literalinclude:: ../examples/mcp23Sxx_simpletest.py
1117
:caption: examples/mcp23Sxx_simpletest.py
1218
:linenos:
19+
20+
MCP230xx Event detect interrupt
21+
-------------------------------
22+
23+
Example showing the event detect interrupt feature
24+
25+
26+
.. literalinclude:: ../examples/mcp230xx_event_detect_interrupt.py
27+
:caption: examples/mcp230xx_event_detect_interrupt.py
28+
:linenos:
29+
30+
MCP23Sxx Event detect interrupt
31+
-------------------------------
32+
33+
Example showing the event detect interrupt feature
34+
35+
36+
.. literalinclude:: ../examples/mcp23Sxx_event_detect_interrupt.py
37+
:caption: examples/mcp23Sxx_event_detect_interrupt.py
38+
:linenos:
39+
40+
MCP230xx LEDs and Buttons
41+
-------------------------------
42+
43+
LEDs and buttons example for the MCP230xx
44+
45+
.. literalinclude:: ../examples/mcp230xx_leds_and_buttons.py
46+
:caption: examples/mcp230xx_leds_and_buttons.py
47+
:linenos:
48+
49+
MCP23Sxx LEDs and Buttons
50+
-----------------------------
51+
52+
LEDs and buttons example for the MCP23Sxx
53+
54+
.. literalinclude:: ../examples/mcp230xx_leds_and_buttons_irq.py
55+
:caption: examples/mcp230xx_leds_and_buttons_irq.py
56+
:linenos:

0 commit comments

Comments
 (0)