Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-mcp230xx/badge/?version=latest
:target: https://docs.circuitpython.org/projects/mcp230xx/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_MCP230xx/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_MCP230xx/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 module for the MCP23017/08 I2C and MCP23S17/08 SPI I/O extenders.
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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
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-mcp230xx/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-mcp230xx
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-mcp230xx
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-mcp230xx
Usage Example
=============
See examples/mcp230xx_simpletest.py for a demo of the usage.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/mcp230xx/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>`_.
Warning
=======
Some people have reported an undocumented bug that can potentially corrupt the I2C bus.
It occurs if an MCP230XX input pin state changes during I2C readout. **This should be very rare.** For more information, see this `forum post <https://www.microchip.com/forums/m646539.aspx>`_ and this `knowledge base article <https://microchipsupport.force.com/s/article/On-MCP23008-MCP23017-SDA-line-change-when-GPIO7-input-change>`_ .
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_MCP230xx/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-mcp230xx",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, mcp23017, mcp23008, i2c, gpio, expander, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/b7/1e/3806ce56649a46d7fd455d39ce0f0f2ecc747012490e9e75d71a54bf6678/adafruit_circuitpython_mcp230xx-2.5.15.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-mcp230xx/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/mcp230xx/en/latest/\n :alt: Documentation Status\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.. image:: https://github.com/adafruit/Adafruit_CircuitPython_MCP230xx/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_MCP230xx/actions/\n :alt: Build Status\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 module for the MCP23017/08 I2C and MCP23S17/08 SPI I/O extenders.\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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-mcp230xx/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-mcp230xx\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-mcp230xx\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 .venv/bin/activate\n pip3 install adafruit-circuitpython-mcp230xx\n\nUsage Example\n=============\n\nSee examples/mcp230xx_simpletest.py for a demo of the usage.\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/mcp230xx/en/latest/>`_.\n\nFor 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>`_.\n\nWarning\n=======\nSome people have reported an undocumented bug that can potentially corrupt the I2C bus.\nIt occurs if an MCP230XX input pin state changes during I2C readout. **This should be very rare.** For more information, see this `forum post <https://www.microchip.com/forums/m646539.aspx>`_ and this `knowledge base article <https://microchipsupport.force.com/s/article/On-MCP23008-MCP23017-SDA-line-change-when-GPIO7-input-change>`_ .\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_MCP230xx/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for controlling a MCP23008 or MCP23017 I2C GPIO expander.",
"version": "2.5.15",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_MCP230xx"
},
"split_keywords": [
"adafruit",
" mcp23017",
" mcp23008",
" i2c",
" gpio",
" expander",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "07a9f9e859f4073224a8b4b15f50312bbbfe95baa450604e93380190f00f10a8",
"md5": "4867335fae0a95b262d2a81967e8ee6a",
"sha256": "fcfa62bd647d71639bffb0e0d5f795d49f415503bbd598f41ae6f1e12c772ace"
},
"downloads": -1,
"filename": "adafruit_circuitpython_mcp230xx-2.5.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4867335fae0a95b262d2a81967e8ee6a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 18317,
"upload_time": "2024-10-08T21:49:15",
"upload_time_iso_8601": "2024-10-08T21:49:15.183194Z",
"url": "https://files.pythonhosted.org/packages/07/a9/f9e859f4073224a8b4b15f50312bbbfe95baa450604e93380190f00f10a8/adafruit_circuitpython_mcp230xx-2.5.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b71e3806ce56649a46d7fd455d39ce0f0f2ecc747012490e9e75d71a54bf6678",
"md5": "768a934532bb552c15be0a9201773528",
"sha256": "9c9b5c75174e4ae9dbadf2f24288358e05c7adf59203021b689958d87b9ba776"
},
"downloads": -1,
"filename": "adafruit_circuitpython_mcp230xx-2.5.15.tar.gz",
"has_sig": false,
"md5_digest": "768a934532bb552c15be0a9201773528",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 33824,
"upload_time": "2024-10-08T21:49:16",
"upload_time_iso_8601": "2024-10-08T21:49:16.816456Z",
"url": "https://files.pythonhosted.org/packages/b7/1e/3806ce56649a46d7fd455d39ce0f0f2ecc747012490e9e75d71a54bf6678/adafruit_circuitpython_mcp230xx-2.5.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-08 21:49:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_MCP230xx",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-mcp230xx"
}
JSON
