Skip to content

Commit 840e24b

Browse files
committed
Doc fixes
1 parent 7e42b44 commit 840e24b

File tree

4 files changed

+45
-28
lines changed

4 files changed

+45
-28
lines changed

docs/api.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,17 @@
1313
.. automodule:: i2c_expanders.digital_inout
1414
:members:
1515

16+
.. automodule:: i2c_expanders.helpers
17+
:members:
18+
1619
.. automodule:: i2c_expanders.PCA9555
1720
:members:
21+
22+
.. automodule:: i2c_expanders.PCAL9555
23+
:members:
24+
25+
.. automodule:: i2c_expanders.PCA9554
26+
:members:
27+
28+
.. automodule:: i2c_expanders.PCAL9554
29+
:members:

i2c_expanders/PCA9554.py

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,19 @@
99

1010
# TODO: mostly a copy/paste from the PCA9555, make sure this stuff is still true here.
1111
"""
12-
`pca9554`
12+
`PCA9554`
1313
====================================================
1414
1515
CircuitPython module for the PCA9554 and compatible expanders.
1616
The PCA9554 is a basic 8 pin I2C expander.
17-
*Configurable pins as input or output
18-
*Per pin polarity inversion. This inverts the value that is returned when an input port
19-
is read. Does not affect the pins set as outputs.
20-
*Pin change interrupts. An interrupt is generated on any pin change for a pin configured
21-
as an input. The interrupt signal is cleared by a change back to the original value of
22-
the input pin or a read to the GPIO register.This will have to be detected and tracked in
23-
user code. There is no way to tell from the device what pin caused the interrupt.
17+
18+
* Configurable pins as input or output
19+
* Per pin polarity inversion. This inverts the value that is returned when an input port
20+
is read. Does not affect the pins set as outputs.
21+
* Pin change interrupts. An interrupt is generated on any pin change for a pin configured
22+
as an input. The interrupt signal is cleared by a change back to the original value of
23+
the input pin or a read to the GPIO register.This will have to be detected and tracked in
24+
user code. There is no way to tell from the device what pin caused the interrupt.
2425
2526
Use this class if you are using a PCA9554 or compatible expander. This class is also used
2627
as the base class for the PCAL9554 expander.
@@ -30,9 +31,10 @@
3031
supported. A list of other devices that should be compatible is below.
3132
3233
Compatible Devices
33-
*PCA9554
34-
*PCA9538
35-
*TODO
34+
35+
* PCA9554
36+
* PCA9538
37+
* TODO
3638
3739
Heavily based on the code written by Tony DiCola for the MCP230xx library.
3840

i2c_expanders/PCAL9554.py

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,30 @@
88

99
# TODO: mostly a copy/paste from the PCAL9555, make sure this stuff is still true here.
1010
"""
11-
`pcal9554`
11+
`PCAL9554`
1212
====================================================
1313
1414
CircuitPython module for the PCAL9554 I2C I/O extenders.
1515
The PCAL9554 is a 8 pin IO Expander. It is software compatible with the PCA9554, but has a
1616
bunch of added functions.
1717
1818
Added features of these expanders include:
19-
*Built in pull up and pull down resistors.
20-
*Per pin selectable drive strength.
21-
*Maskable interrupt pins
22-
*Latching interrupt option
23-
*Per bank push-pull/open drain pin setup.
19+
20+
* Built in pull up and pull down resistors.
21+
* Per pin selectable drive strength.
22+
* Maskable interrupt pins
23+
* Latching interrupt option
24+
* Per bank push-pull/open drain pin setup.
2425
2526
There are likely other devices that use this same command set and can be used with this class.
2627
Where I find them, I will probably make a separate class name to make it obvious what devices are
2728
supported. A list of other devices that should be compatible is below.
2829
2930
Compatible Devices
30-
*PCAL9554
31-
*PCAL9538
32-
*TODO
31+
32+
* PCAL9554
33+
* PCAL9538
34+
* TODO
3335
3436
Heavily based on the code written by Tony DiCola for the MCP230xx library.
3537

i2c_expanders/PCAL9555.py

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,28 @@
77
# pylint: disable=too-many-public-methods
88

99
"""
10-
`pcal9555`
10+
`PCAL9555`
1111
====================================================
1212
1313
CircuitPython module for the PCAL9555 I2C I/O extenders.
1414
The PCAL9555 is a 16 pin IO Expander. It is software compatible with the PCA9555, but has a
1515
bunch of added functions.
1616
1717
Added features of these expanders include:
18-
*Built in pull up and pull down resistors.
19-
*Per pin selectable drive strength.
20-
*Maskable interrupt pins
21-
*Latching interrupt option
22-
*Per bank push-pull/open drain pin setup.
18+
19+
* Built in pull up and pull down resistors.
20+
* Per pin selectable drive strength.
21+
* Maskable interrupt pins
22+
* Latching interrupt option
23+
* Per bank push-pull/open drain pin setup.
2324
2425
There are likely other devices that use this same command set and can be used with this class.
2526
Where I find them, I will probably make a separate class name to make it obvious what devices are
2627
supported. A list of other devices that should be compatible is below.
2728
2829
Compatible Devices
29-
*PCAL9555
30-
*TODO
30+
* PCAL9555
31+
* TODO
3132
3233
Heavily based on the code written by Tony DiCola for the MCP230xx library.
3334

0 commit comments

Comments
 (0)