Skip to main content

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.

Release files for Adafruit-Blinka 9.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for Adafruit-Blinka 9.2.0
File Size Uploaded
adafruit_blinka-9.2.0.tar.gz 937.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for Adafruit-Blinka 9.2.0
File Interpreter ABI Platform
adafruit_blinka-9.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 2.0 MB

Release files / adafruit_blinka-9.2.0.tar.gz

Download URL adafruit_blinka-9.2.0.tar.gz
Size 937.6 kB
Tags Source
SHA-256 checksum
How to use checksums
0358f02840f91127246d9c5fa6d49660e2ab1134cc4e56fd5d88ce4c39a50942
BLAKE2b-256 checksum
How to use checksums
aeee63370e529cb21a56406b58773ab2e97c3bffd8dec391746df1fe238e3c1e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.6

Release files / adafruit_blinka-9.2.0-py3-none-any.whl

Download URL adafruit_blinka-9.2.0-py3-none-any.whl
Size 1.1 MB
Tags Python 3
SHA-256 checksum
How to use checksums
ba761bd1eb5fd7c6626e2505dd7e63b0df9b7859eea91d952aba4ee2bec83ee9
BLAKE2b-256 checksum
How to use checksums
d9e162809e4d3f24f433e27e66f03afab7aa653627c7fbb9ddad9088032b6366
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.6

Release history Release notifications | RSS feed

This release

9.2.0 This release

2 release files

9.1.0

2 release files

9.0.4

2 release files

9.0.3

2 release files

9.0.2

2 release files

9.0.1

2 release files

9.0.0

2 release files

8.69.0

2 release files

8.68.1

2 release files

8.68.0

2 release files

8.67.0

2 release files

8.66.2

2 release files

8.66.1

2 release files

8.65.0

2 release files

8.64.0

2 release files

8.63.0

2 release files

8.61.2

2 release files

8.61.1

2 release files

8.61.0

2 release files

8.60.4

2 release files

8.60.3

2 release files

8.60.2

2 release files

8.60.1

2 release files

8.60.0

2 release files

8.59.0

2 release files

8.58.1

2 release files

8.58.0

2 release files

8.56.0

2 release files

8.54.0

2 release files

8.53.0

2 release files

8.52.0

2 release files

8.51.0

2 release files

8.50.0

2 release files

8.49.0

2 release files

8.47.0

2 release files

8.46.1

2 release files

8.46.0

2 release files

8.45.0

1 release file

8.44.4

2 release files

8.44.3

2 release files

8.44.2

2 release files

8.44.1

2 release files

8.44.0

2 release files

8.43.0

2 release files

8.42.1

2 release files

8.42.0

2 release files

8.41.2

2 release files

8.41.1

2 release files

8.39.2

2 release files

8.38.0

2 release files

8.37.0

2 release files

8.36.0

2 release files

8.35.0

2 release files

8.33.0

2 release files

8.31.0

2 release files

8.30.0

2 release files

8.29.0

2 release files

8.28.1

2 release files

8.28.0

2 release files

8.26.0

2 release files

8.25.0

2 release files

8.24.0

2 release files

8.23.0

2 release files

8.22.4

2 release files

8.22.3

2 release files

8.22.2

2 release files

8.22.1

2 release files

8.20.1

2 release files

8.18.1

2 release files

8.15.2

2 release files

8.15.1

2 release files

8.14.0

2 release files

8.13.0

2 release files

8.12.1

2 release files

8.12.0

2 release files

8.10.0

2 release files

8.9.0

2 release files

8.8.0

2 release files

8.7.0

2 release files

8.6.1

2 release files

8.6.0

2 release files

8.5.0

2 release files

8.4.2

2 release files

8.4.0

1 release file

8.3.0

1 release file

8.2.2

1 release file

8.2.1

1 release file

8.2.0

1 release file

8.1.0

1 release file

8.0.2

1 release file

8.0.1

1 release file

8.0.0

1 release file

7.4.0

1 release file

7.3.0

1 release file

7.2.3

1 release file

7.2.2

1 release file

7.2.1

1 release file

7.2.0

1 release file

7.1.2

1 release file

7.1.1

1 release file

7.1.0

1 release file

7.0.2

1 release file

7.0.1

1 release file

7.0.0

1 release file

6.20.4

1 release file

6.20.3

1 release file

6.20.2

1 release file

6.20.1

1 release file

6.20.0

1 release file

6.19.0

1 release file

6.18.0

1 release file

6.17.0

1 release file

6.16.0

1 release file

6.15.0

1 release file

6.14.1

1 release file

6.14.0

1 release file

6.13.1

1 release file

6.13.0

1 release file

6.12.0

1 release file

6.11.1

1 release file

6.11.0

