adafruit-circuitpython-pca9554


Nameadafruit-circuitpython-pca9554 JSON
Version 1.0.1 PyPI version JSON
download
home_page
SummaryCircuitPython library for Adafruit PCA9554 GPIO expanders
upload_time2023-10-31 22:11:06
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords adafruit blinka circuitpython micropython pca9554 pca9554 gpio expander
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============


.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pca9554/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/pca9554/en/latest/
    :alt: Documentation Status


.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
    :target: https://adafru.it/discord
    :alt: Discord


.. image:: https://github.com/adafruit/Adafruit_CircuitPython_PCA9554/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_PCA9554/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 library for Adafruit PCA9554 GPIO expanders


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

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

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>`_.

* Adafruit Qualia ESP32-S3 for TTL RGB-666 Displays

`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5800>`_

Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-pca9554/>`_.
To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-pca9554

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-pca9554

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name
    python3 -m venv .venv
    source .env/bin/activate
    pip3 install adafruit-circuitpython-pca9554

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 adafruit_pca9554

Or the following command to update an existing version:

.. code-block:: shell

    circup update

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

.. code-block:: python

    import time
    import board
    import digitalio
    import adafruit_pca9554

    board.I2C().deinit()
    i2c = board.I2C()
    tft_io_expander = dict(board.TFT_IO_EXPANDER)

    pcf = adafruit_pca9554.PCA9554(i2c, address=tft_io_expander['i2c_address'])
    button_up = pcf.get_pin(board.BTN_UP)
    button_up.switch_to_input(pull=digitalio.Pull.UP)

    while True:
        print(button_up.value)
        time.sleep(0.01)  # debounce

Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/pca9554/en/latest/>`_.

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/adafruit/Adafruit_CircuitPython_PCA9554/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "adafruit-circuitpython-pca9554",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "adafruit,blinka,circuitpython,micropython,pca9554,PCA9554,gpio,expander",
    "author": "",
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/36/ae/41862e7e6ccb9970b80650334f7dd3dc08886d2349f2179c5d192f5154d0/adafruit-circuitpython-pca9554-1.0.1.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pca9554/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/pca9554/en/latest/\n    :alt: Documentation Status\n\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n    :target: https://adafru.it/discord\n    :alt: Discord\n\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_PCA9554/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_PCA9554/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 library for Adafruit PCA9554 GPIO expanders\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\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\n* Adafruit Qualia ESP32-S3 for TTL RGB-666 Displays\n\n`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5800>`_\n\nInstalling from PyPI\n=====================\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-pca9554/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-pca9554\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-pca9554\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n    mkdir project-name && cd project-name\n    python3 -m venv .venv\n    source .env/bin/activate\n    pip3 install adafruit-circuitpython-pca9554\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 adafruit_pca9554\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 time\n    import board\n    import digitalio\n    import adafruit_pca9554\n\n    board.I2C().deinit()\n    i2c = board.I2C()\n    tft_io_expander = dict(board.TFT_IO_EXPANDER)\n\n    pcf = adafruit_pca9554.PCA9554(i2c, address=tft_io_expander['i2c_address'])\n    button_up = pcf.get_pin(board.BTN_UP)\n    button_up.switch_to_input(pull=digitalio.Pull.UP)\n\n    while True:\n        print(button_up.value)\n        time.sleep(0.01)  # debounce\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/pca9554/en/latest/>`_.\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/adafruit/Adafruit_CircuitPython_PCA9554/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CircuitPython library for Adafruit PCA9554 GPIO expanders",
    "version": "1.0.1",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_PCA9554"
    },
    "split_keywords": [
        "adafruit",
        "blinka",
        "circuitpython",
        "micropython",
        "pca9554",
        "pca9554",
        "gpio",
        "expander"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ece93b4c39e2ba29309cfa94994bd54de0c7ac4a40ab5eef70408f5334d2f203",
                "md5": "2d94e39f44bb6891914e35ada1030cdd",
                "sha256": "0dab694763a44e9208bb427314f83df034ef450747371666430a52dc2fd60da6"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_pca9554-1.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2d94e39f44bb6891914e35ada1030cdd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 6243,
            "upload_time": "2023-10-31T22:11:04",
            "upload_time_iso_8601": "2023-10-31T22:11:04.961207Z",
            "url": "https://files.pythonhosted.org/packages/ec/e9/3b4c39e2ba29309cfa94994bd54de0c7ac4a40ab5eef70408f5334d2f203/adafruit_circuitpython_pca9554-1.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "36ae41862e7e6ccb9970b80650334f7dd3dc08886d2349f2179c5d192f5154d0",
                "md5": "be50d1cd98106f473aaea4c35541b96f",
                "sha256": "be53f3f0e24e7ca92190b75290b2a79a86109dc5cb84baf08fe9a2f2be6bce1e"
            },
            "downloads": -1,
            "filename": "adafruit-circuitpython-pca9554-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "be50d1cd98106f473aaea4c35541b96f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 27468,
            "upload_time": "2023-10-31T22:11:06",
            "upload_time_iso_8601": "2023-10-31T22:11:06.398024Z",
            "url": "https://files.pythonhosted.org/packages/36/ae/41862e7e6ccb9970b80650334f7dd3dc08886d2349f2179c5d192f5154d0/adafruit-circuitpython-pca9554-1.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-31 22:11:06",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_PCA9554",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "adafruit-circuitpython-pca9554"
}
        
Elapsed time: 0.13333s