https://github.com/adafruit/adafruit_circuitpython_busdevice

Two helper classes that handle transaction related state for I2C and SPI including locks.
https://github.com/adafruit/adafruit_circuitpython_busdevice

circuitpython hacktoberfest

Last synced: 4 days ago
JSON representation

Two helper classes that handle transaction related state for I2C and SPI including locks.

• Host: GitHub
• URL: https://github.com/adafruit/adafruit_circuitpython_busdevice
• Owner: adafruit
• License: mit
• Created: 2016-12-02T01:41:12.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2024-10-07T22:29:15.000Z (3 months ago)
• Last Synced: 2024-12-27T06:04:43.435Z (4 days ago)
• Topics: circuitpython, hacktoberfest
• Language: Python
• Size: 184 KB
• Stars: 110
• Watchers: 27
• Forks: 76
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
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"

    `_

    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 `_. 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 `_.

For information on building library documentation, please check out `this guide `_.

Contributing

============

Contributions are welcome! Please read our `Code of Conduct

`_

before contributing to help this project stay welcoming.