adafruit-circuitpython-mcp230xx


Nameadafruit-circuitpython-mcp230xx JSON
Version 2.5.10 PyPI version JSON
download
home_page
SummaryCircuitPython library for controlling a MCP23008 or MCP23017 I2C GPIO expander.
upload_time2023-05-18 15:39:31
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords adafruit mcp23017 mcp23008 i2c gpio expander hardware micropython circuitpython
VCS
bugtrack_url
requirements Adafruit-Blinka adafruit-circuitpython-busdevice
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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": "",
    "name": "adafruit-circuitpython-mcp230xx",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "adafruit,mcp23017,mcp23008,i2c,gpio,expander,hardware,micropython,circuitpython",
    "author": "",
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/db/f2/702f6a101a5f9024f340437bcef289422ffbcc31a5f1d9513064e0616c0a/adafruit-circuitpython-mcp230xx-2.5.10.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.10",
    "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": "244219a8310dcde9d2cd8bdc7843baf71d0ed41f3418dc1cd481468302f08394",
                "md5": "7517dd9fb5e63955ab721dd54ef5a8ff",
                "sha256": "6915288356814a7f06260274004e31397cf2ddeb0bf6cfbe026aa15fd4a00691"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_mcp230xx-2.5.10-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7517dd9fb5e63955ab721dd54ef5a8ff",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 18283,
            "upload_time": "2023-05-18T15:39:29",
            "upload_time_iso_8601": "2023-05-18T15:39:29.076076Z",
            "url": "https://files.pythonhosted.org/packages/24/42/19a8310dcde9d2cd8bdc7843baf71d0ed41f3418dc1cd481468302f08394/adafruit_circuitpython_mcp230xx-2.5.10-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dbf2702f6a101a5f9024f340437bcef289422ffbcc31a5f1d9513064e0616c0a",
                "md5": "cd45c17a7d4f941b0f5cfec141216785",
                "sha256": "254511edead94d40c810d7c253211091e743942573dba9cb1de70ac6d0b39b9e"
            },
            "downloads": -1,
            "filename": "adafruit-circuitpython-mcp230xx-2.5.10.tar.gz",
            "has_sig": false,
            "md5_digest": "cd45c17a7d4f941b0f5cfec141216785",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 33848,
            "upload_time": "2023-05-18T15:39:31",
            "upload_time_iso_8601": "2023-05-18T15:39:31.145057Z",
            "url": "https://files.pythonhosted.org/packages/db/f2/702f6a101a5f9024f340437bcef289422ffbcc31a5f1d9513064e0616c0a/adafruit-circuitpython-mcp230xx-2.5.10.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-18 15:39:31",
    "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": [
        {
            "name": "Adafruit-Blinka",
            "specs": []
        },
        {
            "name": "adafruit-circuitpython-busdevice",
            "specs": []
        }
    ],
    "lcname": "adafruit-circuitpython-mcp230xx"
}
        
Elapsed time: 0.13979s