Skip to content

Latest commit

 

History

History
executable file
·
82 lines (56 loc) · 3.04 KB

README.rst

File metadata and controls

executable file
·
82 lines (56 loc) · 3.04 KB
Raw

Introduction

Documentation Status Discord Build Status

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 CPython or 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-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.