CircuitPython APIs for non-CircuitPython versions of Python such as CPython on Linux and MicroPython.
Project description
Introduction
This repository contains a selection of packages mirroring the CircuitPython API on hosts running micropython. Working code exists to emulate the CircuitPython packages;
board - breakout-specific pin identities
microcontroller - chip-specific pin identities
digitalio - digital input/output pins, using pin identities from board+microcontroller packages
bitbangio - software-driven interfaces for I2C, SPI
busio - hardware-driven interfaces for I2C, SPI, UART
time * - substitute functions monkey-patched to time module
Dependencies
The Micropython compatibility layers described above are intended to provide a CircuitPython-like API for devices which are running Micropython. Since corresponding packages should be built-in to any standard CircuitPython image, they have no value on a device already running CircuitPython and would likely conflict in unhappy ways.
The test suites in the test/src folder under testing.universal are by design intended to run on either CircuitPython or Micropython+compatibility layer to prove conformance.
Usage Example
At the time of writing (git:7fc1f8ab), the following sequence runs through some basic testing of the digitalio compatibility layer…
from testing import test_module_name
test_module_name("testing.universal.digitalio")An example log from running the suites is here .
Contributing
Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.
Building locally
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-Blinka-0.4.0.tar.gz.
File metadata
- Download URL: Adafruit-Blinka-0.4.0.tar.gz
- Upload date:
- Size: 67.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 841fec719cd2a6ce6c936cbe8066c1ead449d2844b2212b0f1525e49251f5d0d |
|
| MD5 | a82ddd3c256f837dd31e83554477e267 |
|
| BLAKE2b-256 | b4b60992703e7e319d075057628aaa6c34d4435e080164148f7a82cad75cec00 |
