Skip to content

adafruit/Adafruit_CircuitPython_BusDevice

Repository files navigation

Adafruit CircuitPython BusDevice

Documentation Status Discord Build Status

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.

Installation

This library is NOT built into CircuitPython to make it easy to update. To install it either follow the directions below or install the library bundle.

To install:

  1. Download and unzip the latest release zip.
  2. Copy the unzipped adafruit_bus_device to the lib directory on the CIRCUITPY drive.

Usage Example

See examples/read_register_i2c.py and examples/read_register_spi.py for examples of the module's usage.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Documentation

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