Skip to main content

CircuitPython APIs for non-CircuitPython versions of Python such as CPython on Linux and MicroPython.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

This repository contains a selection of packages emulating the CircuitPython API for devices or hosts running CPython or MicroPython. Working code exists to emulate these CircuitPython packages:

  • analogio - analog input/output pins, using pin identities from board+microcontroller packages

  • bitbangio - software-driven interfaces for I2C, SPI

  • board - breakout-specific pin identities

  • busio - hardware-driven interfaces for I2C, SPI, UART

  • digitalio - digital input/output pins, using pin identities from board+microcontroller packages

  • keypad - support for scanning keys and key matrices

  • microcontroller - chip-specific pin identities

  • micropython - MicroPython-specific module

  • neopixel_write - low-level interface to NeoPixels

  • pulseio - contains classes that provide access to basic pulse IO (PWM)

  • pwmio - contains classes that provide access to basic pulse IO (PWM)

  • rainbowio - provides the colorwheel() function

  • usb_hid - act as a hid-device using usb_gadget kernel driver

For details, see the Blinka API reference.

Dependencies

The emulation described above is 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 CPython/Micropython+compatibility layer to prove conformance.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install Adafruit-Blinka

To install system-wide (this may be required in some cases):

sudo pip3 install Adafruit-Blinka

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install Adafruit-Blinka

Usage Example

The pin names may vary by board, so you may need to change the pin names in the code. This example runs on the Raspberry Pi boards to blink an LED connected to GPIO 18 (Pin 12):

import time
import board
import digitalio

PIN = board.D18

print("hello blinky!")

led = digitalio.DigitalInOut(PIN)
led.direction = digitalio.Direction.OUTPUT

while True:
    led.value = True
    time.sleep(0.5)
    led.value = False
    time.sleep(0.5)

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 Adafruit-PlatformDetect

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.

Project details


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

adafruit_blinka-8.50.0.tar.gz (249.0 kB view details)

Uploaded Source

Built Distribution

Adafruit_Blinka-8.50.0-py3-none-any.whl (364.6 kB view details)

Uploaded Python 3

File details

Details for the file adafruit_blinka-8.50.0.tar.gz.

File metadata

  • Download URL: adafruit_blinka-8.50.0.tar.gz
  • Upload date:
  • Size: 249.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for adafruit_blinka-8.50.0.tar.gz
Algorithm Hash digest
SHA256 64feecaa7f806fdd02b39521b5b400ebfb629a06a27a3360644375af0bbe67c2
MD5 d36fc6174c04f60cd491ada67e2dec35
BLAKE2b-256 a361e849ab2fd7a0a154d30535aa7b4cf11cb9fbcc6a5817cbc1307e509e0b34

See more details on using hashes here.

File details

Details for the file Adafruit_Blinka-8.50.0-py3-none-any.whl.

File metadata

File hashes

Hashes for Adafruit_Blinka-8.50.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a0832316ac4155df956a1e35561c75e37e6f8d8e2f28b58859c80207e7819351
MD5 73b8925d9eacf76ff4d7587d3a9e8f0f
BLAKE2b-256 d922035a6d7526388f0fef67725e3d3584c5b2cbd2c1d5a233681f4ec01e6a7e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page