Adafruit CircuitPython BusDevice
================================
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-busdevice/badge/?version=latest
:target: https://docs.circuitpython.org/projects/busdevice/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_BusDevice/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice/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
The ``I2CDevice`` and ``SPIDevice`` helper classes make managing transaction state
on a bus easy. For example, they manage locking the bus to prevent other
concurrent access. For SPI devices, it manages the chip select and protocol
changes such as mode. For I2C, it manages the device address.
.. _bus_device_installation:
.. note:: On microcontroller boards using CircuitPython v6.3.0 or newer, the firmware
may already have the ``adafruit_bus_device`` package builtin, thus there may be no
need to add this package to your CIRCUITPY drive's "lib" directory. If both the
builtin and add-on ``adafruit_bus_device`` packages are present, then some
libraries that require this package *might* have problems importing it.
Please check the `CircuitPython documentation's "module support matrix"
<https://docs.circuitpython.org/en/latest/shared-bindings/support_matrix.html>`_
to make sure that your board's firmware does include the builtin ``adafruit_bus_device``
package.
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-busdevice/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-busdevice
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-busdevice
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-busdevice
Usage Example
=============
See examples/read_register_i2c.py and examples/read_register_spi.py for examples of the module's usage.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/busdevice/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_BusDevice/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-busdevice",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, spi, i2c, bus, device, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/a8/04/cf8d2ebfe0d171b7c8fe3425f1e2e80ed59738855d419e5486f5d2fa9145/adafruit_circuitpython_busdevice-5.2.9.tar.gz",
"platform": null,
"description": "Adafruit CircuitPython BusDevice\n================================\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-busdevice/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/busdevice/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_BusDevice/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice/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\nThe ``I2CDevice`` and ``SPIDevice`` helper classes make managing transaction state\non a bus easy. For example, they manage locking the bus to prevent other\nconcurrent access. For SPI devices, it manages the chip select and protocol\nchanges such as mode. For I2C, it manages the device address.\n\n.. _bus_device_installation:\n\n.. note:: On microcontroller boards using CircuitPython v6.3.0 or newer, the firmware\n may already have the ``adafruit_bus_device`` package builtin, thus there may be no\n need to add this package to your CIRCUITPY drive's \"lib\" directory. If both the\n builtin and add-on ``adafruit_bus_device`` packages are present, then some\n libraries that require this package *might* have problems importing it.\n\n Please check the `CircuitPython documentation's \"module support matrix\"\n <https://docs.circuitpython.org/en/latest/shared-bindings/support_matrix.html>`_\n to make sure that your board's firmware does include the builtin ``adafruit_bus_device``\n package.\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-busdevice/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-busdevice\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-busdevice\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-busdevice\n\nUsage Example\n=============\n\nSee examples/read_register_i2c.py and examples/read_register_spi.py for examples of the module's usage.\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/busdevice/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\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_BusDevice/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython bus device classes to manage bus sharing.",
"version": "5.2.9",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_BusDevice"
},
"split_keywords": [
"adafruit",
" spi",
" i2c",
" bus",
" device",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "070d6d730f9b0867437d701503792988abe663a09c7a3a5fcd98c19ce3c94681",
"md5": "fd91a5c5a4052b835e93c21656ba0abe",
"sha256": "78245c551eb3795a4f3739f1adac0b08a65c9fb0f722e866de620482cbbac51f"
},
"downloads": -1,
"filename": "adafruit_circuitpython_busdevice-5.2.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fd91a5c5a4052b835e93c21656ba0abe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7526,
"upload_time": "2024-04-22T16:50:32",
"upload_time_iso_8601": "2024-04-22T16:50:32.395421Z",
"url": "https://files.pythonhosted.org/packages/07/0d/6d730f9b0867437d701503792988abe663a09c7a3a5fcd98c19ce3c94681/adafruit_circuitpython_busdevice-5.2.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a804cf8d2ebfe0d171b7c8fe3425f1e2e80ed59738855d419e5486f5d2fa9145",
"md5": "faf73b20ccaf62ed343169ae84ee56c2",
"sha256": "9f9c3df385091410dac5961918e475ec88faed7ff543ad6d74208f08c2566513"
},
"downloads": -1,
"filename": "adafruit_circuitpython_busdevice-5.2.9.tar.gz",
"has_sig": false,
"md5_digest": "faf73b20ccaf62ed343169ae84ee56c2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27607,
"upload_time": "2024-04-22T16:50:34",
"upload_time_iso_8601": "2024-04-22T16:50:34.707986Z",
"url": "https://files.pythonhosted.org/packages/a8/04/cf8d2ebfe0d171b7c8fe3425f1e2e80ed59738855d419e5486f5d2fa9145/adafruit_circuitpython_busdevice-5.2.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-22 16:50:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_BusDevice",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-busdevice"
}
JSON
