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.
Raw data
{
"_id": null,
"home_page": "https://github.com/gpongelli/CircuitPython_gpio_expander.git",
"name": "circuitpython-gpio-expander",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit blinka circuitpython micropython gpio_expander gpio expander PCA9534 PCA9535 PCA9555 TCA9534 TCA9535 TCA9555",
"author": "Gabriele Pongelli",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/d5/c0/7766b0bbcd4cef83ba702bc37690d41b5744c0e16f34e9fe8e789c2063ac/circuitpython-gpio-expander-0.3.2.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/circuitpython-gpio-expander/badge/?version=latest\n :target: https://circuitpython-gpio-expander.readthedocs.io/\n :alt: Documentation Status\n\n\n\n.. image:: https://img.shields.io/discord/327254708534116352.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/gpongelli/CircuitPython_gpio_expander/workflows/Build%20CI/badge.svg\n :target: https://github.com/gpongelli/CircuitPython_gpio_expander/actions\n :alt: Build Status\n\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nCircuitPython helper library for gpio expanders (Texas Instrument PCA95xx and TCA95xx chips).\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install gpio_expander\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import board\n\n from gpio_expander import PCA9555, PCA9534\n\n #######################\n # 16 bit I2C expander #\n #######################\n _pca9555 = PCA9555(board.I2C(), 0x20)\n\n # print input 0 bit 0 value; datasheet bit field's name has underscore in place of dot for 16 bit expander\n print(_pca9555.I0_0)\n\n # configure an output port and set its value\n _pca9555.C1_3 = 0\n _pca9555.O1_3 = 0\n\n # print entire configuration registry\n print(_pca9555.configuration_ports)\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://circuitpython-gpio-expander.readthedocs.io/>`_.\n\nFor information on building library documentation, please check out\n`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/gpongelli/CircuitPython_gpio_expander/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython helper library for gpio expanders (Texas Instrument PCA95xx and TCA95xx chips).",
"version": "0.3.2",
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"gpio_expander",
"gpio",
"expander",
"pca9534",
"pca9535",
"pca9555",
"tca9534",
"tca9535",
"tca9555"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d5c07766b0bbcd4cef83ba702bc37690d41b5744c0e16f34e9fe8e789c2063ac",
"md5": "45e3d1ce506764330fe12953d8096ba3",
"sha256": "38a4aa1d8f2bebbff9003be3ab2967beed4e034f697cc68cfdc05cb0f65cea25"
},
"downloads": -1,
"filename": "circuitpython-gpio-expander-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "45e3d1ce506764330fe12953d8096ba3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 67203,
"upload_time": "2023-02-02T11:43:18",
"upload_time_iso_8601": "2023-02-02T11:43:18.430782Z",
"url": "https://files.pythonhosted.org/packages/d5/c0/7766b0bbcd4cef83ba702bc37690d41b5744c0e16f34e9fe8e789c2063ac/circuitpython-gpio-expander-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-02 11:43:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "gpongelli",
"github_project": "CircuitPython_gpio_expander.git",
"lcname": "circuitpython-gpio-expander"
}
JSON
