Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gpongelli/circuitpython_gpio_expander

CircuitPython helper library for gpio expanders (Texas Instrument PCA95xx and TCA95xx chips).
https://github.com/gpongelli/circuitpython_gpio_expander

circuitpython-community circuitpython-community-bundle gpio-expander gpio-extender python3

Last synced: 7 days ago
JSON representation

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

Awesome Lists containing this project

README

        

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 `_
* `Bus Device `_
* `Register `_

Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle `_
or individual libraries can be installed using
`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 `_.

For information on building library documentation, please check out
`this guide `_.

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

Contributions are welcome! Please read our `Code of Conduct
`_
before contributing to help this project stay welcoming.