1 release file

6.10.3

1 release file

6.10.2

1 release file

6.10.1

1 release file

6.10.0

1 release file

6.9.2

1 release file

6.9.1

1 release file

6.9.0

1 release file

6.8.3

1 release file

6.8.2

1 release file

6.8.1

1 release file

6.8.0

1 release file

6.7.0

1 release file

6.6.2

1 release file

6.6.1

1 release file

6.6.0

1 release file

6.5.0

1 release file

6.4.2

1 release file

6.4.1

1 release file

6.4.0

1 release file

6.3.2

1 release file

6.3.1

1 release file

6.3.0

1 release file

6.2.2

1 release file

6.2.1

1 release file

6.2.0

1 release file

6.1.0

1 release file

6.0.2

1 release file

6.0.1

1 release file

6.0.0

1 release file

5.13.1

1 release file

5.13.0

1 release file

5.12.0

1 release file

5.11.0

1 release file

5.10.0

1 release file

5.9.2

1 release file

5.9.1

1 release file

5.9.0

1 release file

5.8.2

1 release file

5.8.1

1 release file

5.8.0

1 release file

5.7.0

1 release file

5.6.0

1 release file

5.5.4

1 release file

5.5.3

1 release file

5.5.2

1 release file

5.5.1

1 release file

5.5.0

1 release file

5.4.1

1 release file

5.4.0

1 release file

5.3.4

1 release file

5.3.3

1 release file

5.3.2

1 release file

5.3.1

1 release file

5.3.0

1 release file

5.2.4

1 release file

5.2.3

1 release file

5.2.2

1 release file

5.2.1

1 release file

5.2.0

1 release file

5.1.0

1 release file

5.0.1

1 release file

5.0.0

1 release file

4.10.1

1 release file

4.10.0

1 release file

4.9.0

1 release file

4.8.1

1 release file

4.8.0

1 release file

4.7.0

1 release file

4.6.0

1 release file

4.5.0

1 release file

4.4.0

1 release file

4.3.0

1 release file

4.2.0

1 release file

4.1.0

1 release file

4.0.0

1 release file

3.10.0

1 release file

3.9.0

1 release file

3.8.0

1 release file

3.7.1

1 release file

3.7.0

1 release file

3.6.1

1 release file

3.6.0

1 release file

3.5.2

1 release file

3.5.1

1 release file

3.5.0

1 release file

3.4.1

1 release file

3.4.0

1 release file

3.3.10

1 release file

3.3.9

1 release file

3.3.8

1 release file

3.3.7

1 release file

3.3.6

1 release file

3.3.5

1 release file

3.3.4

1 release file

3.3.3

1 release file

3.3.2

1 release file

3.3.1

1 release file

3.3.0

1 release file

3.2.0

1 release file

3.1.2

1 release file

3.1.1

1 release file

3.1.0

1 release file

3.0.8

1 release file

3.0.7

1 release file

3.0.6

1 release file

3.0.5

1 release file

3.0.4

1 release file

3.0.3

1 release file

3.0.2

1 release file

3.0.1

1 release file

3.0.0

1 release file

2.6.1

1 release file

2.6.0

1 release file

2.5.3

1 release file

2.5.2

1 release file

2.5.1

1 release file

2.5.0

1 release file

2.4.1

1 release file

2.4.0

1 release file

2.3.3

1 release file

2.3.2

1 release file

2.3.1

1 release file

2.3.0

1 release file

2.2.1

1 release file

2.2.0

1 release file

2.1.6

1 release file

2.1.5

1 release file

2.1.4

1 release file

2.1.3

1 release file

2.1.2

1 release file

2.1.1

1 release file

2.1.0

1 release file

2.0.2

1 release file

2.0.1

1 release file

2.0.0

1 release file

1.3.4

1 release file

1.3.3

1 release file

1.3.2

1 release file

1.3.1

1 release file

1.3.0

1 release file

1.2.8

1 release file

1.2.7

1 release file

1.2.6

1 release file

1.2.5

1 release file

1.2.4

1 release file

1.2.3

1 release file

1.2.1

1 release file

1.2.0

1 release file

1.1.1

1 release file

1.1.0

1 release file

1.0.2

1 release file

0.4.0

1 release file

0.3.2

1 release file

0.3.1

1 release file

0.3.0

1 release file

0.2.7

1 release file

0.2.6

1 release file

0.2.5

1 release file

0.2.4

1 release file

0.2.3

1 release file

0.2.2

1 release file

0.2.1

1 release file

0.2

1 release file

0.1.10

1 release file

0.1.9

1 release file

0.1.8

1 release file

0.1.7

1 release file

0.1.6

1 release file

0.1.5

1 release file

0.1.4

1 release file

0.1.3

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page