CircuitPython bus device classes to manage bus sharing.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for adafruit-python from gravatar.com adafruit-python Avatar for adafruit-travis from gravatar.com adafruit-travis Avatar for tannewt from gravatar.com tannewt

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Adafruit Industries
  • Tags adafruit, spi, i2c, bus, device, micropython, circuitpython
  • Provides-Extra: optional
Classifiers
Report project as malware

Project description

Adafruit CircuitPython BusDevice

Documentation Status Discord Build Status 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.

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-busdevice

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-busdevice

To install in a virtual environment in your current project:

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.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page