alvahdean / adafruit_circuitpython_busdevice Goto Github PK

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.

This library is NOT built into CircuitPython to make it easy to update. To install it either follow the directions below or :ref:`install the library bundle <bundle_installation>`.

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.

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

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

To build this library locally you'll need to install the circuitpython-build-tools package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-busdevice --library_location .

Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

cd docs
sphinx-build -E -W -b html . _build/html

This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.