Introduction
============
.. image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/XENONFFM/CircuitPython_PCA9674/workflows/Build%20CI/badge.svg
:target: https://github.com/XENONFFM/CircuitPython_PCA9674/actions
:alt: Build Status
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Code Style: Ruff
Interface library for the NXP PCA9674 and PCA9674A I2C 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://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!
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/circuitpython-pca9674/>`_.
To install for current user:
.. code-block:: shell
pip3 install circuitpython-pca9674
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install circuitpython-pca9674
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 circuitpython-pca9674
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 pca9674
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
See examples/pca9674_simpletest.py for a demo of the usage.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://circuitpython-pca9674.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/XENONFFM/CircuitPython_PCA9674/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "circuitpython-pca9674",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "blinka, circuitpython, micropython, pca9674, pca9674a",
"author": null,
"author_email": "Finn Scheller <23389984+XENONFFM@users.noreply.github.com>",
"download_url": "https://files.pythonhosted.org/packages/59/9c/5539279dc85ff1ebd83c1b85317135cb101bb023fd088325965db49850b2/circuitpython_pca9674-1.0.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\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/XENONFFM/CircuitPython_PCA9674/workflows/Build%20CI/badge.svg\n :target: https://github.com/XENONFFM/CircuitPython_PCA9674/actions\n :alt: Build Status\n\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Code Style: Ruff\n\n\nInterface library for the NXP PCA9674 and PCA9674A I2C I/O extenders.\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\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\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/circuitpython-pca9674/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install circuitpython-pca9674\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install circuitpython-pca9674\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 circuitpython-pca9674\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 pca9674\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\nSee examples/pca9674_simpletest.py for a demo of the usage.\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://circuitpython-pca9674.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/XENONFFM/CircuitPython_PCA9674/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": null,
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/XENONFFM/CircuitPython_PCA9674"
},
"split_keywords": [
"blinka",
" circuitpython",
" micropython",
" pca9674",
" pca9674a"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b04d10e57711e212dd84dcc9434d8f80d18d1a59a1327000ecf68621697860bc",
"md5": "33fd78c679b960eaf3cdbb62e981e5d3",
"sha256": "79220b8ff1a1b2c1bad119e77129119a052292663bb1b462d7df4a3a3e021d25"
},
"downloads": -1,
"filename": "circuitpython_pca9674-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "33fd78c679b960eaf3cdbb62e981e5d3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7223,
"upload_time": "2024-08-16T16:22:08",
"upload_time_iso_8601": "2024-08-16T16:22:08.768320Z",
"url": "https://files.pythonhosted.org/packages/b0/4d/10e57711e212dd84dcc9434d8f80d18d1a59a1327000ecf68621697860bc/circuitpython_pca9674-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "599c5539279dc85ff1ebd83c1b85317135cb101bb023fd088325965db49850b2",
"md5": "03c3aff9c4bb56d039916eaa3592cd20",
"sha256": "bcb7df1faaba7b873a9c1eedf700117700a9fcab66fad67b0a309772289ab6cd"
},
"downloads": -1,
"filename": "circuitpython_pca9674-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "03c3aff9c4bb56d039916eaa3592cd20",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 18896,
"upload_time": "2024-08-16T16:22:14",
"upload_time_iso_8601": "2024-08-16T16:22:14.902565Z",
"url": "https://files.pythonhosted.org/packages/59/9c/5539279dc85ff1ebd83c1b85317135cb101bb023fd088325965db49850b2/circuitpython_pca9674-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-16 16:22:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "XENONFFM",
"github_project": "CircuitPython_PCA9674",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "circuitpython-pca9674"
}
JSON
