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.
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:
pip3 install adafruit-circuitpython-busdeviceTo install system-wide (this may be required in some cases):
sudo pip3 install adafruit-circuitpython-busdeviceTo 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-busdeviceSee examples/read_register_i2c.py and examples/read_register_spi.py for examples of the module's usage.
API documentation for this library can be found on Read the Docs.
For information on building library documentation, please check out this guide.
Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.
