Skip to main content

PIO implementation of CircuitPython UART API

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

PIO implementation of CircuitPython UART API

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

Works with the Raspberry Pi RP2040 Pico family.

Purchase one from the Adafruit shop.

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-circuitpython-pio-uart

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

sudo pip3 install adafruit-circuitpython-pio-uart

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-pio-uart

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install adafruit_pio_uart

Or the following command to update an existing version:

circup update

Usage Example

import board
import adafruit_pio_uart

uart = adafruit_pio_uart.UART(board.TX, board.RX)

uart.write(b"\x00")
print(uart.read(1))

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit_circuitpython_pio_uart-1.1.5.tar.gz (25.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file adafruit_circuitpython_pio_uart-1.1.5.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_pio_uart-1.1.5.tar.gz
Algorithm Hash digest
SHA256 1b6c158eff9a23913527e1c6eb8ed0caca36faffda11912bd74511a7401c7b41
MD5 7166825e952ad91567b52a44c0608078
BLAKE2b-256 fb61fee48580d561d1f965b1e2a1f7bbba6650200b409256bf3e06a2c1f13bf7

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_pio_uart-1.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_pio_uart-1.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 5395ff5d01a299980e8d5d92728e678ced0fd16e208f1bbcda9b49ffc6cb98d8
MD5 9179eb823024dc565d624f9ff53ed73b
BLAKE2b-256 8fee6018f79af82d0027d5c731a8b19add16e773d1a5237f0994702aad7f36ce

See more details on using hashes here.

Supported by

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