circuitpython-gpio-expander 0.3.2
CircuitPython helper library for gpio expanders (Texas Instrument PCA95xx and TCA95xx chips).
License: MIT
Keywords: adafruit blinka circuitpython micropython gpio_expander gpio expander PCA9534 PCA9535 PCA9555 TCA9534 TCA9535 TCA9555

Introduction
============


.. image:: https://readthedocs.org/projects/circuitpython-gpio-expander/badge/?version=latest
    :target: https://circuitpython-gpio-expander.readthedocs.io/
    :alt: Documentation Status



.. image:: https://img.shields.io/discord/327254708534116352.svg
    :target: https://adafru.it/discord
    :alt: Discord


.. image:: https://github.com/gpongelli/CircuitPython_gpio_expander/workflows/Build%20CI/badge.svg
    :target: https://github.com/gpongelli/CircuitPython_gpio_expander/actions
    :alt: Build Status


.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
    :alt: Code Style: Black

CircuitPython helper library for gpio expanders (Texas Instrument PCA95xx and TCA95xx chips).


Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_

Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.

Installing to a Connected CircuitPython Device with Circup
==========================================================

Make sure that you have ``circup`` installed in your Python environment.
Install it with the following command if necessary:

.. code-block:: shell

    pip3 install circup

With ``circup`` installed and your CircuitPython device connected use the
following command to install:

.. code-block:: shell

    circup install gpio_expander

Or the following command to update an existing version:

.. code-block:: shell

    circup update

Usage Example
=============

.. code-block:: python

    import board

    from gpio_expander import PCA9555, PCA9534

    #######################
    # 16 bit I2C expander #
    #######################
    _pca9555 = PCA9555(board.I2C(), 0x20)

    # print input 0 bit 0 value; datasheet bit field's name has underscore in place of dot for 16 bit expander
    print(_pca9555.I0_0)

    # configure an output port and set its value
    _pca9555.C1_3 = 0
    _pca9555.O1_3 = 0

    # print entire configuration registry
    print(_pca9555.configuration_ports)

Documentation
=============
API documentation for this library can be found on `Read the Docs <https://circuitpython-gpio-expander.readthedocs.io/>`_.

For information on building library documentation, please check out
`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/gpongelli/CircuitPython_gpio_expander/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.