CircuitPython bus device classes to manage bus sharing.
Project description
Adafruit CircuitPython BusDevice
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:
Download and unzip the latest release zip.
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.
Building locally
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-toolsOnce installed, make sure you are in the virtual environment:
source .env/bin/activateThen run the build:
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-busdevice --library_location .Sphinx documentation
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-themeNow, once you have the virtual environment activated:
cd docs
sphinx-build -E -W -b html . _build/htmlThis 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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file adafruit-circuitpython-busdevice-2.2.11.tar.gz.
File metadata
- Download URL: adafruit-circuitpython-busdevice-2.2.11.tar.gz
- Upload date:
- Size: 23.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6a91e341bf36e105f0a4f6556558314e4b333feceeefb8b67c58344f4fe2cdd1 |
|
| MD5 | 3863f1841c72d25c389ad8856d60db39 |
|
| BLAKE2b-256 | 394682b0f595f7d9d94d197d26391db6b04addc389e7c66ee047117338204734 |
