Introduction
============
.. image:: https://readthedocs.org/projects/circuitpython-i2c-expanders/badge/?version=latest
:target: https://circuitpython-i2c-expanders.readthedocs.io/
:alt: Documentation Status
.. image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/ilikecake/CircuitPython_I2C_Expanders/workflows/Build%20CI/badge.svg
:target: https://github.com/ilikecake/CircuitPython_I2C_Expanders/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
Drivers for various I2C GPIO expanders. The library does not require any libraries other than the standard install of circuit python. Once the exapander has been initialized, the pins can be defined and interacted with in the same way as GPIOs on the CPU.
This library currently supports
* PCA9555
* PCAL9555
* PCA9554
* PCAL9554
* PCA9538
* PCAL9538
Other expanders will likely be added over time as I use them.
Based on Adafruit's library for the `MCP230xx expanders <https://github.com/adafruit/Adafruit_CircuitPython_MCP230xx>`_
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>`_.
Installing from PyPI
=====================
.. note:: This library is not available on PyPI yet. Install documentation is included
as a standard element. Stay tuned for PyPI availability!
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 i2c_expanders
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
Take a look in the examples folder for a basic example of using this library.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://circuitpython-i2c-expanders.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/ilikecake/CircuitPython_I2C_Expanders/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "circuitpython-i2c-expanders",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,i2c_expanders,pca9555,pcal9555,pca9554,pcal9554,pca9538,pcal9538,i2c,expander,gpio",
"author": "",
"author_email": "Pat Satyshur <patrick@satyshur.net>",
"download_url": "https://files.pythonhosted.org/packages/6e/66/98ba5ac944b0322c2d9f38de4c0a915a801b6fda3dd1a8d41eaa99d9624f/circuitpython-i2c-expanders-1.0.0rc1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/circuitpython-i2c-expanders/badge/?version=latest\n :target: https://circuitpython-i2c-expanders.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/ilikecake/CircuitPython_I2C_Expanders/workflows/Build%20CI/badge.svg\n :target: https://github.com/ilikecake/CircuitPython_I2C_Expanders/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\nDrivers for various I2C GPIO expanders. The library does not require any libraries other than the standard install of circuit python. Once the exapander has been initialized, the pins can be defined and interacted with in the same way as GPIOs on the CPU.\n\nThis library currently supports\n\n* PCA9555\n* PCAL9555\n* PCA9554\n* PCAL9554\n* PCA9538\n* PCAL9538\n\nOther expanders will likely be added over time as I use them.\n\nBased on Adafruit's library for the `MCP230xx expanders <https://github.com/adafruit/Adafruit_CircuitPython_MCP230xx>`_\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\nInstalling from PyPI\n=====================\n.. note:: This library is not available on PyPI yet. Install documentation is included\n as a standard element. Stay tuned for PyPI availability!\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 i2c_expanders\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\nTake a look in the examples folder for a basic example of using this library.\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://circuitpython-i2c-expanders.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/ilikecake/CircuitPython_I2C_Expanders/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Drivers for various I2C GPIO expanders.",
"version": "1.0.0rc1",
"project_urls": {
"Homepage": "https://github.com/ilikecake/CircuitPython_I2C_Expanders"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"i2c_expanders",
"pca9555",
"pcal9555",
"pca9554",
"pcal9554",
"pca9538",
"pcal9538",
"i2c",
"expander",
"gpio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c6f75bdf9aa7b69d7385de759031d65207f99423a86249d8b931410c3c532f56",
"md5": "2ac8936a6eac0b4cce6e3fdbb1bf434d",
"sha256": "d165fcf6a15d01213578bb5c400ae57088f93e2616d4e42241b7e8fc3f7c46a9"
},
"downloads": -1,
"filename": "circuitpython_i2c_expanders-1.0.0rc1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2ac8936a6eac0b4cce6e3fdbb1bf434d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 23917,
"upload_time": "2024-01-07T17:58:31",
"upload_time_iso_8601": "2024-01-07T17:58:31.315525Z",
"url": "https://files.pythonhosted.org/packages/c6/f7/5bdf9aa7b69d7385de759031d65207f99423a86249d8b931410c3c532f56/circuitpython_i2c_expanders-1.0.0rc1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6e6698ba5ac944b0322c2d9f38de4c0a915a801b6fda3dd1a8d41eaa99d9624f",
"md5": "cd5411aeb62fa99e676f49a9b15ed4c6",
"sha256": "117be3e57515c3cdcb3affc2ae37905e20e0114ebe43548ad593f3af2a4e2871"
},
"downloads": -1,
"filename": "circuitpython-i2c-expanders-1.0.0rc1.tar.gz",
"has_sig": false,
"md5_digest": "cd5411aeb62fa99e676f49a9b15ed4c6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 35520,
"upload_time": "2024-01-07T17:58:32",
"upload_time_iso_8601": "2024-01-07T17:58:32.607701Z",
"url": "https://files.pythonhosted.org/packages/6e/66/98ba5ac944b0322c2d9f38de4c0a915a801b6fda3dd1a8d41eaa99d9624f/circuitpython-i2c-expanders-1.0.0rc1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-07 17:58:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ilikecake",
"github_project": "CircuitPython_I2C_Expanders",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "circuitpython-i2c-expanders"
}
JSON
